43 lines
2.2 KiB
Markdown
43 lines
2.2 KiB
Markdown
# Playerbot 1.2.0
|
|
|
|
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 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.
|
|
- `/contact` allows users to file support tickets which ping the configured maintainer. This is only registered for servers with supplied maintainer UIDs.
|
|
- `/about` displays information about the bot itself.
|
|
|
|
## Configuration
|
|
|
|
The program requires a file named config.json to be present in its current working directory. Below is an example of its schema.
|
|
|
|
```json
|
|
{
|
|
"version": "0.2.0",
|
|
"entries": [
|
|
{
|
|
"Minecraft": {
|
|
"host": {
|
|
"Ipv4": "10.0.0.2:233" // Can be "Domain", "Ipv4", or "Ipv6", required
|
|
},
|
|
"token": "FAKETOKENPLACEHOLDERWHICHISVERYLONG", // Bot tokem, required
|
|
"contact": 999999999999999999 // Maintainence contact Discord UID, optional
|
|
}
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
The file should consist of a list of entries, each representing a single server, represented by a single bot. The address can either be `Domain`, `IPv4`, or `IPv6`, representing a hostname, an IPv4 address, or an IPv6 address, respectively. Port numbers are supported.
|
|
|
|
Presently, only Minecraft servers are supported, but soon I will backport support for the SCP: Secret Laboratory handler.
|
|
|
|
## License
|
|
|
|
This project is available under the MIT license.
|