Back to mods
JasonConfig project artwork

Modrinth · Minecraft mod

JasonConfig

Simple config API that uses the JSON data structure

Choose a version Pick your version below, then grab the matching file.

Quick answer

Which JasonConfig release matches 1.20.6 Forge?

Updated 1 year ago
Best match for your filters 1.1.1
Game version 1.20.1, 1.20.2, 1.20.3
Loader Forge

JasonConfig 1.1.1 targets 1.20.1, 1.20.2, 1.20.3 with Forge. Installation on the client is optional. Installation on the dedicated server is optional. No extra mods listed for this file.

Where it goes

Is JasonConfig required on the client, server, or both?

Installation on the client is optional. Installation on the dedicated server is optional.

Client Optional
Dedicated server Optional
Loader for this release Forge
Required install it here Optional supported, not mandatory Not supported do not install here Source doesn’t say do not assume

The source marks this as usable on both the client and server.

What else does JasonConfig 1.1.1 need?

1.1.1 on 1.20.6 Forge. Every mod below is checked against that same setup.

No extra mods listed for this file

This file does not list any required mods. Do not add a library just because a different file uses it.

This file does not list any required or optional mods.

Before you install it

Add JasonConfig without breaking your instance.

Built for JasonConfig 1.1.1 on 1.20.6 Forge. Pick another file and the loader, install side or required mods may change.

  1. 01

    Stick to this file

    Use 1.1.1. It targets 1.20.1, 1.20.2, 1.20.3 with Forge; another release may have different loader, side or dependency requirements.

  2. 02

    Bring the mods it needs

    This file does not list any required mods. Do not add a library just because a different file uses it.

  3. 03

    Put it on the correct side

    Installation on the client is optional. Installation on the dedicated server is optional.

  4. 04

    Pick the file you checked

    Use the “Get this file” button beside 1.1.1. It opens that exact file at the source.

About this project

What does JasonConfig add?

This is a LIBRARY mod, if you are a user just INSTALL it, do not read below!

For Developers ---

Adding the dependancy [
Just use CurseMaven, the repository for that is here, https://www.cursemaven.com/
Add the dependency using the snippet in the needed version in Files
example (not the right mod)
implementation "curse.maven:cloth-config-348521:5987045"
]

Pros and Cons vs Forge's config

-Pros ----------------------------------

Uses JSON instead of TOML, making it more reliable (For example, Forge Configs do not easily support empty lists and can break when using them)
Compatible with reading and writing many more Java / Minecraft classes than Forge configs (For example, Vec3 cannot be written or read to a forge config, JasonConfig has no issues with it because of JSON objects)
Simpler to write in code while still being similar to how you create Forge config classes (see below)

-Cons ----------------------------------

Slightly less user readable because its in JSON format
Experimental, while I haven't found bugs yet I'm sure some will come, I'm only one guy after all

Example Config (Can also be found in the "api" package of the mod once you add it to your dependencies)

Everything you need in the "api" package is well documented and should be referred to

public class ExampleConfigClass {
    public static final Config EXAMPLE_CONFIG = new Config(MODID + "-example_config");

    public static final ConfigComment DEVCOMMENT
            = new ConfigComment("This file is only generated in a Dev environment", EXAMPLE_CONFIG);

    ///The following config values are called with the {<code>EXAMPLE_CONFIG</code>} Config passed in, this automatically adds it to the Config
    public static final ConfigValue<Float> EXAMPLE_FLOAT
            = new ConfigValue<>(10f, "exampleFloat", EXAMPLE_CONFIG, new TypeToken<Float>(){}.getType());
    ///Comments are placed in order of declaration, so this comment will be below {<code>EXAMPLE_FLOAT</code>} and above {<code>EXAMPLE_LIST</code>}
    public static final ConfigComment EXAMPLE_COMMENT
            = new ConfigComment("This is a list!", EXAMPLE_CONFIG);
    public static final ConfigValue<List<String>> EXAMPLE_LIST
            = new ConfigValue<>(List.of("value1", "value2", "value3", "value4"), "exampleList", EXAMPLE_CONFIG, new TypeToken<List<String>>(){}.getType());
    public static final ConfigComment VEC3_COMMENT
            = new ConfigComment("This is a Vec3! Many Java classes that don't work in Forge configs will work here!", EXAMPLE_CONFIG);
    public static final ConfigValue<List<Vec3>> EXAMPLE_VEC3
            = new ConfigValue<>(List.of(new Vec3(123,123,123), Vec3.ZERO), "exampleVec3", EXAMPLE_CONFIG, new TypeToken<List<Vec3>>(){}.getType());
    public static final ConfigComment CLASS_COMMENT
            = new ConfigComment("This is a newly created class, records are the best way to hold data like this", EXAMPLE_CONFIG);
    public static final ConfigValue<LinkedHashMap<String, Info>> EXAMPLE
            = new ConfigValue<>(new LinkedHashMap<>(Map.of("information", new Info(1.0f, false, 8))), "example", EXAMPLE_CONFIG, new TypeToken<LinkedHashMap<String, Info>>(){}.getType());

    ///This method must be called in your mod's Main class
    ///
    /// You will need to call the {<code>register()</code>} method on the {<code>Config</code>} you declared
    /// and add any {<code>ConfigValue<?></></code>} variables you created if you did not assign them in the constructor
    public static void init()/* This method can be called anything, init(), register(), etc*/ {
        EXAMPLE_CONFIG.register();

        ///EXAMPLES OF GRABBING VALUES
        //EXPLICIT (Very similar to Forge's Config)
    }

    public record Info(float f, boolean bool, int integer) { }
}

Project description from Modrinth.

Pick your setup

JasonConfig by Minecraft version and loader

Choose the version and loader you play, then open the matching release.

6 available setups

Check the dependencies, then try the file in a copied instance before changing a world you care about.

Recent files

JasonConfig versions and loaders

1 of 2 releases match
Clear filters

Looking for an older file? The official Modrinth project page is in Resources.