Documentation

Connect your s&box game, call your backend from the C# library or plain HTTP, and run the server yourself. Generated from the server at v0.5.0 and the library at 9b6ec5d41d99afd1756293d958be1f1330aa73b7.

New in the next server release: Endpoints can now be written in YAML or JavaScript/TypeScript (more languages planned): a full global environment of shared code, sandboxed on your server. Script endpoints docs (Next release (unreleased, 8e7623d))

Get started

Connect a gamePoint the game library at your server: project, public key and base URL.Game client startupWhat the library sends at startup: revision init, heartbeats and compatibility headers.

Game library

Library overviewInstall the library, configure credentials and call endpoints from game code.Authoring collections and endpointsYAML sources for collections, endpoints and workflows, synced by the editor tool.ExamplesExample sources you can copy into a project.C# API referencePublic types and members of the game library, from its source and XML docs.

HTTP API

HTTP API referenceEvery game-facing route: method, path, headers, bodies and status codes, checked against the HTTP contract tests.

Self-hosting

Self-hostingInstall, update, back up and run the server on Linux, macOS, Windows or Docker.Hosting modelsPlayer-hosted, P2P and dedicated servers, and what the backend checks in each.ConfigurationEvery server.toml setting and environment variable.DatabasesSQLite and PostgreSQL, migrations, backups and rollback.Owner consoleThe web dashboard: login, projects, records, keys and security.Export and move projectsPortable archives and moving a project between servers.AlertingEmail and webhook alerts for errors, updates and certificates.Coding agents (MCP)Let coding agents operate your server through MCP.

Compatibility

Library and server compatibilityHow server updates keep published games working.Library certificationHow a library and server pairing is tested and recorded.