Welcome to Colyseus!

This project has been created using ⚔️ create-colyseus-app - an npm init template for kick starting a Colyseus project in TypeScript.

This repo provides a basic example of storing walking and talking Bumpkins on your island.

Usage

yarn start

index.ts: main entry point, register an empty room handler and attach @colyseus/monitor
src/rooms/MyRoom.ts: an empty room handler for you to implement your logic
src/rooms/schema/MyRoomState.ts: an empty schema used on your room's state.
loadtest/example.ts: scriptable client for the loadtest tool (see npm run loadtest)
package.json:
- scripts:
  - npm start: runs ts-node-dev index.ts
  - npm test: runs mocha test suite
  - npm run loadtest: runs the @colyseus/loadtest tool for testing the connection, using the loadtest/example.ts script.
tsconfig.json: TypeScript configuration file

Deploying this server is out of scope, further guides coming soon.

MIT