installation - DevNatan/inventory-framework GitHub Wiki

Inventory Framework releases are published on Maven Central repository

repositories {
    mavenCentral()
}

dependencies {
    implementation 'me.devnatan:inventory-framework-platform-bukkit:3.0.10-SNAPSHOT'
}

Inventory Framework development builds are published on Maven Central Snapshots Repository

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

PaperSpigot with Kyori's Adventure support

Only needed if you use Inventory Framework as a shaded library in your project.

implementation 'me.devnatan:inventory-framework-platform-paper:3.0.10-SNAPSHOT'

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.

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:3.0.10-SNAPSHOT'
}

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.