minestom-commands

Minestom commands

A command is a class extending Command. You declare syntaxes (argument patterns); Minestom parses input, picks the matching syntax, and provides client-side autocomplete from the brigadier tree.

Basic command

package com.example.commands;

import net.minestom.server.command.builder.Command;
import net.minestom.server.command.builder.arguments.ArgumentType;

public class GiveCommand extends Command {
    public GiveCommand() {
        super("give", "g"); // name + aliases

        // fallback when no syntax matches
        setDefaultExecutor((sender, context) ->
            sender.sendMessage("Usage: /give <amount>"));

        var amount = ArgumentType.Integer("amount");

        addSyntax((sender, context) -> {
            int n = context.get(amount);
            sender.sendMessage("Giving " + n);
        }, amount);
    }
}

Register once at startup:

MinecraftServer.getCommandManager().register(new GiveCommand());

Arguments

ArgumentType factory methods, e.g. Integer, Float, Boolean, String, StringArray (greedy rest), Word, Enum, Entity, ItemStack, BlockState, RelativeVec3 / Position. Read with context.get(arg).

var target = ArgumentType.Entity("target").onlyPlayers(true);
var pos = ArgumentType.RelativeVec3("pos");
addSyntax((sender, context) -> { /* ... */ }, target, pos);

Multiple addSyntax calls = overloads; longest/most-specific match wins.

Sender type

sender is a CommandSender — could be a Player or the ConsoleSender. Guard before player-only logic:

addSyntax((sender, context) -> {
    if (!(sender instanceof Player player)) {
        sender.sendMessage("Players only.");
        return;
    }
    // use player
}, /* args */);

Conditions & permissions

setCondition((sender, commandString) ->
    sender instanceof Player p && p.getPermissionLevel() >= 2);

Per-syntax condition is the 1st arg of an addConditionalSyntax(...). Minestom has no built-in permission plugin — you define what permissions mean.

Suggestions (tab-complete)

var name = ArgumentType.Word("name").setSuggestionCallback((sender, context, suggestion) -> {
    suggestion.addEntry(new SuggestionEntry("alice"));
    suggestion.addEntry(new SuggestionEntry("bob"));
});

Sources: https://minestom.net/docs/feature/commands