docs(pterodactyl): added documentation for the topic subcommand
All checks were successful
Actions / Build Documentation (MkDocs) (push) Successful in 25s
Actions / Lint Code (Ruff & Pylint) (push) Successful in 30s

This commit is contained in:
Seaswimmer 2024-03-14 16:34:54 -04:00
parent 5f4cb88ea8
commit 7b859e07e9
Signed by: cswimr
GPG key ID: B8953EC01E5C4063

View file

@ -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.