Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexisgeoffrey/aoe4elobot
Discord bot that automatically retrieves ELO ratings for Age of Empires 4 and gives users custom roles. (Mirrored from https://git.sr.ht/~alexisgeoffrey/aoe4elobot)
https://github.com/alexisgeoffrey/aoe4elobot
age-of-empires aoe4 aoe4-api bot discord discord-bot discordgo go
Last synced: 3 months ago
JSON representation
Discord bot that automatically retrieves ELO ratings for Age of Empires 4 and gives users custom roles. (Mirrored from https://git.sr.ht/~alexisgeoffrey/aoe4elobot)
- Host: GitHub
- URL: https://github.com/alexisgeoffrey/aoe4elobot
- Owner: alexisgeoffrey
- License: mit
- Created: 2022-01-15T07:24:46.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-10T20:00:03.000Z (over 1 year ago)
- Last Synced: 2024-06-20T00:26:44.880Z (5 months ago)
- Topics: age-of-empires, aoe4, aoe4-api, bot, discord, discord-bot, discordgo, go
- Language: Go
- Homepage:
- Size: 285 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-golang-repositories - aoe4elobot
README
# AOE 4 Elo Bot
[](https://builds.sr.ht/~alexisgeoffrey/aoe4elobot?)
[](https://goreportcard.com/report/github.com/alexisgeoffrey/aoe4elobot/v2)
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](https://www.ageofempires.com/stats/ageiv/) via my [aoe4api](https://git.sr.ht/~alexisgeoffrey/aoe4api) library.
Developed with [DiscordGo](https://github.com/bwmarrin/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](https://discord.com/developers/applications).
### *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:
```bash
$ 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.
```bash
$ 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:
```bash
$ sudo docker build . -t aoe4elobot
```
Then, create, a volume for the bot config file:
```bash
$ sudo docker volume create aoe4elobot-config
```
Finally, run the Docker image:
```bash
$ 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`:
```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`