Skip to content

Setup

Jump to bottom
Lortseam edited this page Sep 26, 2023 · 13 revisions

First, add the required repositories to your build.gradle file:

repositories {
    [...]
    maven {
        url "https://oss.sonatype.org/content/repositories/snapshots"
    }
    maven {
        url "https://maven.terraformersmc.com/"
    }
    maven {
        url "https://maven.shedaniel.me/"
    }
    maven {
        url "https://maven.isxander.dev/releases"
    }
    maven {
        url "https://maven.quiltmc.org/repository/release"
    }
    maven {
        url "https://jitpack.io"
    }
}

CompleteConfig is split up into multiple modules. The base module contains the basic classes without GUI support. Add it to your dependencies like this:

dependencies {
    [...]
    
    // Replace Tag with the latest version
    modImplementation("com.github.Lortseam.completeconfig:base:Tag")
}

JitPack

GUI

To provide a config screen for your mod, you also need to add one of the following GUI modules:

Cloth Config

modImplementation("com.github.Lortseam.completeconfig:gui-cloth:Tag")

YetAnotherConfigLib

modImplementation("com.github.Lortseam.completeconfig:gui-yacl:Tag")

Note that users of your mod have to install CompleteConfig and optionally the GUI library (Cloth Config or YACL) by downloading them from Modrinth or CurseForge. Alternatively, you can bundle these libraries in your mod using include. This is not recommended though, as some of them are quite big in size.

NEXT: Quickstart

CompleteConfig Wiki

General

GUI

Advanced

Clone this wiki locally