Deny a Player Joining a Room
You can deny a player connection by throwing an error during onAuth()
or onJoin()
methods.
The implementation of...

Example of a Room implementations
This example demonstrates an entire room implementing the onCreate
, onJoin
and onMessage
methods.

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

...of incoming and outgoing messages
- Table of raw events from the framework
- Allow the client to send messages by type (auto-detected)
You can...

WebTransport
WebTransport is a new transport protocol that allows for low-latency, bidirectional, and multiplexed communication between a client and a server. It is...

3rd Party Packages
Contribute - Click on the “Edit this page” link at the sidebar to add more packages.
Here’s a list of useful...

Environment Variables and Secrets
Colyseus Cloud allows you to safely store your secrets and environment variables via Application Settings page:
Values are encrypted and...

Advanced: Implement Your Own Callback System
The @colyseus/schema
version 3.0
introduced a way to bring your own callback system during decoding.
The...

Database & Persistance
Colyseus is agnostic to the database you use. You can use your preferred database and Node module for working with databases.
⚠️
We...

...Colyseus can be integrated with WeChat to create real-time multiplayer experiences.
As the WeChat JavaScript runtime is not fully compatible with the browser...