OdalitaMenus
Advanced yet simple to use inventory api for Spigot plugins
Advanced yet simple to use inventory api for Spigot plugins
This resource is for developers only, if you're a server owner then this is not intended for you.
Java version
At least Java 17
Getting started
(NOTE) If you're running on 1.20.6 or later, please make sure you use Paper as your server software. Spigot is no longer supported for newer versions.
In order to get started you would need to add the libary to your project using maven or gradle. You can also upload it to your server as a plugin and make the dependency provided to not implement it in your own code.
Maven dependency:
Code (YAML):
<dependency
>
<groupId>io.github.odalita-developments.odalitamenus</groupId >
<artifactId>core</artifactId >
<version>0.6.2</version >
</dependency>
<groupId>io.github.odalita-developments.odalitamenus</groupId >
<artifactId>core</artifactId >
<version>0.6.2</version >
</dependency>
Code (Text):
repositories {
mavenCentral()
}
dependencies {
implementation 'io.github.odalita-developments.odalitamenus:core:0.6.2'
}
mavenCentral()
}
dependencies {
implementation 'io.github.odalita-developments.odalitamenus:core:0.6.2'
}
Documentation and examples
The wiki can be found here.
Examples can be found here.
Features
- Simple menu setup (with annotation)
- Menu types (inventory types)
- Inbuilt items and option to create your own items
- DisplayItem
- ClickableItem
- UpdatableItem
- BackItem
- CloseItem
- OpenMenuItem
- PageItem
- ScrollItem
- Refreshable items
- Decide yourself when to refresh an item
- Scheduler
- Menu cache
- Option to use global caching using a key which syncs the cache across the menus with the same key
- Option to change title without reopening the menu
- Option to cancel menu from closing NEW
- Player inventory interaction
- Click event
- Item meta changer (client side)
- Placeable items (option to place items from player inventory into your menu)
- Shift click support NEW
- Menu providers
- This is the way how a menu should initialize it's items, this has to option to create custom providers for your own use
- Iterators
- Normal iterators
- Iterators based on patterns
- Object iterators
- This can be used to easily sort and filter items due to it using objects instead of items to fill the iterator
- This can also be used in pagination
- Patterns
- Pagination
- Async page switching
- Scollable
- Frames
- You can create a smaller piece of a menu with a frame that you can use across multiple menus
- Option to change inventory properties
- Option to listen to bukkit inventory and player events NEW
- Multi version support
- Async support
- You can change items in the inventory anytime you want, on any thread you want
- Option to register your own providers
- ColorProvider
- CooldownProvider
- DefaultItemProvider
- MenuItemDataProvider
- PacketListenerProvider
Plugin dependencies
- (Optional) ProtocolLib
- This is used for item meta changer, we have our own packet listener builtin and also an option to register your own PacketListenerProvider. ProtocolLib is supported but not required.
Quick facts
- Edition: Minecraft Java
- File type: .jar
- Minecraft versions listed: 1.16, 1.17, 1.18
- How to install: Install the matching mod loader (Forge, Fabric or NeoForge) for your Minecraft version. → Download the .jar. → Put it in the .minecraft/mods folder and launch that loader profile.
- Where to get it: Opens on Spigot — not every file is mirrored on our own servers.
Install steps are the general flow for this file type — How to install Minecraft Java mods & modpacks walks through it step by step.
OdalitaMenus - Menu/GUI/Inventory library for developers is a free Minecraft Java mod. Compatible with Minecraft 1.16, 1.17, 1.18, 1.19 and newer. Downloaded 3,438 times (via Spigot). Download it and open it directly in the game.