Chat Builder

EriChat — Fluent builder

EriChat is the entry point for building chat messages. Call EriChat.create() to start a new builder, chain any number of .text() segments with their styling, then deliver the result with .to(player) or .broadcast().

Simple colored message

// Simple colored message
EriChat.create()
    .text("[INFO] ").color(TextFormatting.GOLD).bold()
    .text("Welcome to the server!").color(TextFormatting.WHITE)
    .to(player);

Clickable links and commands

Each segment can carry a click action — either a chat command or a URL — and an optional hover tooltip shown when the player moves their cursor over the text.

// Clickable message
EriChat.create()
    .text("[Teleport] ").color(TextFormatting.GREEN)
        .command("/tp spawn").hover("Click to teleport")
    .text("[Website] ").color(TextFormatting.AQUA)
        .url("https://example.com").hover("Open website")
    .to(player);

Broadcasting to all players

// Broadcast to all online players
EriChat.create()
    .text("[Announcement] ").color(TextFormatting.RED).bold()
    .text("Server restarting in 5 minutes.").color(TextFormatting.YELLOW)
    .broadcast();

Method reference

ChatSegment — Internal segment

Every call to .text() on an EriChat builder internally creates a ChatSegment instance. A segment holds a single string together with all the style information applied after the .text() call: color, bold, italic, underline, strikethrough, obfuscated, click event, and hover event.

When .build() or a delivery method is invoked, each ChatSegment is converted to a TextComponentString with a corresponding Style object, then appended to a parent TextComponentString as a sibling.

Lifecycle of a segment

1. You call .text("some text") — a new ChatSegment is created and set as current.
2. You call style methods (.color(), .bold(), .command(), etc.) — they mutate the current segment.
3. You call .text() again — a new segment is created; the previous one is finalized.
4. You call .build() — each segment is converted to a TextComponentString with a Style and chained as siblings.

ChatPaginator — Pagination

ChatPaginator splits a list of lines into pages and sends them to a player with automatic << Prev and Next >> navigation buttons. Each navigation button generates a click command that re-runs your base command with the appropriate page number.

ChatPaginator paginator = ChatPaginator.create("/mycommand page")
    .title("Player List")
    .linesPerPage(8)
    .headerColor(TextFormatting.GOLD);

for (String name : playerNames) {
    paginator.add(name);
}

paginator.send(player, 1); // show page 1

In the example above, if there are 20 players, the paginator creates 3 pages of 8, 8, and 4 lines respectively. The Next >> button on page 1 sends the click command /mycommand page 2, and so on.

Navigation buttons

Navigation buttons are generated automatically by send():

• If there is a previous page: << Prev runs /mycommand page N-1
• If there is a next page: Next >> runs /mycommand page N+1
• Both buttons show a hover tooltip indicating the target page number.
• Buttons are omitted when there is only one page.

Method reference

Complete Example

The following example shows how to send a rich RPG-style level-up message to a player. It combines colors, bold, underline, a click command, and a hover tooltip in a single fluent chain.

// Rich RPG message
EriChat.create()
    .text("★ ").color(TextFormatting.GOLD)
    .text("You reached ").color(TextFormatting.WHITE)
    .text("Level 10").color(TextFormatting.GREEN).bold()
    .text("! ").color(TextFormatting.WHITE)
    .text("[Skills]").color(TextFormatting.AQUA).underline()
        .command("/skills").hover("View your skills")
    .to(player);

What the player sees in chat:

Paginator + Command integration

A common pattern is to register a command that accepts a page argument and delegates to ChatPaginator:

public class CommandPlayerList extends CommandBase {

    @Override public String getName() { return "players"; }
    @Override public String getUsage(ICommandSender s) { return "/players [page]"; }

    @Override
    public void execute(MinecraftServer server, ICommandSender sender, String[] args) {
        EntityPlayerMP player = (EntityPlayerMP) sender;

        int page = args.length > 1 ? Integer.parseInt(args[1]) : 1;

        List<String> names = new ArrayList<>();
        for (EntityPlayerMP p : server.getPlayerList().getPlayers()) {
            names.add(p.getName());
        }

        ChatPaginator paginator = ChatPaginator.create("/players page")
            .title("Online Players")
            .linesPerPage(8)
            .headerColor(TextFormatting.GOLD)
            .lineColor(TextFormatting.WHITE)
            .navColor(TextFormatting.YELLOW)
            .addAll(names);

        paginator.send(player, page);
    }
}