https://github.com/colyseus/create-colyseus-app
Create an empty Colyseus server project ready to bring your own implementation
https://github.com/colyseus/create-colyseus-app
colyseus create multiplayer
Last synced: 2 months ago
JSON representation
Create an empty Colyseus server project ready to bring your own implementation
- Host: GitHub
- URL: https://github.com/colyseus/create-colyseus-app
- Owner: colyseus
- License: mit
- Created: 2019-04-26T03:58:08.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-05-31T13:51:36.000Z (4 months ago)
- Last Synced: 2025-07-27T19:57:43.166Z (2 months ago)
- Topics: colyseus, create, multiplayer
- Language: JavaScript
- Homepage: https://docs.colyseus.io/
- Size: 108 KB
- Stars: 36
- Watchers: 7
- Forks: 12
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `create-colyseus-app`
An npm init template for kick starting your Colyseus server.
## :crossed_swords: Usage
```
npm create colyseus-app@latest ./my-server
```
## Structure
- `index.ts`: main entry point, register an empty room handler and attach [`@colyseus/monitor`](https://github.com/colyseus/colyseus-monitor)
- `MyRoom.ts`: an empty room handler for you to implement your logic
- `loadtest/example.ts`: scriptable client for the loadtest tool (see `npm run loadtest`)
- `package.json`:
- `scripts`:
- `npm start`: runs `ts-node 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.
- `dependencies`:
- `colyseus`
- `@colyseus/monitor`
- `express`
- `devDependencies`
- `ts-node`
- `typescript`
- `@colyseus/loadtest`
- `tsconfig.json`: TypeScript configuration file
## License
MIT