Skip to content

A Minecraft library mod which adds a new abstraction to create GUI interfaces. Still close to the Vanilla design code-wise.

License

Notifications You must be signed in to change notification settings

LambdAurora/SpruceUI

Repository files navigation

SpruceUI

Java 21 GitHub license Environment: Client Mod loader: Fabric

A Minecraft mod API which adds some GUI utilities.

Build

Just do ./gradlew build and everything should build just fine!

To test SpruceUI, you can run the testmod with ./gradlew runTestmodClient.

Use inside a mod

You can look at the SpruceUI test mod for examples of use.

Import inside a project

Add this to your build.gradle in addition of the base Fabric mod build.gradle:

repositories {
    maven {
        name = "Gegy"
        url = uri("https://maven.gegy.dev")
    }
}

dependencies {
    /* Fabric definitions */

    include(modImplementation("dev.lambdaurora:spruceui:${project.spruceui_version}"))
}

And this to your gradle.properties:

spruceui_version=7.0.1+1.21.5

It will JAR-in-JAR SpruceUI so users of your mod don't need to download it separately!

For NeoForge

Defining the dependency on NeoForge is slightly different:

dependencies {
	val spruceui = implementation("dev.lambdaurora:spruceui:${project.spruceui_version}") {
		capabilities {
			requireCapability("dev.lambdaurora:spruceui-mojmap")
		}
	}

	jarJar(spruceui) {
		jarJar.pin(it, "[7.0.1,8.0.0)")
	}
}

About

A Minecraft library mod which adds a new abstraction to create GUI interfaces. Still close to the Vanilla design code-wise.

Topics

Resources

License

Stars

Watchers

Forks

Packages