Wiki 9Minecraft Wiki 9Minecraft

Cloth Config API Wiki & Guide

Guides 4FAQ 17Related mods 48

A client-side configuration library that provides a settings screen framework for other mods, adding no items or blocks of its own.

DownloadCloth Config API

Get the files on 9Minecraft

Contents (6)
  1. Overview
  2. Overview
  3. Guides
  4. Frequently asked questions
  5. Gallery
  6. You May Also Like

Overview

Cloth Config API is a technical mod and developer library that serves as a dependency for hundreds of other Minecraft mods. Its primary purpose is to provide a unified, aesthetically pleasing configuration screen that allows players to modify mod settings directly from within the game's main menu or the ModMenu interface, rather than manually editing .json, .toml, or .conf files in a text editor.

While Cloth Config is primarily client-sided (as it handles the Graphical User Interface), it includes robust backend systems for data serialization and synchronization. It is widely considered the industry standard for configuration screens due to its support for complex data types, smooth scrolling, and deep integration with the Fabric and Forge ecosystems.

Guides

Step-by-step, in-game.

Editing a Cloth Config Mod's Settings File by HandCloth Config screens write to a config file, and you can edit that file directly when a mod has no in-game screen or…Fixing a Cloth Config Screen That Won't Save or CrashesA config screen that refuses to save, resets on restart, or crashes the game usually points to a bad value, a…How to Open and Use a Mod's Config Screen (Cloth Config)Cloth Config doesn't add its own menu button. Instead, it gives other mods a settings screen that you open through…Why a Mod's Config Screen Looks Different or Is MissingIf a mod that should have settings shows no config button, or the screen looks broken, the cause is almost always a…

Frequently asked questions

What does Cloth Config actually do?
It's a library that other mods use to build their in-game settings screens, so it adds no items, blocks, or settings of its own. If you installed it alone, you won't see anything new in-game until another mod depends on it.
How do I open a config screen that uses Cloth Config?
Open the mod list, find the mod whose settings you want to change, and click its config button. Many mods also add a keybind or a button on the main menu or pause menu that opens their Cloth Config screen directly.
Why can't I find Cloth Config in my mod list's config button?
Cloth Config itself has no settings to configure, so it usually has no config button of its own. Look for the config button on the mod that depends on Cloth Config, not on Cloth Config itself.
Do I need Cloth Config installed on a server?
It's a client-side library, so it belongs in your client mods folder for the settings screens to render. Installing it on a server does nothing for players and won't fix a missing-screen problem on their clients.

See all 17 Cloth Config API questions ›