Borgar

A Discord and Stoat bot that provides fun image editing commands, such as image captioning.

<!--suppress HtmlDeprecatedAttribute --> <div align="center"> <!--suppress CheckImageSize --> <img src="images/image_caption_example.png" alt="Image captioning" width=400/> </div>

Available commands

Some of the fun commands provided by Borgar:

• %caption: add captions to an image.
• %rotate: rotates an image.
• %speed: speeds up or slows down a GIF or video.

Run %help to see a full list of commands.

Commands can also be chained together. The following example captions an image and then rotates it by 90 degrees clockwise:

%caption A caption %rotate 90

Prerequisites

• Java 21 SDK or higher.
• A Discord and/or Stoat Bot Token.
  • You can get a Discord token from the Discord Developer Portal or a Stoat token from the "My Bots" section of the Stoat settings.

Getting Borgar

You can find release builds of Borgar on the Releases page.

Builds from recent commits can be found on the Actions page.

Running Borgar

1. Run Borgar with java -jar borgar-X.X.X.jar.
   • Replace X.X.X with the version number of the JAR file you downloaded.
2. Running the program for the first time should create a config.json file and then exit.
3. Add your Discord and/or Stoat bot token to the config.json file and run the program again.

Required permissions

Discord

<!--suppress CheckImageSize --> <img src="images/discord_required_permissions.png" alt="Discord required permissions" width=500/>

Stoat

<!--suppress CheckImageSize --> <img src="images/stoat_required_permissions.png" alt="Stoat required permissions" width=500/>

Using PostgreSQL

Borgar can use PostgreSQL instead of the default SQLite database. To use PostgreSQL, follow these steps:

1. Install Docker if you haven't already.
2. Run the Docker compose file with docker compose up -d.
3. Set the value of database.url in config.json to jdbc:postgresql://localhost:5432/postgres, adjusting the port if changed in the docker-compose.yml file.
4. Optionally, change the user and password values in the docker-compose.yml file and update the config.json file accordingly.

Using Cobalt

Borgar uses Cobalt for the %download command, which allows downloading media from various sites. To set up Cobalt, follow these steps:

1. Install Docker if you haven't already.
2. Run the Docker compose file with docker compose up -d.
3. Set the value of cobalt.apiUrl in config.json to http://localhost:9000, adjusting the port if changed in the docker-compose.yml file.

Running the program from source

1. Run ./gradlew run.
   • If using IntelliJ IDEA, you can also run app/src/main/kotlin/Main.kt.

Building a JAR File from source

1. Run ./gradlew build.
2. The JAR file will be located in build/libs.