Getting Started
A Colyseus game has two parts: a server that runs your game rooms, and a client that connects to them. Set them up in this order.
Create a server
Scaffold a Node.js server with one command, then add a first room to it. Every client SDK below connects to this server.
Connect a client
Colyseus is unopinionated about the game engine or framework you use in the frontend. Pick the official SDK for your platform:
🤖 Using an AI coding agent
Most models learned Colyseus from material older than 0.18. Without guidance, they write colyseus.js imports, Room<MyState> generics and client.id. The Colyseus skill keeps the agent on the current APIs and has it check your installed version before writing any Room or Schema code. Install it for Claude Code, Codex, Cursor, Gemini CLI, Copilot or any other agent that supports skills:
npx skills add colyseus/skill # this project
npx skills add colyseus/skill --global # every projectThe skill activates on its own when a task involves Colyseus. Bundled docs cover the areas agents get wrong most (state, rooms, the client SDK, netcode), with links to the rest.
Without the skill, point the agent at llms.txt. Every page is also served as raw markdown: append .md to its URL, e.g. /room.md.