Racelink
DE
Steam

// OVERLAY API

Overlays für Racelink bauen

Ein Overlay ist eine kleine Webseite. Racelink liefert ihm einheitliche Live-Daten aus jeder unterstützten Sim, ein Einstellungs-Panel aus seinem Manifest und den Weg in den Steam Workshop.

Das SDK auf npm ↗Steam Workshop ↗
  1. 01

    Erstellen

    npm create @racelink/overlay@latest

    Wähle reines TypeScript oder React. Das Projekt läuft sofort.

  2. 02

    Entwickeln

    npm run dev

    npm run dev: das Overlay erscheint in Racelink und lädt bei jeder Änderung neu. Ohne die App erzeugt das SDK Demodaten.

  3. 03

    Veröffentlichen

    npm run build

    Racelink Studio prüft das Overlay, nimmt die Vorschau auf und veröffentlicht es im Steam Workshop. Abonnenten bekommen Updates automatisch.

// TYPESCRIPT

Telemetrie lesen

  • Ein Datenmodell

    Tempo in km/h, Pedale 0–1, Zeiten in Sekunden — dieselben Felder in jeder Sim.

  • Einstellungen aus dem Manifest

    Deklariere Einstellungen in racelink.overlay.json, Racelink zeichnet das Panel.

  • Durchgehend typisiert

    Telemetrie und Einstellungen sind typisiert; die Feldreferenz dokumentiert jeden Wert.

  • Gemacht für KI-Assistenten

    Projekte enthalten AGENTS.md und eine vollständige Anleitung für Coding-Assistenten.

src/main.ts
import { createOverlay } from '@racelink/overlay';
import { defaultSettings, type Settings } from './racelink-settings';

const overlay = createOverlay<Settings>({ defaults: defaultSettings });

overlay.on('telemetry', ({ car, session }) => {
  // Normalized for every sim: km/h, pedals 0..1, seconds.
  draw(car.speedKph, car.throttle, session.lap);
});