Support major platforms, including:
- WebGL
- iOS
- Android
- Mac
- Windows
A Unity Editor window for inspecting connected Colyseus room states in real-time:
- Open via Window → Colyseus → Room Inspector
- View all room properties, connection status, and state
- Auto-refresh display while in Play mode
- Copy state to clipboard for debugging
- See Room Inspector README for details
Open Window → General → Test Runner.
In order to start a test server for this project's included example, do the following:
git clone https://github.com/colyseus/colyseus.git
cd colyseus
pnpm install
pnpm run sdk-test-server
Update the version number under Assets/Colyseus/package.json and push to master branch.
Markdown files can be converted into PDF any number of ways, most recently used was Markdown to PDF. The goal for this is specifically to appease the Unity team's approval process. The documentation was a lightly edited version of our Getting Started - Unity3D documentation, with hyperlinks fixed and an additional "go to the docs page" link added to the top of the file. Both the PDF and the MD files should be placed under Assets/Colyseus/Documentation~/
MIT