Installation

Add the xis-mvui API to your Gradle build, declare the xis_mvui dependency in your mod metadata and run a dev client with the library.

By the end of this page your mod compiles against the API, declares its dependency on the library, and starts in a dev client with the library loaded.

Prerequisites#

• A mod project that builds with Gradle.
• Java 8 or newer as the compile target. The API is compiled for Java 8, so it works on every Minecraft version from 1.7.10 to 26.3.

Steps#

1. Add the repository and the API#

The API jar is dev.xichil.mvui:xis-mvui-api on https://maven.xichil.dev. Add it as compileOnly:

repositories {
    maven("https://maven.xichil.dev")
}

dependencies {
    compileOnly("dev.xichil.mvui:xis-mvui-api:1.0.0")
    // Optional: FakeHost, to test your menus in JUnit without Minecraft.
    testImplementation(testFixtures("dev.xichil.mvui:xis-mvui-api:1.0.0"))
}

repositories {
    maven { url 'https://maven.xichil.dev' }
}

dependencies {
    compileOnly 'dev.xichil.mvui:xis-mvui-api:1.0.0'
    testImplementation testFixtures('dev.xichil.mvui:xis-mvui-api:1.0.0')
}

The API has no dependencies of its own and contains no Minecraft classes, so it compiles in any source set, including code that is shared between loaders (see Build one mod for every loader).

2. Declare the dependency#

Tell the loader that your mod needs the library mod, whose id is xis_mvui:

{
  "depends": {
    "xis_mvui": ">=1.0.0"
  }
}

[[dependencies.mymod]]
modId = "xis_mvui"
mandatory = true
versionRange = "[1.0.0,)"
ordering = "NONE"
side = "CLIENT"

[[dependencies.mymod]]
modId = "xis_mvui"
type = "required"
versionRange = "[1.0.0,)"
ordering = "NONE"
side = "CLIENT"

@Mod(modid = "mymod", dependencies = "required-after:xis_mvui")

3. Run a dev client with the library#

Your dev client needs the library's mod jar for its loader family. Each one is on the same Maven repository:

Add it to the dev client the way your build tool adds a mod at runtime only, for example Fabric Loom's modLocalRuntime:

dependencies {
    modLocalRuntime("dev.xichil.mvui:xis-mvui-fabric:1.0.0")
}

Alternatively, put the release jar in the dev client's mods folder.

4. Check that it loaded#

Start the dev client. The library writes one line to the log when it picks its backend, starting with [Xi's Multiversion UI Lib]:

[Xi's Multiversion UI Lib] UI backend <backend> for <loader> <version>

If the line says No UI backend for … instead, that combination of loader and Minecraft version isn't supported. The game and your mod still run; there are just no menus.

Next steps#

• Your first menu: build a screen and register it.
• Build one mod for every loader: if you ship for several loaders or versions.