Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/despical/inventoryframework
An inventory framework for managing Minecraft GUIs
https://github.com/despical/inventoryframework
inventory-framework minecraft minecraft-library
Last synced: 5 days ago
JSON representation
An inventory framework for managing Minecraft GUIs
- Host: GitHub
- URL: https://github.com/despical/inventoryframework
- Owner: Despical
- License: unlicense
- Created: 2020-09-04T10:42:54.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T08:03:20.000Z (17 days ago)
- Last Synced: 2024-10-28T09:29:00.285Z (17 days ago)
- Topics: inventory-framework, minecraft, minecraft-library
- Language: Java
- Homepage:
- Size: 324 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: .github/README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Inventory Framework
[](https://jitpack.io/#Despical/InventoryFramework)
[](https://javadoc.io/doc/com.github.Despical/InventoryFramework)
[](https://github.com/Despical/InventoryFramework/wiki)
An inventory framework for managing Minecraft GUIs.
This framework is a fork of [InventoryFramework](https://github.com/stefvanschie/IF) 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](https://javadoc.jitpack.io/com/github/Despical/InventoryFramework/latest/javadoc/index.html) 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
```xml
jitpack.io
https://jitpack.io
```
```xml
com.github.Despical
InventoryFramework
2.3.3
```
Now in order to shade the project into your project, add the following to your pom.xml:
```XML
org.apache.maven.plugins
maven-shade-plugin
3.2.2
false
me.despical.inventoryframework
[YOUR PACKAGE].inventoryframework
*:*
fonts/**
package
shade
```
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:
```Groovy
dependencies {
compile 'com.github.Despical:InventoryFramework:2.3.3'
// ...
}
```
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:
```Groovy
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:
```Groovy
shadowJar {
relocate 'me.despical', '[YOUR PACKAGE].inventoryframework'
}
```
## License
This code is under [Unlicense](https://unlicense.org/)
See the [LICENSE.txt](https://github.com/Despical/InventoryFramework/blob/main/LICENSE) file for required notices and attributions.
## Donations
You like this version of Inventory Framework? Then [donate](https://www.patreon.com/despical) 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](../CONTRIBUTING.md).
## 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.