Startseite Erkunden Hilfe
Anmelden
noah
/
CompleteConfig
1
0
Fork 0
Dateien Issues 0 Pull-Requests 0 Wiki

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

Struktur: 78cd1ae662
Branches Tags
CompleteConfig
ZIP TAR.GZ
Lortseam 78cd1ae662 Fix exception messages vor 4 Jahren
gradle 46c9e9da2a GSON -> Configurate refactor vor 4 Jahren
src 78cd1ae662 Fix exception messages vor 4 Jahren
.gitignore 064b496a76 Update to Minecraft 1.16.2 vor 4 Jahren
LICENSE 8251e1d119 Added license vor 5 Jahren
README.md d1e08cfdc7 Update README vor 4 Jahren
build.gradle af3848c136 Update Cloth Config dependency vor 4 Jahren
gradle.properties af3848c136 Update Cloth Config dependency vor 4 Jahren
gradlew 46c9e9da2a GSON -> Configurate refactor vor 4 Jahren
gradlew.bat 46c9e9da2a GSON -> Configurate refactor vor 4 Jahren
lombok.config fac0ab0c86 Use the Lombok log annotation vor 4 Jahren
settings.gradle add061087e Minor changes and fixes vor 5 Jahren

README.md

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 grouped structure
  • Listeners - observe your config entries
  • User-friendly save format
  • Commentable files - comments are retained permanently
  • Customizable 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.