Configuration Library for Minecraft Mods
What is Cloth Config API?
Cloth Config API is a powerful configuration screen API designed specifically for Minecraft mods. This tool streamlines the process of adding customizable settings to your mods by providing a user-friendly graphical interface. Instead of editing configuration files directly, players and mod developers can conveniently adjust a wide range of mod options from within the game’s menus.
Main Features of Cloth Config API
- Seamless Integration: Quickly add intuitive configuration screens to your mods with minimal setup.
- Flexible Options: Supports a wide variety of setting types, such as toggles, sliders, input fields, lists, and more.
- Customizable Layouts: Allows mod authors to tailor the appearance and arrangement of configuration options to best suit their mod.
- Automatic Saving: Ensures user changes are saved and applied immediately without manual file editing.
- Compatibility: Works smoothly with many other mod frameworks, making it a popular choice in the Minecraft modding community.
How to Use Cloth Config API
- Add the Cloth Config API library as a dependency in your mod project.
- Define your configuration options using the provided API methods.
- Implement a config screen and register it, so players can access it easily within Minecraft’s menu system.
- Distribute your mod with the Cloth Config API included or as a required dependency, ensuring users have access to the full configuration experience.
Summary
For mod developers seeking an efficient way to offer in-game configuration, Cloth Config API is an essential resource. Its straightforward approach and robust features can greatly enhance the customizability and usability of any Minecraft mod.
Screenshots


- If you don’t know how to use Minecraft Mods, please click to view the Mods usage tutorial.