Modscraper Modscraper Minecraft
Prickle logo

Prickle

Mod

by DarkhaxDev

Prickle is a JSON based configuration file format brought to Minecraft.

Type

Mod

CurseForge Downloads

46,992,579

CurseForge ID

1023259

Modrinth Downloads

12,454,078

Modrinth ID

aaRl8GiW

Last Updated

Sep 10, 2026

Description

Prickle is a JSON based config format. This mod allows other mods to use Prickle for their config files! For technical documentation please see the GitHub page.

 

FaQ

Why is this called Prickle?
Prickle is the collective noun for a group of hedgehogs. Hedgehogs are one of my favourite animals and I think they are a fitting metaphor for config files. For example, they both may seem intimidating at first but can be nice once you get to know and understand them.

Why not use an existing format?
In the past I used standard JSON for my config files but there were several issues such as the lack of comments and default values. Prickle adds these features to JSON while remaining 100% backwards compatible. I have tried several other formats like TOML but I was disappointed with a lot of their Java implementations. They often lack features I found important, has serious bugs, and were no longer being maintained. Minecraft also uses JSON for datapacks and commands, making it a familiar choice for most players.

Format Specifications

In Prickle property values are wrapped in a JSON object. This allows metadata and other properties to be attributed to that property. The actual value that the user edits is held by the value property.

For example in standard JSON a file would look like this.

{ "database_host": "192.168.1.222" }

The same JSON as a Prickle file would look like this.

{ "database_host": { "value": "192.168.1.222" } }

Comments

The // key is reserved for comments. Comments are only used to provide additional context to the reader and should never influence how the file is parsed. Comments can be a JSON string or an array of JSON strings for multiline comments.

{ "database_host": { "//": "The IP address of the database to connect to.", "value": "192.168.1.0" } "database_host_backup": { "//": [ "A backup IP address to connect to. This is only", "used if the default host can not be reached " ], "value": "192.168.1.0" } }

Decorators

Decorators are named comments that convey a specific attribute of the property to the reader. A common example of a decorator is //default which declares the default value for the reader. Like comments, decorators never influence how the file is parsed, they are purely descriptive.

You may encounter some of the following decorators in prickle files.

  • //default - The default value of the property.
  • //reference - A resource that can be used to learn more, like a wiki/docs page.
  • //range - The acceptable range for a numeric value.
  • //regex - A regex pattern that the value must match.
  • //empty-allowed - If the value can be empty or not.

Nodecraft Sponsorship LogoThis project is sponsored by Nodecraft. Use code DARKHAX for 30% off your first month of service!

Recommended Gear

Affiliate

Hardware and extras that pair well with this mod.

As an Amazon Associate I earn from qualifying purchases.

Similar Mods

Included in Modpacks (1,549)

Show fewer
Plants vs Zombies Overgrowth Plants vs Zombies Overgrowth TJP - Endless Sky TJP - Endless Sky Sky Frogs Sky Frogs Elite Tensura Elite Tensura Cobblemon - Master Mon Cobblemon - Master Mon Farming Crossing 6 Dinner Party Farming Crossing 6 Dinner Party Mystical Block Reloaded Mystical Block Reloaded Industrial Upgrade Horizon Industrial Upgrade Horizon VampireReborn VampireReborn Servidor Magnatas Servidor Magnatas SmashMC Cobblemon SmashMC Cobblemon [MODIFIED] Cobblemon: Essentials [MODIFIED] Cobblemon: Essentials Neuroshroud: The Abandoned Neuroshroud: The Abandoned MC Rebalanced MC Rebalanced It Takes a Journey It Takes a Journey Invincible: Overdrive Invincible: Overdrive Project Minecolonies United Project Minecolonies United Progressionistic Progressionistic Chaos OneBlock Chaos OneBlock Replay Lite Replay Lite CobblemonOneBlock CobblemonOneBlock EMC & FE +++ EMC & FE +++ The Zombie Conquest - Easy Mode | You Can Revive! The Zombie Conquest - Easy Mode | You Can Revive! Truly Essentials [FABRIC] - First Step Truly Essentials [FABRIC] - First Step Mechanomania Mechanomania Cozy Experience - with Cute & Cozy Items! Cozy Experience - with Cute & Cozy Items! OneBlock OneLife OneBlock OneLife Gobba's Crystal PVP Modpack Gobba's Crystal PVP Modpack Mythic: Spellbound Mythic: Spellbound Create - Plane and Simple Create - Plane and Simple space, fight and simulation space, fight and simulation Create: Basically Everything Create: Basically Everything Ascension of Ages Ascension of Ages Poppy Playtime Pack Poppy Playtime Pack Cobblemon & Origins SMP Cobblemon & Origins SMP CoreCraft CoreCraft Improved Oritech | Oritech, Technology & Quests (Oritech 1.21.1) Improved Oritech | Oritech, Technology & Quests (Oritech 1.21.1) Train Yard Train Yard Elden Kingdom Elden Kingdom Volormon Volormon DexMasters [Cobblemon] DexMasters [Cobblemon] Delta's Just Give Me Features Delta's Just Give Me Features The Skies of Newstone Hollow The Skies of Newstone Hollow Keo Create Optimized Keo Create Optimized DivineRPG Server pack DivineRPG Server pack PixelGO - To the Sky 2 PixelGO - To the Sky 2 Generations (Forge) (Cobblemon) Generations (Forge) (Cobblemon) Morning Brew Morning Brew PROJECT: Keyblade - An Oath to Return PROJECT: Keyblade - An Oath to Return Kingdom of Elchea Kingdom of Elchea Isabel's Aeroscapes [for Create: Aeronautics] Isabel's Aeroscapes [for Create: Aeronautics] Ars Expeditions Ars Expeditions Absurdo! Absurdo! WitchHazel Halloween Magic WitchHazel Halloween Magic Avali/Furry Floofpack 2025 Avali/Furry Floofpack 2025 CobbleVerse + (For servers with friends) CobbleVerse + (For servers with friends) Soulheart Cobblemon Soulheart Cobblemon The Warborn Realms SMP The Warborn Realms SMP Create: End Times (Apocalypse) - With Create 6.0! Create: End Times (Apocalypse) - With Create 6.0! Fungle flavour Fungle flavour Aeronautics Dream Aeronautics Dream Optimized Client - Boost FPS Optimized Client - Boost FPS Folklore SMP Folklore SMP Cobblemon Guapisimo Cobblemon Guapisimo World Of Dragons World Of Dragons Tensura All The Slime 1 Tensura All The Slime 1 All The Neoforge All The Neoforge All About Decoration - Building & Furniture All About Decoration - Building & Furniture Dark TFC - UltraHardcore Dark TFC - UltraHardcore Cobblemon Realms Lite Cobblemon Realms Lite Unaltered+ Unaltered+ Tinker's Tavern: Cobblemon Tinker's Tavern: Cobblemon PikaVerse MC PikaVerse MC The Modded Rizoma MC The Modded Rizoma MC PocketSMP (OFFICIAL) PocketSMP (OFFICIAL) Nexus client Nexus client Creative Mode: A Create Experience Creative Mode: A Create Experience Revelations 3 - just Tech N' building! Revelations 3 - just Tech N' building! KyuSekai KyuSekai Keo Create Optimized Keo Create Optimized TerraKeo TerraKeo WolfCraft Colonies - Season 5! WolfCraft Colonies - Season 5! Better MC [BMC6] Better MC [BMC6] Lucky World Invasion - Survivor Lucky World Invasion - Survivor GSZYpack GSZYpack Inferno - Better Hardcore Inferno - Better Hardcore LifeOre Create S1 LifeOre Create S1 SpookyJam 2025 SpookyJam 2025 Reverie Foundry Reverie Foundry Randoms Packs Randoms Packs Tensura Tomfoolery Tensura Tomfoolery Oritech+ | Oritech & Create Addons and Create Aeronautics Oritech+ | Oritech & Create Addons and Create Aeronautics Ultimate Tensura Reincarnated Ultimate Tensura Reincarnated [Cobblemon] BlockeMon [Cobblemon] BlockeMon Cobblemon Enhanced (Pokemon) Cobblemon Enhanced (Pokemon) Cobblemon Apex Worlds Cobblemon Apex Worlds Prison Escape - Beginnings (reborn) Prison Escape - Beginnings (reborn) Aetherion - The Aether II Expanded Aetherion - The Aether II Expanded MHAC - My Hero Academia Craft MHAC - My Hero Academia Craft Performatic Performatic

External Resources