Installation

Releases are published on Maven Central repository and development builds are published on Maven Central Snapshots Repository. Click here to see the latest and all available versions.

Inventory Framework is Java 1.8 source compatible.

repositories {
    mavenCentral()
    maven { url 'https://oss.sonatype.org/content/repositories/snapshots' }
}

---

Table of Contents

• Available Platforms
  • Bukkit
  • Paper
  • Minestom
  • Folia
• Preventing Library Conflicts
• Integration with External Features

Available Platforms

Inventory Framework is available in a per-platform basis with each platform having its own exclusive features like Paper with Kyori's Adventure Components so you need to import them accordingly.

Bukkit

dependencies {
    implementation 'me.devnatan:inventory-framework-platform-bukkit:<version>'
}

Paper

Includes with Kyori's Adventure support on inventory titles.
Only needed if you use Inventory Framework as a shaded library in your project.

implementation 'me.devnatan:inventory-framework-platform-paper:<version>'

Minestom

Available since Inventory Framework v3.3.0.

implementation 'me.devnatan:inventory-framework-platform-minestom:<version>'

Folia

Available since Inventory Framework v3.5.0.

implementation 'me.devnatan:inventory-framework-platform-folia:<version>'

Preventing Library Conflicts

There is a good chance that the inventory-framework library will be used in different plugins within your server, these plugins share the same classpath, if a plugin is using a different version of the IF compared to the others there will be a version conflict because it has been shaded inside that plugin.

1. Install IF latest version for your platform on Github Releases.

2. Add the inventory framework as a dependency of your plugin to be able to access it.

   depend: [ InventoryFramework ]

3. Put the downloaded platform plugin in your plugins directory.

Note: When you have the IF in your plugins you shouldn't compile them together with your projects, but put them as a compileOnly and runtimeOnly dependency in Gradle and scoped provided in Maven.

Integration with External Features

First, you need to get the notation of this feature to apply it in your project, usually in the "Project Setup" section of the documentation of that feature you can get this information.

In this example we will use the Anvil Input feature.

1. Include the dependency on your project.

dependencies {
    implementation 'me.devnatan:inventory-framework-anvil-input:<version>'
}

2. You can apply it so much locally that it's recommended if you need to control which frameworks can have this feature.\

import static me.devnatan.inventoryframework.AnvilInputFeature.AnvilInput;

viewFrame.install(AnvilInput);

And that's it, you now have the feature installed, go to that feature's documentation to learn how to use it.