Simplified Text Format¶

It's a simple, string format inspired by formats like HTML or MiniMessage. It was created to allow quick and readable way of formatting Minecraft Text Components while still providing all of its functionality as opposed for legacy &/§ formatting used by bukkit and bukkit-based plugins.

Structure¶

Formatting is build on concept of tags.

1

<lang:'chat.type.team.sent':'<hover\:\'<lang\:chat.type.team.hover>\'><suggest_command\:\'/teammsg \'>${team}':'${displayName}':'${message}'>

Most of them come in pairs of a starting (<tag>) and closing one (</tag> for direct or <‍/‍> (2.1.3+) for automatic). While closing ones are technically optional, without them formatting will continue until end of an input text or special <reset> tag. Some tags support arguments, which can be passed by adding : after tag name in starting one (for example <color:#FF3333> </color>). Arguments containing symbols like :, <, >, % and spaces should be wrapped in a ' symbols (for example <hover:show_text:'<red>Hello!'>...).

In case you want to type <tag> as plain text, you need to prefix it with \ symbol .

There are also few self-contained tags, that don't require closing ones. They can also take arguments in the same way to previous ones.

Few examples:

• <lang:'item.minecraft.diamond'>
• <reset>

List of available tags¶

Here is list of all default tags available. Other mods can add new or limit usage of existing ones, so not every might work in yours case.

Colors¶

By default, there are multiple tags representing colors. They use their vanilla name or (additional aliases).

The current list includes: <yellow>, <dark_blue>, <dark_purple>, <gold>, <red>, <aqua>, <gray>, <light_purple>, <white>, <dark_gray>, <green>, <dark_green>, <blue>, <dark_aqua>, <dark_green>, <black>

There is also a universal <color:[value]> and <c:[value]> tags, in which you can replace [value] with vanilla color name or an rgb color starting with # (for example <color:#AABBCC>)

Decorations¶

These tags allow decorating text, they are quite simple.

• <strikethrough>/<st> - Makes the text strikethrough,
• <underline>/<underlined> - Underlines the text,
• <italic>/<i> - Makes the text italic,
• <obfuscated>/<obf> - Obfuscates the text (matrix effect),
• <bold>/<b> - Makes the text bold,

Click events¶

Click events allows making text more interactive.

There are few available actions:

• <click:open_url:[value]>/<open_url:[value]>/<url:[value]> - Opens the provided url
• <click:run_command:[value]>/<run_cmd:[value]> - Runs a command as the player
• <click:suggest_command:[value]>/<suggest_command:[value]>/<cmd:[value]> - Suggests a command to the player
• <click:copy_to_clipboard:[value]>/<copy_to_clipboard:[value]>/<copy:[value]> - Copies text to the clipboard
• <click:change_page:[value]>/<change_page:[value]>/<page:[value]> - Changes the page in a book

[value] needs to be replaced with targeted value, for example 'gamemode creative'

Hover¶

Hover tag allows adding simple hover on text. It can be used to display additional information.

• <hover:show_text:[value]>/<hover:[value]> - Adds a simple text hover ([value] uses the same formatting as rest)
• <hover:show_item:[value]> - Adds a simple ItemStack hover ([value] is item in sNBT format)
• <hover:show_entity:[type]:[UUID]:'Display Name'> - Adds an entity hover. (The colon (:) in the entity type needs to be replaced with \:. For example, <hover:show_entity:minecraft\:bee:[UUID]:'Display Name'>)

Fonts¶

This tag allows you to change font to any build in one or one provided by resource pack.

You can use it by simply adding <font:[value]>, where [value] is just a font name. Minecraft has 3 build-in fonts: default, uniform and alt.

Inserting¶

This tag creates a clickable text, that inserts its value at the end of player's chat message.

You can use it by writing <insert:[value]>, where [value] inserted text (should be wrapped in ').

Translations¶

Translations tag allows you to insert a text from a lang file (including ones parsed on servers by some mods).

You use it with <lang:[key]:[optional arg 1]:[optional arg 1]:...>, where [key] is a translation key and [optional arg X] are optional, fully formatted arguments you can pass.

Control keys¶

This tag allows you to add information about player control keys, with respecting of theirs configuration.

You can use it with <keybind:[value]>, where [value] is a control key used.

Gradients¶

This tag allows you to add gradients to the text. However, it has multiple limitation that can block its usage. Currently, you can't use dynamic values (translations, control keys, placeholders, etc) within them, as they require static text.

There 2 types of gradients:

• <gradient:[color 1]:[color 2]:...>/<gr:[color 1]:[color 2]:...> - I can take multiple colors to move between them smoothly.
• <hard_gradient:[color 1]:[color 2]:...>/<hgr:[color 1]:[color 2]:...> - I can take multiple colors to move between them without mixing them.
• <rainbow:[frequency]:[saturation]:[offset]>/<rb:[...]> - It's simple rainbow gradient. All arguments are optional (<ranbow> is still valid) and they take numbers between 0 and 1 (0.3 for example)

Reset¶

<reset> and <r> are special, self-contained tags which close all previous formatting. They are useful in cases, where you want to close multiple formatting tags quickly

Clear (2.1.3+)¶

This tag allows you to clear any formatting within this tag, without leaving any visible tags. It also works with placeholders, which gives a bit more flexibility.

This tag can work without arguments making it clear all formatting or with them limiting clearing to selected types.

Examples:

• <clear> - Removes all formatting, leaving only text.
• <clear:hover> - Removes all hovers.
• <clear:hover:color> - Removes all hovers and colors.

Supported arguments: color, bold, italic, strikethrough, underline, hover, click, insertion, font, all.