# rooms_sdk

> Authoritative multiplayer rooms + realtime chat for Dart and Flutter.
> Self-host the room engine (RoomHub/RoomAuthority) or use the hosted rooms
> node (HTTP API + WebSockets behind Caddy). Private repo of Holotype Pte Ltd,
> consumed via git path dependencies.

## Docs

- [Getting started](/docs/getting-started/): install as git path dependencies, run the counter example, host your first room.
- [Concepts](/docs/concepts/): the authority model, hosting shapes, join/resume lifecycle, baseline/delta replication, room social, templates.
- [Wire protocol](/docs/protocol/): every frame, its fields, direction and semantics; message table plus the repository protocol document.
- [Room templates](/docs/templates/): relay and movement template JSON config reference (schemas, quotas, input protocol).
- [Hosted node HTTP API](/docs/api/): control-plane endpoints, bearer auth, one-time join tokens, error shapes, node v0 notes.
- [Self-hosting](/docs/self-hosting/): docker compose + Caddy TLS deployment, node.json config reference, checklist.

## Machine-readable specs

- [rooms-protocol.json](/spec/rooms-protocol.json): the wire protocol as data — frames, fields, types, direction, required/optional, limits, close codes. Derived from room_hub.dart and cross-checked at build time.
- [room-authority.md](/spec/room-authority.md): the exact interface contract a game implements (RoomAuthority + RoomSocialAuthority) — every method, when the hub calls it, invariants.
- [llms-full.txt](/llms-full.txt): everything above as one plain-markdown file.

## Landing

- [Home](/): pitch, three-step quickstart, feature grid, package cards.