/ss-rando-bot

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

ss-rando-bot

Discord

A racetime.gg chat bot application for automatically generating SS Randomizer seeds in race rooms, based on wooferzfg's TWW Rando Bot

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.

Commands

This list is not comprehensive, for a full list check the handler.py file.

  • !rollseed: Rolls a seed with the current settings. If no settings specified defaults to standard settings. If you want to roll another seed, you have to use !reset first

  • !permalink: Sets the permalink for the seed to be rolled

  • !spoiler: Toggles if a spoiler log should be made publicly available as Github Gist

  • !seed: Outputs the current seed if one has been rolled already

  • !log: Gives the link to the spoiler log if enabled before rolling the seed

  • !lock: Makes seed rolling and elevated commands available only to users with elevated permissions (User who opened the race, Race monitors, category mods/owners)

  • !unlock: Reverses !lock command

  • !reset: Resets all current settings and the seed

  • !francais: Translates the bot's messages to French (currently no French translation available)