v0.16
Documentation
Roadmap
Sponsors
Versions

State SynchronizationClient-side CallbacksReactReact Here you will find a guide on how to use the Client-side Schema Callbacks with React. Getting Started: TypeScript...

Getting Started
Client-side
Colyseus is unopinionated on the game engine or framework you use in the client-side. See how to get started...

Server APITransportTransport Colyseus provides the following Transport implementations for the Transport layer. Node.js Runtime WebSockets (Default)uWebSockets.js (Native)WebTransport Bun Runtime Bun...

Authentication
Authentication is the process of verifying the identity of a user. Colyseus provides built-in tools to help you authenticate your clients into...

Server API Room APIBuilt-In RoomsBuilt-In Rooms Lobby RoomRelay Room The built-in rooms are useful for simple use cases. They are implemented...

⚠️
Feel free to submit your own examples! See Community → Help.
Basic Usage ExamplesTic-Tac-ToeAuthentication w/ Firebase"Push To Talk" ExampleMessaging w/ Protocol Buffers...

Discord Activity
Check out the Discord Activity Examples to see how to use the Discord Activity SDK with Colyseus.
TODO: Reorganize the content of...

Password Protect Room
Step 1: allow the matchmaker to identify the "password"
field.
Define the "password"
field inside the filterBy()

⚠️
Contributions are welcome! If you have a recipe or guide you’d like to share, please open an issue or submit a pull request...