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
Create and Adventure With Friends Create and Adventure With Friends Voloron 4 Voloron 4 Cobbled Industries 2 Cobbled Industries 2 Nova's Toku Craft Server Pack Nova's Toku Craft Server Pack CleanCraft by ACUL [Neoforged] CleanCraft by ACUL [Neoforged] Block Saga Block Saga Spells Gears n' Bells RP Spells Gears n' Bells RP ROLO Edition ROLO Edition Create Aeronautics Age Of Aerolution Create Aeronautics Age Of Aerolution Arkobia 3 Arkobia 3 Triberean's Ultimate Furniturecraft Triberean's Ultimate Furniturecraft Impostor Syndrome - Reimagined Impostor Syndrome - Reimagined HexTech: The New Age HexTech: The New Age Gun Isekai Gun Isekai Haydenmon Evolved Haydenmon Evolved VACraft VACraft Cobble Lemon Cobble Lemon ComboTech 4 Sky High ComboTech 4 Sky High Aerium Aerium Hidecraft Modpack Hidecraft Modpack Cobblemon Honey Academy Cobblemon Honey Academy KaijuuCraft KaijuuCraft Sneykor's Cobblemon online Sneykor's Cobblemon online The Iron Frontier The Iron Frontier A Crazy Adventure: Science & Survival A Crazy Adventure: Science & Survival Mechanical Infinity Mechanical Infinity Silver's Cobblemon Silver's Cobblemon XAVIER Personal Pack XAVIER Personal Pack Karmunism-Refugee Karmunism-Refugee Velkaris Velkaris All About Aether - Sky Dimension Adventure All About Aether - Sky Dimension Adventure Old Scenery Old Scenery Lucky Pixelados Lucky Pixelados Mythic Machina Mythic Machina WindCrest War SMP WindCrest War SMP Totheron Totheron All You Need 2 - AYN 2 All You Need 2 - AYN 2 BuildUp (NeoForge) BuildUp (NeoForge) Enchantments Enchantments RPG-LITE RPG-LITE PixelSprings Plus PixelSprings Plus Create - Tamed Frontiers Create - Tamed Frontiers Brother's RPG Brother's RPG Cobblemon Eclipse Cobblemon Eclipse Cobblemon Survival with Friends Cobblemon Survival with Friends Cataclysmic Ascension Cataclysmic Ascension Oasis Tropic Oasis Tropic EasyColonies2 EasyColonies2 Maria's Create Project Maria's Create Project Create Boundary Engineer Create Boundary Engineer Pvp Optimizer Pvp Optimizer CanarioLand 2 CanarioLand 2 Cobbled Kingdom Mons Cobbled Kingdom Mons BlazeCraft Infinite BlazeCraft Infinite All Ultimate Selection All Ultimate Selection GearboundSMP S2 - Create Multiplayer GearboundSMP S2 - Create Multiplayer CreateCraft Aero SMP CreateCraft Aero SMP Sengoku Jidai - Samurai Legends Sengoku Jidai - Samurai Legends HARDCORE EVOLUTIONS HARDCORE EVOLUTIONS Peace of Mind 21.1 Peace of Mind 21.1 Create Areo Naughts Create Areo Naughts Cobblemon Enhanced - Pokemon Adventure Cobblemon Enhanced - Pokemon Adventure Sengoku Chronicles Sengoku Chronicles Create Industrial Village Create Industrial Village SC Final Adventure - Machines SC Final Adventure - Machines Braincells: Back to Basics Braincells: Back to Basics The Kindred's Cobblemon Adventures The Kindred's Cobblemon Adventures Create Beyond Horizons Create Beyond Horizons Sibo`s Vanilla Enhanced Sibo`s Vanilla Enhanced Nic YOLO's Pixelmon 2 Nic YOLO's Pixelmon 2 Minecolonies Create - Aeronautics Colonies Minecolonies Create - Aeronautics Colonies PureSavage-with-shaders-and-rp PureSavage-with-shaders-and-rp Guns, Vehicles and Food Guns, Vehicles and Food Adventure Wildfront Adventure Wildfront Create Even Further Beyond Create Even Further Beyond Vanilla Bloom Vanilla Bloom TCC - Skyzone TCC - Skyzone Zenith Lite Zenith Lite Terraria not MC Terraria not MC KarmaCraft Chaos & bleibender Schaden KarmaCraft Chaos & bleibender Schaden The Broken World (New) The Broken World (New) Towny Cobblemon Towny Cobblemon Karmalandia Oficial BY KKurotsukii Karmalandia Oficial BY KKurotsukii Egregious Industrialization Egregious Industrialization OuiOuiCreate OuiOuiCreate Government Government Lively Craft Lively Craft Evil larry's playground Evil larry's playground Rusty's Create Rusty's Create MineColonies Advance MineColonies Advance Homesteaders (Cozy Vibes) Homesteaders (Cozy Vibes) Xianxia and Magic++ Xianxia and Magic++ Weedie's Undead Adventure Weedie's Undead Adventure Aeronautics: Cogs and Clouds Aeronautics: Cogs and Clouds Create Vine & Wine Create Vine & Wine Simply's Tensura Simply's Tensura Steamland - SP Steamland - SP Advenium 3 Advenium 3 Very Optimised Very Optimised CobbleQuests CobbleQuests

External Resources