Modscraper Modscraper Minecraft

Sort By

Type

Content

Tags

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.

LEGO Minecraft Set

LEGO Minecraft Set

Official sets that translate the building side of the game off-screen.

View on Amazon →

As an Amazon Associate I earn from qualifying purchases.

Similar Mods

Cloth Config API (Fabric/Forge/NeoForge)

Cloth Config API (Fabric/Forge/NeoForge)

Config Screen API for Minecraft

Mod 539,600,731
Mouse Tweaks

Mouse Tweaks

Enhances inventory management by adding various functions to the mouse buttons.

Mod 531,462,053
AppleSkin

AppleSkin

Adds some useful information about food/hunger to the HUD

Mod 499,700,478
Fabric API

Fabric API

Core API library for the Fabric toolchain

Mod 480,123,459
GeckoLib

GeckoLib

A 3D animation library for entities, blocks, items, armor, and more!

Mod 473,768,572
Architectury API

Architectury API

An intermediary api aimed to ease developing multiplatform mods.

Mod 440,694,543

Included in Modpacks (1,549)

Show fewer
prjkt333 prjkt333 CC - CreateCobble CC - CreateCobble Pandora's Cobblemon Pandora's Cobblemon Serenor Serenor Create: Just Extended Tuned Tuned Medieval Epic Adventure Medieval Epic Adventure Cherry Cobblemon Modpack Cherry Cobblemon Modpack Blad Pack Blad Pack Quantum Haunt Quantum Haunt Modded Bridge Modded Bridge Colosal [TunazMC] Colosal [TunazMC] The Maddest Son The Maddest Son Destiny's Kitchen Sink Destiny's Kitchen Sink Millenaire Magics Millenaire Magics Hausimausis Hausimausis Cobblemon Forever Edition Cobblemon Forever Edition Cobblemon Chaos Edition Cobblemon Chaos Edition TroulyCube TroulyCube Buba's SMP+ Buba's SMP+ Souls Of Noxxastraël Souls Of Noxxastraël Create Gearbound Nexus Create Gearbound Nexus Cobblemon automated Cobblemon automated Vtube Meets Cobblemon Vtube Meets Cobblemon Unova-Unys Unova-Unys RainbowMon 2 RainbowMon 2 WildCraft Golden Era Reimagined WildCraft Golden Era Reimagined TPW: Redux TPW: Redux Fever MC Fever MC Hope SMP S2 (COBBLEMON) Hope SMP S2 (COBBLEMON) Oxide SMP Oxide SMP The Created Pack The Created Pack Project Combat Project Combat Create: Nations & Frontiers Create: Nations & Frontiers Amped Delight Amped Delight Just a Random Vanilla Adventure Just a Random Vanilla Adventure BanderCraft.com Optimize+comfort Modpack BanderCraft.com Optimize+comfort Modpack Magic & Flight Magic & Flight NeoFrontier NeoFrontier Fluidity Fluidity Diggicraft - The Beginning Diggicraft - The Beginning Steamspire Syndicate [Season 2] Steamspire Syndicate [Season 2] AeroMechanica AeroMechanica Glatzencraft Glatzencraft The Oblivion The Oblivion The Cobblemon Collective The Cobblemon Collective Farmer Academy Farmer Academy Cobblemon Pals Cobblemon Pals Mochi Mochi John's Cobblemon ServerPack John's Cobblemon ServerPack Hearthvale Hearthvale Motions and Smooth Motions and Smooth Nirvanium Nirvanium Batom e Cafe Batom e Cafe The Living World The Living World DriedFlower DriedFlower Create: Airborne Industry Create: Airborne Industry Blastub Aeronautics A Winterly Christmas World - WCW A Winterly Christmas World - WCW UnstableCraft UnstableCraft Dylan's Cozy Vanilla+ Dylan's Cozy Vanilla+ RanchMania RanchMania Wolly's Adventure Pack Wolly's Adventure Pack NEWMON NEWMON Trademarked Trademarked eXtra Live Collect them all eXtra Live Collect them all Wen's Create Experience [Server-side] Wen's Create Experience [Server-side] RC Cobblemon RC Cobblemon Mine Attack Mine Attack ftehe's Vanilla+ ftehe's Vanilla+ Build n' Bake Build n' Bake Wild Frontiers Wild Frontiers Realms of Craft Realms of Craft Almost Pure Vanilla Almost Pure Vanilla Last MC 2025 JTF Last MC 2025 JTF RothCraft RothCraft Vanilla Plus+++ Vanilla Plus+++ Hug Trees With Gromit Hug Trees With Gromit JPO SMP JPO SMP Bachnet Survival Bachnet Survival Astryx Astryx CityParts Pack CityParts Pack FortMine ++ FortMine ++ Create Mod - Second Chance Create Mod - Second Chance Just Around The Block Just Around The Block KDesp Survival KDesp Survival Vanilla Enhanced Vanilla Enhanced MMOs Group Modpack MMOs Group Modpack AzeSoupiPack AzeSoupiPack Project Overclock Project Overclock Blue Moon SMP Blue Moon SMP Cobbleish Cobbleish Cobblemon Tokai Construction Pack Cobblemon Tokai Construction Pack WildWorld WildWorld Barely Modded Barely Modded The Lost Realms The Lost Realms Minetlan Minetlan UnitedUnion UnitedUnion Eve's LITE Eve's LITE Re-Crafted 2 Re-Crafted 2

External Resources

CurseForge Modrinth Source Code Issues