====== Syntax ====== ===== Inline Formatting ===== | **Description** | **Syntax** | **Preview** | **More Info** | | Color legacy |` &6Text `| ![](https://i.phoenix616.dev/gbJYVeql.png) | [Formatting codes](https://minecraft.wiki/w/Formatting_codes) | | Color |` &gold&Text `| ![](https://i.phoenix616.dev/gfgApGrn.png) | [Color names](https://minecraft.wiki/w/Formatting_codes) | | RGB Hex Color |` &#ff00ff&Text `| ![](https://i.phoenix616.dev/glFV9zgw.png) | Full hexadecimal format | | RGB Hex Color |` &#f0f&Text `| ![](https://i.phoenix616.dev/gojZlSaN.png) | Short format (equivalent to long one) | | Gradient |` &#f0f-#fff&Text `| ![](https://i.phoenix616.dev/giOQuXV6.png) | Inline gradients | | Rainbow |` &rainbow&Text `| ![](https://i.phoenix616.dev/ggYaEWZt.png) | Inline Rainbow | | Rainbow Phase |` &rainbow:20&Text `| ![](https://i.phoenix616.dev/gojDf1ZM.png) | Inline Rainbow with a phase | | Bold |` **Text** `| ![](https://i.phoenix616.dev/fYDs0soW.png) | | | Italic |` ##Text## `| ![](https://i.phoenix616.dev/gaLmjWZA.png) | | | Underlined |` __Text__ `| ![](https://i.phoenix616.dev/gk6lbR0B.png) | | | Strikethrough |` ~~Text~~ `| ![](https://i.phoenix616.dev/gpc5zBr4.png) | | | Obfuscated |` ??Text?? `| ![](https://i.phoenix616.dev/giRU4C9u.gif) | | ===== Events ===== You can define click and hover events with the commonly used MarkDown link syntax. ==== Simple Syntax ==== | **Description** | **Syntax** | | General syntax |` [Text](text-color text-formatting... link hover text) `| | Simple Link |` [Text](https://example.com) `| | Simple Command |` [Text](/command to run) `| | Link + Hover |` [Text](https://example.com Hover Text) `| | Text formatting |` [Text](blue underline) `| | Gradient |` [Text](#fff-#000) `| | Rainbow |` [Text](rainbow) `| | Phased Rainbow |` [Text](rainbow:20) `| | Text formatting + Link + Hover |` [Text](#0000ff underline https://example.com Hover Text) `| ==== Advanced Syntax ==== | **Description** | **Syntax** | **More Info** | | General syntax | ` [Text](action=value) ` | [ClickEvent.Action](https://jd.advntr.dev/api/4.24.0/net/kyori/adventure/text/event/ClickEvent.Action.html), [HoverEvent.Action](https://jd.advntr.dev/api/4.24.0/net/kyori/adventure/text/event/HoverEvent.Action.html) | | Link | ` [Text](open_url=https://example.com) ` | | | Color | ` [Text](color=red) ` | [Color names](https://minecraft.wiki/w/Formatting_codes) | | RGB Hex Color | ` [Text](color=#ff00ff) ` | Full hexadecimal format | | RGB Hex Color | ` [Text](color=#f0f) ` | Short format (equivalent to long one) | | RGB Color Gradient | ` [Text](color=#fff-#000) ` | Gradient of two colors. (Supports all color forms) | | RGB Color Gradient | ` [Text](color=#fff-#333-#222) ` | Gradient of three colors. | | RGB Rainbow | ` [Text](color=rainbow) ` | An RGB rainbow. | | Phased RGB Rainbow | ` [Text](color=rainbow:50) ` | An RGB rainbow with a specific phase. | | Text Shaddow | ` [Text](shadow=#ff00ff) ` | Specify the shadow of the text | | Formatting | ` [Text](format=underline,bold) ` | Specify formatting | | Disable Formatting | ` [Text](format=!underline) ` | Disable the specific formatting with a ! prefix | | Font | ` [Text](font=custom_font) ` | Set a custom font from a resource pack | | Translatable | ` [fallback](translate=translation.key with={value1, value2}) ` | Translatable component with optional replacements | | Player head | ` [](player_head=name) ` | Show a player head from a player with a specified name | | Player head | ` [](player_head=83688181-ce68-4136-918b-15e88ec2c705) ` | Show a player head from a player with a specified UUID | | Player head | ` [](player_head=name hat=false) ` | Show a player head without the hat layer | | Player head | ` [](player_head=minecraft:entity/player/wide/alex) ` | Show a player head with a specified client-side texture | | Player head | ` [](player_head=name texture=minecraft:entity/player/wide/alex) ` | Show a player head with a specified client-side texture | | Player head | ` [](player_head=base64encodedstring) ` | Show a player head using custom base64 encoded online profile textures | | Player head | ` [](player_head=name profile={textures=base64encodedstring}) ` | Show a player head with custom profile information | | Block/Item | ` [](sprite=item/diamond) ` | Show a block or item sprite | | Block/Item | ` [](sprite=item/diamond atlas=blocks) ` | Show a block or item sprite from a specific atlas | | Run Command | ` [Text](run_command=/command string) ` | Run command on click | | Suggest Command | ` [Text](suggest_command=/command) ` | Suggest a command on click | | Copy to Clipboard | ` [Text](copy_to_clipboard=Text to be copied) ` | Copy some text to the clipboard | | Change Book Page | ` [Text](change_page=42) ` | Change the page to a certain page number. **Only works in books!** | | Open Dialog (Soon) | ` [Text](show_dialog=custom:my/dialog) ` | Open a dialog on click, by resource location | | Open Dialog (Soon) | ` [Text](show_dialog={dialog-definition}) ` | Open a dialog on click, with a custom dialog definition | | Send custom action | ` [Text](custom=namespace:key payload={optional-payload}) ` | Execute some custom action specified by namespaced key, requires a plugin to listen on that | | Simple Hover | ` [Text](hover=Hover Text) ` | Show hover text | | Hover Text | ` [Text](show_text=Hover Text) ` | Show hover text | | Hover Entity Info | ` [Text](show_entity=uuid:pig Name) ` | Show entity information. | | Hover Item Info | ` [Text](show_item=stone*2 nbt...) ` | Show item information, additional information needs to be provided as a string of the nbt in json | | Insertion | ` [Text](insert=insert into input) ` | Insert into input on shift click, can be combined with other events | All advanced settings can be chained/included in an event definition by writing them after each other separated by a **space**. You can't however add multiple different colors or click and hover actions!