🪁 Command handler

This library makes handling commands very easy.
It's simple to add aliases, required permissions or specifying the command for only one type.

🏷 Summary

Installation
Adding a basic command handler
Handling commands
Handling slash commands
Dependencies

📀 Installation

VERSION:

🐘 Gradle

maven {
    url 'https://m5rian.jfrog.io/artifactory/java'
}

maven {
   implementation group: 'com.github.m5rian', name: 'JdaCommandHandler', version: 'VERSION'
}

〽 Maven

<repository>
    <id>marian</id>
    <name>m5rian-java</name>
    <url>https://m5rian.jfrog.io/artifactory/java</url>
</repository>

<dependency>
    <groupId>com.github.m5rian</groupId>
    <artifactId>JdaCommandHandler</artifactId>
    <version>VERSION</version>
</dependency>

🏗️ Adding a basic command handler

This example shows how you can create a DefaultCommandService. This does not automatically register your commands.

// Your main class
public class Bot {
    // Create a new command service
    // You can make your own implementation or use the DefaultCommandService
    public static DefaultCommandService commandService = new DefaultCommandServiceBuilder()
            // Set a default prefix, which is used in dms
            .setDefaultPrefix("!")
            // Set a variable prefix which is used only in guilds
            // If you don't specify a variable prefix, the default prefix will be used instead
            .setVariablePrefix(guild -> Database.getGuild(guild).getPrefix())
            .build();

    public static void main(String[] args) {
        JDABuilder.createDefault(Config.get().getString("token"))
                // Register the CommandListener
                // Without it the bot won't respond on any commands
                .addEventListeners(new CommandListener(commandService))
                .build();
    }
}

Now let's create some commands. Always remember to implement the CommandHandler, if a class contains commands.

⛮ Handling commands

Before writing in the command class you need to register the class in the command service. To do so use the command register methods, like DefaultCommandServiceBuilder#registerCommandClass.
After that's done, we create a command. You can create as many command methods as you want, but make sure your methods have the CommandEvent annotation.

// A command class
public class Ping implements CommandHandler {

    @CommandEvent(
            name = "ping", // Set the main executor for the command
            aliases = {"latency"} // Add aliases
    )
    public void onHelpCommand(CommandContext ctx) {
        ctx.getChannel().sendMessage("Pong! Who cares about ping :)").queue(); // Send response
    }

}

The CommandEvent annotation provides much more features that aliases, which aren't covered here. Please check them out by your own.

⛮ Handling slash commands

Same for SlashCommands. To register one of them use the slash command specific register methods. Then do the following:

public class Ping implements CommandHandler {

    @SlashCommandEvent(
            name = "ping",
            description = "Check the latency"
    )
    public void onResourceFind(SlashCommandContext sctx) {
        sctx.reply("Pong! Who cares about ping :)").queue();
    }
}

m5rian/jda-command-handler