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: 7c13904025
Branches Tags
CompleteConfig
ZIP TAR.GZ
Lortseam 7c13904025 Code improvement vor 4 Jahren
example b3177056f5 Remove unnecessary annotations in example mod vor 4 Jahren
gradle 5ba8984b17 Update dependencies vor 4 Jahren
lib 7c13904025 Code improvement vor 4 Jahren
.gitignore 8b02034674 Ignore default run directory vor 4 Jahren
LICENSE 8251e1d119 Added license vor 5 Jahren
README.md 2814ca6998 Add missing repositories to README vor 4 Jahren
build.gradle 5ba8984b17 Update dependencies vor 4 Jahren
gradle.properties 90b4565c12 Bump version 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 b5757c0d72 Create multi-project structure vor 4 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 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.