Modrinth Β· Fabric, Forge, NeoForge Β· Client mod

Konfig

Konfig is a client-side mod. Install it on your computer; the server does not need it.

Ergonomic multiloader configuration library with sync support.

Downloads
347.7K
Author
iamkaf
Loader
Fabric, Forge, NeoForge
Minecraft
1.14.4 – 26.3
Updated
–

Setup

Install Konfig on your client

Client-side mods only run on your computer. More server RAM does not change their performance.

  1. 01

    Install the loader locally

    Install Fabric or Forge or NeoForge for your Minecraft version in your launcher.

  2. 02

    Download the file

    Download the Konfig file for your loader and your exact Minecraft version, for example 26.3.

  3. 03

    Add it to the mods folder

    Put the .jar file in your local .minecraft/mods folder and remove older duplicates.

  4. 04

    Launch

    Launch Minecraft with the loader profile. Nothing needs to change on the server.

On the server
Unknown
On the client
Unknown
Loader
Fabric, Forge, NeoForge
Minecraft
26.3, 26.2, 26.1.2 +41 more
License
MIT License

Releases

Published releases

Pick the file that matches your server’s loader and Minecraft version. The server and players need the same release.

Konfig Β· Modrinth
Original description by the project author

Konfig

Konfig is a multiloader configuration library for Minecraft mods.

It lets mods declare typed config values in common code, save them as commented TOML, sync selected values to clients, and generate config screens for Fabric, Forge, and NeoForge.

Konfig is built for shared common code. Loader-specific integration stays in the loader roots, while config declaration, validation, migration, sync metadata, and screen metadata can live beside the rest of your mod logic.

What You Get

  • Typed config values for booleans, numbers, enums, strings, string lists, RGB/ARGB colors, and custom codecs
  • Side-aware config scopes: CLIENT, COMMON, and SERVER
  • Commented TOML files at config/<modid>/<name>.toml
  • Built-in sync modes: NONE, LOGIN, and LOGIN_AND_RELOAD
  • Schema versioning and step-by-step migrations
  • Generated config screens for registered handles
  • Inline screen decorations: headers, images, descriptive text, and clickable URLs
  • Explicit tooltips for generated screen rows
  • Rich hover info panels for global, category, and value-specific help
  • Fabric Mod Menu integration
  • Forge and NeoForge config button helpers

Pics

Konfig overview with inline documentation and info panel

Konfig boolean, enum, and number controls

Konfig registry-backed string and color controls

Konfig string list controls with registry icons

Konfig registry-backed string list editor

Konfig ARGB color editor with channel sliders

Supported Versions

Konfig 0.4.0 supports every Minecraft line from 1.14.4 through 26.2.

  • Fabric starts at 1.14.4
  • Forge starts at 1.16.5
  • NeoForge starts at 1.21.1

Konfig uses one semantic release across supported Minecraft lines. The +<mc> suffix tells you which Minecraft version the artifact targets, for example 0.4.0+1.21.11 or 0.4.0+26.2.

Quick Example

import com.iamkaf.konfig.api.v1.ConfigBuilder;
import com.iamkaf.konfig.api.v1.ConfigHandle;
import com.iamkaf.konfig.api.v1.ConfigScope;
import com.iamkaf.konfig.api.v1.ConfigValue;
import com.iamkaf.konfig.api.v1.Konfig;
import com.iamkaf.konfig.api.v1.RestartRequirement;
import com.iamkaf.konfig.api.v1.SyncMode;

public final class ExampleConfig {
    public static final ConfigHandle HANDLE;
    public static final ConfigValue<Boolean> ENABLED;
    public static final ConfigValue<Integer> RANGE;

    static {
        ConfigBuilder builder = Konfig.builder("examplemod", "common")
                .scope(ConfigScope.COMMON)
                .syncMode(SyncMode.LOGIN)
                .comment("Example mod config")
                .info(info -> info
                        .header("Example Mod")
                        .inlineText("These settings control shared gameplay behavior.")
                        .url("Documentation", "https://example.invalid/docs"));

        builder.header("Example Mod Settings");
        builder.inlineText("These entries are saved automatically.");
        builder.url("Documentation", "https://example.invalid/docs");

        builder.push("general");
        builder.categoryComment("General gameplay tuning");
        builder.categoryTooltip("General gameplay tuning");
        builder.categoryInfo(info -> info
                .header("General")
                .inlineText("Values in this section affect the whole mod."));

        ENABLED = builder.bool("enabled", true)
                .comment("Master toggle")
                .tooltip("Enable example mod features")
                .sync(true)
                .info(info -> info
                        .header("Master Toggle")
                        .inlineText("Turns the main feature set on or off."))
                .build();

        RANGE = builder.intRange("range", 8, 1, 64)
                .comment("Effect radius")
                .tooltip("Controls the effect radius in blocks")
                .sync(true)
                .restart(RestartRequirement.WORLD)
                .build();

        builder.pop();
        HANDLE = builder.build();
    }
}

Use ConfigValue#get() when reading a value and ConfigValue#set(value) when changing it programmatically.

Comments are written to TOML. Generated-screen hover text is explicit through tooltip(...) and richer info(...) content, so your config files and UI help can say different things when needed.

Dependencies

Add the Kaf Maven repository:

repositories {
    maven { url = "https://maven.kaf.sh" }
}

Use the loader artifact for the Minecraft line you target:

modImplementation "com.iamkaf.konfig:konfig-fabric:<version>"
modImplementation "com.iamkaf.konfig:konfig-forge:<version>"
modImplementation "com.iamkaf.konfig:konfig-neoforge:<version>"

Do not depend on Konfig common directly. Use the loader-specific artifact.

Help Translate Konfig

Want to help translate this mod into your language? Join the community translation project:

Contribute translations

πŸ‡ΊπŸ‡Έ πŸ‡ͺπŸ‡Έ πŸ‡§πŸ‡· πŸ‡«πŸ‡· πŸ‡©πŸ‡ͺ πŸ‡·πŸ‡Ί πŸ‡ΉπŸ‡· πŸ‡―πŸ‡΅ πŸ‡°πŸ‡· πŸ‡¨πŸ‡³

Q&A

Q: Where can I ask something that is not listed here?

A: Make an issue here or join the Discord and shoot me a message.

Q: Can you port it to [MC version/Mod loader]?

A: If enough people request it I'll give it some time, but this really is a 1-man team so it might take a while.

Q: Can I include it in my modpack?

A: Yes, no need to give credit or ask.

Join our Discord

More mods by me

Bonded
Bonded
Kaf's Valentine Special
Kaf's Valentine Special
Liteminer
Liteminer
Mochila
Mochila
Torch Toss
Torch Toss

FAQ

Konfig questions

Question not listed? Ask our team.

Does Konfig need to be installed on the Minecraft server?

No. Modrinth marks Konfig as unsupported on the server side. Install it only in your local mods folder. Your server can stay unchanged unless the project page lists an additional dependency.

Which version and loader does Konfig require?

Use a file for Fabric, Forge, NeoForge and your exact Minecraft version. Supported versions include 26.3, 26.2, 26.1.2. Files for different loaders are not interchangeable.

Konfig is not working – what should I check?

First check the Minecraft version, loader version and required dependencies. Because the mod is client-side, more server RAM will not fix it.

Looking for mods for your own server?

The catalog lists mods that run on Minecraft servers.

Browse all mods