SimpleCommandGroup - Foundation

Overview

SimpleCommandGroup allows you to organize multiple related subcommands under a single main command. For example, /arena join, /arena leave, /arena list would all be subcommands of the /arena command group. The command group automatically handles help menus, tab completion, and subcommand routing.

Class hierarchy

org.mineacademy.fo.command.SimpleCommandGroup
  └── MainCommand (inner class extends SimpleCommand)

Creating a command group

Constructors

SimpleCommandGroup()

constructor

Creates a new command group using SimpleSettings.MAIN_COMMAND_ALIASES.Requires a settings class extending SimpleSettings with Command_Aliases defined.

SimpleCommandGroup(String labelAndAliases)

constructor

Creates a new command group with label and aliases separated by | or /.Example: "arena|a|ar" creates /arena with /a and /ar as aliases.

Show parameters

labelAndAliases

String

required

The main label and aliases separated by | or /

SimpleCommandGroup(String label, List<String> aliases)

constructor

Creates a new command group with explicit label and aliases.

Show parameters

label

String

required

The main command label

aliases

List<String>

required

List of command aliases

SimpleCommandGroup(StrictList<String> labelAndAliases)

constructor

Creates a new command group from a list where the first item is the label and the rest are aliases.

Show parameters

labelAndAliases

StrictList<String>

required

List containing label and aliases

Basic example

public class ArenaCommandGroup extends SimpleCommandGroup {
    
    public ArenaCommandGroup() {
        super("arena|a|ar");
    }
    
    @Override
    protected void registerSubcommands() {
        registerSubcommand(new ArenaJoinCommand());
        registerSubcommand(new ArenaLeaveCommand());
        registerSubcommand(new ArenaListCommand());
    }
}

Registration

register()

void

Registers this command group into Bukkit and starts using it.Automatically registers all subcommands added in registerSubcommands().

unregister()

void

Removes this command group from Bukkit.Takes immediate effect in the game.

isRegistered()

boolean

Checks if the command group has been registered.

Show returns

boolean

True if registered

ArenaCommandGroup arenaCmd = new ArenaCommandGroup();
arenaCmd.register();

// Later...
if (arenaCmd.isRegistered()) {
    arenaCmd.unregister();
}

Core methods

registerSubcommands()

abstract void

Required implementation. Override this method to register your subcommands.Call registerSubcommand() for each subcommand you want to add.

@Override
protected void registerSubcommands() {
    registerSubcommand(new CreateSubCommand());
    registerSubcommand(new DeleteSubCommand());
    registerSubcommand(new ListSubCommand());
    
    // Add help text
    registerHelpLine(
        "&6Arena Commands:",
        "&e  Manage your arena battles"
    );
}

Registering subcommands

registerSubcommand(SimpleSubCommand command)

void

Registers a new subcommand for this group.

Show parameters

command

SimpleSubCommand

required

The subcommand instance to register

registerSubcommand(Class<? extends SimpleSubCommand> parentClass)

void

Automatically registers all extending classes for the given parent class.Ignores abstract classes. Child classes must be final.

Show parameters

parentClass

Class<? extends SimpleSubCommand>

required

The parent subcommand class

@Override
protected void registerSubcommands() {
    // Auto-register all subcommands extending ArenaSubCommand
    registerSubcommand(ArenaSubCommand.class);
}

When using auto-registration, ensure all child classes are final to avoid accidental registration of intermediate classes.

registerHelpLine(String… menuHelp)

Registers simple help messages for this group.Displayed in the help menu along with subcommands.

Show parameters

Help message lines

registerHelpLine(
    "",
    "&6Plugin Information:",
    "&7Version: " + getDescription().getVersion(),
    "&7Author: YourName"
);

Customization methods

getNoParamsHeader()

List<SimpleComponent>

Returns the message displayed when no parameters are given.By default, displays plugin credits and author information.

Show returns

List<SimpleComponent>

The header components

@Override
protected List<SimpleComponent> getNoParamsHeader() {
    return Arrays.asList(
        SimpleComponent.of("&8" + Common.chatLineSmooth()),
        SimpleComponent.of("&6&lArena Plugin &7v1.0"),
        SimpleComponent.of("&7Type &f/arena help &7for commands"),
        SimpleComponent.of("&8" + Common.chatLineSmooth())
    );
}

sendHelpIfNoArgs()

boolean

Should we send command help instead of the no-params header when no arguments are provided?Default: false

Show returns

boolean

True to show help, false to show header

@Override
protected boolean sendHelpIfNoArgs() {
    return true; // Show help menu when just /arena is typed
}

getHelpLabel()

List<String>

Returns which subcommands should trigger the automatic help menu.Default: ["help", "?"]

Show returns

List<String>

The help trigger labels

@Override
protected List<String> getHelpLabel() {
    return Arrays.asList("help", "?", "commands");
}

getHelpHeader()

String[]

Returns the header messages for the help menu.Displayed at the top of /arena help or /arena ?.

Show returns

String[]

The help header lines

@Override
protected String[] getHelpHeader() {
    return new String[] {
        "&8&m------------------------------",
        "&6&lArena Commands",
        " ",
        "&2  [] &f= Optional",
        "&6  <> &f= Required",
        " "
    };
}

getSubcommandDescription()

String

Returns the format for subcommand descriptions in the help menu.Available placeholders: {label}, {sublabel}, {usage}, {description}, {dash}

Show returns

String

The description format

getCredits()

String

Returns credits text shown in the no-params header.Typically shows your website or support information.

Show returns

String

The credits text

@Override
protected String getCredits() {
    return "&7Visit &fwww.example.com &7for support";
}

getHeaderPrefix()

String

Returns the default color/style prefix used in headers.Default: GOLD + BOLD

Show returns

String

The header prefix (color codes)

getTheme()

ChatColor

Returns the theme color used in various places of the help menu.Default: ChatColor.GOLD

Show returns

ChatColor

org.bukkit.ChatColor

The theme color

@Override
protected ChatColor getTheme() {
    return ChatColor.AQUA;
}

getCommandsPerPage()

int

Returns how many commands to display per page in the help menu.Default: 12

Show returns

int

Commands per page

@Override
protected int getCommandsPerPage() {
    return 8; // Show fewer commands per page
}

Setters

setLabel(String label)

void

Updates the command label.Only works if the command is not registered yet.

Show parameters

label

String

required

The new label

setAliases(List<String> aliases)

void

Updates the command aliases.Only works if the command is not registered yet.

Show parameters

aliases

List<String>

required

The new aliases

Both setLabel() and setAliases() can only be used before registration. Attempting to use them on a registered command group will throw an error.

Getters

getLabel()

String

Gets the main command label.

Show returns

String

The command label

getAliases()

List<String>

Gets the command aliases.

Show returns

List<String>

The aliases list

getSender()

CommandSender

Gets the temporary sender currently viewing the command group.Mainly used in customization methods like getNoParamsHeader().

Show returns

CommandSender

org.bukkit.command.CommandSender

The current sender, or null

Complete example

public class ArenaCommandGroup extends SimpleCommandGroup {
    
    public ArenaCommandGroup() {
        super("arena|a");
    }
    
    @Override
    protected void registerSubcommands() {
        // Register individual subcommands
        registerSubcommand(new ArenaJoinCommand());
        registerSubcommand(new ArenaLeaveCommand());
        registerSubcommand(new ArenaListCommand());
        registerSubcommand(new ArenaCreateCommand());
        registerSubcommand(new ArenaDeleteCommand());
        
        // Add custom help text
        registerHelpLine(
            "",
            "&6Arena System:",
            "&7  Create and manage PvP arenas",
            "&7  Players can join, leave, and battle"
        );
    }
    
    @Override
    protected boolean sendHelpIfNoArgs() {
        return true; // Show help when /arena is typed
    }
    
    @Override
    protected ChatColor getTheme() {
        return ChatColor.RED; // Use red theme for arena commands
    }
    
    @Override
    protected String getCredits() {
        return "&7Arena plugin by &fYourName";
    }
    
    @Override
    protected String[] getHelpHeader() {
        return new String[] {
            "&8&m------------------------------",
            "&c&lArena Commands &7v1.0",
            " ",
            "&2  [] &f= Optional parameter",
            "&c  <> &f= Required parameter",
            " "
        };
    }
}

Automatic features

The command group automatically provides:

Help menu
Tab completion
Permission handling
Error handling

Automatically completes:

Subcommand names when typing /arena <tab>
Delegates to subcommand tab completion for further arguments
Only shows subcommands the player has permission for

Subcommands inherit the main command label
Default permission format: plugin.command.{label}.{sublabel}
Players only see subcommands they can use

Registration patterns

In your main plugin class

public class MyPlugin extends SimplePlugin {
    
    @Override
    protected void onPluginStart() {
        ArenaCommandGroup arenaCmd = new ArenaCommandGroup();
        arenaCmd.register();
    }
}

Using auto-register annotation

@AutoRegister
public class ArenaCommandGroup extends SimpleCommandGroup {
    // Constructor and methods...
}

The @AutoRegister annotation automatically registers your command group when the plugin starts, as long as it has a no-args constructor.

Plugin

Commands

Menus

Database

NBT

Models

Core Utilities

​Overview

​Class hierarchy

​Creating a command group

​Constructors

​Basic example

​Registration

​register()

​unregister()

​isRegistered()

​Core methods

​registerSubcommands()

​Registering subcommands

​registerSubcommand(SimpleSubCommand command)

​registerSubcommand(Class<? extends SimpleSubCommand> parentClass)

​registerHelpLine(String… menuHelp)

​Customization methods

​getNoParamsHeader()

​sendHelpIfNoArgs()

​getHelpLabel()

​getHelpHeader()

​getSubcommandDescription()

​getCredits()

​getHeaderPrefix()

​getTheme()

​getCommandsPerPage()

​Setters

​setLabel(String label)

​setAliases(List<String> aliases)

​Getters

​getLabel()

​getAliases()

​getSender()

​Complete example

​Automatic features

​Registration patterns

​In your main plugin class

​Using auto-register annotation

​See also

Build docs developers (and LLMs) love

Overview

Class hierarchy

Creating a command group

Constructors

Basic example

Registration

register()

unregister()

isRegistered()

Core methods

registerSubcommands()

Registering subcommands

registerSubcommand(SimpleSubCommand command)

registerSubcommand(Class<? extends SimpleSubCommand> parentClass)

registerHelpLine(String… menuHelp)

Customization methods

getNoParamsHeader()

sendHelpIfNoArgs()

getHelpLabel()

getHelpHeader()

getSubcommandDescription()

getCredits()

getHeaderPrefix()

getTheme()

getCommandsPerPage()

Setters

setLabel(String label)

setAliases(List<String> aliases)

Getters

getLabel()

getAliases()

getSender()

Complete example

Automatic features

Registration patterns

In your main plugin class

Using auto-register annotation

See also