customMiniMessage

val customMiniMessage: @NotNull MiniMessage(source)

Rebar's custom MiniMessage instance with custom tags. This instance is used when translating any Rebar translation keys.

Custom Tags

  • <arrow>|<arrow:\[color\]> - Inserts a right arrow (→) with the specified color (default: 0x666666)

  • <guidearrow> - Shorthand for arrow:0x3a293`

  • <diamond>|<diamond:\[color\]> - Inserts a diamond (◆) with the specified color (default: 0x666666)

  • <star>|<star:\[color\]> - Inserts a star (★) with the specified color (default: NamedTextColor.BLUE)

  • <insn></insn> - Applies a yellow styling (0xf9d104), used for instructions

  • <guideinsn></guideinsn> - Applies a purple styling (0xc907f4), used for guide instructions

  • <attr></attr> - Applies a cyan styling (0xa9d9e8), used for attributes

  • <unit:\[prefix\]:[unit]></unit> - Formats a constant number as a unit, with an optional metric prefix

  • <nbsp></nbsp> - Replaces spaces with non-breaking spaces ( ), useful for preventing line breaks in lore

  • <item:\[item_name\]> - Renders the translated name of a vanilla/rebar item (e.g., <item:stone> → "Stone", <item:pylon:loupe> → "Loupe")

  • <entity:\[entity_type\]> - Renders the translated name of an entity type (e.g., <entity:creeper> → "Creeper")

  • <effect:\[effect_type\]> - Renders the translated name of a potion effect (e.g., <effect:speed> → "Speed")

  • <enchant:\[enchant_name\]> - Renders the translated name of an enchantment (e.g., <enchant:sharpness> → "Sharpness")

  • <biome:\[biome_name\]> - Renders the translated name of a biome (e.g., <biome:plains> → "Plains")

For item, entity, effect, enchant, and biome tags:

  • If no namespace is provided (e.g., stone), it defaults to minecraft:stone

  • Full namespaced keys are supported (e.g., myplugin:custom_item)

  • For custom items without a minecraft translation, falls back to rebar-style key (e.g., rebar:custom)