diff --git a/docs/Conditional-Placeholders.md b/docs/Conditional-Placeholders.md index 1430d38..f096b6d 100644 --- a/docs/Conditional-Placeholders.md +++ b/docs/Conditional-Placeholders.md @@ -1,5 +1,3 @@ -# Velocitab Conditional Placeholders Documentation - In order to use these placeholders, install MiniPlaceholders on your Velocity proxy, set the `formatter_type` to `MINIMESSAGE`, and ensure `enable_miniplaceholders_hook` is set to `true`. diff --git a/docs/Config-File.md b/docs/Config-File.md index 090bdd5..6a5e8d7 100644 --- a/docs/Config-File.md +++ b/docs/Config-File.md @@ -122,39 +122,5 @@ Velocitab supports basic header and footer animations by adding multiple frames ### Placeholders You can use various placeholders that will be replaced with values (for example, `%username%`) in your config. Support for PlaceholderAPI is also available through [a bridge library plugin](https://modrinth.com/plugin/papiproxybridge), as is the component-based MiniPlaceholders for users of that plugin with the MiniMessage formatter. See [[Placeholders]] for more information. -### YAML MultiLine Syntax - -In order to have a multi-line string in YAML, you can use the `|-` or `|` syntax. The `|-` syntax will remove last newline character, while the `|` syntax will keep it. -You can also use `\n` to add a newline character in a string. - -# Example 1 -```yaml -foo: |- - bar 1 - bar 2 - bar 3 -``` - -is equivalent to - -```yaml -foo: "bar 1\nbar 2\nbar 3" -``` - -# Example 2 - -```yaml -foo: | - bar 1 - bar 2 - bar 3 -``` - -is equivalent to - -```yaml -foo: "bar 1\nbar 2\nbar 3\n" -``` - ### Server Links For Minecraft 1.21+ clients, Velocitab supports specifying a list of URLs that will be sent to display in the player pause menu. See [[Server Links]] for more information. \ No newline at end of file diff --git a/docs/Formatting.md b/docs/Formatting.md index 6b50d3c..ca0d106 100644 --- a/docs/Formatting.md +++ b/docs/Formatting.md @@ -12,3 +12,36 @@ MiniMessage formatting can be enabled by setting `formatter` to `MINIMESSAGE` in > **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. + +## Multi-line strings +In order to have a multi-line string in YAML, you can use the `|-` or `|` syntax. The `|-` syntax will remove last newline character, while the `|` syntax will keep it. +You can also use `\n` to add a newline character in a string. + +### Example 1 +```yaml +foo: |- + bar 1 + bar 2 + bar 3 +``` + +is equivalent to + +```yaml +foo: "bar 1\nbar 2\nbar 3" +``` + +### Example 2 + +```yaml +foo: | + bar 1 + bar 2 + bar 3 +``` + +is equivalent to + +```yaml +foo: "bar 1\nbar 2\nbar 3\n" +``` \ No newline at end of file