Fzzy Config is a powerful multi-loader configuration engine for Minecraft Mods that meets you where you want to be. Quick and dirty or detailed and featureful, Fzzy Config will work with you. It provides a wide array of features above and beyond what you can find in other libraries.
The Basics
- Automatic serialization to TOML.
- Minimal API with lightweight integration requirements
GUIs
- Automatic GUI generation based on the layout and content of your config files.
- Screens are fully keyboard-navigable and narratable out of the box.
- Fully vetted and tested by a visually impaired member of the modding community.
- No need for screen builders or registration.
- ModMenu and Catalogue automatically integrated.
Synchronization
- Automatic server-client sync.
- Push live updates to a server from a client.
- Forward client settings to other users who want your setup.
Validation
- Validation and Correction built into everything, beyond just primitive types.
- Tightly control what values a player can choose from and how they choose them.
- Automatic suggestions for settings like tags and identifiers.
Updates
- Versioned updates supported with one simple method implementation.
- Scrape previous configs to easily update from another config library.
Flexibility
- Implement a config with as little or much effort as you want.
- Plain java/kotlin object, or Minecraft GameOptions-like carefully crafted settings.
- Seamless multi-loader support. Use the same API on Fabric and Forge; including a lightweight mutli-loader Networking API!
A typical config screen. The breadcrumbs at the top track back to the previous config screens opened. The settings list is fully translatable and describable. settings can be searched for at the bottom.
All settings are controlled with powerful pre--defined widgets, some inline and some as popups.
Fzzy Config works with a variety of common key combinations, such as copy/paste, page up/down, and more. It also supports context menus via right clicking.
All changes are tracked and can be applied, reverted, and more.
All tracked changes can be viewed in the Change History button of the Change Manager
use the /configure command to open any registered config screen, or access them thru ModMenu or Catalogue
Mods can add multiple configs under one namespace. All configs in that namespace will be summarized in a "header" screen with buttons leading to each. Configs can have settings that prompt a restart.