MixinExtras Documentation

FabricLoader 0.15.0+ includes MixinExtras by default. If you need to support older versions or require a specific version, use the following Gradle configuration. Note that you should use annotationProcessor for the fabric-specific artifact.

dependencies {
    include(implementation(annotationProcessor("io.github.llamalad7:mixinextras-fabric:0.5.4")))
}

For platforms not listed above, you can use ShadowJar to bundle the mixinextras-common artifact. It is critical to relocate the package to avoid conflicts and call mergeServiceFiles() in your shadowJar configuration.

plugins {
    id "com.github.johnrengelman.shadow" version "8.1.0"
}

configurations {
    implementation.extendsFrom shadow
}

dependencies {
    shadow(annotationProcessor("io.github.llamalad7:mixinextras-common:0.5.4"))
}

shadowJar {
    configurations = [project.configurations.shadow]
    relocate("com.llamalad7.mixinextras", "your.package.goes.here.mixinextras")
    mergeServiceFiles() // Very important!
}

For Forge 1.18.2+, you must provide both the mixinextras-common artifact via annotationProcessor for compilation and the mixinextras-forge artifact via jarJar or include for runtime. Use the -all jar when bundling MixinExtras yourself.

// Using ForgeGradle
dependencies {
    compileOnly(annotationProcessor("io.github.llamalad7:mixinextras-common:0.5.4"))
    implementation(jarJar("io.github.llamalad7:mixinextras-forge:0.5.4")) {
        jarJar.ranged(it, "[0.5.4,")
    }
}

// Using Architectury Loom
dependencies {
    compileOnly(annotationProcessor("io.github.llamalad7:mixinextras-common:0.5.4"))
    implementation(include("io.github.llamalad7:mixinextras-forge:0.5.4"))
}

NeoForge 20.2.84+ includes MixinExtras by default. To use a specific version or maintain compatibility with older versions, use jarJar with the mixinextras-neoforge artifact.

// Using ModDevGradle
dependencies {
    implementation(jarJar("io.github.llamalad7:mixinextras-neoforge:0.5.4"))
}

// Using NeoGradle
dependencies {
    implementation(jarJar("io.github.llamalad7:mixinextras-neoforge:0.5.4")) {
        jarJar.ranged(it, "[0.5.4,")
    }
}

To enable MixinExtras features, you must call MixinExtrasBootstrap.init() early in the application lifecycle. The recommended way to do this is within the onLoad method of an IMixinConfigPlugin implementation.

MixinExtrasBootstrap.init();