⚡ Command Framework

A modern, flexible command framework for Bukkit/Spigot and especially Paper Minecraft servers.
Easily create, register, and manage commands at runtime—even on Paper, where this is usually difficult.

---

✨ Features

---

• 🔄 Dynamic Command Registration: Register/unregister commands at runtime, even on Paper.
• 🌳 Sub-Commands: Build command hierarchies with permissions and aliases.
• ✨ Tab Completion: Context-aware suggestions with TabBuilder.
• 🔐 Permissions: Wildcard and custom permission checks.
• 🧑‍💻 Fluent API: Quickly build commands with CommandBuilder.

🛠️ Quick Example

Create and register a simple command with a sub-command:
In your plugin’s main class (extending JavaPlugin), register the command:

package com.example.myplugin;

import me.croabeast.command.BukkitCommand;
import me.croabeast.command.SubCommand;
import org.bukkit.plugin.java.JavaPlugin;

public class MyPlugin extends JavaPlugin {

    @Override
    public void onEnable() {
        // Create an instance of GreetCommand and register it
        GreetCommand greetCommand = new GreetCommand(this);
        greetCommand.register();

        // To unregister the command later, call:
        // greetCommand.unregister();
    }

    // Define the GreetCommand class
    // It can be anywhere in your project
    static class GreetCommand extends BukkitCommand {

        GreetCommand(JavaPlugin plugin) {
            super(plugin, "greet");
            setDescription("Greet command");
            setPermission("my-plugin.greet");

            SubCommand sub = new SubCommand(plugin, "hello");
            sub.setPermission("my-plugin.greet.hello");
            sub.setPredicate((sender, args) -> {
                sender.sendMessage("Hello, " + sender.getName() + "!");
                return true;
            });
            addSubCommand(sub);
        }
    }
}

---

⚙️ Installation

Maven:

<repositories>
    <repository>
        <id>croabeast-repo</id>
        <url>https://croabeast.github.io/repo/</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>me.croabeast</groupId>
        <artifactId>CommandFramework</artifactId>
        <version>${version}</version>
        <scope>compile</scope>
    </dependency>
</dependencies>

Gradle:

repositories {
    maven {
        url "https://croabeast.github.io/repo/"
    }
}

dependencies {
    implementation "me.croabeast:CommandFramework:${version}"
}

Replace ${version} with the latest version.

---

❓ Why Use This?

• Works reliably on Paper forks where other frameworks fail.
• Makes complex command trees and tab completions easy.
• Handles permissions and registration for you.

---

🚀 Get Started

1. Add the dependency.
2. Extend BukkitCommand or create your own command class.
3. Register your command in your plugin's onEnable().

---

🎉 Happy Coding!

Build powerful, modern commands for your Minecraft plugin with ease!
Questions? Join our Discord 💬

— CroaBeast