minestom-adventure-text

Minestom Adventure text

Minestom uses Kyori Adventure for all user-facing text. There are no legacy § color codes — build Components instead. Adventure is bundled with Minestom (no extra dependency) except MiniMessage, which is separate.

Anything that can receive text/titles/sounds is an Audience: Player, Instance, CommandSender, Scoreboard, Team, and the global Audiences helpers.

Components

import net.kyori.adventure.text.Component;
import net.kyori.adventure.text.format.NamedTextColor;
import net.kyori.adventure.text.format.TextColor;
import net.kyori.adventure.text.format.TextDecoration;

Component msg = Component.text("Hello", NamedTextColor.GREEN)
    .append(Component.text(" world").color(TextColor.color(0xFF8800)))
    .decorate(TextDecoration.BOLD);

player.sendMessage(msg);
instance.sendMessage(Component.text("broadcast"));        // whole instance

Component.text(...) is immutable — every method returns a new copy. Build with .append(...), .color(...), .decoration(deco, false) to turn one off (e.g. kill the default italic on item names).

Broadcasting — Audiences

import net.minestom.server.adventure.audience.Audiences;

Audiences.players().sendMessage(Component.text("to everyone"));
Audiences.console().sendMessage(Component.text("to server log"));
Audiences.players(p -> p.getInstance() == lobby).sendMessage(...); // filtered

For a custom group, PacketGroupingAudience.of(collection) sends one packet to many viewers.

Click & hover

import net.kyori.adventure.text.event.ClickEvent;
import net.kyori.adventure.text.event.HoverEvent;

Component button = Component.text("[Teleport]", NamedTextColor.AQUA)
    .clickEvent(ClickEvent.runCommand("/spawn"))
    .hoverEvent(HoverEvent.showText(Component.text("Go to spawn")));

Click actions: runCommand, suggestCommand, openUrl, copyToClipboard, changePage. Hover: showText, showItem, showEntity.

Titles, action bar, boss bar

import net.kyori.adventure.title.Title;
import net.kyori.adventure.bossbar.BossBar;
import java.time.Duration;

player.showTitle(Title.title(
    Component.text("Welcome"),
    Component.text("subtitle"),
    Title.Times.times(Duration.ofMillis(500), Duration.ofSeconds(3), Duration.ofMillis(500))));

player.sendActionBar(Component.text("action bar text"));

BossBar bar = BossBar.bossBar(Component.text("Boss"), 1.0f,
    BossBar.Color.RED, BossBar.Overlay.PROGRESS);
player.showBossBar(bar);
bar.progress(0.5f);              // updates live for all viewers
player.hideBossBar(bar);

Sounds

import net.kyori.adventure.sound.Sound;
import net.kyori.adventure.key.Key;

player.playSound(Sound.sound(Key.key("entity.experience_orb.pickup"),
    Sound.Source.PLAYER, 1.0f, 1.0f));
// or emit at a position:
player.playSound(sound, x, y, z);

Minestom also exposes SoundEvent constants usable as the key.

Books

import net.kyori.adventure.inventory.Book;

player.openBook(Book.book(
    Component.text("Title"), Component.text("Author"),
    Component.text("Page 1"), Component.text("Page 2")));

MiniMessage (optional dependency)

Add net.kyori:adventure-text-minimessage to parse tag-style strings:

implementation("net.kyori:adventure-text-minimessage:4.17.0") // match Adventure ver

import net.kyori.adventure.text.minimessage.MiniMessage;

Component c = MiniMessage.miniMessage()
    .deserialize("<red>Hello <bold>world</bold> <gradient:#5e4fa2:#f79459>!</gradient>");

Great for config-driven / user-authored text. For hard-coded strings the builder API is fine.

Notes & gotchas

• Item/entity display names default to italic — disable with .decoration(TextDecoration.ITALIC, false).
• Server-side translation: set MinestomAdventure.AUTOMATIC_COMPONENT_TRANSLATION = true and use Component.translatable(key) to render per player locale.
• Keep the Adventure version of MiniMessage matched to the one Minestom bundles or you get linkage errors.

Sources: https://minestom.net/docs/feature/adventure, https://docs.advntr.dev