Library [1.8/1.7] MenuEngine - Create simple and complex menus easily

MenuEngine
GitHub Repo
Current version: 1.3​

Hello everyone! I am finally writing this up, even though my library has been out for a while, I have been debugging it intensively, and it seems to be at a perfectly working state.

What is MenuEngine?
MenuEngine is a library, that makes it extremely easy to create custom menu's, including very simple ones, to complex and dynamic ones.

Why MenuEngine?
I have used many menu libraries before, but there always have been certain problems with them, where I wouldn't be able to use them for very complex inventories, or they would lag intensively, or even worse: break and not work at all. I have created MenuEngine, in the hope of fixing all of the above.

Usage:

For Server Owners
Download latest version from Here and put it in your plugins folder.

For Developers:
Yes, it doesn't require a repository, it is in the central Maven repository.

Code:xml

<dependency>
    <groupId>me.vilsol</groupId>
    <artifactId>menuengine</artifactId>
    <version>1.3</version>
</dependency>

Example:

Example (open) Example (close)

This example will create a menu, with an item that looks like an arrow, and once it left/right clicked, it will send a message to the player who clicked it and with which button.

TestPlugin.class
It is required that every object is initialized at least once.​

Code:java

public class TestPlugin extends JavaPlugin {
    public void onEnable(){
        // Register Items
        new ExampleItem().registerItem();
        // Register Menus
        new MainMenu();
    }
}

MainMenu.class
In the simple MenuModel, you can simply add items in the constructor, by only passing the class of the item, and the slot you want the place the item in.​

Code:java

public class MainMenu extends MenuModel {
    public MainMenu() {
        super(9, "Main Menu");
        getMenu().addItem(ExampleItem.class, 0);
    }
}

ExampleItem.class
Every menu item has to have its own class. Each item must have a registerItem() method, which will register the item in the MenuEngine.​

Code:java

public class ExampleItem implements MenuItem {
    @Override
    public void registerItem() {
        MenuItem.items.put(this.getClass(), this);
    }
 
    @Override
    public void execute(Player plr, ClickType click) {
        plr.closeInventory();
        if(click == ClickType.LEFT){
            plr.sendMessage("You Left Clicked!");
        }else if(click == ClickType.RIGHT){
            plr.sendMessage("You Right Clicked!");
        }
    }
 
    @Override
    public ItemStack getItem() {
        return new Builder(Material.ARROW).setName("Example Item").getItem();
    }
}

 

Code:

    @Override
    public ItemStack getItem() {
        return new Builder(Material.ARROW).setName("Example Item").getItem();
    }

Those are incorrect builder pattern naming conventions.

 

@_Filip Will be fixed in the next release

 

@Vilsol You're a pretty goofy guy.

 

Any criticism is welcome!

 

Released version 1.3.5

Only one change in this release (though I learned how to auto-deploy to maven central), but this release deprecates old builder methods, and added new ones!

 

Hi there, I'm trying to use this API but I can't get it to work in an easy way.

The only thing I could get to use it and show the menu was this:

Code:

                Menu m = MenuModel.getMenu(AdminMenu.class).getMenu();
                m.addItem(ExampleItem.class, 0);
                m.addItem(AdminCreateArena.class, 12);
                m.showToPlayer(p);
                break;

As if I do the .getMenu().showToPlayer(p) without adding the items first (there are the getItem.add... in the AdminMenu class) it shows the menu without items.