forked from Upstream/Velocitab
89a1f7add3
* Started refactor * more work * Bug fixes and more work * Fixed task problem * More work on providers + fixed relocation problem * Added providers + relocated snakeyaml * Fixed relocation problem + removed org.json * maps instantiation refactored * Fixed reload problem * Fixed logic problem * More work on refactoring PlayerTabList * Using lombok for procteded values * More work * Fixed cache problem + more work on refactor * Fix for https://github.com/WiIIiam278/Velocitab/issues/35 * fixed conversations * Code refactor * Fixed problem while using minimessage * Added more javadocs and removed kick handling as velocity fixed that problem * Added username_lower placeholder and removed useless libraries * Updated docs * Added option to remove spectator effect in tablist
47 lines
4.3 KiB
Markdown
47 lines
4.3 KiB
Markdown
Velocitab supports a number of Placeholders that will be replaced with their respective proper values in-game. In addition to the set of provided default Placeholders, you can make use of PlaceholderAPI and MiniPlaceholder-provided placeholders through special hooks.
|
|
|
|
## Default placeholders
|
|
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 |
|
|
|--------------------------|------------------------------------------------------|--------------------|
|
|
| `%players_online%` | Players online on the proxy | `6` |
|
|
| `%max_players_online%` | Player capacity of the proxy | `500` |
|
|
| `%local_players_online%` | Players online on the server the player is on | `3` |
|
|
| `%current_date%` | Current real-world date of the server | `24 Feb 2023` |
|
|
| `%current_time%` | Current real-world time of the server | `21:45:32` |
|
|
| `%username%` | The player's username | `William278` |
|
|
| `%username_lower%` | The player's username, in lowercase | `william278` |
|
|
| `%server%` | Name of the server the player is on | `alpha` |
|
|
| `%ping%` | Ping of the player (in ms) | `6` |
|
|
| `%prefix%` | The player's prefix (from LuckPerms) | `&4[Admin]` |
|
|
| `%suffix%` | The player's suffix (from LuckPerms) | `&c ` |
|
|
| `%role%` | The player's primary LuckPerms group name | `admin` |
|
|
| `%role_display_name%` | The player's primary LuckPerms group display name | `Admin` |
|
|
| `%role_weight%` | Comparable-formatted primary LuckPerms group weight. | `100` |
|
|
| `%luckperms_meta_(key)%` | Formats a meta key from the user's LuckPerms group | (varies) |
|
|
| `%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` |
|
|
| `%debug_team_name%` | (Debug) Player's team name, used for [[Sorting]] | `1alphaWilliam278` |
|
|
|
|
### Customising server display names
|
|
You can make use of the `server_display_names` feature in `config.yml` to customise how server display name appear when using the `%server%` placeholder. In the below example, if a user is connected to a server with the name "`very-long-server-`name" and the player name format for the group that server belongs to includes a `%server%` placeholder, the placeholder would be replaced with "`VSLN`" instead of the full server name.
|
|
|
|
<details>
|
|
<summary>Server display names (config.yml)</summary>
|
|
|
|
```yaml
|
|
# Define custom names to be shown in the TAB list for specific server names.
|
|
# If no custom display name is provided for a server, its original name will be used.
|
|
server_display_names:
|
|
very-long-server-name: VLSN
|
|
```
|
|
</details>
|
|
|
|
## PlaceholderAPI support
|
|
To use PlaceholderAPI placeholders in Velocitab, install the [PAPIProxyBridge](https://modrinth.com/plugin/papiproxybridge) library plugin on your Velocity proxy and all Minecraft spigot servers on your network, and ensure the PAPI hook option is enabled in your Velocitab [[Config File]]. You can then include PAPI placeholders in your formats as you would any of the default placeholders.
|
|
|
|
PlaceholderAPI placeholders are cached to reduce plugin message traffic. By default, placeholders are cached for 30 seconds (30000 milliseconds); if you wish to use PAPI placeholders that update more frequently, you can reduce the cache time in the Velocitab config.yml file by adjusting the `papi_cache_time` value.
|
|
|
|
## MiniPlaceholders support
|
|
If you are using MiniMessage [[Formatting]], you can use [MiniPlaceholders](https://github.com/MiniPlaceholders/MiniPlaceholders) with Velocitab for MiniMessage-styled component placeholders provided by other proxy plugins. Install MiniPlaceholders on your Velocity proxy, set the `formatter_type` to `MINIMESSAGE` and ensure `enable_miniplaceholders_hook` is set to `true` |