Prickle
by Darkhax
Prickle lets a JSON config file carry comments, default values, ranges and regex checks while staying readable by any plain JSON parser.
What it does
A configuration file format built on JSON, Prickle keeps existing JSON syntax, tools and syntax highlighting working, so a plain JSON file is already a valid Prickle file. Its extra features come from comments and decorators, which attach rules to individual values.
The format was designed for mod authors who want config files that explain themselves. Decorators record a default, a link to documentation, an allowed range, a pattern the value must match, and whether the value may be empty. Fabric, Forge, NeoForge and Quilt builds exist, and Fabric builds need Fabric API. Client and server installs both need it, and its source code is released under the GNU Lesser General Public License v2.1 only, which makes it open source.
Builds span 1.21 – 26.3 across 17 release versions, including 1.21, 1.21.1, 1.21.11, 26.1, 26.1.1, 26.1.2, 26.2 and 26.3. Fabric and NeoForge share the newest build, 26.3.0.2 for 26.3, released 2026-09-24. Forge stops at 21.1.11 for 1.21.1, while Quilt reaches 21.11.1 for 1.21.11, released 2026-01-29.
Key features
Comments in config files
Prickle files accept comments, which JSON itself does not allow, so authors can explain each option in place.
Default values
A default decorator records the value a setting starts with, so the file documents its own baseline.
Range checks
A range decorator states the acceptable span for a number, such as a minimum and maximum.
Regex validation
A regex decorator gives a pattern that a value must match, which catches typos in text settings.
Empty value control
An empty-allowed decorator states whether a value may be left empty, and defaults to allowing it.
Gallery
Compatibility
Latest build for each game version and loader.
26.x5 of 5 versions with builds
1.21.x12 of 12 versions with builds
Only full game releases are shown. This mod publishes no snapshot builds.
Requirements
Dependencies declared by the latest file for each loader.
Required 1
Required by 42 mods
Use cases
Documenting mod configs
Mod authors can ship a config file that shows each option's default, allowed range and purpose without a separate guide.
Validating edited settings
Range and regex decorators let a loader flag a value that falls outside what the author allows.
Who it’s for: Mod developers who ship configuration files, and server owners who edit those files by hand and want the options explained inside them.
Questions
Does Prickle need Fabric API?
Are existing JSON config files still valid?
Which mods depend on Prickle?
In the catalog
Prickle is one of 3,514 Library mods on ModsFinder, and one of 2,348 Library mods for Fabric. 8,071 mods support Minecraft 26.3.
More from Darkhax
Similar mods
What the author says
Prickle is a JSON based config format. This mod allows the format to be used in Minecraft! For technical documentation please see the GitHub page. What benefits does Prickle offer? Prickle is based on JSON but adds several useful features like comments and decorators. Prickle is 100% backwards compatible with JSON…
Official listing
- Modrinth page
- modrinth.com/mod/prickle
- Owner
- Darkhax
- Published
- 2024-08-20
- Updated on Modrinth
- 2026-09-24
- Facts verified
- 2026-10-15