forked from Upstream/Velocitab
c23fdd1ff6
* feat: support Minecraft 1.20.5 * build: bump to 1.6.5 * refactor: optimize imports * docs: update about menu author credits * docs: update velocity meta author credits * docs: update URL * refactor: use Minedown from new repo * docs: shorten name of Plugin Message API docs page * deps: bump minimum Velocity version to 380
15 lines
1.7 KiB
Markdown
15 lines
1.7 KiB
Markdown
Velocitab supports the full range of modern color formatting, including RGB colors and gradients. Both MineDown (_default_), MiniMessage and Legacy formatting are supported. To change which formatter is being used, change the `formatter` value in `config.yml` to `MINEDOWN`, `MINIMESSAGE` or `LEGACY` respectively.
|
|
|
|
Formatting is applied on header, footer and player text for each server group, and is applied after [[Placeholders]] have been inserted.
|
|
|
|
## MineDown syntax reference
|
|
MineDown is the default formatter type, enabled by setting `formatter` to `MINEDOWN` in `config.yml`. See the [MineDown Syntax Reference](https://github.com/WiIIiam278/MineDown) on GitHub for the specification of how to format text with it.
|
|
|
|
## MiniMessage syntax reference
|
|
MiniMessage formatting can be enabled by setting `formatter` to `MINIMESSAGE` in `config.yml`. See the [MiniMessage Syntax Reference](https://docs.advntr.dev/minimessage/format.html) on the Adventure Docs for how to format text with it. Using MiniMessage as the formatter also allows compatibility for using MiniPlaceholders in text.
|
|
|
|
## Legacy formatting
|
|
> **Warning:** The option for legacy formatting is provided only for backwards compatibility with other plugins. Please consider using the MineDown or MiniMessage options instead!
|
|
|
|
Legacy formatting can be enabled by setting `formatter` to `LEGACY` in `config.yml`. Legacy formatter supports Mojang color and formatting codes (e.g. `&d`, `&l`), Adventure-styled RGB color codes (e.g. `&#a25981`), as well as BungeeCord RGB color codes (e.g. `&x&a&2&5&9&8&1`). See the [LegacyComponentSerializer Syntax Reference](https://docs.advntr.dev/serializer/legacy.html) on the Adventure Docs for more technical details.
|