/gavui

A Minecraft UI library that is aimed towards creating simple and effective elements.

Primary LanguageJavaMIT LicenseMIT

GavUI

A Minecraft UI library that aims to bring ease of use to the modding community.

Features

  • Clickable elements
  • Dragging elements
  • Scrolling elements
  • Toggle elements
  • Cycling elements
  • An extensive color palette

How to use

  1. Ensure mavenCentral is added as a repository.
  2. In your project's gradle.properties file, add the following:
gavui_version = <your-version>
  1. In your project's build.gradle file, add the following:
dependencies {
    // the rest of your dependencies...
    modImplementation "com.peasenet:gavui:${gavui_version}"
}
  1. Sync your gradle project
  2. Add the following line to your mod's initializer:
@Override
public void onInitialize() {
    // Note that its best to put this before any other intialization that requires the UI
    GavUI.initialize();
    // your mod's initialization code...
}
  1. Enjoy!

Examples

If you want to see examples, please check out the Gavin's Mod GitHub repository for some usage, more specifically the Gui Element class for the project.

License

This project is licensed under the MIT license.

Contributing

All contributions are welcome, but are under the discretion of the maintainers.