-
Notifications
You must be signed in to change notification settings - Fork 22
Home
Welcome to the inventory-framework wiki!
Inventory Framework is a Bukkit Inventory API framework that allows you to create custom inventories with varied interaction treatments that would be almost impossible to create manually by the developer.
Here you'll learn about how IF works internally and how to use it in your projects.
- Issue Tracker
-
dev.natanon Discord
Currently, we should support any Minecraft Server versions due to its compatibility with Bukkit. If there's any issue with a different minecraft version, please report it in Issue Reporting section.
Here is the compatibility table, see if your version is compatible before trying to use this library.
(This table doesn't apply to Protocol-Level Integrations)
| MC version | Minimum IF version | Status |
|---|---|---|
| 1.8 | v1.0 | ✅ Supported |
| 1.9 | v2.4.0 | ✅ Supported |
| 1.10–1.18 | v2.5.0 | ✅ Supported |
| 1.19 | v2.5.4-rc.1 | ✅ Supported |
| 1.20 | v3.0.0-EAP | ✅ Supported |
| 1.20.2 | v3.0.3 | ✅ Supported |
| 1.20.4 | v3.1.0-beta | ✅ Supported |
| 1.21.* | 3.2.0 | ✅ Supported |
IF uses third-party code to complement its functionality or to make its operation as complete and perfect as possible, see the list of third-party libraries and their licenses used in the project.
You will need to have Java Development Kit (JDK) v17 and Kotlin SDK if you are going to develop in the Kotlin module.
Clone the project repository
git clone https://github.com/DevNatan/inventory-framework
Run code format checks and see if the tests are passing
./gradlew check
Publish this to your local repository to use in your projects
./gradlew publishToMavenLocal
Create an executable plugin for all supported platforms
./gradlew shadowJar