Fork/Velocitab
2
0
Fork 0
forked from Upstream/Velocitab
Code Pull Requests Actions Releases Activity

docs: Document new placeholders

Browse Source
This commit is contained in:
William278 2023-10-12 13:44:29 +01:00
parent 8224cd0ff1
commit b40a48a987
1 changed files with 18 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/Placeholders.md
View File

@ -4,7 +4,7 @@ Velocitab supports a number of Placeholders that will be replaced with their res
Placeholders can be included in the header, footer and player name format of the TAB list. The following placeholders are supported out of the box: Placeholders can be included in the header, footer and player name format of the TAB list. The following placeholders are supported out of the box:
| Placeholder | Description | Example | | Placeholder | Description | Example |
|--------------------------|---------------------------------------------------|--------------------| |--------------------------|------------------------------------------------------|--------------------|
| `%players_online%` | Players online on the proxy | `6` | | `%players_online%` | Players online on the proxy | `6` |
| `%max_players_online%` | Player capacity of the proxy | `500` | | `%max_players_online%` | Player capacity of the proxy | `500` |
| `%local_players_online%` | Players online on the server the player is on | `3` | | `%local_players_online%` | Players online on the server the player is on | `3` |
@ -17,6 +17,7 @@ Placeholders can be included in the header, footer and player name format of the
| `%suffix%` | The player's suffix (from LuckPerms) | `&c ` | | `%suffix%` | The player's suffix (from LuckPerms) | `&c ` |
| `%role%` | The player's primary LuckPerms group name | `admin` | | `%role%` | The player's primary LuckPerms group name | `admin` |
| `%role_display_name%` | The player's primary LuckPerms group display name | `Admin` | | `%role_display_name%` | The player's primary LuckPerms group display name | `Admin` |
| `%role_weight%` | Comparable-formatted primary LuckPerms group weight. | `100` |
| `%server_group%` | The name of the server group the player is on | `default` | | `%server_group%` | The name of the server group the player is on | `default` |
| `%server_group_index%` | Indexed order of the server group in the list | `0` | | `%server_group_index%` | Indexed order of the server group in the list | `0` |
| `%debug_team_name%` | (Debug) Player's team name, used for [[Sorting]] | `1alphaWilliam278` | | `%debug_team_name%` | (Debug) Player's team name, used for [[Sorting]] | `1alphaWilliam278` |