# 🎨 Rich Text (MiniMessage)

## Information

Phoenix Lobby understands [MiniMessage](https://docs.advntr.dev/minimessage/format.html) tags, like `<red>`, `<bold>` or `<gradient:#ff5555:#5555ff>`, on top of the classic `&` colour codes. This lets you use gradients, hover text and clickable links, none of which `&` codes can do.

## Format

| Example                                                  | Result                                 |
| -------------------------------------------------------- | -------------------------------------- |
| `<red>Hello`                                             | Red text                               |
| `<#ff8800>Hello`                                         | Any hex colour                         |
| `<gradient:#5e4fa2:#f79459>Phoenix Lobby</gradient>`     | Text fading from one colour to another |
| `<bold><underlined>Warning`                              | Bold and underlined                    |
| `<rainbow>Welcome back!</rainbow>`                       | Each letter a different colour         |
| `<hover:show_text:'Click me'>Hover</hover>`              | Text with a tooltip                    |
| `<click:open_url:'https://example.com'>Our site</click>` | Text that opens a link                 |

A closing tag is optional. `<red>Hello` colours the rest of the line, while `<red>Hello</red> there` colours only the first word.

## Where it works

| Place                                                | Notes                                        |
| ---------------------------------------------------- | -------------------------------------------- |
| [Holograms](../featues/holograms/)                   | Including `<font:...>` from a resource pack  |
| [Scoreboard](../modules/scoreboard.md)               | Title and lines                              |
| [MOTD](../modules/motd.md)                           | Message, and the player count on Paper       |
| [Tablist](../modules/tablist.md)                     | Header and footer                            |
| [Join and quit messages](../modules/join-actions/join-quit-messages.md) | And the rest of the plugin's chat messages |
| Menu titles, item names and lore                     | Anywhere the editor lets you write text      |

## Where it doesn't work

Nametag prefixes and suffixes are the exception. Minecraft draws those through the scoreboard team system, which only understands the old colour codes, so a tag there is reduced to the nearest legacy colour.

## Usage notes

* Legacy `&` codes, including `&#RRGGBB` hex, keep working everywhere exactly as before.
* In **chat messages**, use one style per line. A chat line is only sent as MiniMessage when it contains no legacy colour codes at all, so mixing `&c` and `<red>` in the same line falls back to legacy and prints the tag.
* Everywhere else the two can be mixed freely. A scoreboard line or a hologram is read as MiniMessage as soon as it contains a tag, and any `&` codes in it are converted along with it.
* A tag the server does not recognise is left in the text as written rather than being dropped, which is what keeps resource pack glyph tags working.

> **Warning:**
MiniMessage needs [Paper](https://papermc.io/) or a fork of it. On plain Spigot the tags are printed exactly as you typed them, so stay on `&` codes there.

Source: https://www.phoenixplugins.com/docs/phoenix-lobby/plugin-information/rich-text