https://github.com/vriskaserket51/resistance-avalon-online-api
https://github.com/vriskaserket51/resistance-avalon-online-api
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/vriskaserket51/resistance-avalon-online-api
- Owner: VriskaSerket51
- Created: 2024-03-01T06:48:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-09T14:49:12.000Z (about 1 year ago)
- Last Synced: 2025-01-22T07:33:04.457Z (4 months ago)
- Language: TypeScript
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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 test`: runs mocha test suite
- `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