CompleteConfig

CompleteConfig

CompleteConfig is a flexible, all-in-one configuration API for Fabric mods.
Because of its object-oriented and annotation-based system, it is very easy to integrate the library into your mod.

Features

• Creating, grouping and observing config entries
• Building a customizable GUI
• File saving and loading

Setup

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

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

Then add CompleteConfig as dependency:

dependencies {
    [...]

    // This adds CompleteConfig and includes it in your mod's jar, so users don't have to install it
    // Replace Tag with the current version you can find above
    modApi 'com.gitlab.Lortseam:completeconfig:Tag'
    include 'com.gitlab.Lortseam:completeconfig:Tag'
    
    // This bundles Cloth Config in your mod's jar
    // Only required if you want to display a GUI based on your mod's config and don't provide your own GUI generation
    // Replace Version with the current version
    include 'me.shedaniel.cloth:config-2:Version'

    // Recommended: Adds Mod Menu to your game, so you can easily open and check your config GUI (see the Mod Menu documentation for more information)
    // Replace Version with current version
    modImplementation 'io.github.prospector:modmenu:Version'
}

Usage

See the wiki for usage instructions.

License

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