API reference
Use the reference for exact options, defaults, signatures, and results. Guides show how to combine them.
| API | Look up |
|---|---|
| Room configuration | defineRoom, all config properties, physics, lobby, replay, bus |
| Server room API | Lifecycle callbacks, state, ctx, runtime room methods |
| Client SDK | joinRoom, joinRelay, client state, events, and calls |
| Schema | Field types, collections, ownership, and visibility options |
| Room testing | testRoom, test clients, clocks, and matchers |
| Lobby panel | Attributes, events, readiness, and styling |
| CLI | Commands, arguments, and flags |
| Project configuration | irtio.json properties |
| Rooms HTTP API | Scoped keys, room listing, retention, saves, and deletion |
| Errors | Error codes and recovery actions |
| MCP | Tools for coding agents |