Commands Framework

👾 No more difficult commands ️👾

Introduction

Have you ever face difficulty of creating even simple spigot command working well? Are you a begginer and you got lost creating a command with more then one argument?

The library offers easy and elegant approach of creating commands.

documentation

<dependency>
    <groupId>io.github.jwdeveloper.spigot.commands</groupId>
    <artifactId>commands-framework-core</artifactId>
    <version>1.0.8</version>
    <scope>compile</scope>
</dependency>

Paterns

 /hello <name:Text> <count:Number> <job:Text[Miner, Fisherman, Farmer]>

public final class Example extends JavaPlugin {

    @Override
    public void onEnable() {
        CommandsApi commandsApi = CommandsFramework.enable(this);

           commands.create("/hello <name:Text> <age:number> <job:Text[Miner, Fisherman, Farmer]>")
                .onPlayerExecute(event ->
                {
                    event.sender().sendMessage("You called the hello command");

                    var name = event.getString("name");
                    var age = event.getNumber("age");
                    var job = event.getString("job");

                    event.sender().sendMessage("Name: " + name + " Age: " + age + " Job: " + job);
                }).register();
    }
}

Templates

Is the most streight-forward way of creating command! Just add annotation @FCommand above a method and that's it!

public final class MyHelloCommand
{
    @FCommand(pattern = "/hello <name:Text> <age:Number> <job:[Miner,Fisherman,Farmer]")
    public void helloCommand(CommandSender sender, String name, int age, String job)
    {
        event.sender().sendMessage("Name: " + name + " Age: " + age + " Job: " + job);
    }
}

public final class ExamplePlugin extends JavaPlugin {

    @Override
    public void onEnable() {
        
        MyHelloCommand helloCommand = new MyHelloCommand();
        
        Commands commands = CommandsFramework.enable(this);
        commands.create(helloCommand).register();
    }
}

Builder

Great choice for the advanced command customization. You can have access to all command properties

public final class ExamplePlugin extends JavaPlugin {

    @Override
    public void onEnable() {
        Commands commands = CommandsFramework.enable(this);
        commands.create("hello")
                .addTextArgument("name")
                .addNumberArgument("age")
                .addArgument("job", argumentBuilder ->
                {
                    argumentBuilder.withSuggestions("Miner", "Fisherman", "Farmer");
                })
                .onPlayerExecute(event ->
                {
                    var name = event.getString("name");
                    var age = event.getNumber("age");
                    var job = event.getString("job");
                    event.sender().sendMessage("Name: " + name + " Age: " + age + " Job: " + job);
                })
                .register();
    }
}

But why?

Commands are the most important element of a Spigot plugin. They are responsible for communication between player and code. Therefor it is essential to make them reliable and easy to manage.

Unfortunately the default Spigot commands registration is pretty rough. Most of the beginners have hard to adapt and understand it, with leads to frustration and many unwanted bugs.

Library aims to be dead simple and extendable offers not one the 3 different approaches of creating comments. Since that, eveyone from the begginer to the most expierenced coder will find

To see how well documented it is, check documentation

Join the support discord and visit the #programming channel for questions, contributions and ideas. Feel free to make pull requests with missing/new features, fixes, etc

Installation

Install the dependencie

<dependency>
    <groupId>io.github.jwdeveloper.spigot.commands</groupId>
    <artifactId>commands-framework-core</artifactId>
    <version>1.0.8</version>
    <scope>compile</scope>
</dependency>

Create your first command

public final class Example extends JavaPlugin {

    @Override
    public void onEnable() {
        CommandsApi commandsApi = CommandsFramework.enable(this);

           commands.create("/hello <name:Text> <age:number> <job:Text[Miner, Fisherman, Farmer]>")
                .onPlayerExecute(event ->
                {
                    event.sender().sendMessage("You called the hello command");

                    var name = event.getString("name");
                    var age = event.getNumber("age");
                    var job = event.getString("job");

                    event.sender().sendMessage("Name: " + name + " Age: " + age + " Job: " + job);
                }).register();
    }
}

Call the command in game!

Contributing

Library documentation for contributors

Your improvements are welcome! Feel free to open an issue or pull request.

jwdeveloper/CommandsFramework