/tww-rando-bot

racetime.gg bot for The Wind Waker Randomizer races

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

tww-rando-bot

Build Status

A racetime.gg chat bot application for automatically generating TWW Randomizer seeds in race rooms.

How to get started

Requirements

  • Docker

Installation

  1. Clone the repo
  2. Build the Docker image with docker compose build

Usage

  1. Set up environment variables:
export GITHUB_TOKEN=... # a GitHub personal access token with permission to create Gists
export CATEGORY_SLUG=... # the slug of the racetime.gg category the bot should operate in (e.g. `twwr`)
export CLIENT_ID=... # the OAuth2 client ID for this bot on racetime.gg
export CLIENT_SECRET=... # the OAuth2 client secret for this bot on racetime.gg
  1. Run docker compose up to start the bot.

Running tests

docker-compose run --rm tww_rando_bot python -m unittest discover -s randobot/tests -p 'test_*.py'