Racelink
FR
Steam

// OVERLAY API

Créez des overlays pour Racelink

Un overlay est une petite page web. Racelink lui fournit des données en direct unifiées pour chaque simulateur, un panneau de réglages tiré de son manifeste et un chemin vers le Steam Workshop.

Le SDK sur npm ↗Steam Workshop ↗
  1. 01

    Créer

    npm create @racelink/overlay@latest

    Choisissez TypeScript seul ou React. Le projet fonctionne tout de suite.

  2. 02

    Développer

    npm run dev

    npm run dev : l’overlay apparaît dans Racelink et se recharge à chaque modification. Sans l’application, le SDK génère des données de démo.

  3. 03

    Publier

    npm run build

    Racelink Studio vérifie l’overlay, capture son aperçu et le publie dans le Workshop Steam. Les abonnés reçoivent les mises à jour automatiquement.

// TYPESCRIPT

Lire la télémétrie

  • Un seul modèle de données

    Vitesses en km/h, pédales de 0 à 1, temps en secondes — les mêmes champs dans chaque simulateur.

  • Réglages depuis le manifeste

    Déclarez les réglages dans racelink.overlay.json et Racelink dessine le panneau.

  • Typé de bout en bout

    Télémétrie et réglages sont typés ; la référence des champs documente chaque valeur.

  • Pensé pour les assistants IA

    Les projets incluent AGENTS.md et un guide complet pour les assistants de code.

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);
});