Home

Welcome Mod Dev! Lets get your Fzzy Config system up and running. Guides in this wiki will cover two basic cases: Minimal Effort and Above and Beyond. Feel free to take whatever route suits your needs!

Starting Fresh

Creating a new mod and using Fzzy Config from the start? Thank you for choosing Fzzy Config! Take a trip to the New Configs guide for the step-by-step proceses.

New Configs

Switching from Another Lib

Making the leap from another config lib to this one? Welcome aboard! Check out the Existing Configs guide for the steps you'll need to integrate your existing system into Fzzy Configs.

Existing Configs

Depending on Fzzy Config

Add the following to your build script to depend on Fzzy Config:

Repositories section

// Kotlin
maven {
    name = "Modrinth"
    url = uri("https://api.modrinth.com/maven")
    content {
        includeGroup("maven.modrinth")
    }
}

// java
maven {
    name = "Modrinth"
    url = "https://api.modrinth.com/maven"
    content {
        includeGroup "maven.modrinth"
    }
}

Dependencies section:

// kotlin
val fzzyConfigVersion: String by project //define this in your gradle.properties file
modImplementation("maven.modrinth:fzzy-config:$fzzyConfigVersion")

// java
modImplementation "maven.modrinth:fzzy-config:${project.fzzyConfigVersion}"

Documentation

Check out the projects API documentation for detailed overviews of all classes, methods, and so on.

Further Help

Stuck? Drop a line in my Discord server and I will help you out.