Skip to content
Fzzy Config Mod | Config API with automatic GUIs, validation, and sync
Fzzy Config Mod
Config API with automatic GUIs, powerful validation options, server-client sync, and more! โ€ข Fabric / Forge / NeoForge / Quilt

๐Ÿ“– Mod Overview & Core Features

Fzzy Config is a powerful multi-loader configuration engine for MCPE 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 format.
  • Minimal API โ€“ with lightweight integration requirements.
  • Plain Java/Kotlin objects โ€“ or Minecraft GameOptions-like carefully crafted settings.
  • Seamless multi-loader support โ€“ use the same API on Fabric and Forge.

๐Ÿ–ฅ๏ธ Automatic GUIs

  • Automatic GUI generation โ€“ based on the layout and content of your config files.
  • 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 โ€“ keep settings consistent.
  • Push live updates โ€“ to a server from a client.
  • Forward client settings โ€“ to other users who want your setup.

โœ… Validation & Updates

  • Validation and Correction โ€“ built into everything, beyond just primitive types.
  • Tight control โ€“ over what values a player can choose from.
  • Automatic suggestions โ€“ for settings like tags and identifiers.
  • Versioned updates โ€“ supported with one simple method implementation.
  • Scrape previous configs โ€“ to easily update from another config library.

๐Ÿ› ๏ธ Technical Summary

๐Ÿง  Architecture & Data

  • TOML serialization โ€“ automatic reading/writing of config files.
  • Multi-loader support โ€“ uses a lightweight networking API for cross-loader compatibility.
  • Client & Server support โ€“ works on both sides with sync capabilities.
  • Minimal dependencies โ€“ lightweight integration with existing mods.

๐Ÿ“ฆ Loader & Dependencies

  • Fabric โ€“ requires Fabric Loader + Fabric API.
  • Forge โ€“ requires Forge for your MCPE version.
  • NeoForge โ€“ requires NeoForge for 1.20.4+.
  • Quilt โ€“ requires Quilt Loader + QSL.
  • No additional dependencies โ€“ works standalone.

โš™๏ธ Core Mechanics

  • Automatic GUI generation โ€“ uses reflection and annotations to build screens.
  • Server-client sync โ€“ uses a custom networking protocol.
  • Validation pipeline โ€“ applies constraints and corrections to values.
  • Version migration โ€“ updates configs from previous versions seamlessly.

๐Ÿ”ง Advanced Features

  • Custom validators โ€“ implement your own validation logic.
  • Dynamic suggestions โ€“ provide context-aware suggestions for settings.
  • ModMenu & Catalogue integration โ€“ automatic config screen registration.
  • Keyboard navigation โ€“ full accessibility support.
/* Technical highlights */
โ€ข Uses TOML for human-readable config files.
โ€ข Automatic GUI generation via reflection and annotations.
โ€ข Server-client sync uses a lightweight networking API.
โ€ข Validation pipeline applies constraints before saving.
โ€ข Version migration allows seamless updates from older configs.
โ€ข ModMenu and Catalogue are automatically detected and integrated.
โ€ข Fully accessible with keyboard navigation and screen narration.

๐Ÿ“ฅ Installation Guide

๐Ÿงต Fabric / Quilt Installation

RECOMMENDED Best performance & stability

1. Install the Fabric Loader or Quilt Loader (recommended version for your MCPE version).

2. Download Fabric API (or QSL for Quilt).

3. Download FzzyConfig-[loader]-[version].jar.

4. Place both JARs in .minecraft/mods/.

5. Launch using the Fabric/Quilt profile.

Example mods folder:
โ””โ”€โ”€ mods/
    โ”œโ”€โ”€ fabric-api-0.92.0+1.20.1.jar
    โ””โ”€โ”€ FzzyConfig-Fabric-1.0.0+1.20.1.jar

โœ… Note: Fabric API / QSL is recommended.

โš™๏ธ Forge / NeoForge Installation

ALTERNATIVE For modpacks relying on Forge ecosystem

1. Install the recommended Forge or NeoForge version.

2. Download FzzyConfig-Forge-[version].jar (or NeoForge version).

3. Place the JAR in mods/.

4. Launch the Forge/NeoForge profile.

Example mods folder (Forge):
โ””โ”€โ”€ mods/
    โ””โ”€โ”€ FzzyConfig-Forge-1.0.0+1.20.1.jar

โš ๏ธ Note: No additional dependencies are required.

๐Ÿ“Œ Universal steps & recommendations

  • Modpack: Available on Modrinth and CurseForge. Recommended launchers: Modrinth App, Prism Launcher, MultiMC.
  • Client & Server โ€“ works on both sides; server-side sync features require installation on both.
  • Performance tip: The mod is lightweight; automatic GUI generation is efficient.
  • Mod compatibility: Works with most mods; integrates with ModMenu and Catalogue automatically.
  • Data location: Config files are stored in /config/.
โšก Quick setup (dedicated server):
1. Download Fabric/Forge/NeoForge/Quilt server launcher.
2. Add Fzzy Config JAR to "mods" folder.
3. Start server (agree to EULA).
4. Config files are generated in /config/ on first launch.
โœ… Fabric/Quilt: Loader + API + FzzyConfig โœ… Forge/NeoForge: Forge + FzzyConfig ๐Ÿ“ฆ Place JARs in /mods folder ๐Ÿ–ฅ๏ธ Client & Server supported

๐Ÿ“‹ Compatibility

๐Ÿ•น๏ธ Supported versions

26.2 26.1.x 1.21.x 1.20.4โ€“1.20.6 1.20.1

Platforms

Fabric Forge NeoForge Quilt

Environments: Client and Server

๐Ÿท๏ธ Tags

Game Mechanics Library Management Utility

Creators

Owner: fzzyhmstrs

Fzzy Config Mod ยท by fzzyhmstrs ยท made for developers and modpack creators.