BrickGUI

A Minecraft library for creating GUIs.

Platforms

• Minestom
• Spigot / Paper (1.18+)

Usage

Gradle

repositories {
    maven { url "https://repo.jorisg.com/snapshots" }
}

dependencies {
    implementation 'com.guflimc.brick.gui:spigot-api:1.0-SNAPSHOT'
}

Javadocs

• Spigot

Examples

Register events when the plugin enables.

SpigotBrickGUI.register(this);

Using the itemstack builder

ItemStack back = ItemStackBuilder.of(Material.PAPER).withName(ChatColor.GREEN + "Back").build();

// there are other builders too: skulls, leather armor, books, firework, potions, banners
ItemStack skull = ItemStackBuilder.skull().withSkullTexture("eyJ0ZXh0dX....").build();
ItemStack book = ItemStackBuilder.book(BookType.WRITTEN).withAuthor("Joris Guffens").withPage("Awesome!").build();

// and colored items: wool, terracotta, glass, beds, carpets, dye
ItemStack wool = ItemStackBuilder.wool(DyeColor.BLUE).withName("I'm blue dabe die dabe daa").build();

Creating your own menu with full control.

// create a simple menu
ISpigotMenu menu = SpigotBrickGUI.create(45, "Fancy Title");

// add item
menu.setItem(back, (event) -> {
    event.getWhoClicked().sendMessage("clicked on back item!");
});

// custom listeners
menu.addClickListener(event -> {
    event.getWhoClicked().sendMessage("clicked anywhere!");
});

menu.addCloseListener(player -> {
    player.sendMessage("closed gui!");
});

Using the menu builder, this will generate a symmetrical gui. Limited to 10 items.

ISpigotMenu menu = SpigotBrickGUI.builder()
        .withTitle("Fancy Title")
        .withItem(skull, (event) -> {
            event.getWhoClicked().sendMessage("clicked skull!");
        })
        .build();

Using a paginated gui.

List<Thing> items = ...
ISpigotMenu menu = SpigotBrickGUI.paginatedBuilder()
        .withTitle("Paginated inventory")
        .withBackItem(back)
        .withNextItem(next)
        .withItems(items.size(), (index) -> {
            // will only create/render an itemstack when this page is opened.
            return items.get(index).itemStack();
        })
        .build()