https://github.com/colyseus/colyseus

⚔ Multiplayer Framework for Node.js
https://github.com/colyseus/colyseus

colyseus game-server multiplayer multiplayer-game-engine multiplayer-game-server networking nodejs realtime-games turn-based websockets

Last synced: 7 days ago
JSON representation

⚔ Multiplayer Framework for Node.js

• Host: GitHub
• URL: https://github.com/colyseus/colyseus
• Owner: colyseus
• License: mit
• Created: 2015-11-22T22:57:33.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-10-18T19:39:09.000Z (17 days ago)
• Last Synced: 2024-10-28T02:07:40.405Z (8 days ago)
• Topics: colyseus, game-server, multiplayer, multiplayer-game-engine, multiplayer-game-server, networking, nodejs, realtime-games, turn-based, websockets
• Language: TypeScript
• Homepage: https://colyseus.io
• Size: 6.77 MB
• Stars: 5,835
• Watchers: 153
• Forks: 554
• Open Issues: 50
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-github-star - colyseus
• StarryDivineSky - colyseus/colyseus

README

        


  

    

  

  


  


  

    

  

  

    

  

  

    

  

  


    Multiplayer Framework for Node.js. 
View documentation

  



Colyseus is an Authoritative Multiplayer Framework for Node.js, with SDKs

available for the Web, Unity, Defold, Haxe, Cocos and Construct3. ([See official SDKs](https://docs.colyseus.io/client/))

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!

## Key features:

- 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](https://github.com/colyseus/colyseus/wiki/Public-Roadmap) for future plans.

# 🚀 Quickstart

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

```

# 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](https://github.com/sponsors/endel) 💖



  



# Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):

  

    
Aymeric Chauvin
💬 💡

    
Brian Hay
🖋

    
Damian A. Pastorini
💬 📖 🐛

    
Darek Greenly
💬 🐛 💻

    
David Rydwanski
💬 💻

    
Dr. Burton
🧑‍🏫

    
Endel Dreyer
💻 📖 💡

  

  

    
Enriqueto
💼

    
Fazri Zubair
💼

    
Federico
🐛 💻

    
James Jacoby
💬 💡 🖋

    
Jonas Voland
💬 🐛 💻 🤔 💡

    
Kyle J. Kemp
💬 🐛 💻 🤔

    
Luke Wood
💬 🐛 💻

  

  

    
Milad Doorbash
🐛 💻

    
Nikita Borisov
🐛 💻 💼 🤔

    
Phil Harvey
📖

    
Sergey
🐛 💻

    
Tom
💬 🐛 🤔

    
Tommy Leung
🧑‍🏫

    
digimbyte
📖

  

This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification.

Contributions of any kind are welcome!

# Contributing

We encourage you to contribute to Colyseus! Please check out the [Contributing

guide](.github/CONTRIBUTING.md) 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](CODE_OF_CONDUCT.md).

# License

MIT