trucksim-telemetry

Telemetry data from the scs-sdk-plugin

Usage no npm install needed!

<script type="module">
  import trucksimTelemetry from 'https://cdn.skypack.dev/trucksim-telemetry';
</script>

README

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.

Node version NPM version NPM Downloads Github Licence Discord

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.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.

High memory usage
This is due converting a lot of buffer data to JSON at a high interval.
To help with this you can use the --expose-gc flag with the node process you are running TruckSim-Telemetry on.
This will expose the node/V8 garbage collector and if TruckSim-Telemetry detect it, it will force the garbage collector to run every time the data is converted.
However this is not recommended as it can cause performance issues.

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

demo screenshot

License

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