satnami / colyseus

Multiplayer Game Server for Node.js.

Multiplayer Game Server for Node.js. View documentation

Read the version 0.5.0 update.

Why?

Writing your own multiplayer boilerplate using Socket.io/SockJS/etc is time consuming and you'll face a range of different problems along the way. Colyseus should have all these problems figured out already.

Features / Characteristics

• Authoritative game server
• WebSocket-based communication
• Binary delta compressed state (through msgpack / fossil-delta-js)
• Match-making
• Custom room handlers
• Scalable vertically
• Lag compensation (using timeframe, a Timeline implementation) - Not automatic. You should apply the technique as you need, in the client and/or the server.

See roadmap for our future plans.

Official client integration

• JavaScript/TypeScript
• Unity (compatible with server v0.5.x)
• CoronaSDK (compatible with server v0.3.x)

Community client integration

• Construct2 (compatible with server v0.5.0)
• Cocos2d-x (compatible with server v0.5.0)

Usage examples

• Official Examples - Official examples for learning purposes.
• tanx (source-code) - Multiplayer tanks game, originally from PlayCanvas
• tic-tac-toe (source-code) - Simple Tic Tac Toe using pixi.js
• LD35 entry: dotower (source-code) - Simple experimental MOBA using pixi.js
• React Example (source-code) - Example integrating with ReactJS

Huge thanks to our first sponsor!

EvenNode provides Node.js hosting fully compatible with Colyseus. Discount is available to Colyseus projects on request. Contact support for more information

Sponsors

Become a sponsor and get your logo on our README on Github with a link to your site. [Become a sponsor]

Backers

Support us with a monthly donation and help us continue our activities. [Become a backer]

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