bot/README.md

33 lines
1.1 KiB
Markdown

# Discord bot for 42CTF
This bot allows you to automatically assign the top1/top10/top50 roles on the 42CTF Discord server.
Create an `env_file` file containing :
```
DISCORD_TOKEN=<token_discord>
AUTH_TOKEN=<api_42CTF_token>
```
And then run it with :
```
docker-compose up --build -d
```
By default it will run on 42CTF Guild and with RolesID from this server.
You can run :
```
docker-compose run bot_discord [--wait WAIT] [--force] [--dryrun]
```
## Arguments
| arg | Default | Usage |
|:------------:|:-------:|:---------------------------------------------:|
| --guild / -g | `nil` | Guild ID |
| --top1 | `nil` | TOP1 Role ID |
| --top10 | `nil` | TOP10 Role ID |
| --top50 | `nil` | TOP10 Role ID |
| --wait | `1` | Minutes to wait between runs |
| --force | `false` | Force update of all users |
| --dryrun | `false` | Display log but don't execute discord command |