Colyseus rooms

Multiplayer state is owned by a Colyseus room on the server. The template ships four (packages/editor/template/server/rooms/), registered in server/rooms.ts.

A room owns authoritative state; clients sync via the Callbacks API.

The shipped rooms

Room	Purpose	Used by
ArenaRoom	Tag game with phases (lobby → countdown → playing → scoreboard), NPC bots, server-authoritative tag logic	third-person-arena, third-person-arena-game
TankRoom	Tank arena — server owns tank positions; clients send movement input; @colyseus/schema syncs state	tanks
NotbloxRoom	Physics playground — server-authoritative player + box physics	notblox
GameRoom	A worked Schema-synced room (an orb-collecting arena) to start from	—

Each is a Room<State> using @colyseus/schema for the synced state. The client connects via the Callbacks API (onAdd / onChange / onRemove).

Adding a room

1. Create packages/editor/template/server/rooms/{name}.ts with a Room<State> class and a @colyseus/schema state.
2. Register it in server/rooms.ts.
3. On the client, connect and subscribe via the StateReplication / Callbacks API; read live schema fields in onChange.
4. Set serverRoom: '{name}' on the example’s registry entry.

Running the server

npm run dev does not start Colyseus — the room bootstrap (server/colyseus-setup.ts, port 2567) is launched separately (the e2e showcase harness does this). For a game, start it yourself alongside the client.

See also

• Networking — the contract + Callbacks API.
• Examples gallery — which examples use which room.