search

padtrack / track

GNU Affero General Public License v3.0
19 stars 4 forks source link

readme

Track

Track is a Discord bot with World of Warships utilities.

For a list of features, see the commands reference in the wiki.

Installation

  1. Get Python 3.10 or higher

A virtual environment can be created with python3.10 -m venv venv.

  1. Clone the repository
git clone https://github.com/padtrack/track.git
  1. Install dependencies
cd track
pip install -U -r requirements.txt
  1. Set up the database
python bot/utils/db.py
  1. Create a secrets.ini file from secrets_template.ini

For more information about creating a Discord applications, see this article.

  1. Install Redis

For more information, see this article.

  1. Install FFmpeg

For more information, see this website.

  1. Configure the project in config.py

Most of these can be left unchanged, but it is highly advised to change the values at the bottom.

  1. You're set! For information about updating the bot between game updates, see here.

Usage

The bot can be launched with bot/run.py. The full usage is:

python run.py [--sync | --no-sync]

The optional sync flag will cause the bot to sync the command tree on startup. Only use this flag when necessary to avoid being rate-limited.

Render workers can be launched with bot/worker.py. The full usage is:

python worker.py -q {single, dual} [{single,dual} ...]

Which queues the worker should listen to can be specified with the respective option.

License

This project is licensed under the GNU AGPLv3 License.

Credits and Links