Skip to content

Commit e06e2c2

Browse files
Update README.md
1 parent 73f43af commit e06e2c2

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![Logo](https://i.imgur.com/bFqCsuj.png)
1+
![Logo](https://i.imgur.com/yim89HQ.png)
22

33
[![Stars](https://img.shields.io/github/stars/NichtStudioCode/InvUI?color=ffa200)](https://github.com/NichtStudioCode/InvUI/stargazers)
44
![GitHub issues](https://img.shields.io/github/issues/NichtStudioCode/InvUI)
@@ -8,7 +8,14 @@
88

99
An Inventory API for Minecraft Paper servers.
1010

11-
[Documentation](https://xenondevs.xyz/docs/invui/)
11+
Highlighted features:
12+
* Supports many inventory types: Chest, Anvil, Brewer, Cartography, Crafter, Crafting, Furnace, Grindstone, Merchant, Smithing, Stonecutter
13+
* Different Gui types: Normal, Paged, Tab, Scroll
14+
* Gui-embeddable inventories with a powerful event system (e.g. only allow input for certain item types, customize maximum stack size per slot, etc.)
15+
* First-class [MiniMessage](https://docs.advntr.dev/minimessage/index.html) support
16+
* Easy localization of UI items using the built-in ItemBuilder
17+
18+
Check out the [InvUI Documentation](https://xenondevs.xyz/docs/invui/) to learn more.
1219

1320
## Version Compatibility
1421

@@ -20,21 +27,6 @@ See the table below for an overview of which InvUI version is compatible with wh
2027
| `2.0.x` | `TBD` |
2128
| `1.46` | `1.14.0` - `TBD` |
2229

23-
24-
## Features
25-
26-
* Different types of inventories (Chest, Anvil, Cartography Table, Dropper...)
27-
* Different GUI types (Normal, Paged, Tab, Scroll)
28-
* Nested GUIs (For example use a Scroll-GUI as a tab page)
29-
* Easily customizable (Create your own GUI types and Items)
30-
* VirtualInventory: Store real items inside GUIs, customize maximum stack size per slot, etc.
31-
* Easy way to add localization using the ItemProvider system and the built-in ItemBuilder
32-
* Advanced ItemBuilder (Normal, Potion, Skull, Banner, Firework) with BaseComponent support
33-
* Support for BaseComponents in inventory titles
34-
* Uncloseable inventories
35-
* GUI Animations
36-
* GUI Builder
37-
3830
## Maven
3931

4032
```xml
@@ -52,9 +44,17 @@ See the table below for an overview of which InvUI version is compatible with wh
5244
</dependency>
5345
```
5446

55-
Check out the [InvUI documentation](https://xenondevs.xyz/docs/invui/) for more information.
47+
Check out the [InvUI documentation](https://xenondevs.xyz/docs/invui2/) for more information.
5648

5749
## Examples
58-
59-
![1](https://i.imgur.com/uaqjHSS.gif)
60-
![2](https://i.imgur.com/rvE7VK5.gif)
50+
_These examples are taken from the documentation linked above. To keep the code examples there short, button names are often omitted._
51+
52+
<p>
53+
<img src="https://i.imgur.com/FhRGCqW.gif" width="256">
54+
<img src="https://i.imgur.com/eA8Qz15.gif" width="256">
55+
<img src="https://i.imgur.com/seE3awF.gif" width="256">
56+
<img src="https://i.imgur.com/Kf0eB4L.gif" width="256">
57+
<img src="https://i.imgur.com/hgIgLHJ.gif" width="256">
58+
<img src="https://i.imgur.com/XkvkvBH.gif" width="256">
59+
<img src="https://i.imgur.com/3ogItrb.gif" width="256">
60+
</p>

0 commit comments

Comments
 (0)