Setup with Gradle

Learn how to import YACL into your development environment.

This wiki is currently a work-in-progress and is incomplete!

First, you will need to add the maven repository that hosts YACL.

Groovy DSL (build.gradle)

repositories {
    maven {
        name 'Xander Maven'
        url 'https://maven.isxander.dev/releases'
    }
}

Kotlin DSL (build.gradle.kts)

repositories {
    maven("https://maven.isxander.dev/releases") {
        name = "Xander Maven"
    }
}

Next, you need to add the dependency to the classpath.

It is highly discouraged to JiJ (jar in jar) the YACL dependency as it is likely that it's already in the user's mod folder and will significantly increase the size of your JAR.

Kotlin DSL (build.gradle.kts)

dependencies {
    modImplementation("dev.isxander:yet-another-config-lib:(modversion)+(mcversion)-(loader)")
    // for example...
    modImplementation("dev.isxander:yet-another-config-lib:3.4.0+1.20.4-fabric")
}

Replace (latest) with the latest version of YACL available for the target Minecraft version. You can find this on Modrinth.

Groovy DSL (build.gradle)

dependencies {
    modImplementation 'dev.isxander:yet-another-config-lib:(modversion)+(mcversion)-(loader)'
    // for example...
    modImplementation 'dev.isxander:yet-another-config-lib:3.4.0+1.20.4-fabric'
}

Replace (latest) with the latest version of YACL available for the target Minecraft version. You can find this on Modrinth.

Finally, you should also add the dependency in your fabric.mod.json so Fabric will crash elegantly, giving the user a clear description of what they need to do.

Fabric Dependency

fabric.mod.json

"dependencies": {
  "yet_another_config_lib_v3": "*"
}

Forge Dependency

mods.toml

[[dependencies.modid]]
modId = "yet_another_config_lib_v3"
mandatory = true
versionRange = "[,)"
ordering = "NONE"
side = "CLIENT"