diff --git a/README.md b/README.md index 6038683..47c8eb9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,26 @@ # Playerbot -Using Tokio to run two futures simultaneously, I put together two discord bots which each update their statuses/presences with information about a corresponding game server. +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. + +## Configuration + +Place a file named config.json at the current working directory. + +``` +{ + "version": "0.1.0", + "entries": [ + { + "handler_type": "minecraft", + "address": { + "Domain": "mc.example.com" + }, + "token": "FAKEDISCORDAPPLICATIONTOKENPLACEHOLDER" + }, + ] +} +``` + +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