Skip to content

Repository files navigation

shtep

SimHub Telemetry Export Plugin.

A SimHub plugin that records telemetry from rally and circuit sims (RBR, Dirt Rally, ACR, EA WRC, ACC, AC, iRacing, etc.) to a plain-text TSV + JSON sidecar file pair, per stage or per stint.

The core output format is a tool-agnostic intermediate designed to be consumed by an external converter (see the companion shakedown-engineer repo), or opened directly with any TSV-capable tool (Excel, pandas, awk). Optionally, shtep can also write a MoTeC .ld file itself as a post-processing step after each recording (see Export/ and the "Export MoTeC (.ld)" plugin setting) — off by default, useful if you want to use shtep standalone without the shakedown-engineer converter.

Layout

src/
  TelemetryExportPlugin/       # the plugin itself
  TelemetryExportPlugin.Tests/
fixtures/                      # sample TSV/sidecar pairs for testing
SCHEMA.md                      # the TSV + sidecar file format spec
PLUGIN_IMPLEMENTATION_PLAN.md  # v1 design notes

Building

Requires the SimHub Plugin SDK. By default the project looks for SimHub at C:\Program Files (x86)\SimHub\; override with -p:SimHubInstallPath=... or the SIMHUB_INSTALL_PATH environment variable if installed elsewhere.

dotnet build

To copy the built plugin into a running SimHub install (SimHub must be closed first):

dotnet build -t:Deploy

See SCHEMA.md for the on-disk file format and PLUGIN_IMPLEMENTATION_PLAN.md for the design rationale.

Third-party dependencies

Built against the SimHub Plugin SDK (GameReaderCommon, InputManagerCS, log4net, MahApps.Metro, Newtonsoft.Json, SimHub.Logging, SimHub.Plugins), referenced from a local SimHub install and not redistributed by this repo.

The test project additionally pulls xUnit.net and Newtonsoft.Json from NuGet as dev-time dependencies.

License

MIT — see LICENSE.

About

SimHub telemetry export plugin — records rally/circuit sim telemetry to TSV + JSON sidecar pairs

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages