Minecraft.How
Loading...
Skip to content

Cloth Config API

by shedaniel

Cloth Config API by shedaniel is a Java library that gives Fabric and Neoforge mods a unified framework to build in-game configuration screens.

Our summary

What this project does

what this mod is

Cloth Config API is a configuration library and config screen API built by shedaniel. It belongs to the libraries and APIs category for Java mods.

Mods in Minecraft often need options screens so players can change settings directly. This library gives mod authors the framework to build those configuration screens. You get a standardized way to handle user settings without writing interface code from scratch.

It's a backend tool. You don't interact with it directly as a standalone game feature. It doesn't add blocks, items, or gameplay changes on its own. Instead, other mods use it when they need configuration screens.

who it's for

This project targets two main groups.

First, mod developers who want config screens in their projects. If you develop mods, you can use the API to build menus for your settings. So it provides the base code for those screens.

Second, regular players who install mods that rely on it. You'll usually add it to your game because another mod lists it as a requirement. Without it, mods that depend on its config screens can't open their option menus properly.

supported platforms and environments

Cloth Config API runs on Fabric and Neoforge. Loaders like Fabric and Neoforge handle the mod loading process. Both environments can load the library without extra steps.

On both the client and the server, this mod is optional. Look, you can run it on a client instance, a dedicated server, or both depending on what your specific mod list needs.

Compatibility covers specific Minecraft releases. The supported Minecraft versions are 26.3, 26.2, 26.1.2, 26.1.1, 26.1, and 1.21.11. Make sure your game installation matches one of these specific versions before you add the file to your mods folder.

licensing and documentation

The project is published under the GNU Lesser General Public License v3.0 only. This open license sets the rules for using, modifying, and sharing the code.

For developers who want to integrate the library, shedaniel maintains a GitBook wiki. The wiki covers developer setup and shows how to create config screens for your own projects.

Reactions

Log in to react.

Compatibility

Versions and loaders

9 releases on record

26.3.158+fabric

release

Download (1.1 MB)

26.2.155+neoforge

release

Download (1.1 MB)

26.2.155+fabric

release

Download (1.1 MB)

21.11.153+neoforge

release

Download (1.1 MB)

21.11.153+fabric

release

Download (1.1 MB)

21.11.152+neoforge

release

Download (1.1 MB)
Show all 9 versions

21.11.152+fabric

release

Download (1.1 MB)

Gallery

Cloth Config API icon

We use cookies to improve your experience. By continuing to use this site, you agree to our use of cookies. Read our Privacy Policy