COAL - Cloth Config adapter

Quick rating

Community listing page, reviews here may not be monitored by the author.

Report a bug to the author How listings work Are you the author?

COAL - Cloth Config adapter

By oliveryasunaOwner

No reviews yet

Renders every COAL-using mod's settings screen in Cloth Config.

Mod Loaders
Minecraft
Hosting Partner

Want to reach Minecraft players?

We're looking for a server hosting partner to feature here and other parts of the site. Interested? Send us a message!

Get in touch

About

Description

Renders every COAL-using mod's settings screen in Cloth Config, plus JSON persistence, load-time validation, and versioned migrations.

For players

Install all three side-by-side in your mods/ folder:

  1. COAL — the abstraction layer that COAL-consuming mods depend on.
  2. coal-cloth-adapter — this mod.
  3. Cloth Config — the GUI library that actually renders the screens.

Any mod that consumes COAL will use Cloth Config for its settings screen once these three are installed together.

Cloth vs. YACL

Cloth Config's sub-category widget recurses cleanly, so this adapter preserves deep-nested config trees end-to-end. YACL's equivalent flattens after two levels. If your mods declare heavily-nested configs and you want every level preserved in the GUI, pick this adapter.

Don't install alongside coal-yacl-adapter

Only one COAL adapter should be installed at a time. If you'd rather use YACL, install coal-yacl-adapter instead of this one.

For mod authors

You don't compile against this mod. Depend on coal-api + coal-api-gui-<loader> at compile time; your users install whichever adapter they prefer at runtime. See the docs for the walkthrough.

Feature coverage

Advertises MIGRATION, VALIDATION, and GUI_DELEGATION. Does not advertise SYNC, FILE_WATCH, JSON5, or CUSTOM_FORMATS — see the module README on GitHub for the full annotation-to-widget mapping and known limitations.

Links