Commands Quick Start

Prerequisites

• The plugin declares a runtime dependency on BetterPlugin (depend in plugin.yml)
• Call it in onEnable(); this is the current plugin instance (either JavaPlugin or PluginBase works)
• Call register() before LifecycleEvents.COMMANDS fires — that means during onEnable()

Required Imports for the Examples

import org.bukkit.plugin.java.JavaPlugin;
import org.coffeepop.betterPlugin.api.command.CommandBuilder;
import io.papermc.paper.command.brigadier.Commands; // Required for the subcommand example
import java.time.Duration;                          // Required for the cooldown example
import java.util.List;                              // Required for the completion example

Minimal Command

CommandBuilder.create(this)
        .name("ping")
        .executes((sender, command, label, args) -> {
            sender.sendPlainMessage("pong");
            return true;
        })
        .register();

Common Configuration

CommandBuilder.create(this)
        .name("greet")
        .permission("myplugin.greet")
        .aliases("hello")
        .description("Greets the sender")
        .executes((sender, command, label, args) -> {
            sender.sendPlainMessage("Hello, " + sender.getName() + "!");
            return true;
        })
        .register();

.usage() and .permissionMessage() are only metadata on the callback parameter command for now; they don't affect the command registration result. See API Reference for details.

Completion, Restrictions, and Cooldown

CommandBuilder.create(this)
        .name("feed")
        .playerOnly()
        .cooldown(Duration.ofSeconds(30))
        .executes((sender, command, label, args) -> {
            sender.sendPlainMessage("You are full");
            return true;
        })
        .register();

CommandBuilder.create(this)
        .name("give")
        .executes((sender, command, label, args) -> true)
        .tabCompleter((sender, command, alias, args) ->
                args.length == 1 ? List.of("diamond", "iron", "gold") : List.of())
        .register();

Subcommands

Subcommands must keep the parent command's executor, otherwise register() throws CommandException because validation fails:

CommandBuilder.create(this)
        .name("admin")
        .permission("myplugin.admin")
        .executes((sender, command, label, args) -> {
            sender.sendPlainMessage("Usage: /admin <reload|status>");
            return true;
        })
        .then(Commands.literal("reload")
                .executes(ctx -> {
                    ctx.getSource().getSender().sendPlainMessage("reloaded!");
                    return 1;
                }))
        .register();

Note: after you add .then(...) child nodes, .tabCompleter(...) is ignored. The parent command's .cooldown(...) also applies only to the parent execution path; child nodes are not affected.

For more options, see API Reference; for complete examples, see Examples.