Modscraper Modscraper Minecraft
Prickle logo

Prickle

Mod

by DarkhaxDev

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

Type

Mod

CurseForge Downloads

52,910,401

CurseForge ID

1023259

Modrinth Downloads

14,144,795

Modrinth ID

aaRl8GiW

Last Updated

Nov 7, 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!

Compatibility

Mod Loaders

Client Neoforge Server

Game Versions

26.3

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,819)

Show fewer
Faes & Frogs - Fabric Faes & Frogs - Fabric MrOptituber MrOptituber Create Unending Create Unending OuiOuiCreate OuiOuiCreate KRC The First KRC The First CobbleQuests CobbleQuests WorkLoad WorkLoad Mint Flavored Mint Flavored Steamland - SP Steamland - SP Assembly Assembled | Server Assembly Assembled | Server Create Even Further Beyond Create Even Further Beyond Bizarre Craft (A Homage To Crazy Craft) Bizarre Craft (A Homage To Crazy Craft) NeoFrontier NeoFrontier MineColonies Advance MineColonies Advance Civilization Isolaria Civilization Isolaria Space Block Eclipse Space Block Eclipse Homesteaders (Cozy Vibes) Homesteaders (Cozy Vibes) BetterCraft Lite BetterCraft Lite AdvoTech Aeronautic AdvoTech Aeronautic Lo-RPG Maygk Adventure Lo-RPG Maygk Adventure Magic & Flight Magic & Flight Redacted II: Aerofactory Redacted II: Aerofactory Cobblemon Harmony Modpack Cobblemon Harmony Modpack jaaj jaaj Modded Bridge Modded Bridge CobbleNerd CobbleNerd Cobblemon Industrial revolution Cobblemon Industrial revolution Cobblemon x Jacarezinhos Cobblemon x Jacarezinhos Moss & Stone Serwer Moss & Stone Serwer [FMCS-H] fps X media X crystal x survival Optimized HIGH [FMCS-H] fps X media X crystal x survival Optimized HIGH DFN - SMP DFN - SMP minna no saba minna no saba A MAFIA SMP A MAFIA SMP Fishy's Client Fishy's Client Tensura - Sovereign Rebirth Tensura - Sovereign Rebirth TKS SMP TKS SMP Creating Sandwiches Creating Sandwiches RainbowMon 2 RainbowMon 2 EmberHorizon's Custom Pack EmberHorizon's Custom Pack Rust and Rituals Rust and Rituals KarmaCraft Chaos & bleibender Schaden KarmaCraft Chaos & bleibender Schaden Re-Crafted 2 Re-Crafted 2 The Created Pack The Created Pack Pvp Optimized Pack Pvp Optimized Pack Creator's Delight 3 Creator's Delight 3 CobbleAnacrônico CobbleAnacrônico HexTech: The New Age HexTech: The New Age Braincells: Back to Basics Braincells: Back to Basics Horror Pokemom Horror Pokemom Advanced Space and Beyond Advanced Space and Beyond Create Craft 4 Create Craft 4 All Those Tech All Those Tech Wen's Create Experience Wen's Create Experience Range's Pack Range's Pack Vanilla Expanse Tulacraft IV Tulacraft IV HoopieSMP HoopieSMP Vanilla Planifolia Vanilla Planifolia Cobbromon Cobbromon Nic YOLO's Pixelmon 2 Nic YOLO's Pixelmon 2 AeroCobble AeroCobble Create's Colonies Create's Colonies Ultimate Survival Overhaul Ultimate Survival Overhaul Homer Pack Homer Pack Cozy Cobble Adventures Cozy Cobble Adventures Industrial Skies pack Industrial Skies pack Trial by Farmer Trial by Farmer The ELemental Deathcord Smp The ELemental Deathcord Smp PokeHarvest PokeHarvest ShroomCluster ShroomCluster Cobblezados Cobblezados Pixel Valley Pixel Valley WrightCraft WrightCraft Atom & Dragon Atom & Dragon Main by Waldnetworks Main by Waldnetworks Cobblemon Honey Academy Cobblemon Honey Academy A Toca da Coruja Modpack - Lite A Toca da Coruja Modpack - Lite Trademarked Trademarked Casual Chaos Cobble & Cloud [Cobblemon & Create] Casual Chaos Cobble & Cloud [Cobblemon & Create] Attack on Block {AoT} Attack on Block {AoT} Umbral Requiem - The Hollowed World (RPG) Umbral Requiem - The Hollowed World (RPG) The Living World The Living World Sublime Experience Sublime Experience Antariad Antariad Brite-sur-Mer 4 Brite-sur-Mer 4 Mococoa Mococoa Reino de Celeste Reino de Celeste Better, Faster, Fancier Better, Faster, Fancier OuiOuiCreate 2 OuiOuiCreate 2 Tis the Season Tis the Season Cobblemon Cursed Lake Cobblemon Cursed Lake Sky Energy Tech Sky Energy Tech TUIA (The Ultimate Indefinite Adventure) TUIA (The Ultimate Indefinite Adventure) Dimensional Chaos - OneBlock Dimensional Chaos - OneBlock Survival Recrafted Survival Recrafted KnopiaPack KnopiaPack Jhotonheim Cobblemon Jhotonheim Cobblemon Chronos Archives Chronos Archives Chronicles of Verdara Chronicles of Verdara Dwarfz Fantasy Dwarfz Fantasy

External Resources