API & Development
This section covers building on top of RomM (third-party apps, scripts, integrations) and contributing to it (code, translations, docs). End-user content lives in Using RomM, and server owner content lives in Administration.
Calling the API
- API Reference: every endpoint, OpenAPI-driven
- API Authentication: all five auth modes (session, Basic, OAuth2, Client API Token, OIDC)
- Consuming OpenAPI: codegen, Postman imports, schema validation
- WebSockets: socket.io endpoints for live updates and Netplay
Building companion apps
- Client API Tokens: how companion apps authenticate, including the device-pairing flow
- Device Sync Protocol: wire-level reference for save/state/play-session sync
- Argosy, Grout: reference implementations to crib from
Contributing to RomM itself
- Development Setup: get a local env running
- Architecture: high-level codebase walkthrough
- Contributing: process, style, AI-assistance disclosure
- Translations (i18n): add or improve a locale
Reference
- Environment Variables: every env var, grouped by area
- Configuration File:
config.ymlschema - Exports: gamelist.xml/Pegasus export formats
- Glossary: canonical terminology