alexgustafsson / f1-telemetry

A telemetry processor for the official Formula 1 games. Work in progress

Formula 1 Telemetry Companion

A telemetry processor for the official Formula 1 games.

Features and Use Cases

• Cross platform
• Use as a CLI, via the embedded web UI or as a standalone application
• Stores data as Prometheus-compatible time series
• Query data using embedded PromQL
• Fast and resource efficient
• Effortlessly produce telemetry graphs modeled after real-world teams' graphs

Usage

Work in progress.

CLI

# Start the server with the bundled web UI listening on UDP 127.0.0.1:20777 and TCP 127.0.0.1:20777
./cli start --output database --web

Development

There are some rough guidelines available below for now.

Frontend

The frontend is built with React, Tailwind CSS and Vite. It resides in frontend. Entrypoints are frontend/main.tsx for the app, frontend/main.css for the style.

# Install dependencies
yarn install

# Run the development server on http://localhost:3000
yarn run dev

# Format code
yarn run format

# Build the frontend
yarn run build

CLI

The CLI's entrypoint is cmd/cli/main.go. It handles parsing CLI flags and arguments and invokes one of the supported actions found in internal/cli.

# Build the CLI
go build -o cli cmd/cli/*.go

APP

The app's entrypoint is app.go. It handles parsing CLI flags and arguments and is mostly a wrapper for internal/app/action.go.

# Install Wails
go install github.com/wailsapp/wails/v2/cmd/wails@latest

# Run Wails in dev mode
wails dev

# Build the app in debug mode (includes DevTools accessible via right click)
wails build -debug

# Build the app
wails build

Known issues

• It seems as if F1 always give players the name "Player" in races, which makes it difficult to identify the car a certain player drove.