Text components

A Component is a tree of styled nodes. Each node has its own color, decorations, font, hover event, and click event, and children inherit the style of their parent.

Component message = Component.text("Hello, ", NamedTextColor.GRAY)
        .append(Component.text(player.getUsername(), NamedTextColor.GOLD))
        .hoverEvent(HoverEvent.showText(Component.text("Click to greet back")))
        .clickEvent(ClickEvent.runCommand("/greet"));

player.sendMessage(message);

Component construction is documented in the Adventure text guide. Conversion to and from other formats is covered in Component serialization.

Colors

The color of text is a TextColor. NamedTextColor holds the sixteen standard vanilla colors, and TextColor.color builds any other:

Component.text("Warning", NamedTextColor.RED);
Component.text("Warning", TextColor.color(0xFF8800));

TextColor.color also accepts separate channels, an HSVLike, or any RGBLike.

Colors that are not text

Color is Minestom's own RGB class, for the places the protocol carries a color that is not text: dyed leather, map colors, firework stars.

ItemStack armor = ItemStack.builder(Material.LEATHER_CHESTPLATE)
        .set(DataComponents.DYED_COLOR, new Color(0, 128, 255))
        .build();

mixWith mixes it with other colors the way vanilla mixes dyes:

Color purple = new Color(255, 0, 0).mixWith(new Color(0, 0, 255));

Color implements RGBLike rather than TextColor, so styling text with one means converting it first, with TextColor.color(color).

AlphaColor extends Color with an alpha channel and implements ARGBLike, the type ShadowColor.shadowColor takes.

DyeColor is the enum of the sixteen vanilla dyes. Vanilla uses a different color per dye depending on context, and each value exposes all of them:

DyeColor.LIME.color();          // the dye's own color
DyeColor.LIME.textColor();      // the color used when rendering text, e.g. on signs
DyeColor.LIME.fireworkColor();  // the color of a firework star made with this dye
DyeColor.LIME.mapColorId();     // the map palette index

Click callbacks

ClickEvent.callback runs server-side code when a player clicks a component, without registering a command for it. Minestom implements this with ClickCallbackManager:

Component component = Component.text("Click me")
        .clickEvent(ClickEvent.callback(audience -> {
            audience.sendMessage(Component.text("Clicked!"));
        }, ClickCallback.Options.builder()
                .uses(1)
                .lifetime(Duration.ofMinutes(5))
                .build()));

WARNING

Always set uses. A callback with unlimited uses and a finite lifetime is registered in neither the permanent nor the temporary map, so the component is still sent and clicking it does nothing, with no error. Unlimited uses only works when the lifetime is effectively infinite, and such callbacks are stored permanently and never released.