| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| library:minedown:syntax [2021/06/17 16:13] – Add preview images phoenix616 | library:minedown:syntax [2025/10/06 14:21] (current) – [Advanced Syntax] Add new click and ojbect events phoenix616 |
|---|
| ===== Inline Formatting ===== | ===== Inline Formatting ===== |
| |
| | **Description** | **Syntax** | **More Info** | **Preview** | | | **Description** | **Syntax** | **Preview** | **More Info** | |
| | Color legacy |` &6Text `| [Formatting codes](https://minecraft.gamepedia.com/Formatting_codes) |  | | | Color legacy |` &6Text `|  | [Formatting codes](https://minecraft.wiki/w/Formatting_codes) | |
| | Color |` &gold&Text `| [Color names](https://minecraft.gamepedia.com/Formatting_codes) |  | | | Color |` &gold&Text `|  | [Color names](https://minecraft.wiki/w/Formatting_codes) | |
| | RGB Hex Color |` &#ff00ff&Text `| Full hexadecimal format |  | | | RGB Hex Color |` &#ff00ff&Text `|  | Full hexadecimal format | |
| | RGB Hex Color |` &#f0f&Text `| Short format (equivalent to long one) |  | | | RGB Hex Color |` &#f0f&Text `|  | Short format (equivalent to long one) | |
| | Gradient |` &#f0f-#fff&Text `| Inline gradients |  | | | Gradient |` &#f0f-#fff&Text `|  | Inline gradients | |
| | Rainbow |` &rainbow&Text `| Inline Rainbow |  | | | Rainbow |` &rainbow&Text `|  | Inline Rainbow | |
| | Rainbow Phase |` &rainbow:20&Text `| Inline Rainbow with a phase |  | | | Rainbow Phase |` &rainbow:20&Text `|  | Inline Rainbow with a phase | |
| | Bold |` **Text** `| |  | | | Bold |` **Text** `|  | | |
| | Italic |` ##Text## `| |  | | | Italic |` ##Text## `|  | | |
| | Underlined |` __Text__ `| |  | | | Underlined |` __Text__ `|  | | |
| | Strikethrough |` ~~Text~~ `| |  | | | Strikethrough |` ~~Text~~ `|  | | |
| | Obfuscated |` ??Text?? `| |  | | | Obfuscated |` ??Text?? `|  | | |
| |
| ===== Events ===== | ===== Events ===== |
| ==== Advanced Syntax ==== | ==== Advanced Syntax ==== |
| |
| | **Description** | **Syntax** | **More Info** | | | **Description** | **Syntax** | **More Info** | |
| | General syntax |` [Text](action=value) `| [ClickEvent.Action](https://ci.md-5.net/job/BungeeCord/ws/chat/target/apidocs/net/md_5/bungee/api/chat/ClickEvent.Action.html), [HoverEvent.Action](https://ci.md-5.net/job/BungeeCord/ws/chat/target/apidocs/net/md_5/bungee/api/chat/HoverEvent.Action.html) | | | 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) `| | | Link | ` [Text](open_url=https://example.com) ` | | |
| | Color |` [Text](color=red) `| [Color names](https://minecraft.gamepedia.com/Formatting_codes) | | | 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=#ff00ff) ` | Full hexadecimal format | |
| | RGB Hex Color |` [Text](color=#f0f) `| Short format (equivalent to long one) | | | 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-#000) ` | Gradient of two colors. (Supports all color forms) | |
| | RGB Color Gradient |` [Text](color=#fff-#333-#222) `| Gradient of three colors. | | | RGB Color Gradient | ` [Text](color=#fff-#333-#222) ` | Gradient of three colors. | |
| | RGB Rainbow |` [Text](color=rainbow) `| An RGB rainbow. | | | RGB Rainbow | ` [Text](color=rainbow) ` | An RGB rainbow. | |
| | Phased RGB Rainbow |` [Text](color=rainbow:50) `| An RGB rainbow with a specific phase. | | | Phased RGB Rainbow | ` [Text](color=rainbow:50) ` | An RGB rainbow with a specific phase. | |
| | Formatting |` [Text](format=underline,bold) `| | | | Text Shaddow | ` [Text](shadow=#ff00ff) ` | Specify the shadow of the text | |
| | Font |` [Text](font=custom_font) `| Set a custom font from a resource pack | | | Formatting | ` [Text](format=underline,bold) ` | Specify formatting | |
| | Run Command |` [Text](run_command=/command string) `| Run command on click | | | Disable Formatting | ` [Text](format=!underline) ` | Disable the specific formatting with a ! prefix | |
| | Suggest Command |` [Text](suggest_command=/command) `| Suggest a command on click | | | Font | ` [Text](font=custom_font) ` | Set a custom font from a resource pack | |
| | Simple Hover |` [Text](hover=Hover Text) `| Show hover text | | | Translatable | ` [fallback](translate=translation.key with={value1, value2}) ` | Translatable component with optional replacements | |
| | Hover Text |` [Text](show_text=Hover Text) `| Show hover text | | | Player head | ` [](player_head=name) ` | Show a player head from a player with a specified name | |
| | Hover Entity Info |` [Text](show_entity=uuid:pig Name) `| Show entity information. | | | Player head | ` [](player_head=83688181-ce68-4136-918b-15e88ec2c705) ` | Show a player head from a player with a specified UUID | |
| | 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 | | | 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 a event definition. | 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! | You can't however add multiple different colors or click and hover actions! |
