YetAnotherConfigLib (YACL): A Builder-Based Configuration Library for Minecraft
Introduction
YetAnotherConfigLib (YACL) is a versatile builder-based configuration library specifically designed for Minecraft mod development. Its main goal is to provide a modern, user-friendly, and highly customizable configuration system for Fabric modders.
Why Was YACL Created?
YACL was developed to address specific limitations found in existing Fabric configuration libraries. Each major alternative presents its own set of challenges:
- Cloth Config API: This library is no longer actively updated, and further feature development has stopped.
- SpruceUI: While functional, it was not intended for configuration use and can feel cluttered during setup.
- OwoLib: Although it provides configuration support, it bundles a wide range of features contributing to a larger file size.
Given the drawbacks of these alternatives, YetAnotherConfigLib was developed with a focus on clean design, effective features, and true configurability tailored to Minecraft.
What Makes YACL Stand Out?
- Refined API: Inspired by the well-designed configuration system found in Sodium, YACL offers a straightforward and intuitive developer API.
- Seamless Integration: The graphical user interface is carefully styled to visually blend with standard Minecraft menus.
Main Features
- Custom Control Widgets: If the standard control set doesn’t serve your requirements, easily create and integrate custom “controllers.”
- Rich Descriptions: Enhance your configuration screen with clickable and hoverable text, leveraging Minecraft’s built-in Text component system.
- WebP Image Previews: Include support for both static and animated WebP image previews, or substitute images with custom-rendered sections.
- Diverse Controllers for Each Data Type:
- Sliders or input fields for numerical values
- Dropdown menus, cyclers, and raw text fields for string input
- Tickboxes or ON/OFF displays for boolean options
- …and many more possibilities!
- Comprehensive Color Picker: Includes a full-featured color picker, fully compatible with keyboard navigation and optimized for Controlify users.
- Organizational Tools: Configurations can be grouped into tabs (categories) and collapsible sections for a structured layout.
- Automatic Serialization: Built-in serialization and deserialization features help eliminate error-prone manual config code.
- Kotlin DSL Support: For Kotlin users, the library provides a full-featured domain-specific language for fluent configuration definition.
Summary
YetAnotherConfigLib delivers a thoughtfully designed, highly extensible, and easy-to-use solution for Minecraft mod configuration. By building on feedback from previous libraries, it ensures a smooth integration into your mods while offering a modern, Minecraft-styled experience for both developers and players.
Screenshots
- If you don’t know how to use Minecraft Mods, please click to view the Mods usage tutorial.
