Home - DevNatan/inventory-framework GitHub Wiki

Welcome to the inventory-framework wiki!

Looking for Gradle, version or something like that? Go to Installation page!

Resources

Software Compatibility Table

Software Minimum IF version Status
Bukkit v1.x ✅ Supported
Paper v2.x ✅ Supported
Minestom v3.3.0 ✅ Supported
Folia v3.5.0 ✅ Supported

Versions Compatibility Table

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.x ✅ Supported
1.9 v2.4.x ✅ Supported
1.10–1.18 v2.5.x ✅ 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.x v3.2.0 ✅ Supported
1.21.5 v3.3.0 ✅ Supported
1.21.7 v3.4.0 ✅ Supported

About Third-Party

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.

Local Development

Minimum requirement is JDK 21 but Inventory Framework souce is written in Language Level 8!

Install Kotlin SDK if you are going to develop in Kotlin source sets (available in all modules).

To get started, clone the project repository

git clone https://github.com/DevNatan/inventory-framework

Publish this to your local repository to use in your projects

./gradlew publishToMavenLocal

Create an executable plugin for all supported platforms

./gradlew shadowJar

Before creating a PR, check if everything is OK with lint, javadoc and build!
Run ./gradlew lint to format code and ./gradlew build to run checks!

./gradlew lint build

Help & Community