https://github.com/nichtstudiocode/invui

A spigot library for creating custom inventory-based GUIs.
https://github.com/nichtstudiocode/invui

api bukkit gui inventories inventory java library spigot

Last synced: 3 days ago
JSON representation

A spigot library for creating custom inventory-based GUIs.

• Host: GitHub
• URL: https://github.com/nichtstudiocode/invui
• Owner: NichtStudioCode
• License: mit
• Created: 2021-01-20T21:27:19.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2025-03-29T10:24:03.000Z (about 1 year ago)
• Last Synced: 2025-04-03T15:11:47.601Z (about 1 year ago)
• Topics: api, bukkit, gui, inventories, inventory, java, library, spigot
• Language: Java
• Homepage:
• Size: 5.24 MB
• Stars: 282
• Watchers: 7
• Forks: 24
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
![Logo](https://i.imgur.com/yim89HQ.png)

[![Stars](https://img.shields.io/github/stars/NichtStudioCode/InvUI?color=ffa200)](https://github.com/NichtStudioCode/InvUI/stargazers)

![GitHub issues](https://img.shields.io/github/issues/NichtStudioCode/InvUI)

![License](https://img.shields.io/github/license/NichtStudioCode/InvUI)

# InvUI

An Inventory GUI library for Minecraft Paper servers.  

Highlighted features:

* Supports most inventory types: Chest, Anvil, Brewer, Cartography, Crafter, Crafting, Furnace, Grindstone, Merchant, Smithing, Stonecutter

* Different Gui types: Normal, Paged, Tab, Scroll

* Gui-embeddable inventories with a powerful event system (e.g. only allow input for certain item types, customize maximum stack size per slot, etc.)

* First-class [MiniMessage](https://docs.advntr.dev/minimessage/index.html) support

* Easy localization of UI items using the built-in ItemBuilder

Check out the [InvUI Documentation](https://xenondevs.xyz/docs/invui/) to learn more.  

If you have any questions, feel free to join the [Discord](https://discord.com/invite/EpVMXtXB2t) or ask them in [GitHub Discussions](https://github.com/NichtStudioCode/InvUI/discussions).

## Version Compatibility

Starting with v2, InvUI is no longer a multi-version library.

See the table below for an overview of which InvUI version is compatible with which Minecraft version.

| Minecraft version    | InvUI version     |

|----------------------|-------------------|

| `26.1.2`             | `2.0.0` - `2.1.x` |

| `1.14.0` - `1.21.11` | `1.49`            |

## Maven

```xml

    xenondevs

    https://repo.xenondevs.xyz/releases

```

```xml

    xyz.xenondevs.invui

    invui

    VERSION

```

Check out the [InvUI documentation](https://xenondevs.xyz/docs/invui/) for more information.

## Examples

_These examples are taken from the documentation linked above. To keep the code examples there short, button names are often omitted._