colyseus
    TypeScript icon, indicating that this package has built-in type declarations

    0.14.23 • Public • Published


    Discussion forum

    Multiplayer Framework for Node.js.
    View documentation

    Colyseus is an Authoritative Multiplayer Framework 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!

    ⭐️ Enjoying Colyseus? Show your support by starring the project on GitHub ⭐️

    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

    💻 📖 💡

    Fazri Zubair

    💬 💻 🤔 💼

    Kyle J. Kemp

    💬 🐛 💻 🤔

    James Jacoby

    💬 💡 🖋

    Aymeric Chauvin

    💬 💡

    Jonas Voland

    💬 🐛 💻 🤔 💡

    Dr. Burton

    🧑‍🏫

    Tommy Leung

    🧑‍🏫

    Damian A. Pastorini

    💬 📖 🐛

    Luke Wood

    💬 🐛 💻

    Milad Doorbash

    🐛 💻

    Sergey

    🐛 💻

    Darek Greenly

    💬 🐛 💻

    Nikita Borisov

    🐛 💻 💼 🤔

    Phil Harvey

    📖

    Brian Hay

    🖋

    Enriqueto

    💼

    digimbyte

    📖

    Tom

    💬 🐛 🤔

    Federico

    🐛 💻

    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

    As of February 2021, Colyseus is owned and sponsored by Lucid Sight. A warm thank you for previous supporters of the project is forever documented in the early supporters wiki page.

    License

    MIT

    Install

    npm i colyseus

    Homepage

    colyseus.io/

    DownloadsWeekly Downloads

    1,678

    Version

    0.14.23

    License

    MIT

    Unpacked Size

    21.6 kB

    Total Files

    8

    Last publish

    Collaborators

    • endel