chore: updated the README

This commit is contained in:
2026-11-08 23:24:08 +00:00
parent cd7850987c
commit c6129d0351
2 changed files with 15 additions and 7 deletions
+12 -7
View File
@@ -1,23 +1,28 @@
# BeamNGMockOG # TelemetryMockserver
Utility to both record (with the caveat that it doesn't record yet) and replay Utility to both record and replay telemetry data from multiple simulators.
binary data relating to the Outgauge struct of beamng.
This will help me develop some stuff I'm doing for `ESDI` and my peripherals This will help me develop some stuff I'm doing for `ESDI` and my peripherals
without having to be playing the game while doing it (fans are noisy). without having to be playing the game while doing it (fans are noisy).
## Related projects
- [ESDI](https://github.com/ESilva15/ESDI)
- [iRacing Go SDK](https://github.com/ESilva15/goirsdk)
- [BeamNG Go SDK](https://github.com/ESilva15/gobngsdk)
# Installation # Installation
`go install github.com/ESilva15/BeamNGMockOg@latest` `go install github.com/ESilva15/TelemetryMockserver@latest`
# Usage # Usage
To start replaying: To start replaying (BeamNG as an example):
`telemetrymockserver beamng replay [--loop] -a 127.0.0.1 -p 4443 -i sunburstManual.bin` `telemetrymockserver beamng replay [--loop] -a 127.0.0.1 -p 4443 -i sunburstManual.bin`
- `loop` allows the replay functionality to keep replaying the same data file - `loop` allows the replay functionality to keep replaying the same data file
To start recording: To start recording (BeamNG as an example):
`BeamNGMockOg beamng record -a 127.0.0.1 -p 4443 -o sunburstDCT.bin` `TelemetryMockserver beamng record -a 127.0.0.1 -p 4443 -o sunburstDCT.bin`
## Development ## Development
Use `tcpdump` to listen to the socket and check if data is coming through: Use `tcpdump` to listen to the socket and check if data is coming through:
+3
View File
@@ -15,3 +15,6 @@ require (
golang.org/x/text v0.19.0 // indirect golang.org/x/text v0.19.0 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect gopkg.in/yaml.v3 v3.0.1 // indirect
) )
//
// replace github.com/ESilva15/goirsdk => ../pkg/goirsdk/
// replace github.com/ESilva15/gobngsdk => ../pkg/gobngsdk/