MidnightLib

`midnight-lib`

Dependencies: Fabric API

Manual initialization: Yes

Config method: an extending class with annotated static members
Examples: `@Comment("This is a string list") List<String>@Config int@Config File`

Extra config type(s) supported: File

Ui method: Automatic

Available for versions: 1.17.x, 1.18.x, 1.19.x, 1.20.x, 1.21.x, 26.1.x, 26.2.x

Example config

Show/hide

public class ConfigClass extends MidnightConfig {
	@Entry(category = "Example category") public static boolean exampleBoolean = false;
}

Client

Server

Ui

Loader

Slider

Mod menu integration

Modrinth View entry Source code

McQoy

`mcqoy`

Dependencies: Mod Menu, Yacl

Manual initialization: n/a

Ui method: Automatic

Available for versions: 1.16.5, 1.17.x, 1.18.x, 1.19.x, 1.20.x, 1.21.x, 26.1.x

Notes:

Makes a YACL config screen for kaleido configs

Client

Ui

Mod menu integration

Modrinth View entry Source code

YAML Config

`yaml-config`

Dependencies: UI Lib

Manual initialization: Yes

Config method: a normal class with static members, typed using builder methods
Examples: `builder.push()builder.defineBoolean()builder.defineString()`

Extra config type(s) supported: Identifier, Registry entry, Date Time

Ui method: Automatic

Available for versions: 1.21, 1.21.1, 1.21.5, 1.21.6, 1.21.7, 1.21.8, 1.21.9, 1.21.11, 26.1.x, 26.2.x

Example config

Show/hide

None yet! Contribute by providing an example here.

Client

Server

Ui

Loader

Custom config types

Constraint

Yaml

Json5

Toml

Hocon

Modrinth View entry Source code

ukulib

`ukulib`

Manual initialization: Yes

Config method: an extending class with instance members, of primitive types
Examples: `FileintList<String>`

Extra config type(s) supported: Color, Button

Ui method: Builder

Available for versions: 1.14.4, 1.15.2, 1.16.5, 1.17.1, 1.18.2, 1.19, 1.19.2, 1.19.3, 1.19.4, 1.20.x, 1.21.x, 26.1.x, 26.2.x

Example config

Show/hide

public class ConfigClass implements Serializable {
	public boolean exampleBoolean = false;
}

Client

Ui

Loader

Slider

Json

Toml

Modrinth View entry Source code

Cryonic Config

`cryonic-config`

Manual initialization: At mod initialization

Config method: a normal class with instance members, of primitive types
Examples: `FileintList<String>`

Available for versions: 1.18.x, 1.19.x, 1.20.x, 1.21.x, 26.1.x, 26.2.x

Example config

Show/hide

public class ConfigClass {
	static final ConfigStorage config = CryonicConfig.getConfig("mod_id");

	public static boolean getExampleBoolean() {
		config.getBoolean("exampleBoolean", false);
	}
}

Client

Server

Loader

Json

Modrinth View entry Source code

CompleteConfig

`complete-config`

Manual initialization: Yes

Config method: an extending class with annotated instance members
Examples: `@Comment("This is a string list") List<String>@Config int@Config File`

Ui method: Builder

Available for versions: 1.20.6, 1.20.4, 1.20.3, 1.20.2, 1.20.1, 1.20, 1.19.4.x, 1.18.2.x, 1.17.1, 1.17

Example config

Show/hide

@ConfigEntries(includeAll = true)
public class ConfigClass extends Config {
	public ConfigClass() {
		super(ConfigOptions
				.mod("complete-config-example")
				.fileHeader("This is an example config")
		);
	}

	private boolean exampleBoolean;
}

Client

Server

Ui

Loader

Custom config types

Config section

Json

View entry Source code

OneConfig

`oneconfig`

Dependencies: Fabric Language Kotlin

Manual initialization: At mod initialization

Config method: an extending class with annotated static members
Examples: `@Comment("This is a string list") List<String>@Config int@Config File`

Extra config type(s) supported: Button, Hotkey, Color

Ui method: Automatic

Available for versions: 1.21.1, 1.21.4, 1.21.5, 1.21.8, 1.21.10, 1.21.11, 26.1.x, 26.2.x

Notes:

Currently in beta

Example config

Show/hide

public class TestConfig extends Config {
	public static TestConfig INSTANCE = new TestConfig();

	@Checkbox(title = "checkbox", description = "I do checkboxes", category = "bob")
	public static boolean checkbox = false;
	@Slider(title = "Slide", min = 10f, max = 110f, icon = "assets/oneconfig/ico/paintbrush.svg", description = "I do sliding", category = "bob")
	public static float p = 50f;
	@Text(title = "Text")
	public static String text = "Hello world!";

	public TestConfig() {
		super("test_mod.json", "Test Mod", Category.QOL);
	}
}

Client

Ui

Loader

Slider

Custom config types

Config section

Json

Yaml

Toml

Modrinth View entry Source code

BetterConfig

`betterconfig`

Manual initialization: Yes

Config method: a normal class with annotated static members
Examples: `@Comment("This is a string list") List<String>@Config int@Config File`

Available for versions: 1.19.3, 1.19.4, 1.20, 1.20.1, 1.21

Example config

Show/hide

public class ConfigClass {
	@Config
	public static boolean exampleBoolean = false;
}

Client

Server

Loader

Custom config types

Modrinth View entry Source code

MaLiLib

`malilib`

Manual initialization: At mod initialization

Config method: an extending class with static members, typed with special classes
Examples: `ConfigDoubleConfigOptionListConfigInteger`

Extra config type(s) supported: Color, Hotkey

Ui method: Manual

Available for versions: 1.14, 1.14.2, 1.14.3, 1.14.4, 1.15.x, 1.16.x, 1.17.x, 1.18.x, 1.19.x, 1.20.x, 1.21.x, 26.1.x, 26.2.x

Notes:

Hard to set up

Example config

Show/hide

public class Configs implements IConfigHandler {
	private static final Path CONFIG_FILE = FabricLoader.getInstance().getConfigDir(CONFIG_FILE_NAME);
	public class ConfigClass {
		public static final ConfigBoolean EXAMPLE_BOOLEAN = new ConfigBoolean("Example boolean", false);
		public static final ImmutableList<IConfigBase> OPTIONS = ImmutableList.of(
				EXAMPLE_BOOLEAN
		);
	}

	@Override
	public void load() {
		if (Files.exists(CONFIG_FILE) && Files.isReadable(CONFIG_FILE)) {
			JsonElement element = JsonUtils.parseJsonFile(CONFIG_FILE);

			if (element != null && element.isJsonObject()) {
				JsonObject root = element.getAsJsonObject();

				ConfigUtils.readConfigBase(root, "main", Configs.ConfigClass.OPTIONS);
			}
		} else {
			System.err.println("load(): Failed to load config file " + CONFIG_FILE.toAbsolutePath());
		}
	}

	@Override
	public void save() {
		JsonObject root = new JsonObject();

		ConfigUtils.writeConfigBase(root, "main", Configs.ConfigClass.OPTIONS);

		JsonUtils.writeJsonToFile(root, CONFIG_FILE);
	}
}

Client

Ui

Loader

Slider

Json

Modrinth View entry Source code

Fzzy Config

`fzzy-config`

Dependencies: Fabric API, Fabric Language Kotlin

Manual initialization: Yes

Config method: an extending class with either annotated instance members, or instance members, Config<Integer>
Examples: `@Comment("This is a string list") List<String>@Config intConfig<List<String>>`

Ui method: Automatic

Available for versions: 1.20.1, 1.20.4, 1.20.5, 1.20.6, 1.21.x, 26.1.x, 26.2.x

Example config

Show/hide

public class ConfigClass extends Config {
	public MyConfig() {
		super(Identifier.of("fzzy-config-example", "example"));
	}

	public boolean exampleBoolean = false;
}

Client

Server

Ui

Loader

Config section

Json5

Toml

Json

JsonC

Modrinth View entry Source code

Gson

`gson`

Manual initialization: Yes

Config method: a normal class with instance members, of primitive types
Examples: `FileintList<String>`

Available for versions: 1.14.x, 1.15.x, 1.16.x, 1.17.x, 1.18.x, 1.19.x, 1.20.x, 1.21.x, 26.1.x, 26.2.x

Notes:

Not really a config library, but still useful for some

Example config

Show/hide

public class ConfigClass {
	public boolean exampleBoolean = false;

	// could be anywhere
	public static ConfigClass config = new ConfigClass();
	public static final Gson GSON = new GsonBuilder().setPrettyPrinting().create();
	public static final Path PATH = FabricLoader.getInstance().getConfigDir().resolve("gson-example");
	public static save() {
		try {
			Files.writeString(PATH, GSON.toJson(CONFIG));
		} catch (IOException e) {
			throw new RuntimeException(e);
		}
	}
	public static load() {
		try {
			CONFIG = GSON.fromJson(Files.readString(PATH));
		} catch (IOException e) {
			throw new RuntimeException(e);
		}
	}
}

Client

Server

Loader

Json

View entry Source code

ConfigToolKit

`configtoolkit`

Dependencies: Fabric API

Manual initialization: At mod initialization

Config method: a record class with instance members, of primitive types
Examples: `FileintList<String>`

Available for versions: 1.21.11.x, 1.20.6

Example config

Show/hide

@GenerateMutable(useFancyMethodNames = true)
public record ConfigClass(boolean exampleBoolean) implements MutableConfigClass.Source {
	public static final ConfigClass DEFAULT = new ConfigClass(false);
	public static final Codec<ConfigClass> CODEC = RecordCodecBuilder.create(instance -> instance.group(
			AlwaysSerializedOptionalFieldCodec.create(Codec.BOOL, "exampleBoolean", BarrelConfig.DEFAULT.exampleBoolean).forGetter(ConfigClass::exampleBoolean)
	).apply(instance, ConfigClass::new));
}

Client

Server

Loader

Codec based configs

Json

View entry Source code

AxolotlClientConfig

`axolotlclientconfig`

Dependencies: Fabric API

Manual initialization: At mod initialization

Config method: static or instance members, typed with special classes
Examples: `IntegerOptionStringArrayOptionBooleanOption`

Extra config type(s) supported: Color

Ui method: Automatic

Available for versions: 1.16.2, 1.16.3, 1.16.4, 1.16.5, 1.20.1, 1.21.1, 1.21.4, 1.21.5, 1.21.6, 1.21.7, 1.21.8, 1.21.10, 1.21.11, 26.1.x, 26.2.x

Notes:

Not all available Minecraft versions are actively maintained.

Custom config formats are possible.

Custom UI implementations are supported (partial & full).

Only the GUI depends on Minecraft, the common module is independent.

Supports graphical options (when used with Minecraft).

Annotation-based configs are possible with an add-on.

Example config

Show/hide

public class ExampleConfig {
	public final BooleanOption exampleBoolean = new BooleanOption("exampleBoolean", false);
	public ExampleConfig() {
		var configPath = FabricLoader.getInstance().getConfigDir().resolve("example-config.json");
		// create a root category. For automatic modmenu integration this must be named the same as your mod's modid.
		var exampleCategory = OptionCategory.of("example-category");
		exampleCategory.add(exampleBoolean);

		// versioned
		var currentVersion = 1;
		var configManager = new VersionedJsonConfigManager(configPath, exampleCategory, currentVersion,
			(oldVersion, newVersion, config, json) -> {
			// this lambda can be used to convert old config values into new ones
			});
		// unversioned
		//var configManager = new JsonConfigManager(configPath, exampleCategory);

		// register the config
		AxolotlClientConfig.register(configManager);
		// The config will not load automatically.
		// Similarly, you can also manually save the config using .save() but the GUI will do that
		// for you after an option is changed as well.
		configManager.load();
	}
}

Client

Ui

Loader

Automatic upgrading

Custom config types

Mod menu integration

Slider

Config section

Json

Modrinth View entry Source code

Forge Config API Port

`forge-config-api-port`

Manual initialization: Yes

Available for versions: 1.16.x, 1.17.x, 1.18.x, 1.19.x, 1.20, 1.20.1, 1.20.2, 1.20.4, 1.20.6, 1.21, 1.21.1, 1.21.3, 1.21.4, 1.21.5, 1.21.6, 1.21.7, 1.21.8, 1.21.9, 1.21.10, 1.21.11, 26.1.x, 26.2.x

Example config

Show/hide

None yet! Contribute by providing an example here.

Client

Server

Loader

Modrinth View entry Source code

Codec config API

`codec-config-api`

Manual initialization: Yes

Config method: an extending class with instance members, of primitive types
Examples: `FileintList<String>`

Available for versions: 26.1.2.x, 1.21.11.x, 1.20.6.x, 1.19.4, 1.19.3, 1.19.2, 1.19.1, 1.19

Example config

Show/hide

public record ExampleConfig(boolean exampleBoolean) implements ModConfig<ExampleConfig> {
	public static final MapCodec<ExampleConfig> TYPE_CODEC = RecordCodecBuilder.mapCodec(instance -> instance.group(
		Codec.BOOL.fieldOf("example_boolean").forGetter(ExampleConfig::exampleBoolean)
	).apply(instance, instance.stable(ExampleConfig::new)));

	public static final ModConfig.Type<ExampleConfig, ExampleConfig> TYPE = new ModConfig.Type<>(1, TYPE_CODEC);
	@SuppressWarnings("unchecked")
	public static final ModConfig.Type<ExampleConfig, ? extends ModConfig<ExampleConfig>>[] VERSIONS = new ModConfig.Type[] { TYPE, };
	public static final Codec<ModConfig<ExampleConfig>> CODEC = ModConfig.createCodec(TYPE.version(), version ->
		ModConfig.getConfigType(VERSIONS, version));

	public static final ExampleConfig DEFAULT = new ExampleConfig(true);

	@Override
	public Type<ExampleConfig, ?> type() {
		return TYPE;
	}

	@Override
	public ExampleConfig latest() {
		return this;
	}

	@Override
	public boolean shouldUpdate() {
		return true;
	}
}

Client

Server

Loader

Codec based configs

Automatic upgrading

Json

View entry Source code

Kaleido config

`kaleido-config`

Manual initialization: Yes

Config method: an extending class with annotated instance members
Examples: `@Comment("This is a string list") List<String>@Config int@Config File`

Available for versions: 1.14.x, 1.15.x, 1.16.x, 1.17.x, 1.18.x, 1.19.x, 1.20.x, 1.21.x, 26.1.x, 26.2.x

Notes:

Not made with minecraft in mind

Example config

Show/hide

public class ExampleModConfig extends ReflectiveConfig {
	public final TrackedValue<Boolean> exampleBoolean = this.value("Example boolean");
}

Client

Server

Loader

Toml

View entry Source code

Carbon Config

`carbon-config`

Manual initialization: Yes

Config method: a normal class with instance members, typed using builder methods
Examples: `section.addBool()section.addInt()section.addString()`

Ui method: None

Available for versions: 1.16.5, 1.18.2, 1.19.2, 1.20, 1.20.1, 1.20.2, 1.20.4, 1.20.5, 1.20.6, 1.21, 1.21.1

Example config

Show/hide

public class ConfigClass {
	public static ConfigHandler CONFIG;
	public static ConfigSection SECTION;
	public static BoolValue EXAMPLE_BOOLEAN;

	static {
		Config config = new Config("example");
		ConfigSection section = config.add("general");
		EXAMPLE_BOOLEAN = section.addBool("example_key", false);
		CONFIG = CarbonConfig.CONFIGS.createConfig(config);
		CONFIG.register();
	}
}

Client

Server

Ui

Loader

Custom config types

Mod menu integration

Json

Modrinth View entry Source code

QoMC

`qomc`

Dependencies: Fabric API

Manual initialization: No

Ui method: Commands

Available for versions: 1.16.x, 1.17.x, 1.18.x, 1.19.x, 1.20.x, 1.21.x, 26.1.x, 26.2.x

Notes:

Makes config commands for kaleido configs

Server

Ui

Modrinth View entry Source code

Cloth config

`cloth-config`

Manual initialization: n/a

Extra config type(s) supported: Color, Dropdown

Ui method: Builder

Available for versions: 1.14.x, 1.15.x, 1.16.x, 1.17.x, 1.18.x, 1.19.x, 1.20.x, 1.21.x, 26.1.x, 26.2.x

Client

Server

Ui

Mod menu integration

Modrinth View entry Source code

MonkeyLib538

`monkeylib538`

Dependencies: Fabric API, Text Placeholder API

Manual initialization: Yes

Ui method: Commands

Available for versions: 1.19.2, 1.19.3, 1.19.4, 1.20.x, 1.21.x, 26.1.x, 26.2.x

Server

Ui

Modrinth View entry Source code

Configuration

`configuration`

Manual initialization: Yes

Config method: an annotated class with annotated instance members
Examples: `@Comment("This is a string list") List<String>@Config int@Config File`

Ui method: Automatic

Available for versions: 1.16.5, 1.18.2, 1.19.2, 1.20.1, 1.21.x, 26.1.x, 26.2.x

Example config

Show/hide

@Config(id = "configuration-example")
public class ConfigClass {
	@Configurable
	public boolean exampleBoolean = false;
}

Client

Server

Ui

Loader

Custom config types

Constraint

Mod menu integration

Config section

Json

Yaml

.properties

.ini

Modrinth View entry Source code

OffsetUtils538

`offsetutils538`

Manual initialization: At mod initialization

Config method: an extending class with annotated instance members
Examples: `@Comment("This is a string list") List<String>@Config int@Config File`

Available for versions: 1.14.x, 1.15.x, 1.16.x, 1.17.x, 1.18.x, 1.19.x, 1.20.x, 1.21.x, 26.1.x, 26.2.x

Example config

Show/hide

public final class ConfigClass implements Config {
	public boolean exampleBoolean = false;

	@Override
	public Path getConfigDirPath() {
		return FabricLoader.getInstance().getConfigDir().resolve("offsetutils538-example");
	}

	@Override
	public String getId() {
		return "offsetutils538-example/main";
	}
}

Client

Server

Loader

Custom config types

Json

View entry Source code

oωo

`owo-lib`

Dependencies: Fabric API

Manual initialization: Yes

Config method: an annotated class with instance members, of primitive types
Examples: `FileintList<String>`

Ui method: Automatic

Available for versions: 1.17.x, 1.18.x, 1.19.x, 1.20.x, 1.21.x, 26.1.x, 26.2.x

Notes:

Comes with a lot of additional, sometimes problematic, features.

Example config

Show/hide

@Config(name = "owo-lib-example", wrapperName = "ConfigClass")
public class ConfigClassModel {
	public boolean exampleBoolean = false;
}

Client

Server

Ui

Loader

Constraint

Modrinth View entry Source code

YetAnotherConfigLib

`yacl`

Dependencies: Fabric API

Manual initialization: Yes

Config method: a normal class with annotated instance members
Examples: `@Comment("This is a string list") List<String>@Config int@Config File`

Extra config type(s) supported: Button, Color, Dropdown

Ui method: Builder

Available for versions: 1.19.x, 1.20.x, 1.21.x, 26.1.x, 26.2.x

Example config

Show/hide

public class ConfigClass {
	public static final ConfigClassHandler<ConfigClass> GSON = ConfigClassHandler.createBuilder(ConfigClass.class)
			.serializer(config -> GsonConfigSerializerBuilder.create(config)
					.setPath(YACLPlatform.getConfigDir().resolve("yacl-example.json"))
					.build())
			.build();

	@SerialEntry
	public boolean exampleBoolean = false;
}

Client

Server

Ui

Loader

Json

Json5

Modrinth View entry Source code

MaLiLib API

`malilib-api`

Dependencies: MaLiLib

Manual initialization: Optional

Config method: an annotated class with static members, typed with special classes
Examples: `ConfigList<ConfigString>ConfigCycleConfigInteger`

Extra config type(s) supported: Color, Hotkey, Pair, Button

Ui method: Automatic

Available for versions: 1.14.x, 1.15.x, 1.16.x, 1.17.x, 1.18.x, 1.19.x, 1.20.x, 1.21.x, 26.1.x, 26.2.x

Example config

Show/hide

@Config("malilib-api-example")
public class ConfigClass {
	public static final ConfigBooleanPlus EXAMPLE_BOOLEAN = new ConfigBooleanHotkeyedPlus("Example boolean");
}

Client

Ui

Loader

Slider

Custom config types

Mod menu integration

Config section

Json

Modrinth View entry Source code

Configurable

`configurable`

Dependencies: Fabric API

Manual initialization: No

Config method: annotated static members
Examples: `@Comment("This is a string list") List<String>@Config int@Config File`

Available for versions: 1.21.11.x, 1.20.1

Example config

Show/hide

/** Example comment */ @Configurable boolean exampleBoolean = false;

Versions

Reset filters

1.14

1.14

1.14.1

1.14.2

1.14.3

1.14.4

1.15

1.15

1.15.1

1.15.2

1.16

1.16

1.16.1

1.16.2

1.16.3

1.16.4

1.16.5

1.17

1.17

1.17.1

1.18

1.18

1.18.1

1.18.2

1.19

1.19

1.19.1

1.19.2

1.19.3

1.19.4

1.20

1.20

1.20.1

1.20.2

1.20.3

1.20.4

1.20.5

1.20.6

1.21

1.21

1.21.1

1.21.2

1.21.3

1.21.4

1.21.5

1.21.6

1.21.7

1.21.8

1.21.9

1.21.10

1.21.11

26.1

26.1

26.1.1

26.1.2

26.2

26.2

Side

Client

Server

Config types

Color

Hotkey

Dropdown

Button

File

Pair

Registry entry

Identifier

Date Time

Features

Slider

Constraint

Mod menu integration

Custom config types

Codec based configs

Config section

Automatic upgrading

Field kind
instance

static

Type of fields
Wrapper

Primitive

Builder

Special

Annotated primitive

`midnight-lib`

Config method: an extending class with annotated static members
Examples: `@Comment("This is a string list") List<String>@Config int@Config File`

`mcqoy`

`yaml-config`

Config method: a normal class with static members, typed using builder methods
Examples: `builder.push()builder.defineBoolean()builder.defineString()`