Unnamed Common Library (UCL)

Add the repository to your build.gradle(.kts):

repositories {

maven {

url = "https://maven.pkg.github.com/aurorarissime/unnamed-common-library"

}

}

And in your buildscript, add the dependency (modImplementation for Fabric, implementation for NeoForge):

dependencies {

(mod)Implementation("from.discorde:ucl:${ucl_version}+${minecraft_version}-fabric")

}

1. Create your configuration model

MyModConfig.java

import from.discorde.ucl.common.config.annotations.*;
@Configuration(

name = "mymod"

)

public class MyModConfig {

@Comment("Enable the awesome feature")

public boolean awesomeFeature = true;
@Comment("Maximum power level (0-100)")

public int maxPower = 50;
@Comment("Welcome message displayed to players")

public String welcomeMessage = "Hello!";

}

2. Load the configuration in your mod initialiser

MyMod.java

public class MyMod implements ModInitializer {

// The wrapper class is auto-generated at compile time

public static final MyModConfigWrapper CONFIG = MyModConfigWrapper.createAndLoad();
@Override

public void onInitialize() {

if (CONFIG.awesomeFeature) {

System.out.println("Awesome feature is enabled!");

}

}

}

Annotations

@Configuration

Add this annotation right above your config class

| Parameter | Type | Default | Description |
|————|————————-|—————-|—————————–|
| name | String | required | Config file or folder name |
| location | ConfigurationLocation | SUBDIRECTORY | Where to save the config |
| format | ConfigurationFormat | JSON5 | File format to use |
| screen | boolean | true | Generate YACL config screen |

@Comment

Add this annotation above any field to include a comment in the config file

@Comment("This comment will appear above the field in the config file")

public boolean myOption = true;

Enums

ConfigurationLocation

| Value | Description |
|—————-|——————————————————|
| ROOT | Save directly in the config folder as {name}.{ext} |
| SUBDIRECTORY | Save in a subfolder as {name}/configuration.{ext} |

ConfigurationFormat

| Value | Extension | Description |
|———|———–|——————————————————–|
| JSON5 | .json5 | JSON with comments, trailing commas, and unquoted keys |
| TOML | .toml | Tom’s Obvious Minimal Language |
| YAML | .yaml | YAML Ain’t Markup Language |

If screen = true (default) in your @Configuration annotation and YetAnotherConfigLib (YACL) is installed, a configuration screen will be auto-generated and accessible through Mod Menu.
To disable the config screen, just set the screen parameter to false in the @Configuration annotation.