Bun WebSockets
Bun support on Colyseus is still experimental. Please report any issues you may find.
Installation
Terminal
bun add @colyseus/bun-websockets

Custom HTTP/API Routes
Colyseus uses Express as a web server by default.
You may add custom routes to your server by defining them...

Best Practices
Limitations and Best practices
- Each
Schema
structure can hold up to64

JavaScript SDK
The JavaScript/TypeScript SDK is engine agnostic and can be used with any game engine or framework that supports WebSockets, such as...

Compute Plans
Low Performance
The Low Performance is powered by previous generation Intel CPUs and regular SSD.
(Recommended for development environments.)
High Frequency (Recommended...

Construct 3
Installation
⚠️
You need a server to use Colyseus!
Construct has well-known existing features to “host” a multiplayer session from the client...

Pricing & Billing
See the Pricing Simulator for more details.
Colyseus Cloud uses a subscription-based billing model with upfront provisioning and proration for flexibility...

Private NPM Registry
If you rely on private NPM packages from your organization, you need to configure authentication to access them during deployment. This...

HTTP Middleware
If you are using the HTTP API, you can authenticate your requests using the Authorization
header.
Client SDK: Set the auth token...

Recommendations & Best Practices
This section provides general recommendations and best practices to keep your codebase healthy and readable for your team. They are all...