EmbedBot

A Discord bot for managing infractions against misbehaving users.

About

EmbedBot is a Discord bot which can create and send embeds in text channels.

Installing and configuring EmbedBot

EmbedBot runs in a Docker container, and there is a docker-compose.yaml file which simplifies this process.

Clone the repository

To start off, clone the repository into your desired directory:

git clone https://github.com/BrackeysBot/EmbedBot.git

Step into the EmbedBot directory using cd EmbedBot, and continue with the steps below.

Setting things up

The bot's token is passed to the container using the DISCORD_TOKEN environment variable. Create a file named .env, and add the following line:

DISCORD_TOKEN=your_token_here

Two directories are required to exist for Docker compose to mount as container volumes, data and logs:

mkdir data
mkdir logs

The bot currently makes no use of a configuration file, so while the data directory is required, it can be empty.

The logs directory is used to store logs in a format similar to that of a Minecraft server. latest.log will contain the log for the current day and current execution. All past logs are archived.

The data directory is used to store persistent state of the bot, such as config values and the infraction database.

Launch EmbedBot

To launch EmbedBot, simply run the following commands:

sudo docker-compose build
sudo docker-compose up --detach

Updating EmbedBot

To update EmbedBot, simply pull the latest changes from the repo and restart the container:

git pull
sudo docker-compose stop
sudo docker-compose build
sudo docker-compose up --detach

Using EmbedBot

For further usage breakdown and explanation of commands, see USAGE.md.

License

This bot is under the MIT License.

Disclaimer

This bot is tailored for use within the Brackeys Discord server. While this bot is open source and you are free to use it in your own servers, you accept responsibility for any mishaps which may arise from the use of this software. Use at your own risk.