fsufitch/tagioalisi-bot repository overview

⁠Tagioalisi

Custom bot for the Sociologic Planning Boar server on Discord. Now in Go!

             ,           _______________
        `-.   \    .-'  < Hello, world! >
,-"`````""-\__ |  /      ---------------
 '-.._    _.-'` '-o,   /
     _>--:{{<   ) |)  /
 .-''      '-.__.-o`
'-._____..-/`  |  \
     ,-'   /    `-.

⁠Requirements

• Go 1.14+
• Docker and Docker Compose (optional)

⁠Build and run instructions

The bot provides two executable entry points, which can be built with these commands:

go build ./cmd/tagi-bot
go build ./cmd/tagi-migrate

The executables produced by these packages are ready to be run anywhere. They are configured using environment variables. An example configuration for local development can be found in .env.template⁠.

Remember that the bot depends on connecting to Discord itself, and there is no "fake" local Discord server available. Also take not that both the bot and its migrations rely on a Postgres database. To simplify setting that up, see the Docker instructions below.

⁠Using Docker

The bot comes with a Dockerfile and docker-compose.yml to ease setup. To set up a full running bot, follow these steps.

1. Copy .env.template into .env and edit it so DISCORD_TOKEN contains a valid Discord bot token
2. Run docker-compose run bot ./tagi-migrate to set up the database
3. Run docker up (with --build after every time you make code changes)

⁠Configuration

The runtime is configured exclusively through environment variables. Note the below default behaviors do differ from the values in .env.template.

⁠Modular design

The bot functionality is split up into mostly independent modules that each act as a controller for a smaller set of behavior. They are:

These can be individually turned on/off using the BLACKLIST_BOT_MODULES environment variable.