Getting Started

Prerequisites

Node.js LTS version (or Bun)
Git
A code editor (VS Code recommended)

Frontend

Colyseus is unopinionated on the game engine or framework you use in the frontend. See how to get started with one of the official SDKs available for different platforms:

Backend

Creating your local development server is as simple as running a single command.

Create your Colyseus server

Terminal: Node.js

# Create a new Colyseus project
npm create colyseus-app@latest ./my-server
 
# Enter the project directory
cd my-server
 
# Run the server
npm start

Edit your room code

Go to src/rooms/MyRoom.ts and start building your game logic! See more:

Room API State Synchronization

Introduction

TypeScript