๐ 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.
โข 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.
โโโ 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.
โโโ 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/.
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.
๐ Compatibility
๐น๏ธ Supported versions
Platforms
Environments: Client and Server
๐ท๏ธ Tags
Creators
Owner: fzzyhmstrs