Developer docs

Connect your game to Rudder

Rudder is a LiveOps layer for games. These docs cover client authentication, remote config, analytics, stores, leaderboards, scenario execution, and realtime sessions through the SDKs that exist in this repository.

Base endpoints

Endpoint Production value
API URL https://api.rudder.build
Realtime URL wss://realtime.rudder.build/api/realtime/ws
Dashboard https://app.rudder.build/

Integration shape

  1. Create a project in the Rudder dashboard and copy the project key.
  2. Initialize the SDK with the project key and production endpoints.
  3. Authenticate the player with device login before calling protected SDK APIs.
  4. Load remote config and register handlers for scenario, store, leaderboard, or realtime events.
  5. Call the SDK from game lifecycle hooks and dispose or disconnect when the session ends.

The first documentation version intentionally covers TypeScript and C# only. Engine-specific wrappers can be added later without changing the public endpoint model.