# 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 {EXAMPLE_CONFIG} Config passed in, this automatically adds it to the Config public static final ConfigValue EXAMPLE_FLOAT = new ConfigValue<>(10f, "exampleFloat", EXAMPLE_CONFIG, new TypeToken(){}.getType()); ///Comments are placed in order of declaration, so this comment will be below {EXAMPLE_FLOAT} and above {EXAMPLE_LIST} public static final ConfigComment EXAMPLE_COMMENT = new ConfigComment("This is a list!", EXAMPLE_CONFIG); public static final ConfigValue> EXAMPLE_LIST = new ConfigValue<>(List.of("value1", "value2", "value3", "value4"), "exampleList", EXAMPLE_CONFIG, new TypeToken>(){}.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> EXAMPLE_VEC3 = new ConfigValue<>(List.of(new Vec3(123,123,123), Vec3.ZERO), "exampleVec3", EXAMPLE_CONFIG, new TypeToken>(){}.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> EXAMPLE = new ConfigValue<>(new LinkedHashMap<>(Map.of("information", new Info(1.0f, false, 8))), "example", EXAMPLE_CONFIG, new TypeToken>(){}.getType()); ///This method must be called in your mod's Main class /// /// You will need to call the {register()} method on the {Config} you declared /// and add any {ConfigValue} 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) { } } ```