VDTelemetry

Just want to run it? → Setup guide (English) · Anleitung (Deutsch) · Downloads

A telemetry pipeline for Farming Simulator 25, in two parts:

• vdTelemetry/ — the in-game mod (Lua) that exports live game state to vdTelemetry.json and a set of sibling channel files, and takes commands back through a command channel.
• VDTerminal/ — a Kotlin Multiplatform app that watches those files and renders a live web dashboard, on this machine or on a tablet or phone on the LAN.

The shared Kotlin model (VDTerminal/shared/.../model/) plus the examples/json/ fixtures are the contract between the two: changing the data shape means changing the Lua collectors and the Kotlin model together, and refreshing the fixtures.

Requirements: the mod needs FS25_additionalInputs; the terminal needs JDK 25+ and a WasmGC-capable browser. Each README has the full story — how the mod is configured and what each channel carries, and how to run the terminal in development or as a single production process.

Licence

MIT — see LICENSE, and NOTICE for the trademarks this project does not own and the third-party terms that apply alongside it. Both halves are covered; the mod zip carries the same licence, and every terminal download — bundled or portable — ships both files.

The one component that is not ours to relicense is the DSEG font bundled with the terminal, under the SIL Open Font License — VDTerminal/licenses/DSEG-OFL-1.1.txt travels with every build that contains it.

Planned and deferred work

FUTURE.md collects everything planned, deferred or still open across the whole repo — the follow-ups finished work left behind and the in-game checks nobody has run. Read it before proposing something that looks new; it may already be there, with the reason it was left. (A limitation that is accepted rather than open is a decision, not future work, and lives with the feature it belongs to.)

Commit messages

Commit subjects follow:

<issue> <modifier> <[area]> <subject>

where issue and area are optional — for example LS42-8 ✨ [ui] add short-url filtering.

• issue – LS42-8 (<PROJECT>-<number>) or #8.

• modifier – a gitmoji describing the kind of change. Write the emoji directly, or use the one-letter shorthand below; the local commit-msg hook rewrites the shorthand to the emoji on commit:

  shorthand	emoji	meaning
  +	✨	new feature
  !	🚑	bug fix
  -	🔥	remove code
  r	🔨	refactor (no behavior change)
  c	📖	documentation only
  t	🚨	tests
  v	⬆️	upgrade dependencies / versions
  b	💚	CI
  i	🎉	initial / project setup

• area – the affected scope in brackets, e.g. [ui], [service], [common].