Skip to content
⚔ Multiplayer Game Server for Node.js
TypeScript
Branch: master
Clone or download

README.md



Patreon donate button Discussion forum

Multiplayer Game Server for Node.js.
View documentation

Colyseus is an Authoritative Multiplayer Game Server for Node.js, with clients available for the Web, Unity3d, Defold, Haxe, and Cocos2d-X. (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!

You're encouraged to take a look on some games being developed with it and make your own!

What Colyseus provides to you:

  • WebSocket-based communication
  • Simple API in the server-side and client-side.
  • Automatic state synchronization between server and client.
  • Matchmaking clients into game sessions
  • Scale vertically or horizontally

What Colyseus won't provide:

  • Game Engine: Colyseus is agnostic of the engine you're using. Need Physics? Add your own logic / package.
  • Database: It's up to you to configure and select which database you'd like to use.

See roadmap for our future plans.

🚀 Quickstart

Create a bare-bones Colyseus server by using npm init colyseus-app.

npm init colyseus-app my-colyseus-server
cd my-colyseus-server
npm start

🕹️ Official Client Integration

🛠️ Tools

Tools made by the community ❤️

Usage examples

See the official examples for usage reference with the latest version of Colyseus.

Contributors

Thanks goes to these wonderful people (emoji key):

Endel Dreyer
Endel Dreyer

💻 📖 💡
Kyle J. Kemp
Kyle J. Kemp

💬 🐛 💻 💵 🤔
Jonas Voland
Jonas Voland

💬 🐛 💻 💵 🤔
Milad Doorbash
Milad Doorbash

🐛 💻
Tom
Tom

💬 🐛 🤔
James Jacoby
James Jacoby

💡 💵 🖋
Nikita Borisov
Nikita Borisov

🐛 💻 💵 🤔
Phil Harvey
Phil Harvey

💵 📖
Brian Hay
Brian Hay

💵
Enriqueto
Enriqueto

💵
digimbyte
digimbyte

📖
Federico
Federico

🐛 💻
Derwish
Derwish

🐛 🔧

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.

Backers / Supporters via Patreon

Sponsors

  • BubbleboxGames
  • TypeRush

Generous backers:

  • Kyle Kemp
  • Wenish

Backers:

  • Brian Hay
  • Damian Alberto Pastorini
  • Endre Johnsen
  • enriqueto
  • Eric McDaniel
  • James Jacoby
  • João Mosmann
  • LeeSeHeon
  • Nikita Borisov
  • Phil
  • Plaid World
  • Rob Drake
  • tobi4s1337
  • Worph

License

MIT

You can’t perform that action at this time.