Skip to content

Latest commit

 

History

History
60 lines (55 loc) · 2.6 KB

README.md

File metadata and controls

60 lines (55 loc) · 2.6 KB
Raw

AOE 4 Elo Bot

builds.sr.ht status Go Report Card

A Discord bot that automatically retrieves Elo ratings for Age of Empires 4 and gives users custom roles.

Uses the public API for the Age of Empires Leaderboards via my aoe4api library.

Developed with DiscordGo.

Build Instructions

Before using the AOE 4 Elo Bot backend, a Discord application and bot must be set up and added to a Discord server here.

Go CLI

The simplest way to compile and run the bot is directly with the Go CLI. Make sure Go v1.18 or higher is installed.

First, clone the repo and navigate into its directory:

$ git clone https://git.sr.ht/~alexisgeoffrey/aoe4elobot
$ cd aoe4elobot

Make sure the environment variable CONFIG_PATH is set to the path you want for the config file, or leave it empty for a config file called config.yml in the project directory. Then, run the project once in order to generate a sample config.

$ go run

After editing the values in the config file, run the project again using the same command.

Docker

A Dockerfile is included in this repo so the bot can be run in a Docker container. First, clone the repo and navigate into its directory as before. Then, build the Docker image:

$ sudo docker build . -t aoe4elobot

Then, create, a volume for the bot config file:

$ sudo docker volume create aoe4elobot-config

Finally, run the Docker image:

$ sudo docker run -v aoe4elobot-config:/app/config \
  -e CONFIG_PATH=/app/config/config.yml \
  aoe4elobot

Alternatively, Docker Compose can be used. Here is a sample docker-compose.yml:

services:
  aoe4elobot:
    image: aoe4elobot
    container_name: aoe4elobot
    environment:
      - CONFIG_PATH=/app/config/config.yml
    volumes:
      - config:/app/config
volumes:
  config:

Discord Commands

  • !setEloInfo AOE_4_USERNAME, AOE4_ID - Registers your AOE4 username and ID in the bot to retrieve your Elo rating.
    • Aliases: !set, !link
  • !updateElo - Manually updates Elo ratings for all registered members on the server.
    • Aliases: !update, !u
  • !eloInfo [@USER] - Retrieve Elo for yourself or optionally a specified user.
    • Aliases: !info, !stats, !i, !s