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
Ultimate Client Ultimate Client Serenity Create SMP Serenity Create SMP Cyclo's Gearbound Cyclo's Gearbound CobbleSpirits CobbleSpirits Aeronautics: Complete Warfare Aeronautics: Complete Warfare SIMPLY: Vanilla SIMPLY: Vanilla Eternity - Refugievements Eternity - Refugievements KnopiaPack KnopiaPack Weathered Weathered Advancement Race Modpack Advancement Race Modpack Pigeon Craft s2 Pigeon Craft s2 Create OneBlock | by Saurier.xyz Create OneBlock | by Saurier.xyz Create: War and Economy Create: War and Economy BeyondCraft BeyondCraft Create: Physics And Aeronautics [Server-Side] Create: Physics And Aeronautics [Server-Side] Realms of Palluto Realms of Palluto CobbleHelx Modpack (Cobblemon) CobbleHelx Modpack (Cobblemon) Renderium Optimized Renderium Optimized Electrical Warfare Electrical Warfare Lumora Lumora Holiday blocks Holiday blocks Corpus 2026 Corpus 2026 SALOLAND SALOLAND TIMEGEAR TIMEGEAR Trial by Farmer Trial by Farmer Ron's Forever World Ron's Forever World Comfortable survival Comfortable survival CreateAbility CreateAbility Create: Horizons Create: Horizons Qwnks's Better Adventures Qwnks's Better Adventures GenPlus GenPlus Create - Brand New World Create - Brand New World Create Lite Create Lite CPWN Pack 2 CPWN Pack 2 Essentials Essentials GeekMon Modpack GeekMon Modpack vilmiComfort vilmiComfort Poketod SMP Poketod SMP Endless horizon Endless horizon Embervale SMP Embervale SMP Anthos: Grounded Anthos: Grounded Orange Juice with Pulp Orange Juice with Pulp Bogwood Matcha Flavoured Bogwood Matcha Flavoured Dark's simple QoL Dark's simple QoL CREATE HUB CREATE HUB SiestaSMP Modpack SiestaSMP Modpack Redacted II: Aerofactory Redacted II: Aerofactory DarkMetaKnight's Adventure Pack DarkMetaKnight's Adventure Pack PlasmicMC PlasmicMC Iron Sky: TurboClocked Iron Sky: TurboClocked Forever Building Forever Building Re-Crafted 3 Re-Crafted 3 Create Aero Mobile Cities Create Aero Mobile Cities AeroIslands AeroIslands Refabricated Beta Refabricated Beta Wayward Wayward Everything Refined II Everything Refined II Cobblemon WITH LYRICS Cobblemon WITH LYRICS Chaos & Adventure Chaos & Adventure Echoes of Alpha: The Herobrine Myth Echoes of Alpha: The Herobrine Myth Worlds O' Plenty II Worlds O' Plenty II Darkness to Dawn Darkness to Dawn Smolder's Ultimatum Smolder's Ultimatum IOOMNI 8 IOOMNI 8 Create: Full Steam Create: Full Steam fedcraft Voidbound Chronicles Voidbound Chronicles TherianCraft TherianCraft Pixel Earth's Enchanted Survival Pixel Earth's Enchanted Survival Stardivers Stardivers PURE. PURE. MC Sooty Edition MC Sooty Edition Vanilla: Remixed Vanilla: Remixed MUNI SMP MUNI SMP Rise of the Ancients Rise of the Ancients Felix′s Survival Modpack Tralty's Modded Adventure 2 Tralty's Modded Adventure 2 MerVik’s Vanilla+ MerVik’s Vanilla+ PeakMine PeakMine Official Yakuza modpack Official Yakuza modpack Cleanslate SMP Modpack Cleanslate SMP Modpack LumaVale LumaVale SkyForge (Member Edition) SkyForge (Member Edition) PacPack Voxydized Server PacPack Voxydized Server Vanguard Optimized Vanguard Optimized Beautiful For You Beautiful For You Many Many Mods I - MMM1 Many Many Mods I - MMM1 MineboundSMP MineboundSMP Astral Project Astral Project 永遠 EIEN 永遠 EIEN Venture INC. Venture INC. Lush Lands Lush Lands Rub3n's Vanilla pack Rub3n's Vanilla pack Full Scale Full Scale Truly Vanilla Truly Vanilla The Roaring 20's Oasis The Roaring 20's Oasis DiamondFire Modpack aLFa_iq aLFa_iq Better Adventure Enhanced Better Adventure Enhanced Domo's Cozy Adventure Domo's Cozy Adventure

External Resources