InvUI/README.md

50 lines
1.6 KiB
Markdown
Raw Normal View History

2021-02-06 15:48:20 +00:00
![Logo](https://i.imgur.com/bFqCsuj.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)
2021-02-02 20:10:08 +00:00
# InvUI
2021-10-30 12:15:05 +00:00
2022-06-13 10:25:24 +00:00
An Inventory API for Minecraft Spigot servers.
Supports all versions from 1.14 to 1.19.
2021-02-06 15:48:20 +00:00
2022-06-24 19:28:27 +00:00
[Documentation](https://xenondevs.xyz/docs/invui/)
2021-02-06 15:48:20 +00:00
## Features
2021-10-30 12:15:05 +00:00
2021-12-01 13:57:25 +00:00
* Different types of inventories (Chest, Anvil, Cartography Table, Dropper...)
2021-10-30 12:15:05 +00:00
* Different GUI types (Normal, Paged, Tab, Scroll)
2022-06-13 10:25:24 +00:00
* Nested GUIs (For example use a Scroll-GUI as a tab page)
2021-10-30 12:15:05 +00:00
* Easily customizable (Create your own GUI types and Items)
2022-06-13 10:25:24 +00:00
* VirtualInventory: Store real items inside GUIs, customize maximum stack size per slot, etc.
2021-12-01 13:57:25 +00:00
* Easy way to add localization using the ItemProvider system and the built-in ItemBuilder
2022-06-13 10:25:24 +00:00
* Supports custom textures (forced resource pack system, compatible with AuthMe)
* Advanced ItemBuilder (Normal, Potion, Skull) with BaseComponent support
* Support for BaseComponents in inventory titles
2021-10-30 12:15:05 +00:00
* Uncloseable inventories
2022-06-13 10:25:24 +00:00
* GUI Animations
2021-10-30 12:15:05 +00:00
* GUI Builder
2021-02-06 15:48:20 +00:00
2022-12-31 13:11:53 +00:00
## Maven
2022-12-17 13:32:45 +00:00
```xml
<repository>
<id>xenondevs</id>
<url>https://repo.xenondevs.xyz/releases</url>
</repository>
```
```xml
<dependency>
2023-04-10 20:02:38 +00:00
<groupId>xyz.xenondevs.invui</groupId>
<artifactId>invui</artifactId>
2022-12-17 13:32:45 +00:00
<version>VERSION</version>
</dependency>
```
Check out the [InvUI documentation](https://xenondevs.xyz/docs/invui/) for more information.
2021-02-06 15:48:20 +00:00
## Examples
2021-10-30 12:15:05 +00:00
![1](https://i.imgur.com/uaqjHSS.gif)
2021-02-06 15:48:20 +00:00
![2](https://i.imgur.com/rvE7VK5.gif)