search

QuiltMC / quilt-config

Quilt Config (aka "haven king's metadata of madness") is a library designed to facilitate the creation and management of config files.
Apache License 2.0
21 stars 8 forks source link

readme

Quilt Config

Quilt Config is a library designed to facilitate the creation and management of config files.

Usage

Importing via Gradle

Quilt Config can be imported from the Quilt maven using the following code in your build.gradle:

repositories {
    // tell gradle where to find quilt config's artifacts
    maven { url = "https://maven.quiltmc.org/repository/release/" }
}

dependencies {
    // the main quilt config API. replace <version> with the latest version
    implementation("org.quiltmc:quilt-config:<version>")

    // optional: a serializer to use when saving and reading the config
    // you can omit this and implement your own serializer
    // replace <serializer> with either "json5" or "toml" and <version> with the latest version
    implementation("org.quiltmc.quilt-config.serializers:<serializer>:<version>")
}

Documentation

Quilt Config has extensive javadoc, as well as tutorials on the Quilt Wiki. We recommend going to the Getting Started tutorial to begin using out Quilt Config.