From 1b9d7d154e4675207fba39412c666198616dd9de Mon Sep 17 00:00:00 2001 From: August Date: Wed, 6 May 2026 19:58:34 -0400 Subject: [PATCH] license --- LICENSE | 7 +++++++ README.md | 12 ++++++++---- 2 files changed, 15 insertions(+), 4 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e8579f6 --- /dev/null +++ b/LICENSE @@ -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. \ No newline at end of file diff --git a/README.md b/README.md index fe42d51..81f7521 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file +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.