29 lines
1.0 KiB
Markdown
29 lines
1.0 KiB
Markdown
# Welcome to Colyseus!
|
|
|
|
This project has been created using [⚔️ `create-colyseus-app`](https://github.com/colyseus/create-colyseus-app/) - an npm init template for kick starting a Colyseus project in TypeScript.
|
|
|
|
[Documentation](http://docs.colyseus.io/)
|
|
|
|
## :crossed_swords: Usage
|
|
|
|
```
|
|
npm start
|
|
```
|
|
|
|
## Structure
|
|
|
|
- `index.ts`: main entry point, register an empty room handler and attach [`@colyseus/monitor`](https://github.com/colyseus/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 run loadtest`: runs the [`@colyseus/loadtest`](https://github.com/colyseus/colyseus-loadtest/) tool for testing the connection, using the `loadtest/example.ts` script.
|
|
- `tsconfig.json`: TypeScript configuration file
|
|
|
|
|
|
## License
|
|
|
|
MIT
|