This commit is contained in:
August 2026-05-06 19:58:34 -04:00
parent bdb117c232
commit 1b9d7d154e
Signed by: shibedrill
SSH Key Fingerprint: SHA256:M0m3JW1s38BgO2t0fG146Yxd9OJ2IOqkvCAsuRHQ6Pw
2 changed files with 15 additions and 4 deletions

7
LICENSE Normal file
View File

@ -0,0 +1,7 @@
Copyright © 2026 shibedrill
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

View File

@ -7,14 +7,14 @@ Playerbot is a utility to monitor the status of game servers through Discord bot
- 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.
- `/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
Place a file named config.json at the current working directory.
```
```json
{
"version": "0.1.0",
"entries": [
@ -31,4 +31,8 @@ Place a file named config.json at the current working directory.
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. Currently, it does not support specifying port numbers.
Presently, only Minecraft servers are supported, but soon I will backport support for the SCP: Secret Laboratory handler.
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.