[LIB] Annotation based command system

I created a very lightweight annotation based command system that works similar to Bukkit's events system. It removes the necessity to add the command to your plugin.yml but will still allow you to set descriptions and usages through code.

UPDATE:

• Added inGameOnly option to command
• Made commands automatically set executor
• Added length() and getArgs(int index) to CommandArgs
• Changed package declaration to com.minnymin.command

Code on Github https://github.com/minnymin3/CommandFramework

Single class Gist https://gist.github.com/minnymin3/8114618

Example:

Code:java

 
public class DemoPlugin extends JavaPlugin {
 
/** * Your plugin's command framework object. */
CommandFramework framework;
 
public void onEnable() {
/**Initializes a new CommandFramework object**/
framework = new CommandFramework(this);
 
/** This will register all commands inside of this class. It works much the same as the registerEvents() method. Note: Commands do not need to be registered in plugin.yml! */
framework.registerCommands(this);
}
 
@Command(name = "test", aliases = { "testing" }, description = "This is a test command", usage = "This is how you use it")
public void test(CommandArgs args) {
args.getSender().sendMessage("This is a test command");
}
}
 

This example will create a command called test and register it. It will set the description and usage of the command as well. Notice the aliases option. Aliases will be registered the same way as the regular command and are alternate commands that the method will be invoked with. Here is an example of a sub command:

Code:java

 
@Command(name = "test.sub", aliases = { "test.subcommand"})
public void testSub(CommandArgs args) {
args.getSender().sendMessage("This is a test subcommand");
}
 

This will create a sub command of test and will be executed when someone sends the command '/test sub' or '/test subcommand'. Descriptions and usages also work with these.

Commands may also have permissions set. The command handler will check if the player has permission and if they do not then it will send a message that can also be defined with the annotation. The default no permission message is "You do not have permission to perform that action"

Code:java

 
@Command(name = "test.sub", aliases = { "test.subcommand"}, permission = "testplugin.subcommand", noPerm = "This is a modified no perm message.")
public void testSub(CommandArgs args) {
args.getSender().sendMessage("This is a test subcommand");
}
 

You can also create tab completers with an annotation! Same naming conventions apply as the command annotation.

Code:java

 
@Completer(name = "test", aliases = { "testing" })
public List<String> testCompleter(CommandArgs args) {
List<String> list = new ArrayList<String>();
list.add("Hello");
return list;
}
 

 

Minnymin3
Might use this sometime. The problem is if you happen to handle multiple commands in a single class, then you're stuck with a bunch of commands with the same permission

 

I don't follow... The permissions are set per annotation so '/test subcommand' could easily have a different permission than '/test' or '/testing'.

 

Minnymin3
You are a boss. I will totally use this sometime.

 

Added a TabCompleter annotation! TabCompleters are registered the same way as the regular commands. They must return a List<String> and must also have a single CommandArgs argument.

Also added a registration for help to be executed after all commands are registered. Add framework.registerHelp() to make your commands appear in your plugin's help ('/help (pluginname)') when commands are not registered in plugin.yml

EDIT by Moderator: merged posts, please use the edit button instead of double posting.

 

Minnymin3 This is a very good idea! Will be using this in the future. Do I need all the classes for this work or are they optional features?

 

Wow beautiful I know what I'm going to use! are we allowed to embed it?

 

Ad237
You do in-fact need all the classes
2016mfransen
Go right ahead (though if its open source the info on the source files should be left)

 

Minnymin3 Thanks. Got it working!

 

how does this handle sub commands? like if i have a command "test" and then the sub "test.sub" if i call the test sub will it also call the test command or will it only call test.sub?

 

It will call test.sub only if you execute command /test with no arguments or unhandled arguments will it call test

 

ok, awesome! definitely going to use this

another question, if there is no command test.sub2 but someone does /test sub2 will it go to the test command or do nothing?

EDIT by Moderator: merged posts, please use the edit button instead of double posting.

 

If there is no test.sub2 then it will go to test but if you do test.sub.sub2 and there is test.sub it will go to test.sub

 

This library is awesome! I've put it together into one class, if you dislike having multiple classes for things like this, like me.

https://gist.github.com/bobacadodl/7743813

 

bobacadodl
Awesome!

 

bobacadodl How exactly would I go about using that minimalised version of minnymin's Library?

Preferably a detailed documentation like what minnymin did :L

 

You throw the class into your project somewhere and then you do the same as how I explained and then press control + shift + o to import the correct imports.

 

Minnymin3 Theres CommandFramework in your example. What's that in boba's example?

 

Oh he called it quickcommand

 

Minnymin3 Oh I see, thanks!

Minnymin3 One more question, how do I instantiate QuickCommand? I don't think I'm supposed to be changing it to a static class.

#Edit: Actually, I fixed it. Thanks anyways.

EDIT by Moderator: merged posts, please use the edit button instead of double posting.

 

xigsag bobacadodl
Noticed that the access modifiers of your class are a bit messed up Bobacadodl. Use this one instead https://gist.github.com/minnymin3/8114618

It can be used the exact same as the tutorial says you need to use CommandFramework instead of QuickCommand

 

Wow man, best util ive seen till now on Bukkit forums, edited it a bit to fit my needs in a plugin i hope to be releasing soon. Regards, DevRo!

 

I got a NullPointerException when running it though, at line 43 of CommandFramework.

 

Are you initializing the command framework in your onEnable? If not then that is probably the issue.

 

Do I initialize it via CommandFramework framework = null; then framework = new CommandFramework(this)?

Ack, I knew I should've done that.

 

Wow, this is great

One problem though, I've been trying to get commands working in external classes, but it isn't working :/ Is there any chance you could create a quick guide on how to do so?

 

mba2012
Register commands.

 

Problem is, it isn't working. I think the issue isn't with command registering though.

I'm getting a NPE error when the constructor for the CommandFramework class is called.

 

mba2012
Are you sure you did not pass a null referant to the CommandFramework?

 

Fairly sure.

I've found exactly where it's giving an NPE.

Code:java

if (plugin.getServer().getPluginManager() instanceof SimplePluginManager) {

I've passed in what I believe to be a valid plugin value, because it works for events etc.