Colyseus is an Authoritative Multiplayer Framework for Node.js, with clients available for the Web, Unity3d, Defold, Haxe, and Cocos. (See official clients)
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!
- WebSocket-based communication
- Simple API in the server-side and client-side.
- Automatic state synchronization from server-to-client (delta compressed)
- Matchmaking clients into game rooms/sessions
- Scale vertically or horizontally
See public roadmap for future plans.
Create a bare-bones Colyseus server by using npm create colyseus-app@latest:
npm create colyseus-app@latest my-colyseus-server
cd my-colyseus-server
npm start
The sustainability of the project relies on Colyseus Cloud subscriptions and sponsorships. If you are not using Colyseus Cloud, please consider sponsoring the project 💖
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind are welcome!
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.
MIT