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
Egregious Industrialization Egregious Industrialization Cobblemon Perfected Cobblemon Perfected MTUM - More Than Useful Modpack MTUM - More Than Useful Modpack Lucky Pixelados Lucky Pixelados Needed Essentials Needed Essentials Goon Crew Collection VR Goon Crew Collection VR MayraLand MayraLand Outerworlds Outerworlds Challenge Craft Challenge Craft A Journey Through The Ages A Journey Through The Ages All You Need 2 - AYN 2 All You Need 2 - AYN 2 Aussie Create 6 Aussie Create 6 Potato Optimizer Potato Optimizer Aeronautic Colonies Aeronautic Colonies Voloron 4 Voloron 4 Triforce's Cobblemon Academy Triforce's Cobblemon Academy Cobblemon aBunchaMods Cobblemon aBunchaMods Evil larry's playground Evil larry's playground Toky Craft Toky Craft Classic Evolved Zero Classic Evolved Zero Bucketsink Bucketsink Essentials Essentials Spells Gears n' Bells RP Spells Gears n' Bells RP VtubersPlayCobblemon VtubersPlayCobblemon TCC - Skyzone TCC - Skyzone LiteHearted LiteHearted HORYZONEA HORYZONEA Blue Skies & Black Smoke Blue Skies & Black Smoke Cradle of the Hosts Cradle of the Hosts A Crazy Adventure: Science & Survival A Crazy Adventure: Science & Survival Peace of Mind 21.1 Peace of Mind 21.1 Cataclysmic Ascension Cataclysmic Ascension Cups & Wine Cups & Wine The Broken World (New) The Broken World (New) Create Reiterated - S2 Create Reiterated - S2 OneBlock Cobblemon NDC OneBlock Cobblemon NDC Create Beyond Horizons Create Beyond Horizons CreateSMP Aeronautics CreateSMP Aeronautics Xomaps Element Xomaps Element Createmon Cindoria Createmon Cindoria Simply's Tensura Simply's Tensura Limbones Server Modpack Limbones Server Modpack Cobblemon Reign Cobblemon Reign CanarioLand 2 CanarioLand 2 Create and Adventure With Friends Create and Adventure With Friends Silver's Cobblemon Silver's Cobblemon hardcore-pvz hardcore-pvz Cobblemon Grand Journey Cobblemon Grand Journey SKD DC SKD DC Create: Aeronautics Experience Create: Aeronautics Experience The Hunter Project The Hunter Project Mythic Machina Mythic Machina Create: Up and Away Create: Up and Away Adventure Wildfront Adventure Wildfront Advenium 3 Advenium 3 Oasis Tropic Oasis Tropic Complimentary Vanilla Complimentary Vanilla Tanehu's Beyond The End Tanehu's Beyond The End Mitte-Erde Mitte-Erde Perfect Java Perfect Java Apotheosis Pack 3 Apotheosis Pack 3 Block Saga Block Saga Minescape Addons Minescape Addons ZenCobblemon ZenCobblemon Weedie's Industrial Fantasy Weedie's Industrial Fantasy Holdy's Chronicle Holdy's Chronicle Pickable Me Pickable Me Karmalandia Oficial BY KKurotsukii Karmalandia Oficial BY KKurotsukii Turkuć SMP: PENTIMENTO Turkuć SMP: PENTIMENTO PackNeverLucky PackNeverLucky DrUltraLux's Steam Fantasy DrUltraLux's Steam Fantasy Embervale SMP Embervale SMP Zenith Lite Zenith Lite The Land of Caellum 2.0 The Land of Caellum 2.0 Andy's Vanilla+ Modpack Andy's Vanilla+ Modpack Cozymon Adventure Cozymon Adventure PixelSprings PixelSprings Comfycraft Comfycraft Dark Hours Dark Hours 9C: Eternity 9C: Eternity Cobblemon Exploration Wonder Cobblemon Exploration Wonder Weedie's Undead Adventure Weedie's Undead Adventure Flookers All The Mons! Flookers All The Mons! Milkman of Walnuts Regrowth Milkman of Walnuts Regrowth NewPath - Echoes of the Wild NewPath - Echoes of the Wild MafiaCraft MafiaCraft Finally a GREAT Tensura Server! Finally a GREAT Tensura Server! All About Aether - Sky Dimension Adventure All About Aether - Sky Dimension Adventure SwellCraft - Create & Cobblemon SwellCraft - Create & Cobblemon Skyindustries Alchemic Skyindustries Alchemic Essence Odyssey Essence Odyssey Everhaven Everhaven Government Government ATMIL - All The Mods I Love ATMIL - All The Mods I Love Pokenautics Pokenautics PureSavage-with-shaders-and-rp PureSavage-with-shaders-and-rp Attack On Titan (Shingeki No Kyojin) By PatakyHD Attack On Titan (Shingeki No Kyojin) By PatakyHD MTZ EXPERTE MTZ EXPERTE Untitled Modpack - Hard Survival Untitled Modpack - Hard Survival DittoLand Cobblemon DittoLand Cobblemon

External Resources