Tags
Creators
Details
Licensed MIT
Published 5 months ago
Updated 4 months ago
All versions
1.0.2
Release
GUIAPI 1.0.25 months ago 27
Compatibility
Minecraft: Java Edition
26.1.x
1.21.x
1.20.x
Platforms
Paper
Purpur
Spigot
Changes
Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
[1.0.2] - Initial Release
β¨ Features
- Component-Based Architecture: Build modular UIs using reusable components.
- Interactive Buttons:
GuiButton: Standard clickable button.GuiCheckButton: Toggle button (true/false states).GuiOptionButton: Cycle through multiple predefined options.GuiConfigurableButton: Buttons with built-in configuration GUIs.
- Text Inputs:
GuiTextInput: Prompt players for single text input via chat with validation.GuiListTextInput: Collect multiple text entries from chat.
- Item Chooser:
GuiItemChooser: Allow players to select any item from their inventory as input.
- True Editable Slots:
GuiEditableSlot: Fully functional slots supporting left-click, right-click, shift-click, stacking, swapping, and splitting. Optionally return items on close.
- Panels & Nesting:
GuiPanel: Group components with independent, nested coordinate systems.
- Scrolling & Pagination:
GuiListPage: Automatic pagination for large lists.GuiScrollPane: Vertical scrolling support.GuiScrollBar: Horizontal scrolling support.
- Live Updates: Schedule async, periodic re-renders for individual components with automatic cleanup.
- GUI Grouping: Group multiple GUI instances for synchronized repaints and closing.
- Advanced Formatting: Full support for Hex colors (
&#FF0000), Gradients (<gradient:#ff0000>Text<#00ff00>), and Legacy codes. - NBT Metadata Injection: Attach custom metadata (String, Integer, Double, Boolean, Long, Float, ItemStack) directly to rendered items.
- Auto-Cleanup: Automatically dispose of GUIs and tasks when no viewers remain.
π Requirements
- Spigot, Paper, or compatible forks (1.20+)
- Java 17+
- NBT-API plugin (2.15.7+)
Projects on Modrinth are automatically available through a Maven repository for use with JVM build tools such as Gradle. To learn more about the Modrinth Maven API, click here.
Note: When available, you should use the creator's maven repo instead as it will have transitive dependency information that the Modrinth Maven API does not. You may also end up with duplicate dependencies if you use a mix of Modrinth and non-Modrinth Maven repositories for your dependencies, because the group identifier will be different when served through the Modrinth Maven API.
Maven coordinates:
Version ID:
build.gradle:
repositories {
exclusiveContent {
forRepository {
maven {
name = "Modrinth"
url = "https://api.modrinth.com/maven"
}
}
// forRepositories(fg.repository) // Uncomment when using ForgeGradle
filter {
includeGroup "maven.modrinth"
}
}
}
// Standard Gradle dependency
dependencies {
implementation "maven.modrinth:ipt81Sgf:BOQoLEst"
}
// Legacy Loom dependency
dependencies {
modImplementation "maven.modrinth:ipt81Sgf:BOQoLEst"
}

