xChris6041x/Devin

DEVIN is a multi-use Spigot framework that builds on top of the existing command, configuration architecture and more.

DEVIN is a framework for Spigot 1.8+ that gives developers the tools to build better and bigger plugins more efficiently. DEVIN takes care of a lot of the cumbersome code that developers would have to traditionally write so they can spend more time developing a better plugin.

Features

• Powerful annotated command and sub command framework with automatic tab completion and help command.
• Connect information to specific players or worlds for temporary or persistent use.
• Dependency Injection for any and all objects. Automatically used when registering commands and events.
• An Inventory GUI that gives you the ability to create GUI's with clickable ItemStacks.
• A MessageSender class for sending messages to one person, a group, or to everyone easily with prefixes.
• Overall faster development and improved maintainability.

Requirements

• Server is running Java 8.
• Server is running Spigot 1.8+

Getting Started

If you are just learning how to develop with DEVIN then you should read over the wiki.

Setting Up for Owners

1. Download the latest Devin.jar from the spigot resource.
2. Place the plugin in your plugins folder on your server.

Setting Up for Developers

1. Download the latest Devin.jar from the spigot resource and install on the server (see above).
2. Create a new Spigot project.
3. Add the Devin.jar as an external reference.

Command Framework

Here is a quick overview of what the command framework can do with comments teaching you most the parts of the framework.

// All command classes must implement Commandable
public class DemoCommands implements Commandable {

    @Inject
    private MessageSender messageSender; // Grabs the message sender from the registrar.
   
    // All commands must use @Command
    // This command will have an auto generated usage of /demo <message> [message type] [player].
    @Command(
            struct = "demo" /* Command structure (REQUIRED) */,
            params = { "message", "message type", "player" } /* Parameter names */,
            perms = "devin.demo" /* Permissions */,
            aliases = { "d", "dem" } /* Command aliases */ )
    public CommandResult demo(CommandSender sender /* Who sent the command */,
            String str /* First argument. */,
            @OptionalArg("0") int i /* Optional argument. Must be an int and 0 if missing. */,
            @OptionalArg Player p /* Optional argument, must be a player name (converted to player) and null if missing. */) {
       
        CommandSender cs = (p == null) ? sender : p;
        switch (i) {
        case 1:
            messageSender.info(cs, str);
            break;
        case -1:
            messageSender.error(cs, str);
            break;
        default:
            messageSender.send(cs, str);  
        }
       
        // Tells DEVIN this command was a success!
        return CommandResult.success();
    }
   
    @Command(struct = "demo player-only" /* sub command */, aliases = "po")
    public CommandResult playerOnly(Player sender /* Who sent the command must be a Player */) {
        return CommandResult.success("This is a player only command.");
    }
   
}

Without comments:

public class DemoCommands implements Commandable {

    @Inject
    private MessageSender messageSender;
   
    @Command(struct = "demo", params = { "message", "message type", "player" }, perms = "devin.demo", aliases = { "d", "dem" })
    public CommandResult demo(CommandSender sender, String str, @OptionalArg("0") int i, @OptionalArg Player p) {
        CommandSender cs = (p == null) ? sender : p;
        switch (i) {
        case 1:
            messageSender.info(cs, str);
            break;
        case -1:
            messageSender.error(cs, str);
            break;
        default:
            messageSender.send(cs, str);  
        }
       
        return CommandResult.success();
    }
   
    @Command(struct = "demo player-only", aliases = "po")
    public CommandResult playerOnly(Player sender) {
        return CommandResult.success("This is a player only command.");
    }
   
}