Repository navigation
Add a Game
Simulated TrueForce already supports a handful of UDP-telemetry sims.
(UDP telemetry is live game data, such as RPM and speed, sent over the
network in small packets.) If your game sends UDP telemetry but is not one
of the listed formats, you can help add it. No programming is needed.
logi-tf-sim ships a capture mode that records the game's raw packets to
a file. Send us that file. 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. The option is usually in the game's settings, under a name like "UDP telemetry" or "dashboard output". Games differ.
-
Note the port number it sends to. It is often already filled in (for example
20777or5606). Sometimes you can pick one. -
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 lets us find the RPM, throttle and redline fields in the packets.
-
Press Ctrl-C when you are done.
logi-tf-simfinalizes the file. It prints a summary (packet count, duration, distinct sizes) and the file's name. -
Open an issue on the project's GitHub. Attach the saved file. Please mention:
- the game's name (and platform/version if relevant),
- what you did while recording (idle, rev sweeps, gear shifts, anything else).
That is it. The file only contains the raw telemetry bytes the game sent, no personal data. It is what we need to reverse the format and wire up a new parser. The existing Codemasters/F1/PCARS2/BeamNG/WRC support was added the same way.
logi-tf-sim capture --port <PORT> [--out <FILE>] [--label <TEXT>]
-
--port <PORT>(required): the UDP port to listen on. It must match 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. It is saved in the file itself, so the file describes itself 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.