forked from cswimr/SeaCogs
docs(pterodactyl): added documentation for the topic subcommand
This commit is contained in:
parent
5f4cb88ea8
commit
7b859e07e9
1 changed files with 35 additions and 0 deletions
|
@ -136,6 +136,41 @@ This option determines which server's websocket to connect to. See [Getting Star
|
||||||
|
|
||||||
Default value: `None`
|
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`
|
## `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.
|
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.
|
||||||
|
|
Loading…
Reference in a new issue