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
Cobblemon Dimensions Cobblemon Dimensions Sylix Cobblemon Sylix Cobblemon Cobblemon Sky Adventure Cobblemon Sky Adventure Pony Pony Panic Pony Pony Panic Cook in Skyland Elegant Feast Cook in Skyland Elegant Feast Unique Block 1 - UB 1 Unique Block 1 - UB 1 Chill Chill HCT - Hexandcube's Client Tweaks HCT - Hexandcube's Client Tweaks ES CRAFT ES CRAFT DragLed Optimized DragLed Optimized Smooth Journey Smooth Journey SubCraft Rebirth SubCraft Rebirth Echoes of Volkrune - Rebirth of Order Echoes of Volkrune - Rebirth of Order Shadow Dragoons Shadow Dragoons Tensura Final Resolve Tensura Final Resolve Trial of the Void Trial of the Void Modern Beta Modern Beta Backtanked Backtanked Tensura Reincarnated Life In Another World Tensura Reincarnated Life In Another World The Next Tomorrow Cobblemon (NO LONGER IN USE) The Next Tomorrow Cobblemon (NO LONGER IN USE) Create: Physics And Aeronautics Create: Physics And Aeronautics SIMPLY: Survival SIMPLY: Survival Most Of The Mods Most Of The Mods TussleCraft - Forgotten Age TussleCraft - Forgotten Age TerraFirmaKingdoms Season 1 TerraFirmaKingdoms Season 1 Minecolonies - Order and Chaos Minecolonies - Order and Chaos MHG: Cities! MHG: Cities! Tensura Tainted Grace Tensura Tainted Grace Multiversal Misadventures - The Blockhead's Guide to the Galaxy Multiversal Misadventures - The Blockhead's Guide to the Galaxy Everwild (Cobblemon) Everwild (Cobblemon) Aeronautics-The Create Dream Aeronautics-The Create Dream Jelly&Co Jelly&Co ImmersiveMC - IMC2 ImmersiveMC - IMC2 Banjo's Lightly Salted Banjo's Lightly Salted Cobblemon Journeys End Cobblemon Journeys End Legacized Legacized Cobblefam Cobblefam SpHiNxX's Technical Overhaul SpHiNxX's Technical Overhaul Dracium Create Edition Dracium Create Edition Farmtastic! Farmtastic! SkyTech Evolution SkyTech Evolution Tensura Pandemonium Official Tensura Pandemonium Official Dragon create Dragon create On Ancient Ground On Ancient Ground Winter Arc Winter Arc Sleepymon [COBBLEMON] Sleepymon [COBBLEMON] Almost enough content Almost enough content Galaxy Sky Galaxy Sky Dimensional Cultivation Dimensional Cultivation KrzakiPudlo_3.5: Pixelmon Edition KrzakiPudlo_3.5: Pixelmon Edition Cobblemon Unbound Cobblemon Unbound Dynamic Odyssey Dynamic Odyssey Bombastic Fantastic World Experience Bombastic Fantastic World Experience NPLX - Modern Beta NPLX - Modern Beta Create: Cogs & Cataclysm Create: Cogs & Cataclysm World at war World at war Kinetic Origins Kinetic Origins Dungeons & Crafting Dungeons & Crafting Create Perfectionn Create Perfectionn RareLabs Colonies RareLabs Colonies Cobblemon Vulkan (Performance Pack) Cobblemon Vulkan (Performance Pack) Cobblemon Empire Cobblemon Empire All About Create - Automation & Mechanicals Tech All About Create - Automation & Mechanicals Tech Cobblemon: Path Of Legends Cobblemon: Path Of Legends Protocol Zero-(HARDCORE EDITION) Protocol Zero-(HARDCORE EDITION) Ancient Worlds Ancient Worlds PokeWild Cobblemon PokeWild Cobblemon Applied Energestic 2 vs Refined Storage Neoforged Applied Energestic 2 vs Refined Storage Neoforged Zecoar Modpack Zecoar Modpack Zenavia Cobblemon Academy Zenavia Cobblemon Academy Trials of Terra Trials of Terra The Bright Side Of Create The Bright Side Of Create Create: Constructs of the Wild Create: Constructs of the Wild VCCP - Vanilla-Compatible Client Pack (NeoForge) VCCP - Vanilla-Compatible Client Pack (NeoForge) Terra by Sexy Crew Terra by Sexy Crew Create: SatisFactory Create: SatisFactory Project Obscura Project Obscura Cobblemon Adventure V2 Cobblemon Adventure V2 Bingus SMP Season 9 Aeronautics Bingus SMP Season 9 Aeronautics Cobblemon: Unbound Cobblemon: Unbound Rob's Cobblemon Academy Rob's Cobblemon Academy Path to Exile - Next Generation Path to Exile - Next Generation Emberspark Cobblemon Emberspark Cobblemon CobbleStories - A Create Adventure CobbleStories - A Create Adventure ReCraft S8 Project infinity 0.1 ReCraft S8 Project infinity 0.1 Vanilla Optimized Plus Vanilla Optimized Plus MuratCraft v2 MuratCraft v2 Professional PVP Professional PVP The Pond Edition [NEOFORGE] The Pond Edition [NEOFORGE] The Panda Foundry The Panda Foundry Return Of The Ancients Return Of The Ancients Cook in Skyland Recaked Cook in Skyland Recaked New Age Science and Technology hard New Age Science and Technology hard Cobblemon SMP: Trainer's Journey Cobblemon SMP: Trainer's Journey Farmageddon Farmageddon Catch, Create, Conquer Catch, Create, Conquer Simplicity Refabricated: Vanilla+ Simplicity Refabricated: Vanilla+ theArcadia theArcadia Mostly Just Cobblemon Mostly Just Cobblemon Cobblemon.RPG Cobblemon.RPG

External Resources