Creating your first Minecraft command

There are two ways to create a command: by methods annotated with a Command or by registering a CommandInfo with a CommandExecutor using CommandFrame#registerCommand(CommandInfo, CommandExecutor).

Subcommands

Subcommands are defined with dots between the command name, e.g: @Command(name = "parent.child"). They inherit both target and permissions from their parents, if a parent requires the sender to be a player or have a specific permission, the subcommand will require it too.

Via the Command annotation

Methods annotated with @Command will be automatically registered. Parameters defined in the method will be used as arguments and are automatically converted into the parameter type, they are order dependent. Parameters are required by default, use the Optional annotation to make it not required, you can set default values too.

You can create multiple commands per class.

Creating a simple command

public class Command {

    @Command(name = "command", aliases = {"nice"}, target = CommandTarget.CONSOLE)
    public void handleCommand(Context<ConsoleCommandSender> context, 
                                Player target, 
                                @Optional(def = {"Hello,", "World!"}) String[] message) {
    
        target.sendMessage("Console sent you: %s", String.join(" ", message));
    }
    
    @Command(name = "command.child")
    public void handleCommandChild(Context<ConsoleCommandSender> context) {
        // ...
    }

}

The command above can only be ran by the console (target = CommandTarget.CONSOLE), the message parameter is optional (@Optional(def = {"Hello,", "World!"}) String[] message), so you can run it with: /command SaiintBrisson or /command SaiintBrisson hey friend, how are you?. Optionals without a default value will be null.

Registering your command class

BukkitFrame frame = new BukkitFrame(plugin);

frame.registerCommands(new Command());

Via CommandFrame#registerCommand method

This approach does not support arguments, you can still use them via Context however.

CommandInfo has the same fields as Command and CommandExecutor is a functional interface that receives Context<CommandSender>.

Creating a simple command

BukkitFrame frame = new BukkitFrame(plugin);

frame.registerCommand(CommandInfo.builder()
  .name("command")
  .aliases(new String[]{
    "nice"
  })
  .build(), context -> {
    context.sendMessage("Hey!");
    return false;
});