Colyseus rooms

Multiplayer state is owned by a Colyseus room on the server. The template ships two (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
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 with typed joinOrCreate<T> and subscribe via the Callbacks API (Callbacks.get(room) — onAdd/onChange/onRemove, per-field listen); read live schema fields in onChange — don’t destructure them into local copies.
4. Declare "server": {"room": "{name}"} in the example’s vgai.game.json manifest.

Running the server

npm run dev does not start Colyseus — run npm run server from the project folder to boot it alongside the client (the room bootstrap server/colyseus-setup.ts, on ws://localhost:2567, with the registry from server/rooms.ts).

See also

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