Caramel

Caramel GUIs

Caramel GUIs provide a quick and easy way to make interactive GUIs.

A fresh menu

Lets start by creating our own GUI. Make a new class - for this tutorial, I’ll call the class “MyGUI” and plugin “MyPlugin”.

public class MyGUI extends CaramelGui {
    public MyGUI() {
        super("Title", rows, paginated); // Replace rows with # of rows and paginated with true/false
    }
    public void setup(Player player) {
        ...
    }
}

Setup Function

Inside the setup# function, we can add and set items using functions ( see function guide below ). Heres an example:

makeLine(9, new ItemStack(Material.STONE)); // add() 9 blocks of stone automatically
add((new ItemBuilder(Material.DIAMOND)).name("&bDiamond!").build());
add((new ItemBuilder(Material.EMERALD)).name("&aClick me").build(), (player) -> {
    player.sendMessage("Item clicked!");
});

Function Guide

Function	Description	Args	Example
slot	Set a slot	Integer slot, ItemStack icon	slot(1, new ItemStack(Material.DIRT))
slot	Set a slot with click	Integer slot, ItemStack icon, Consumer action	slot(1, new ItemStack(Material.DIRT), (event)->{/* Do something */})
add	Add to first air slot	ItemStack icon	add(new ItemStack(Material.DIRT))
add	Add to first air slot with click	ItemStack icon, Consumer action	add(new ItemStack(Material.DIRT), (event)->{/* Do something */})
makeLine	Bulk add()	Integer amount, ItemStack icon	makeLine(9, new ItemStack(Material.DIRT))

Override Vanilla Menus

Inside our constructor, we can choose if we’d like to override vanilla menus and set our pagination toolbar.

public MyGUI() {
    super(...);
    
    // Example (Optional) - Set a custom toolbar for paginated menus.
    // This is not required and will default to a left/right arrow toolbar.
    setPageNavigation((slot, page, defaultType, menu) -> {
        // Return an SGButton based on what slot it is (in the bottom-most row of the menu).
        if(slot == 8) {
            return (new SGButton(itemStackHere)).withListener((event) -> {});
        }
        return (new SGButton(otherItemStack)).withListener((event) -> {});
    });
    
    // Example - Override crafting table menu no matter what 
    setOverride(CaramelGuiOverrides.CRAFTING_TABLE, alwaysTrue); // Caramel provides an alwaysTrue for Always overriding

    // Example - Override crafting table menu if player is in lobby
    setOverride(CaramelGuiOverrides.CRAFTING_TABLE, (player) -> player.getWorld().getName().equals("lobby"));
}

Anvil and Sign Input Prompts

Sign input prompts are not yet supported.

Anvil prompts can be created using the CaramelPrompt class.

CaramelPrompt.anvil()
    .title("Title")
    .text("Default Text")
    .leftItem(new ItemStack(Material.STONE))
    .rightItem(new ItemStack(Material.DIAMOND))
    .resultItem(new ItemStack(Material.EMERALD))
    .onClose((snapshot) -> { /* Do something */ })
    .onClickAsync((event) -> { /* Do something */ })
    .click((integer, snapshot) -> { /* Do something */ })
    .open(player);

Register your GUI

public class MyPlugin {
    public CaramelGui myGui;

    public void onEnable() {
        Caramel.getInstance().guis.add(myGui = new MyGui());
    }
    public void onDisable() {
        Caramel.getInstance().guis.getGuis().remove(myGui);
    }
}