XaGUI 1.6.1
Build inventory GUIs for Bukkit, Spigot, Paper, and Folia plugins.
XaGUI is a Java library for building chest-style Minecraft inventory menus. It handles inventory creation, locked slots, button callbacks, multiple pages, navigation, and menu lifecycle events.
These docs target XaGUI 1.6.1. The examples use Java and Bukkit/Paper types, but the core artifact remains Java 8 compatible.
Start here
Install XaGUI
Add version 1.6.1 and package it with your plugin.
Your first GUI
Initialize XaGUI, create a menu, add a button, and open it.
Real-world menu pattern
Build reusable, data-driven menus with VirtualMenu.
The four main types
| Type | Purpose |
|---|---|
XaGui | Library entry point. Create one instance when your plugin enables. |
GuiMenuInterface / GuiMenu | A menu: title, rows, pages, slots, and lifecycle handlers. |
GuiButton | An item plus optional name, lore, sound, click callback, or redirect. |
VirtualMenu<T> | A reusable menu class whose build(T context) method fills the GUI from data. |
Menu slots are locked by default, & color codes work in titles and item text, and pages and slots use zero-based indexes in method calls.
Continue with Quick start.