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

docs: Update Placeholders.md, tweak script

Browse Source
This commit is contained in:
William 2023-04-21 14:28:46 +01:00
parent ecf0fdfe15
commit 0cee3556f1
No known key found for this signature in database
2 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/update_docs.yml vendored
View File

@ -23,6 +23,6 @@ jobs:
uses: Andrew-Chen-Wang/github-wiki-action@v3
env:
WIKI_DIR: docs/
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_TOKEN: ${{ github.token }}
GH_MAIL: ${{ github.actor }}@users.noreply.github.com
GH_NAME: ${{ github.repository_owner }}

4
docs/Placeholders.md
View File

@ -19,7 +19,7 @@ Placeholders can be included in the header, footer and player name format of the
| `%debug_team_name%` | Internal team value, used for list sorting | `1_alpha_William2` |
### 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 the user was connected to a server with the name "`very-long-server-`name" and the player name format for the group that server belongs to included a `%server%` placeholder, the placeholder would be replaced with "`VSLN`" instead of the full name!
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>
@ -33,7 +33,7 @@ server_display_names:
</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 foramts as you would any of the default placeholders.
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.
## 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`