MaFeLP/discord_bots

A small collection of discord bots

Discord Bots

This repository holds two discord bots written in rust:

• Autokommentator
• Känguru Knecht

They are inspired by u/Kaenguru_Knecht and u/AutoKommentator (both bots of r/ich_iel).

Running

This project is currently in its beta phase, so you need to compile it for yourself.

Then you can choose of a few solution:

• docker,
• docker-compose or
• native

Running with docker

1. Install docker
2. Get the source code for this repository: git clone https://github.com/mafelp/discord_bots.git
3. Build the docker image: DOCKER_BUILDKIT=1 docker build . -t discord_bots
4. Create the env file:
   1. Rename .env.example to .env.
   2. Edit .env and enter behind the equals sign your bot tokens for your two bots
5. Run the docker image:

docker run -it --rm \
    --name xdbot \
    --env-file .env \
    xdbot

Running with docker-compose

For both variants, you need to install docker and docker-compose. You can then choose, how to run and build your container. The recommended version, is to build and run using the Dockerfile, see recommended method. If you want to build for another, platform for example the Raspberry Pi, use the "not recommended method". There you build outside of docker for your or another platform using cross and then just running the binary inside a container.

Building inside of docker (recommended)

1. Create the env file:
   1. Rename .env.example to .env.
   2. Edit .env and enter behind the equals sign your bot tokens for your two bots
2. Rename docker-compose.yml.example to docker-compose.yml.
3. Edit docker-compose.yml to you likings. You do not have to edit it because it already works, but if you have to change something, you can do so here.
4. Run the following command to start the docker container

DOCKER_BUILDKIT=1 docker-compose up

If you want to have your container running in the background, run:

DOCKER_BUILDKIT=1 docker-compose up -d

To stop the container, simply run the following command:

docker-compose down

Native docker-compose (not recommended)

1. Create the env file:
   1. Rename .env.example to .env.
   2. Edit .env and enter behind the equals sign your bot tokens for your two bots
2. Rename native.docker-compose.yml.example to docker-compose.yml.
3. Build the binary:
   • If you are cross compiling for another platform:
     1. Install the rust development tools
     2. Install cross using cargo: cargo install cross
     3. Build the binary for the target platform with ~/.cargo/bin/cross build --release --target TARGET on linux or %USERHOME%\.cargo\bin\cross build --release --target TARGET on Windows. Replace TARGET with the target you are compiling for. See targets below.
        • Raspberry Pi 4: aarch64-unknown-linux-gnu
        • Linux x86: x86_64-unknown-linux-gnu
        • Windows x86: x86_64-pc-windows-gnu
   • If you are planning to run on the current platform:
     1. Install the rust development tools
     2. Run cargo build --release
4. Edit docker-compose.yml:
   1. Change image: debian:buster-slim to the platform your binary has been built for.
      • For a Raspberry Pi running Ubuntu Server 20.04 use: ubuntu:20.04
      • For debian use: debian:buster-slim
      • For Archlinux (based systems) use: archlinux
      • ...
   2. ONLY IF YOU WERE CROSS COMPILING IN STEP 3: In volumes: change ./target/release/:/app/ to ./target/TARGET/release/:/app/ where TARGET is the target you built for in step 3. Or if you are on another system, change this to PATH/TO/THE/BINARY:/app/xd_bot.
5. Run the following command to start the docker container

docker-compose up

If you want to have your container running in the background, run:

docker-compose up -d

To stop the container, simply run the following command:

docker-compose down

Running native

1. Install the rust development tools
2. Run cargo build --release
3. Run the following command to start the bots. Replace YOUR KAENGURU BOT TOKEN and YOUR XD BOT TOKEN with the tokens used by your bots to authenticate to discord. See bot tokens for more information.

On Linux and MacOS:

DISCORD_TOKEN_KAENGURU="YOUR KAENGURU BOT TOKEN" \
DISCORD_TOKE_XD="YOUR XD BOT TOKEN" \
./target/xd_bot

On Windows (CMD):

set DISCORD_TOKEN_KAENGURU="YOUR KAENGURU BOT TOKEN"
set DISCORD_TOKE_XD="YOUR XD BOT TOKEN"
.\target\xd_bot

Bot tokens

1. Go to https://discord.com/developers/applications/.
2. In the top right corner, click on New Application.
3. Give the bot a name and click on Create.
4. In the left side bar, click on Bot.
5. In the top right corner, click on Add bot.
6. Confirm your actions with Yes, do it!.
7. Now Copy your Discord Bot Token by either clicking on copy: or clicking on Click to Reveal Token and then mark your Token and copy it.

Invite the bots

1. Copy and paste The bot invitation token from the console into your webbrowser and go to this website. The link should start with https://discord.com/oauth2/authorize?client_id=.
2. Click on the Pop-Out-Menu Select a Server
   
3. From the list, selct the Server you want to invite the bot to. If the specific server does not appear there, make sure you have the required permissions to invite and manage bots to the server.
   
4. After you selcted the server, click on Authorize.
   
5. Solve the Captcha by clicking the square left to I am human and selecting the fitting images by clicking on them (not everyone has to solve these captchas! Don't be worried, if you don't have to solve them.)
   
6. You should now see a green tick that says Authorized.
   
7. Your bot should now appear on your server: