Giter Club home page Giter Club logo

ss-rando-bot's Introduction

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)

ss-rando-bot's People

Contributors

floha258 avatar crain-32 avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.