SpeedrunBot++

SpeedrunBot++ aims to be an upgrade from the effectively abandoned yet popular SpeedrunBot. The bot is still in it's early stages, but the plan is to support a variety of speedrunning sites such as The Mario Kart Players' Page, Authoritative Minesweeper, etc.

Inner Workings

Unlike the typical structure of having a bot written in Python, which contains the implementations of each command, here the bot is merely a bridge between the discord user and a variety of small programs that do one thing and do it well. For example, when a user runs the command to get a speedrun.com users total run count, the bot runs the program located at src/srcom/bin/runs as a subprocess.

Since every command is it's own little program, you can use any language you'd like to write a command so long as you can get an executable out of it. That being said, some extremely basic commands like +source (links this repository) are just built into the bot for performance reasons.

Running the Bot

To run the bot, you will need to be on a unix based OS, sorry Windows users. The bot it only tested on debian-based Linux, but it can be made to work on other systems with minimal effort.

To install the required dependencies and build the programs, you need to run the setup script. The script will prompt you for the program you use to gain superuser privileges. This is typically sudo, but it could also be doas for example.

$ ./setup.sh
Command to gain superuser privileges [sudo]: doas
Installing dependencies...
... # Makefile output

The script will also check to make sure you have a C compiler and python installed. Python3.9 is recommended and it is not guaranteed that anything will work on other versions of Python3. Additionally, if you use a C compiler that is not clang or gcc (why?), you want to make sure that cc links to it, or you can just edit the setup script yourself.

Developer Information

File Structure

.
├── data          # Configuration files and related.
├── include       # C preprocessor include files.
│   └── srcom     # Include files for speedrun.com
└── src           # Source code files.
    ├── cogs      # The bots cogs.
    └── srcom     # Command source code files for speedrun.com
        ├── bin   # Program executables and binaries.
        └── objs  # C compiler object files.