@colyseus/loadtest

Utility tool for load testing Colyseus.

Demo


Usage

Install the tool globally in your system.

``
npm install -g @colyseus/loadtest
`

`
$ colyseus-loadtest --help

Options:
--endpoint: WebSocket endpoint for all connections (default: ws://localhost:2567)
--room: room handler name
--numClients: number of connections to open

Example:
colyseus-loadtest example/bot.ts --endpoint ws://localhost:2567 --room state_handler
`

Scripting

You may use either JavaScript or TypeScript for scripting your connections:

- See JavaScript template.
- See TypeScript template.

See below the methods that are called automatically, if implemented. (They are all optional.)

$3

Should return a plain object containing the options for client connection i` to join the room provided as an argument.

$3

Triggered when the client successfully joins in the room.

$3

Triggered when the server sends a message to this client, or broadcasts to everyone.

$3

Triggered when the room state changes in the server-side.

$3

Triggered when the client leaves the room.

$3

Triggered whenever an error has occurred in the room handler.

License

MIT.