From 7b859e07e9924dca22c0b6ff17c27d0db0cd63dd Mon Sep 17 00:00:00 2001 From: SeaswimmerTheFsh Date: Thu, 14 Mar 2024 16:34:54 -0400 Subject: [PATCH] docs(pterodactyl): added documentation for the topic subcommand --- .docs/pterodactyl/configuration.md | 35 ++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/.docs/pterodactyl/configuration.md b/.docs/pterodactyl/configuration.md index 87349bd..662e81a 100644 --- a/.docs/pterodactyl/configuration.md +++ b/.docs/pterodactyl/configuration.md @@ -136,6 +136,41 @@ This option determines which server's websocket to connect to. See [Getting Star Default value: `None` +## `topic` + +### `host` + +This option determines the hostname of your server that will be used to retrieve server information. + +### `port` + +This option determines the port of your server that will be used to retrieve server information. + +Default value: `25565` + +### `text` + +This option determines what the channel topic will be set to. + +Available placeholders: + +- `.$H` - replaced with the server's hostname +- `.$O` - replaced with the server's port + +Available with a Minecraft server: + +- `.$I` - replaced with the server's ip address +- `.$M` - replaced with maximum player count +- `.$P` - replaced with current online player count +- `.$V` - replaced with the server's current version +- `.$D` - replaced with the server's description / message of the day + +Default value: + +``` +Server IP: .$H\nServer Players: .$P/.$M +``` + ## `url` This option determines what panel the cog will send requests to. See [Getting Started](getting-started.md#getting-server-information) for more information on this.