Modd Loadtest

A loadtest for Modd.io games.

Installing Dependencies

This project uses Yarn. It is advised not to mix package managers as this can result in inconsistent lockfiles across contributors.

To install dependencies for this project, open a command line interface at the directory of your project, and run:

yarn

This will create a node_modules directory in that of your project and add the packages there.

Compiling the Project

This project utilizes TypeScript. It is a superset of JavaScript and as so, needs to be compiled to it before execution.

To build the project, run:

yarn build

This will create a build directory in that of your project and compile the project there.

Running the Project

To execute the project, run:

yarn start

This will use the default configurations provided by the project. However, you can specify arguments to change some parameters of the program. For example:

yarn start --ip 127.0.0.1 --ssl false --port 2001 --token abc --maxBots 50

Any or all of these arguments can be specified or excluded. Suit them to your own needs.

Contributing

If you would like to contribute to this project, you may fork the repository and open a pull request.

Licensing

This project is licensed under the terms of the GNU AGPLv3.