Skip to content

Commit

Permalink
fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zefanjajobse committed Jul 23, 2023
1 parent de1c974 commit b09a515
Showing 1 changed file with 12 additions and 54 deletions.
66 changes: 12 additions & 54 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,58 +1,16 @@
# Discord status bots for battlefield
This bot shows info about your battlefield servers and updates it every 2 minutes, this bot can also send updates when the status of the server changes. same as the python version, but better when needing running 50 at a time.
# Gamedig Discord status bot

run with
```bash
export token=TOKEN
export name=SERVERNAME
export lang=en-us
export minplayeramount=20
export prevrequestcount=5
export channel=0
export startedamount=50
export game=tunguska
cargo run
```
A Discord bot to check the status of your server in different gamedig supported games, as requested by [onemanarmy](https://www.superinfantryclan.com/)

Or use docker:
```docker
version: '3.7'
set the config to the correct info in a config.txt next to this executable to use:

services:
ace-bot-1:
image: ghcr.io/community-network/server-bot-rust/server-bot-rust:latest
restart: always
environment:
- token=TOKEN
- name=[ACE]#1
- channel=0
- minplayeramount=20
- prevrequestcount=5
- startedamount=50
- guild=0
- game=tunguska
- lang=en-us
healthcheck:
test: ["CMD", "curl", "-f", "http://127.0.0.1:3030/"]
interval: "60s"
timeout: "3s"
start_period: "5s"
retries: 3
```yaml
# discord bot token
token = ''
# game to track
game = 'rust'
# server ip
server_ip = '194.163.156.99'
# and queryport
server_port = 28016
```

This initially used the game api directly, but to not login to the api constandly (many groups use this, so could block logins) it was made to use our main api. it uses the codename for the game for backwards compatability with all locations it is used.

### Game names:
"tunguska" = Battlefield 1

"casablanca" = Battlefield V

"kingston" = Battlefield 2042

#### API Documentation:
- [api.gametools.network](https://api.gametools.network/docs)

#### example images:
![messages send by bot](https://media.discordapp.net/attachments/722532776523464725/828958877071966267/unknown.png)

![serverinfo bots example](https://cdn.discordapp.com/attachments/722532776523464725/828955160336269332/unknown.png)

0 comments on commit b09a515

Please sign in to comment.