-
Notifications
You must be signed in to change notification settings - Fork 5
Add a Game
Simulated TrueForce already supports a handful of UDP-telemetry sims. If
your game sends UDP telemetry but is not one of the listed formats, you can
help add it, no programming needed. logi-tf-sim ships a capture mode
that records the game's raw packets to a file; send us that file and we can
work out the format and add a parser for it.
- The game, with a UDP telemetry (or "dashboard"/"motec"/"data") output option somewhere in its settings.
- A terminal.
-
Turn on UDP telemetry in the game and note the port number it sends to. This is usually in the game's settings under a name like "UDP telemetry", "dashboard output" or similar. Games differ; look for a port number, often already filled in (for example
20777or5606) or one you can pick. -
Start the capture, using that port:
logi-tf-sim capture --port <PORT> --label "<game name>"For example, for a game sending to port 30001:
logi-tf-sim capture --port 30001 --label "My Racing Game"It prints a line every second with the packet count, byte count, and the distinct payload sizes seen so far, so you can tell data is arriving.
-
Drive for about 30 seconds. Include a mix of:
- a few seconds sitting still at idle,
- a few throttle sweeps up toward the redline,
- a couple of gear shifts.
This mix is what lets us find the RPM, throttle and redline fields in the packets.
-
Press Ctrl-C when you are done.
logi-tf-simfinalizes the file and prints a summary (packet count, duration, distinct sizes) along with the file's name. -
Open an issue on the project's GitHub with the saved file attached. Please mention:
- the game's name (and platform/version if relevant),
- what you did while recording (idle, rev sweeps, gear shifts, anything else).
That's it. The file only contains the raw telemetry bytes the game sent (no personal data), and is what we need to reverse the format and wire up a new parser, the same way the existing Codemasters/F1/PCARS2/BeamNG/WRC support was added.
logi-tf-sim capture --port <PORT> [--out <FILE>] [--label <TEXT>]
-
--port <PORT>(required): the UDP port to listen on, matching what you set in the game. -
--out <FILE>: where to save the recording. Defaults to./logi-tf-capture-<port>.binin the current directory. -
--label <TEXT>: a free-text note (typically the game's name) saved in the file itself, so it is self-describing if it gets separated from your message.
See also Simulated TrueForce for how the feature works once a game is supported, and Building and Contributing for other ways to help.