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

Lortseam aa0e66fb87 Fix field access of entry created from outside listener há 4 anos atrás
gradle 46c9e9da2a GSON -> Configurate refactor há 4 anos atrás
src aa0e66fb87 Fix field access of entry created from outside listener há 4 anos atrás
.gitignore 064b496a76 Update to Minecraft 1.16.2 há 4 anos atrás
LICENSE 8251e1d119 Added license há 5 anos atrás
README.md c4b6dbb16d Update README há 4 anos atrás
build.gradle 56982884d3 Tests há 4 anos atrás
gradle.properties 56982884d3 Tests há 4 anos atrás
gradlew 46c9e9da2a GSON -> Configurate refactor há 4 anos atrás
gradlew.bat 46c9e9da2a GSON -> Configurate refactor há 4 anos atrás
lombok.config fac0ab0c86 Use the Lombok log annotation há 4 anos atrás
settings.gradle add061087e Minor changes and fixes há 5 anos atrás

README.md

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 {
    [...]

    // The following lines add CompleteConfig and includes it in your mod's jar
    // Replace Tag with the current version you can find above
    modImplementation ("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")
}

Usage

See the wiki for usage instructions.

License

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