Cloth Config API is a config screen API for Minecraft mods that can be used to create a wide variety of configuration screens. Mod devs can use it to create better and more user-friendly configuration screens for mods.
What can this mod do?
- Create simple text boxes for users to input values.
- Create complex GUIs with multiple tabs and sections.
- Validate configuration values to ensure that they are valid.
- Provide help text to explain what each configuration value does.
- Create custom widgets to display information in a creative way.
Requirements
Before you proceed to install this mod, there are a few things you must check. If any of these requirements are missing make sure to install/update them.
- The latest iteration of Java Runtime Environment (JRE) should be installed.
- Minecraft v1.20 is a must. For older versions of Minecraft make sure that the mod’s version matches the version for Minecraft.
- Ensure you have the latest version of Forge and Fabric Loader installed.
- Fabric API’s latest version for Minecraft v1.20 must also be installed if you plan on installing it with Fabric Loader.
How to Download & Install Cloth Config API
Cloth Config API download and installation is just like installing any other Java-based mod in Minecraft. Follow these simple steps to do it:
- Ensure Java and Forge/Fabric are installed and updated, depending on whichever mod loader you’re using.
- Download the mod and you should see either the “cloth-config-11.0.99-fabric.jar“ or “cloth-config-11.0.99-forge.jar“ file, whichever mod loader you downloaded the mod for.
- Go ahead and move the file into the mods folder in the Minecraft installation folder. The installation folder location can be different depending on where you installed the game. By default, it is located in: “Local Disk (C:) > Users > (Your PC Name) > AppData > Roaming > .minecraft > mods”.
Features
- Improve Your Mod’s User Experience: A well-designed configuration screen makes it easier for users to customize your mod according to their own preferences.
- Avoid Bugs: A well-written configuration screen can help you avoid bugs by ensuring that users are entering valid values.
- Easy to use: It is very easy to use for mod authors. It provides a simple API that can be used to create configuration screens with just a few lines of code.
- Flexible: It allows mod authors to create a wide variety of configuration screens, from simple text boxes to complex GUIs.
- Actively Maintained & Updated: The mod is regularly updated to match Minecraft’s latest version.
- Free & Open Source: It is a free and open source mod meaning both devs and users can use it free of charge and modify it according to their liking.
- Used by Many Mods: Many mod devs use this mod to modify their mod’s configuration screen. So there’s a higher chance of compatibility for the mods you’re running with it.
How to Use Cloth Config API (Devs Only)
To use it, mod authors first need to create a configuration file for their mod. This file can be in JSON or YAML format. Once the configuration file is created, mod authors can use it to create a configuration screen for their mod.
Frequently Asked Questions
Isn’t Cloth Config client-sided only?
Yes, Cloth Config is client-side only. However, Cloth Config is only a config screen API, not actually a full configuration API. You can simply ignore Cloth Config when you are on the client, or you can ask the server to send the client a copy of the config and sync it over when the user saves from Cloth Config.
– Shedaniel
Are you still maintaining Cloth / Auto-Config?
Yes, but only to fix bugs and update it to new Minecraft versions. I tend to maintain support for a long time. Cloth / Auto Config is unlikely to receive new features.
– Shedaniel
