New link: https://github.com/kh498/BukkitCommandAPI
.
.
.
.
.
.
.
.
.
.
This is a CommandAPI that is developed to avoid having to statically register any command whether using reflection and a CommandExecutor, or simply putting the commands into my plugin.yml. This is a purely annotation based API.
- Easy registation and managment of commands
- Advanced automated helpscreen (see pictures below)
- Automated tab completer (for now only first argument, to be improved)
- Support to use flags
- Maven support
- See attribute values explained for more
<repository>
<id>CommandAPI</id>
<url>https://raw.github.com/kh498/CommandAPI/mvn-repo/</url>
<snapshots>
<enabled>true</enabled>
<updatePolicy>always</updatePolicy>
</snapshots>
</repository>
<dependency>
<groupId>com.not2excel.api</groupId>
<artifactId>CommandAPI</artifactId>
<version>3.1.0</version>
</dependency>
To use CommandAPI you also need to shade it into your project to do so add the following to your pom.xml
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId>
<version>3.0.0</version>
<executions>
<execution>
<id>shade</id>
<phase>package</phase>
<goals>
<goal>shade</goal>
</goals>
</execution>
</executions>
<configuration>
<minimizeJar>true</minimizeJar> <!-- Only include packages that you are using Note: Requires Java 1.5 or higher. -->
<artifactSet>
<includes>
<include>com.not2excel.api:CommandAPI</include>
</includes>
</artifactSet>
</configuration>
</plugin>
</plugins>
</build>
Using this CommandAPI is super simple, and requires minimum 3 lines to register the commands, and obviously the commands themselves.
First in either your onEnable() or onLoad() you're going to want to do this:
final CommandManager commandManager = new CommandManager(plugin); //where plugin is a plugin instance
// Automatically finds all classes that implements the CommandListener.class and registers their commands
commandManager.registerCommands();
//registers a generated help topic to bukkit
commandManager.registerHelp();
//so the /help PluginName displays our plugin's registered commandscommand: (String) This is the name of the command. eg command /test will have command = "test"
aliases: (String[], default: {}) A list of aliases for this command
permission: (String, default: "") The permission a players need to execute the command
noPermission: (String, default: "You don't have permission to do that.") The string displayed when the player doesn't have the permission for this command
usage: (String, default: "") The arbitrary arguments of the command
description: (String, default: "") A description of what the command does
min: (int, default: 0) The minimum number of arguments this command can have
max: (int, default: -1) The maximum number og arguments this command can have
playerOnly: (boolean, default: false) If only players can excecute this command
flags: (String, default: "") The flags of this command (see flags example below)
strictArgs: (boolean, default: false) If only known subcommand are allowed as arguments (see first example below)
flagDesc: (String[], default: {}) The description of what each flag does (see flags example below)
Example commands to be registered: Here are some test commands to display how commands should be written to allow registration. CommandListener is a required interface for any class you wish commands to be registered from. This is to allow shrinkage of classes searched for commands, and increase registration time. A real example can be found here
import com.not2excel.api.command.CommandHandler;
import com.not2excel.api.command.CommandListener;
import com.not2excel.api.command.objects.CommandInfo;
public class TestCommand implements CommandListener //CommandListener is required
{
/*
* command is the only required field for the annotation
*
* The base command is required (bug in 2.0). If you want the base command to display the
* help screen when called without any arguments add the attribute values "strictArgs = true" and "max = 0"
*
* Do NOT register the command in plugin.yml as it is all handled by this API!
*/
@CommandHandler(command = "test")
public static void testingCommand(final CommandInfo info) {
info.getSender().sendMessage("Test worked");
}
/*
* A dot in the command string marks this as a sub command. It can go infinitely deep.
* Do not have the command and/or subcommand in the usage, that is built in.
*/
@CommandHandler(command = "test.test2",
permission = "test.test2",
noPermission = "No access!",
aliases = {"2", "testing"},
usage = "<player>",
flags = "f",
flagDesc = "Activate some feature",
description = "Testing out (almost) all of the CommandHandler's attribute values")
public static void testingCommand2(final CommandInfo info) {
info.getSender().sendMessage("Test2 worked");
}
/*
* A flag is a single character such as {@code -f} that will alter the behaviour of the command. flags can only
* be any english character (a-z and A-Z) including * as a catch all.
*
* Defines if there can be arbitrary variables. If set to true the command cannot have any unknown variables.
* The arguments will either be a subcommand or a flag, if not an error is thrown. This means that flags are
* ignored and can be used.
*
* It is suggested that this is set to true if you only want flags as arguments.
*/
@CommandHandler(command = "test.reset",
flags = "kr",
flagDesc = {"-k resets kingdoms", "-r resets reficules"},
strictArgs = true,
// only allow flags as arguments
description = "resets stuff!")
@CommandHandler(command = COMMAND + ".reset",
flags = {@Flag(flag = 'k', usage = "-k resets kingdoms"),
@Flag(flag = 'r', usage = "-r resets reficules")},
strictArgs = true,
description = "resets stuff!")
public static void testingCommand3(final CommandInfo info) {
//user gave the argument -f or -*
if (info.hasFlag('k')) {
// Do some resetting
}
//returns true if one of the chars in the input string matches one of the flags the user gave
if (info.hasOneOfFlags("kr")) {
// reload or something
}
}
}Here are some pictures on how the automated help screen looks.
Finally: Please leave any comments, suggestions, and/or bugs you may find while using this CommandAPI.