CatBot

A simple bot which can send you some animal pictures.

Table of contents

1. Building
2. Running
3. Running with Docker

Building

Java 17 is required for building and running this bot.
First, clone this repo:
git clone https://github.com/bartosz11/catbot.git
Then build it with Gradle:
./gradlew shadowJar
The jar file will be out in build/libs directory.

Building Docker image:

git clone https://github.com/bartosz11/catbot.git
./gradlew shadowJar
docker build -t bartosz11/catbot .

Running

You can start the bot with java -jar <jar name>
After running it for the first time, it'll generate a file called config.json. Open it with some text editor and replace REPLACE_THIS_WITH_YOUR_TOKEN with your bot token. You can get one at Discord Developer Portal.
After saving the config, you can start the bot once again.
To invite the bot to your server, you need to visit the OAuth2 tab in Developer Portal. Go to URL generator. Here you need to select scopes "bot" and "applications.commands". After selecting them, you can copy the URL and paste it to the browser, select the server and invite your bot.
You can use /help command (slash command) to display list of commands.
Note: it can take up to an hour before you'll be able to see and use bot's commands in Discord clients because commands are global and not per-guild.

Running with Docker

To run the bot with Docker, you can use this example docker-compose file:

---
version: "3"

services:
  catbot:
    container_name: catbot
    image: bartosz11/catbot
    restart: unless-stopped
    environment:
        # Timezone used in logs
        TZ: Europe/London
        CATBOT_TOKEN: REPLACE_THIS_WITH_YOUR_TOKEN

Or a docker run command:
docker run -d --name catbot ---restart unless-stopped -e CATBOT_TOKEN=REPLACE_THIS_WITH_YOUR_TOKEN -e TZ=Europe/London bartosz11/catbot
They both do the same thing.