Inventory Framework

An inventory framework for managing Minecraft GUIs.

This framework is a fork of InventoryFramework that has multiple version support and some addition features. Still based on a pane principle. This means that the GUI is divided into different types of panes which all behave differently. A GUI consists of multiple panes which can interact with each other.

Next to those panes, GUIs can also be created from XML files by simple loading them in. This allows for easy GUI creation with little code. Now we support Minecraft 1.17, 1.18 and 1.19 versions and also the upcoming versions when they are released.

Documentation

The JavaDoc can be browsed.

Using Command Framework

The project isn't in the Central Repository yet, so specifying a repository is needed.
To add this project as a dependency to your project, add the following to your pom.xml:

Maven dependency

<repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
</repository>

<dependency>
    <groupId>com.github.Despical</groupId>
    <artifactId>InventoryFramework</artifactId>
    <version>2.2.9</version>
</dependency>

Now in order to shade the project into your project, add the following to your pom.xml:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-shade-plugin</artifactId>
    <version>3.2.2</version>
    <configuration>
        <createDependencyReducedPom>false</createDependencyReducedPom>
        <relocations>
            <relocation>
                <pattern>me.despical.inventoryframework</pattern>
                <shadedPattern>[YOUR PACKAGE].inventoryframework</shadedPattern>
            </relocation>
        </relocations>
        <!-- If you don't want to include fonts which are approximately 150 kbs -->
        <filters>
            <filter>
                <artifact>*:*</artifact>
                <excludes>
                    <exclude>fonts/**</exclude>
                </excludes>
            </filter>
        </filters>
    </configuration>
    <executions>
        <execution>
            <phase>package</phase>
            <goals>
                <goal>shade</goal>
            </goals>
        </execution>
    </executions>
</plugin>

Replace [YOUR PACKAGE] with the top-level package of your project.

Gradle dependency

To add this project as a dependency for your Gradle project, make sure your dependencies section of your build.gradle looks like the following:

dependencies {
    compile 'com.github.Despical:InventoryFramework:2.2.9'
    // ...
}

In order to include the project in your own project, you will need to use the shadowJar plugin. If you don't have it already, add the following to the top of your file:

apply plugin: 'com.github.johnrengelman.shadow'

To relocate the project's classes to your own namespace, add the following, with [YOUR PACKAGE] being the top-level package of your project:

shadowJar {
    relocate 'me.despical', '[YOUR PACKAGE].inventoryframework'
}

License

This code is under Unlicense

See the LICENSE.txt file for required notices and attributions.

Donations

You like this version of Inventory Framework? Then donate back me to support the development.

Contributing

I accept Pull Requests via GitHub. There are some guidelines which will make applying PRs easier for me:

No tabs! Please use spaces for indentation.
Respect the code style.
Create minimal diffs. If you feel the source code should be reformatted create a separate PR for this change.

You can learn more about contributing via GitHub in contribution guidelines.

Building from source

If you want to build this project from source, run the following from Git Bash:

git clone https://github.com/Despical/InventoryFramework.git && cd InventoryFramework
mvn clean package -Dmaven.javadocs.skip=true -DskipTests

The build can then be found in /InventoryFramework/target/

Important

Don't forget to install Maven before building.

Despical / InventoryFramework