Velocitab/docs/Formatting.md
AlexDev_ 89a1f7add3
refactor: internals refactor, fix logic, new configs, spectator fix (#138)
* 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
2024-01-16 21:09:46 +00:00

1.7 KiB

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 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 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 on the Adventure Docs for more technical details.