Architecture / Stack
A solid stack so you can focus on your game instead of re-inventing the wheel.
On-demand, stateful rooms are spawned per client request.See more
Web / API Routes
Define your own custom API routes via Express or µWebSockets.jsSee more
Database / Storage / Authentication
Bring your favorite Node.js tool here. You are free to choose which database or authentication provider to use.
(An official recommendation is coming soon).
Rooms & Match-making
Let clients spawn and join into multiple rooms.
Write your server room code:
Expose the room for match-making:
Let the client join the room. If no room has been found, the server will create one.
An unique approach to room state synchronization.
Define your synchronizable state structures
Mutate the state on within your room code:
Listen to the changes coming from the server:
Simple yet powerful scaling strategy
- Distribute rooms across servers and/or processes
- Allow cluster-wide match-making
- Leverage all your available CPUs
- Connect clients directly to their requested rooms
- Stateful processes keep track of their own rooms
Built-in tools that accompany you from development to production.
Easily create client connections and inspect how they are exchanging data with the serverRead documentation
Realtime Room Inspector
View and inspect the list of rooms spawned by the server.Read documentation
Utility methods for testing your rooms with your favorite testing frameworkRead documentation
Evaluate how your server behaves under high traffic.Read documentation
Bring your favorite tools to your Colyseus server.