Config Object Abstraction Library (COAL)
- By
One config UI for every COAL-consuming mod. Install once, all your mod settings share the same screen.
Config Options Abstraction Layer (COAL) is a stable API and
provider SPI for Minecraft mod configuration. It plays the same role for
configuration that SLF4J plays for logging: mods depend only on coal-api;
the actual reading, writing, validating, migrating, and GUI-rendering of
configuration is delegated to whichever ConfigProvider is on the classpath
at runtime.
For players
Install this plus one adapter for any mod that uses COAL to work with a settings screen:
- coal-yacl-adapter — renders settings in YetAnotherConfigLib.
- coal-cloth-adapter — renders settings in Cloth Config.
Without an adapter, COAL still lets mods start — settings just fall back to their defaults and you'll see a one-time notice.
For mod authors
Depend on coal-api and let your users pick the GUI they want. See the
docs for getting-started, guides, and the
full specification.
Links
The Config Object Abstraction Library (COAL) Team
