⚔ Multiplayer Framework for Node.js
npm install colyseus
Colyseus is an Authoritative Multiplayer Framework for Node.js, with SDKs available for all major platforms and engines.
Client SDKs
| Platform | Install | Documentation | Demo |
|---|---|---|---|
| TypeScript | npm install @colyseus/sdk |
Getting Started | PlayCanvas |
| React | npm install @colyseus/react |
Getting Started | R3F Lobby |
| Unity | Download | Getting Started | Tank Battle |
| Godot | Download | Getting Started | Tank Battle |
| GameMaker | Download | Getting Started | Tank Battle |
| Defold | See documentation → | Getting Started | Tank Battle |
| Construct | Download | Getting Started | Raw Demo |
| Haxe | haxelib install colyseus |
Getting Started | Tank Battle |
| C / Static Libraries | Download | GitHub | raylib |
The project focuses on providing synchronizable data structures for realtime and turn-based games, matchmaking, and ease of usage both on the server-side and client-side.
The mission of the framework is to be a standard netcode & matchmaking solution for any kind of project you can think of!
Why developers choose Colyseus:
- ⚡️ Real-time state sync that just works → Define your state on the server and it automatically synchronizes to all clients, delta-compressed and binary-encoded.
- ⚔️ Built-in matchmaking → Room-based architecture with filtering, queuing, and reconnection support out of the box.
- 📈 Scalable → Go from 10 to 10,000+ CCU by scaling vertically or horizontally with Redis and load balancers.
- 🛡️ Cheat-proof by design → Authoritative server model ensures game logic runs on the server, not the client.
- 🛠️ Use the tools you already know → Built on Node.js and TypeScript with a simple, familiar API on both server and client.
- 💙 Free forever → MIT licensed, even for commercial games.
See public roadmap for version 1.0.
🚀 Quickstart
Set up your own Colyseus server project for your game using npm create colyseus-app@latest:
npm create colyseus-app@latest ./my-server
cd my-server
npm start
Sponsors
The sustainability of the project relies on Colyseus Cloud subscriptions and sponsorships. If you are not using Colyseus Cloud, please consider sponsoring the project 💖
Contributors ✨
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind are welcome!
Contributing
We encourage you to contribute to Colyseus! Please check out the Contributing guide for guidelines about how to proceed. Join us!
Everyone interacting in Colyseus and its sub-projects' codebases, issue trackers and chat rooms is expected to follow the code of conduct.
License
MIT