Game Server Status Discord Bot
- Create a
token.txtfile and place your Discord bot token inside.- you can also use the
--tokenparameter instead.
- you can also use the
- Edit the example
config.jsonfile to work with your Discord channels and game servers.- For each discord channel, you need to create a
botentry in thebotslist.guildid(--print-guilds-infodisplay all the server and channel IDs the bot belongs to)channelidservers
- For each game server, you need to create a
serverentry in theserverslist.typeipportdescmessageid(optional)qport(optional, override port for a2s query)
- Currently, the supported servers are:
- a2s (any server supporting Valve's Server Query Protocol
thanks to python-a2s)
- arma3
- pz (project zomboid)
- enshrouded
- ts3 (teamspeak)
- minecraft
- eco
- bannerlord
- palworld
- a2s (any server supporting Valve's Server Query Protocol
thanks to python-a2s)
- For each discord channel, you need to create a
usage: main.py [-h] [--refresh REFRESH] [--request-timer REQUEST_TIMER]
[--token TOKEN] [--print-guilds-info]
optional arguments:
-h, --help show this help message and exit
--refresh REFRESH Refresh rate (seconds)
--request-timer REQUEST_TIMER
Sleep time after request
--token TOKEN discord token
--print-guilds-info
Refresh rate must be bigger than (request timer x number of messages).
setup venv and install dependency
python -m venv venv
# windows
.\venv\Scripts\activate.bat
pip install -U pip
pip install requests==2.31.0
pip install discord.py==1.7.3
pip install python-a2s==1.3.0
pip install mcstatus==9.4.2
run with docker
docker build -t gssdiscordbot .
docker run --rm -it -d --name gssdiscordbot-container gssdiscordbot
# view logs
docker logs -f gssdiscordbot-container
# stop container
docker attach gssdiscordbot-container
- CTRL+C -
You may want to change the timezone of the container, example for CET:
ENV TZ="Europe/Paris"
run with docker development
# Comment or remove the COPY command in the Dockerfile
# COPY . .
docker run --rm -it -d -v $(pwd):/usr/src/app --name gssdiscordbot-container gssdiscordbot