README.md

TruckSim-Telemetry

TruckSim-Telemetry is a node module that takes telemetry data for Euro Truck Simulator 2 and American Truck Simulator provided by the scs-sdk-plugin and outputs parsed data and events.

Documentation

Read the full documentation over at https://tst.kniffen.dev

Getting started

Prerequisites

Download and install the 󠀠󠀠󠀠󠀠scs-sdk-plugin by RenCloud

Supported plugin versions (Limited meaning some data and/or events may be inaccurate)

• v1.12.0
• v1.11.0
• v1.10.6
• v1.10.5 (Limited)
• v1.10.4 (Limited)

Install the 󠀠󠀠󠀠󠀠windows-build-tools

Installing

Install the module via NPM npm install trucksim-telemetry

Examples

Check the Documentation page for examples

Known issues

refuel-paid event not emitting

This seems to be a problem with the plugin. It seems to only trigger once per game.

Electron and React or Vue (webpack)

An common issue reported by people is getting the following error message when trying to use the module with React or Vue.
Module not found: Error: Can't resolve '../../build/Release/scsTelemetry' ...
This seems to be webpack related, and adding the following alias to your webpack.config.js file should resolve it

// webpack.config.js
module.exports = {
  resolve: {
    alias: {
      "../../build/Release/scsSDKTelemetry": "../../build/Release/scsSDKTelemetry.node"
    }
  }
}

For Electron you may or may not additionally have to set the following preferences when creating your browser window

webPreferences: {
  nodeIntegration: true,
  contextIsolation: false,
}

Trailer damage values

The current version of the scs-sdk-plugin does not provide the damage value for the trailer's body, as such the total damage value is also incorrect.

Demo

To help visualize the data you can use this Demo app

License

This project is licensed under the MIT License - see the LICENSE file for details