README
¶
micromessage
A MiniMessage parser and renderer for Go, targeting Minekube's component
model (go.minekube.com/common/minecraft/component).
msg, err := micromessage.Deserialize("<gradient:aqua:blue>Welcome</gradient> <red><bold>friend</bold></red>!")
if err != nil {
return err
}
return player.SendMessage(msg)
Installation
go get github.com/Hoppou-Hangout/micromessage
Usage
package main
import (
"github.com/Hoppou-Hangout/micromessage"
)
func main() {
msg, err := micromessage.Deserialize("<red>Hello <bold>world</bold></red>!")
if err != nil {
panic(err)
}
// msg is a *component.Text from go.minekube.com/common/minecraft/component.
// Pass it directly to Gate:
// player.SendMessage(msg)
}
MustDeserialize is also available for static messages defined at init
time, where a parse error should just panic instead of being handled:
var welcomeMsg = micromessage.MustDeserialize("<gradient:gold:yellow>Welcome!</gradient>")
Supported tags
| Tag | Notes |
|---|---|
<red>, <blue>, etc. |
All 16 legacy named colors, plus <grey>/<dark_grey> British aliases |
<#rrggbb> |
Bare hex color |
<color:NAME>, <colour:NAME>, <c:NAME> |
Explicit color tag, name or hex |
<bold>, <b> |
and <italic>/<i>/<em>, <underlined>/<u>, <strikethrough>/<st>, <obfuscated>/<obf> |
<!bold> |
Negation shorthand, turns a decoration off |
<bold:false> |
Explicit boolean form, same effect as <!bold> |
<gradient> |
Defaults to white to black with no arguments |
<gradient:c1:c2:...:cN> |
Any number of color stops |
<gradient:c1:c2:phase> |
Trailing numeric argument shifts the gradient's starting point |
<rainbow>, <rainbow:phase>, <rainbow:!> |
Hue cycles across the wrapped text; ! reverses direction, phase is in tenths |
<transition:c1:c2:...:cN[:phase]> |
Same args as <gradient>, but (matching real MiniMessage) resolves to a single static color, not a per-character blend |
<shadow:NAME_OR_HEX:[alpha]>, <shadow:#RRGGBBAA>, <!shadow> |
Text shadow color; alpha (0-1) defaults to 0.25 |
<insert:VALUE> |
Shift-click insertion text |
<font:KEY>, <font:NAMESPACE:KEY> |
Sets the font resource key (default namespace minecraft) |
<click:ACTION:VALUE> |
run_command, suggest_command, open_url, open_file, suggest_command, change_page, copy_to_clipboard, show_dialog, custom |
<hover:show_text:VALUE> |
VALUE is itself parsed as MiniMessage, so it can carry its own colors/formatting |
<hover:show_item:ID[:COUNT[:NBT]]> |
ID needs quoting if namespaced, e.g. "minecraft:diamond"; bare ID defaults to the minecraft namespace |
<hover:show_entity:TYPE:UUID[:NAME]> |
Same TYPE quoting rule as show_item; NAME is parsed as MiniMessage |
<lang:KEY[:with...]> (tr, translate) |
Translatable component; each with argument is itself parsed as MiniMessage |
<lang_or:KEY:FALLBACK[:with...]> (tr_or, translate_or) |
Same as <lang>, with a client-side fallback string |
<reset> |
Clears all style for the remainder of the current scope; never closes |
<br>, <newline> |
Inserts a literal newline; never has children or a close tag |
Not implemented: <key> (keybind), <selector>, <score>, <nbt>/<data> — the underlying
go.minekube.com/common component model has no component types for these. <pride>, <sprite>,
<head> are also unimplemented (client-rendered visuals, not representable as plain text/color).
Testing
go test ./...
Documentation
¶
Overview ¶
Package micromessage is a MiniMessage (https://docs.advntr.dev/minimessage) parser and renderer for Gate/Minekube's component model (go.minekube.com/common/minecraft/component).
Example ¶
This mirrors how you'd use the library inside a Gate plugin:
msg, err := micromessage.Deserialize("<gradient:aqua:blue>Welcome</gradient> <red>%s</red>!")
if err != nil {
return err
}
return player.SendMessage(msg) // player is a go.minekube.com/gate proxy.Player
player.SendMessage takes a component.Component (msg component.Component, opts ...command.MessageOption), and *component.Text (what Deserialize returns) implements that interface directly, so no adapting is needed.
package main
import (
"fmt"
"github.com/Hoppou-Hangout/micromessage"
)
func main() {
msg, err := micromessage.Deserialize(`<gradient:aqua:blue>Welcome</gradient> <red><bold>friend</bold></red>!`)
if err != nil {
panic(err)
}
fmt.Println(len(msg.Children()) > 0)
}
Output: true
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Deserialize ¶
Deserialize parses a MiniMessage string into a *component.Text tree compatible with go.minekube.com/common and, by extension, Gate.
func MustDeserialize ¶ added in v0.3.1
MustDeserialize is similar to Deserialize but panics on error.
Types ¶
type Node ¶ added in v0.3.1
type Node struct {
Kind Kind
Text string // set when Kind == KindText
Name string // tag name, set when Kind == KindElement
Args []string
SelfClosed bool // true for <tag/>
Closed bool // true if an explicit </tag> was found; false = auto-closed
Children []*Node
}
Node is either a run of text or a tag, mirroring how MiniMessage really works: styling tags don't have "children" in a strict sense, they wrap whatever text/tags follow until an explicit close or the end of input.
Source Files