Racelink
ES
Steam

// OVERLAY API

Crea overlays para Racelink

Un overlay es una pequeña página web. Racelink le da datos en directo unificados de cada simulador compatible, un panel de ajustes generado desde su manifiesto y un camino al Steam Workshop.

El SDK en npm ↗Steam Workshop ↗
  1. 01

    Crea

    npm create @racelink/overlay@latest

    Elige TypeScript puro o React. El proyecto funciona desde el principio.

  2. 02

    Desarrolla

    npm run dev

    npm run dev: el overlay aparece en Racelink y se recarga con cada cambio. Sin la aplicación, el SDK genera datos de demo.

  3. 03

    Publica

    npm run build

    Racelink Studio revisa el overlay, captura su vista previa y lo publica en el Workshop de Steam. Los suscriptores reciben las actualizaciones automáticamente.

// TYPESCRIPT

Leer la telemetría

  • Un único modelo de datos

    Velocidad en km/h, pedales de 0 a 1, tiempos en segundos: los mismos campos en cada simulador.

  • Ajustes desde el manifiesto

    Declara los ajustes en racelink.overlay.json y Racelink dibuja el panel.

  • Tipado de principio a fin

    La telemetría y los ajustes están tipados; la referencia de campos documenta cada valor.

  • Pensado para asistentes de IA

    Los proyectos incluyen AGENTS.md y una guía completa para asistentes de código.

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