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 integration into existing code
• Support for multiple configs
• Nested class resolution - easily create a POJO structure
• Listeners - observe your config entries
• User-friendly save format
• Commentable files - comments are retained permanently
• Configurable GUI generation
• Extensible via extension system

Setup

To use the library, first add the JitPack repository to your build.gradle file:

repositories {
    [...]
    maven { url 'https://jitpack.io' }
}

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.