CompleteConfig

CompleteConfig

CompleteConfig is a flexible, all-in-one configuration API for Fabric mods.

Highlights

Beside the basic elements of a config library, CompleteConfig offers the following unique features:

• Simple and fast integration into existing code
• Multiple configs support
• Nested class resolution
• Listeners
• User-friendly save format
• Permanently retained comments
• Customizable config screen (GUI) generation
• Automatic Mod Menu integration
• Fully extensible via extension system

Setup

To use the library, first add the required repositories to your build.gradle file:

repositories {
    [...]
    maven {
        url 'https://jitpack.io'
    }
    maven {
        url "https://maven.shedaniel.me/"
    }
    maven {
        url "https://maven.terraformersmc.com/"
    }
}

Then add CompleteConfig to the dependencies:

dependencies {
    [...]
    
    // Replace Tag with the current version you can find above
    modImplementation("com.gitlab.Lortseam:completeconfig:Tag")
    // Optional: Bundles the library within the mod's jar file, so users don't have to download it seperately
    include("com.gitlab.Lortseam:completeconfig:Tag")
}

Usage

Usage instructions can be found in the wiki.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.