Fzzy Config gives Minecraft mods their settings screens, checks the values players type, and keeps servers and clients in step. It runs on Fabric, Quilt, Forge and NeoForge.
Sent here because a mod said it needs Fzzy Config? Pick your Minecraft version below and install the jar alongside your other mods. That is the whole job.
The Fzzy Config mod is a library. It ships no blocks, items or gameplay of its own. Other mods depend on it to build their config screens, so you install it the way you install Fabric API: because something else asked for it.
For the mods that use it, Fzzy Config writes the settings file, draws the screen, refuses values that would break the game, and syncs the result between a server and everyone connected to it. Version 0.7.6 is the current release, and the mod has been downloaded 37,313,509 times since April 2024.
If you write mods yourself, it is also an API: a plain Java or Kotlin class with public fields becomes a TOML file and a full settings screen, with one registration call and no screen-builder code.
Filter by loader and Minecraft version, then download that exact jar. Each row is one file: Fabric 1.21 and NeoForge 26.1 are different rows. One click starts that download.
The live catalog, newest first. Chips come from the catalog itself, not a hardcoded Minecraft range.
| Version | Loader | Minecraft | Size | Published | Download |
|---|---|---|---|---|---|
| Loading the catalog… | |||||
No files match those filters.
The file list could not be loaded. Try again in a moment.
Each click asks this site for that exact catalog row. The jar is not stored here; the download is counted as it is fetched.
Config screens open through ModMenu on Fabric and Quilt, Catalogue on Forge and NeoForge, or the /configure command in game. If something fails to load, the crash log names the missing piece. Common questions.
The screen is built from the mod's config class, so there is nothing for the author to lay out by hand. Breadcrumbs, a search box, right-click context menus and a change manager that can apply, revert or restore defaults all come as standard. Screens open from ModMenu, Catalogue, or the /configure command.
Configs sync to clients when they join. An operator can push a change to a live server without a restart, and players can forward their own settings to someone who wants the same setup. Updates that look suspect are quarantined until an admin accepts them.
Numbers, enums, colours, identifiers, tags, ingredients, keybinds and whole objects each get a widget that only accepts what fits. Edit the file by hand and put in something impossible, and Fzzy Config corrects it instead of throwing an exception at load. Identifiers and tags suggest as you type, and Tab completes them.
A mod author bumps a version number and writes one method, and old settings files migrate instead of resetting. Configs written for another library can be scraped across. Since 0.7.4, edits made to the file on disk apply live in game.
Fabric and Quilt share a file. Forge and NeoForge get their own. The same API is behind all of them, along with a small networking layer for mods that need to send their own packets. Minecraft 1.20.1 through 26.2 are supported.
Every screen can be driven from the keyboard, and the config screens use their own narrator implementation rather than the vanilla one. The author's listing notes it was "fully vetted and tested by a visually impaired member of the modding community".
Screenshots taken by the mod's author, with their own captions.
The most recent releases, notes straight from the author. Every release back to 0.2.0 in April 2024 is on Modrinth.
ValidatedEnumMap is removed
SmallSpriteDecoration#<init>
SpriteDecorated#textureSet & textures is now a required override
SpriteDecoration#<init>
CustomButtonWidget#<init> & builder is now only non-override method for adding custom button
ActiveButtonWidget
TextlessActionWidget
DynamicListWidget.EntryPos and implementations made internal
PopupWidget position elements; LayoutWidget no longer inherits from the PopupWidget variant
PopupController from PopupParentElement
SuggestionWindowListener and SuggestionWindowProvider moved out of internal sub-package
ImmutableRelPos
RenderUtil#renderBlur
Translatable.Result has been replaced with Translatable.ResultProvider. This affects EntrySearcher as well as Searcher.SearchContent
ValidatedField.translationProvider, ValidatedField.descriptionProvider, ValidatedField.attachProvider, and the associated Provider types are now static (as well as instance methods) so java users won't have to call .Companion. anymore (but can)
ValidatedChoiceList and similar settings with an "inline" widget layout now properly show the tooltip for the individual options as well as the settings overall tooltip
ValidatedEnumMap is removed
SmallSpriteDecoration#<init>
SpriteDecorated#textureSet & textures is now a required override
SpriteDecoration#<init>
CustomButtonWidget#<init> & builder is now only non-override method for adding custom button
ActiveButtonWidget
TextlessActionWidget
DynamicListWidget.EntryPos and implementations made internal
PopupWidget position elements; LayoutWidget no longer inherits from the PopupWidget variant
PopupController from PopupParentElement
SuggestionWindowListener and SuggestionWindowProvider moved out of internal sub-package
ImmutableRelPos
RenderUtil#renderBlur
Translatable.Result has been replaced with Translatable.ResultProvider. This affects EntrySearcher as well as Searcher.SearchContent
FcText
Provider system to Validated Fields
ValidatedField.translationProvider to attach a custom translation provider function to a field.
ValidatedField.descriptionProvider to attach a custom description (tooltip) provider function to a field.
ValidatedField.attachProvider to attach an arbitrary value provider. This system is experimental and currently largely unused except for some widget names
WIDGET_TITLE provider to create custom widget labels
ConfigDeprecated annotation. Use this to mark a setting as deprecated in the config.
Version annotation to update a setting while still being able to use the old setting to update/inform the content of the new one.
ThreadingUtils (the file watcher utility) now uses kotlin coroutines internally and has more robust startup and shutdown processes
ValidatedCondition, ValidatedMapped, etc.)
ValidatedAny
ValidatedEnumMap is removed
SmallSpriteDecoration#<init>
SpriteDecorated#textureSet & textures is now a required override
SpriteDecoration#<init>
CustomButtonWidget#<init> & builder is now only non-override method for adding custom button
ActiveButtonWidget
TextlessActionWidget
DynamicListWidget.EntryPos and implementations made internal
PopupWidget position elements; LayoutWidget no longer inherits from the PopupWidget variant
PopupController from PopupParentElement
SuggestionWindowListener and SuggestionWindowProvider moved out of internal sub-package
ImmutableRelPos
RenderUtil#renderBlur
Translatable.Result has been replaced with Translatable.ResultProvider. This affects EntrySearcher as well as Searcher.SearchContent
onUpdateServer events that take a ServerUpdateContext. The old events are deprecated. They will stop working (no crashes) in 0.8.0, with full removal scheduled for 0.9.0
RegistryBuilder platform system for creating modded registries in a loader-agnostic way, along with other registry-related utils.
PlatformApi#createRegistryBuilder. Much like registrars, a builder is created for a specific namespace.
ValidatedEnum now has more widget types, including INLINE and SCROLLABLE
ValidationResult.bimap error nesting order flipped, the output results error context is now the parent context
ValidatedEnumMap is removed
SmallSpriteDecoration#<init>
SpriteDecorated#textureSet & textures is now a required override
SpriteDecoration#<init>
CustomButtonWidget#<init> & builder is now only non-override method for adding custom button
ActiveButtonWidget
TextlessActionWidget
DynamicListWidget.EntryPos and implementations made internal
PopupWidget position elements; LayoutWidget no longer inherits from the PopupWidget variant
PopupController from PopupParentElement
SuggestionWindowListener and SuggestionWindowProvider moved out of internal sub-package
ImmutableRelPos
RenderUtil#renderBlur
Translatable.Result has been replaced with Translatable.ResultProvider. This affects EntrySearcher as well as Searcher.SearchContent
onUpdateServer events that take a ServerUpdateContext. The old events are deprecated. They will stop working (no crashes) in 0.8.0, with full removal scheduled for 0.9.0
RegistryBuilder platform system for creating modded registries in a loader-agnostic way, along with other registry-related utils.
PlatformApi#createRegistryBuilder. Much like registrars, a builder is created for a specific namespace.
ValidatedEnum now has more widget types, including INLINE and SCROLLABLE
ValidationResult.bimap error nesting order flipped, the output results error context is now the parent context
ValidatedEnumMap is removed
SmallSpriteDecoration#<init>
SpriteDecorated#textureSet & textures is now a required override
SpriteDecoration#<init>
CustomButtonWidget#<init> & builder is now only non-override method for adding custom button
ActiveButtonWidget
TextlessActionWidget
DynamicListWidget.EntryPos and implementations made internal
PopupWidget position elements; LayoutWidget no longer inherits from the PopupWidget variant
PopupController from PopupParentElement
SuggestionWindowListener and SuggestionWindowProvider moved out of internal sub-package
ImmutableRelPos
RenderUtil#renderBlur
Translatable.Result has been replaced with Translatable.ResultProvider. This affects EntrySearcher as well as Searcher.SearchContent
onUpdateServer events that take a ServerUpdateContext. The old events are deprecated. They will stop working (no crashes) in 0.8.0, with full removal scheduled for 0.9.0
RegistryBuilder platform system for creating modded registries in a loader-agnostic way, along with other registry-related utils.
PlatformApi#createRegistryBuilder. Much like registrars, a builder is created for a specific namespace.
ValidatedEnum now has more widget types, including INLINE and SCROLLABLE
ValidationResult.bimap error nesting order flipped, the output results error context is now the parent context
ValidatedEnumMap is removed
SmallSpriteDecoration#<init>
SpriteDecorated#textureSet & textures is now a required override
SpriteDecoration#<init>
CustomButtonWidget#<init> & builder is now only non-override method for adding custom button
ActiveButtonWidget
TextlessActionWidget
DynamicListWidget.EntryPos and implementations made internal
PopupWidget position elements; LayoutWidget no longer inherits from the PopupWidget variant
PopupController from PopupParentElement
SuggestionWindowListener and SuggestionWindowProvider moved out of internal sub-package
ImmutableRelPos
RenderUtil#renderBlur
Translatable.Result has been replaced with Translatable.ResultProvider. This affects EntrySearcher as well as Searcher.SearchContent
CustomWidget interface. This will be used for abstracting all FC widgets away from directly interacting with Element, Widget, etc. to reduce porting headache going forward. Updates related to CustomWidget will be sprinkled into the next versions.
CustomTextWidget utilizing said CustomWidget interface.
syncConfig method to the NetworkApi for manually syncing a server-side config to clients.
CustomMultilineTextWidget now has an align-right method
Relevant has gained three new methods for modifier checks, needsCtrl, needsShift, needsAlt
PopupWidget's wrapped LayoutWidget now contributes to re-sizing the popup based on the dimensions it would like.
ConfigGroup now acts properly with nested collapsedByDefault
ConfigApi.buildTranslations can now "see" inside objects that may be wrapping a translated object (such as ValidatedAny)
ValidationResult.reportTo no longer reports an error context has header information only.
ValidatedEnumMap is removed
SmallSpriteDecoration#<init>
SpriteDecorated#textureSet & textures is now a required override
SpriteDecoration#<init>
CustomButtonWidget#<init> & builder is now only non-override method for adding custom button
ActiveButtonWidget
TextlessActionWidget
DynamicListWidget.EntryPos and implementations made internal
PopupWidget position elements; LayoutWidget no longer inherits from the PopupWidget variant
PopupController from PopupParentElement
SuggestionWindowListener and SuggestionWindowProvider moved out of internal sub-package
ImmutableRelPos
RenderUtil#renderBlur
Translatable.Result has been replaced with Translatable.ResultProvider. This affects EntrySearcher as well as Searcher.SearchContent
ValidatedColor has a new presets feature. These presets will be displayed in a "sub-pane" to the right of the main color popup.
ValidatedColor#withColorPresets
ValidatedNumber#setFormat extension function lets you define a custom DecimalFormat for your number settings
pushChildLayout and popChildLayout in the Builder.
SaveType.SEPARATE can now be opened out of the world (if it's entries can be) without caring about permissions checking, because the clients version will be considered separately anyway
LayoutWidget in favor of a builder pattern. Migrate any custom LayoutWidget impls asap; removal scheduled for 0.8.0
ValidatedCondition not passing widget size changes to it's delegate widget *
ValidatedEnumMap is removed
SmallSpriteDecoration#<init>
SpriteDecorated#textureSet & textures is now a required override
SpriteDecoration#<init>
CustomButtonWidget#<init> & builder is now only non-override method for adding custom button
ActiveButtonWidget
TextlessActionWidget
DynamicListWidget.EntryPos and implementations made internal
PopupWidget position elements; LayoutWidget no longer inherits from the PopupWidget variant
PopupController from PopupParentElement
SuggestionWindowListener and SuggestionWindowProvider moved out of internal sub-package
ImmutableRelPos
RenderUtil#renderBlur
Translatable.Result has been replaced with Translatable.ResultProvider. This affects EntrySearcher as well as Searcher.SearchContent
@IgnoreCommentsForDesc annotation. Use on your config class to have the translation parser ignore @Comment and @TomlComment for in-game descriptions.
SaveType.SEPARATE can now be opened out of the world (if it's entries can be) without caring about permissions checking, because the clients version will be considered separately anyway
ValidatedEnumMap is removed
SmallSpriteDecoration#<init>
SpriteDecorated#textureSet & textures is now a required override
SpriteDecoration#<init>
CustomButtonWidget#<init> & builder is now only non-override method for adding custom button
ActiveButtonWidget
TextlessActionWidget
DynamicListWidget.EntryPos and implementations made internal
PopupWidget position elements; LayoutWidget no longer inherits from the PopupWidget variant
PopupController from PopupParentElement
SuggestionWindowListener and SuggestionWindowProvider moved out of internal sub-package
ImmutableRelPos
RenderUtil#renderBlur
Translatable.Result has been replaced with Translatable.ResultProvider. This affects EntrySearcher as well as Searcher.SearchContent
Translatable.Name, Translatable.Desc, and Translatable.Prefix annotations for data generation of lang files
ConfigApi.buildTranslations and ConfigApiJava.buildTranslations methods for hooking a config into a data generator
ConfigApi.platform().buildRegistryTranslations Used for either RegistrySupplier objects built by a Registrar or Identifier used in a traditional registration system
ConfigScreenProvider, allowing for registering of custom screen implementations in place of the Fzzy Config built in
registerScreenProvider added for registering your provider
afterClose event in PopupWidget
isPressed method in Relevant interface (which is used by FzzyKeybind and ValidatedKeybind), which allows for assertive checking for a key state, above the existing reactive response method relevant
ValidationResult with a new ErrorEntry system and dramatically improved process flow for building complex errors and passing exceptions and other context information
inmap, outmap, and bimap
CustomMultilineTextWidget to handle click and hover events, as well as now implementing a custom MultilineText implementation
ValidatedField bails out of deserialization only on critical errors, now letting correction take its course more often
Registrar system is no longer marked as experimental. Any further changes to the system will follow the standard released content deprecation and update system
ConfigGroup.Pop properly pops multiple times if attached to one setting multiple times
ClickableTextWidget and CustomMultilineTextWidget now properly show hover events
The developer guide, one topic at a time. The generated API reference lists every class and method, and the project wiki carries the full articles.
Add the dependency, write a class, register it once.
Wrap a field to bound it, restrict it, or give it a better widget.
Change how a setting syncs, who may edit it, and what happens when it changes.
Networking, registration, data generation and the other systems that come along.
The problems that come up most, and what causes them.
You write a class. Fzzy Config writes the TOML, draws the screen, validates the values and handles the sync. There is no screen builder to implement and nothing to register beyond one call.
Fzzy Config lives on the author's own maven. The artifact is me.fzzyhmstrs:fzzy_config, with an underscore rather than a hyphen. Forge and NeoForge builds also need the Kotlin for Forge repository.
repositories { maven { name = "FzzyMaven" url = uri("https://maven.fzzyhmstrs.me/") } // Forge and NeoForge only maven { url = uri("https://thedarkcolour.github.io/KotlinForForge/") } } dependencies { // NOTE: underscore, not hyphen modImplementation("me.fzzyhmstrs:fzzy_config:$fzzyConfigVersion") }
Fields need to be public, non-final and non-static. Wrap one in a Validated type when you want bounds, choices or suggestions; leave it plain when you do not care.
class MyConfig : Config(Identifier.of(MOD_ID, "my_config")) { var enableFeature = true // bounded 0.0 to 10.0, corrected if the file says otherwise var speed = ValidatedDouble(5.0, 10.0, 0.0) // its own screen, with a breadcrumb back here var advanced = AdvancedSection() class AdvancedSection : ConfigSection() { @RequiresRestart var renderDistance = ValidatedInt(8, 32, 2) } } // reads the file, creates it if missing, registers screen and sync val CONFIG = ConfigApi.registerAndLoadConfig(::MyConfig)
public class MyConfig extends Config { public MyConfig() { super(Identifier.of(MOD_ID, "my_config")); } public boolean enableFeature = true; // bounded 0.0 to 10.0, corrected if the file says otherwise public ValidatedDouble speed = new ValidatedDouble(5.0, 10.0, 0.0); // its own screen, with a breadcrumb back here public AdvancedSection advanced = new AdvancedSection(); public static class AdvancedSection extends ConfigSection { @RequiresRestart public ValidatedInt renderDistance = new ValidatedInt(8, 32, 2); } } // reads the file, creates it if missing, registers screen and sync public static MyConfig CONFIG = ConfigApiJava.registerAndLoadConfig(MyConfig::new);
The docs on this site cover config classes, every validation type, every annotation and the extras that ship alongside. The licence is TDL-M, which permits use as a dependency but not bundling: no jar-in-jar, no Gradle include.
Fzzy Config is a library mod for Minecraft Java Edition. It gives other mods their settings screens and config files. On its own it adds no blocks, items or gameplay, so you will not see anything new in game after installing it.
Only if another mod asks for it. It is a dependency, like Fabric API. If a mod's page lists Fzzy Config as required, or the game refuses to start with a message naming fzzy_config, then yes. Otherwise there is nothing to gain from installing it by itself.
Match your Minecraft version first, then your mod loader. Fabric and Quilt use the same file. Forge and NeoForge use a separate one, marked +forge on 1.20.1 and +neoforge from 1.20.4 onward. The picker above does the matching for you.
Yes. Fzzy Config is required on both client and server. Part of what it does is keep the two in agreement, so a server running mods that use it needs the jar in its mods folder too.
Fzzy Config is written in Kotlin, so it needs a Kotlin language loader for your platform. On Fabric and Quilt that means Fabric API and Fabric Language Kotlin. On NeoForge for Minecraft 26.2 it is KotlinLangForge; on earlier NeoForge versions and on Forge 1.20.1 it is Kotlin for Forge. The download panel names the right ones for the file you picked.
Through ModMenu on Fabric and Quilt, through Catalogue on Forge and NeoForge, or by typing the /configure command in game. Fzzy Config registers the screens itself, so mod authors do not have to.
Minecraft 1.20.1 through 26.2. That is 20 stable versions, every one of which has a download on this page, plus 14 snapshots and pre-releases that are published but not listed here. Note that 1.20.4 and 1.20.6 stopped receiving updates at version 0.5.9 and were dropped as of 0.6.0, so those two are still downloadable but frozen.
Check three things in order: that the Fzzy Config file matches your exact Minecraft version, that it matches your loader, and that the Kotlin loader it needs is installed as well. Most reports come down to one of those. If it still fails, the crash log will name the missing piece, and the author takes bug reports on GitHub.
It is free, and the full source is on GitHub under the Timefall Development Licence, Modified. Downloads on this page are the author's own published files, served straight from their official host.