shibedrill/playerbot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
August 2026-05-06 19:50:28 -04:00
parent a3d054b824
commit bdb117c232
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -2,6 +2,14 @@
Playerbot is a utility to monitor the status of game servers through Discord bots. These bots provide a rich integration into your Discord server, including things like player counts, server status, game versions, and game server addresses. It's easy to configure and runs as one process. and runs as one process from one binary. Playerbot is a utility to monitor the status of game servers through Discord bots. These bots provide a rich integration into your Discord server, including things like player counts, server status, game versions, and game server addresses. It's easy to configure and runs as one process. and runs as one process from one binary.
## Features
- The bot's online presence will show online when the server is running and there are players on it, idle when the server is online but there are no players, and do not disturb if the server is offline or unreachable.
- The bot's custom status will show the player count, the maximum player count, and the server version.
- The bot will automatically register slash commands:
- `/players` displays the number of players online and, if the server supports it, will list the usernames of all players on the server.
- `/join` displays the address, or some kind of name that players can search to join the server, as well as the server's version.
## Configuration ## Configuration
Place a file named config.json at the current working directory. Place a file named config.json at the current working directory.