# ```commander``` [![](https://jitpack.io/v/QuadraBoy/commander.svg)](https://jitpack.io/#QuadraBoy/commander) **commander** (formerly ModernityAPI) is an easy-to-use, annotation-based, Minecraft Command API for Paper plugin developers! # Features - Easy-to-use: commander is designed to be easy-to-use for developers. - Command Utilities: commander provides the developers a wide-range of utilities such as the **ArgumentHandler** and much more. - No plugin.yml Command Registration: No need to register the command in the ```plugin.yml``` because commander does it for you! - Null Safety: commander is designed to be null-safe. ## Project Status As of now, commander is still in **BETA** due to being an early project and still needs some improving. Feel free to report a bug or issue at the [issues](https://github.com/QuadraBoy/commander/issues) section! It helps commander grow :) # Why commander? Let's say we make a command for players only with one argument that says hello to the player using the normal way: ```java public class TestCommand implements TabExecutor { @Override public boolean onCommand(@NotNull CommandSender commandSender, @NotNull Command command, @NotNull String s, @NotNull String[] strings) { if(commandSender instanceof Player) { if(strings != null) { if(strings.length == 1) { if(strings[0].equalsIgnoreCase("hello")) { commandSender.sendMessage(MiniMessage.miniMessage().deserialize("Hello World!")); return true; } } } } return false; } @Override public @Nullable List onTabComplete(@NotNull CommandSender commandSender, @NotNull Command command, @NotNull String s, @NotNull String[] strings) { return (strings != null && strings.length == 1) ? Collections.singletonList("hello") : Collections.emptyList(); } } ``` Then, we need to register it in the **JavaPlugin** class and **plugin.yml**. ```java public final class PluginExample extends JavaPlugin { @Override public void onEnable() { getCommand("test").setExecutor(new TestCommand()); } } ``` ```yaml name: PluginExample version: '${project.version}' main: me.quadraboy.pluginexample.PluginExample api-version: '1.20' commands: test: description: Test Command usage: "Usage: /test " permission: plugin.command.test aliases: - foo - bar ``` Now here's the problem, doing what all of I mentioned can sometimes be a hassle. With commander, you can just do this: ```java @Command(name = "test", target = Command.InitiatorType.PLAYER, usage = "Usage: /test ", description = "Test command", permission = "plugin.command.test", aliases = {"foo", "bar"}) public class TestCommand { @Executor(preventEmptyArgument = true) public Command.Status onTest(final CommandSender sender, final Structure structure) { structure.argument().create("hello", 0, () -> sender.sendMessage(MiniMessage.miniMessage().deserialize("Hello World!"))); return Command.Status.SUCCESS; } @Suggester public void onSuggest(final CommandSender sender, Suggestion suggestion) { suggestion.create(0, "hello"); } } ``` With commander, the code becomes much cleaner and more manageable. That's not all, commander can convert those arguments into numerous data types (e.g., Player, Integer, Double, Material, Entity, etc.) # Using commander in your projects You can add commander as your project's dependency. Copy and paste the following that corresponds to your build system. ## Maven ### Repository ```xml jitpack.io https://jitpack.io ``` ### Dependency ```xml com.github.QuadraBoy commander BETA-0.4 ``` ## Gradle (Groovy) ### Repository ```groovy repositories { maven { url 'https://jitpack.io' } } ``` ### Dependency ```groovy dependencies { implementation 'com.github.QuadraBoy:commander:BETA-0.4' } ``` ## Gradle (Kotlin) ### Repository ```kts repositories { maven("https://jitpack.io") } ``` ### Dependency ```kts dependencies { implementation("com.github.QuadraBoy:commander:BETA-0.4") } ``` # Documentation You can check the in-progress documentation in the [wiki](https://github.com/QuadraBoy/commander/wiki).

QuadraBoy

QuadraBoy's Plugins

commander by QuadraBoy

QuadraBoy's Organizations

Stars

Watching

commander by