Getting started¶
Colyseus requires Node.js v8.0 or higher.
From examples project¶
See some examples in action by cloning the examples project and running it locally.
git clone https://github.com/colyseus/colyseus-examples.git
cd colyseus-examples
npm install
To run the http + websocket server, run npm start.
Creating a barebones Colyseus server¶
Use the npm init colyseus-app command to generate a barabones Colyseus server. You may select between TypeScript (recommended), JavaScript and Haxe as your language of choice for the server.
npm init colyseus-app ./my-colyseus-app
See the contents of the project templates:
Recommended NodeJS packages for games¶
These modules can be useful while developing games on both NodeJS and the Browser.
- @gamestdio/mathf - Mathematical functions, borrowed from Unity3D's API
- @gamestdio/timer - Reliable timing events
- @gamestdio/keycode - Constants for keyboard key codes (
event.which)
These modules can be used only in the browser: