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

52,906,346

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.

Mini PC for self-hosting

Mini PC for Self-Hosting

A low-power box that can sit in a cupboard and run a modded server around the clock.

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 571,005,080
Mouse Tweaks

Mouse Tweaks

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

Mod 550,375,362
Fabric API

Fabric API

Core API library for the Fabric toolchain

Mod 525,714,625
AppleSkin

AppleSkin

Adds some useful information about food/hunger to the HUD

Mod 520,882,628
GeckoLib

GeckoLib

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

Mod 505,418,317 354.7K this week
Architectury API

Architectury API

An intermediary api aimed to ease developing multiplatform mods.

Mod 461,802,040

Included in Modpacks (1,819)

Show fewer
Aetheris QoL Aetheris QoL Knights of the Eve Knights of the Eve The Convergence I The Convergence I Nogla and Terroriser Reacts Patreon Nogla and Terroriser Reacts Patreon Aquatica Aquatica Continuity Error SMP Modpack Continuity Error SMP Modpack Fritz's RPG Fritz's RPG MaidApocalypse MaidApocalypse Effortless RPG Effortless RPG No Limits Project No Limits Project Endless Sky 2 Endless Sky 2 Karma's Cobblemon Mechanical Magic Karma's Cobblemon Mechanical Magic Prisms Create Prisms Create Terraria not MC Terraria not MC Create Aerodynamic Create Aerodynamic Cobblemon Enhanced - Pokemon Adventure Cobblemon Enhanced - Pokemon Adventure Create, Lanterns and Magic! Create, Lanterns and Magic! Create Integrated Create Integrated Dragon's Ultimate Tensura Adventure Dragon's Ultimate Tensura Adventure Create Aeronautics Age Of Aerolution Create Aeronautics Age Of Aerolution Chime Mon Chime Mon [FMCS-M] fps X media X crystal x survival Optimized MEDIUM [FMCS-M] fps X media X crystal x survival Optimized MEDIUM Lunaria the Creater Lunaria the Creater Techno Vanilla Techno Vanilla The Copper Age The Copper Age MotM - Sodium Edition MotM - Sodium Edition Sky Ground Next Level Sky Ground Next Level CrazyMC - A Special Apocalypse | Apocalypse with Quests! CrazyMC - A Special Apocalypse | Apocalypse with Quests! Stratum Stratum Femtomancy Femtomancy Cobblemon Eclipse Cobblemon Eclipse Age Of Assembly Age Of Assembly NVPack NVPack New Age Branch Line New Age Branch Line Forbidden Engine Of Conquest Forbidden Engine Of Conquest Naruto Destination Showcase Naruto Destination Showcase Yet Another Horror Pack Yet Another Horror Pack Fennix RPG - Fantasy Horizons Fennix RPG - Fantasy Horizons Dark Matter: To The Sky! Dark Matter: To The Sky! scc cobbelmon scc cobbelmon Cogs & Cobblemon Cogs & Cobblemon Mechanical suffering Mechanical suffering The Modpack of absolute all time The Modpack of absolute all time Hub-Craft Hub-Craft Camp Cobblemon - Lightly Modded Cobblemon + Builder Tools Camp Cobblemon - Lightly Modded Cobblemon + Builder Tools Cobblemon Gotta Cobble 'Em All Cobblemon Gotta Cobble 'Em All Nexus RPG Nexus RPG OneBlock Evolution OneBlock Evolution Cobblemon PBG Cobblemon PBG FluxEngine - Ultra Performance & Ultimate FPS Boost FluxEngine - Ultra Performance & Ultimate FPS Boost ChillCraft - Play Your Way Chill Your Way (Neoforge) ChillCraft - Play Your Way Chill Your Way (Neoforge) SC Final Adventure SC Final Adventure Raven's High Fantasy Raven's High Fantasy Slime Kingdom Slime Kingdom Fortnite 3: Victory Royale Fortnite 3: Victory Royale RotomWorks RotomWorks Planet Helios Planet Helios SC Final Adventure - Arcana SC Final Adventure - Arcana Mekacraft! Mekacraft! CreaTRIM CreaTRIM MineColonies: safe and sound MineColonies: safe and sound PossessedArmor's Random Starters Cobblemon PossessedArmor's Random Starters Cobblemon Freaky Pack - Cute vs Horror Freaky Pack - Cute vs Horror Maria's Create Project Maria's Create Project LFY Experience LFY Experience Ninjacat Skies Ninjacat Skies PixelSprings Plus PixelSprings Plus LongPlay Origins LongPlay Origins The One And Only Mania The One And Only Mania Homestead Horizon Homestead Horizon All About Cobblemon - Pokemon World ( Catch, Build, Explore ) All About Cobblemon - Pokemon World ( Catch, Build, Explore ) AVP Tech AVP Tech Echoes of Kaepora Echoes of Kaepora Blighted Dreams Blighted Dreams Cobbletheseballs Cobbletheseballs Goodfellaz Vanilla+ Goodfellaz Vanilla+ Waguri CPvP v2 Waguri CPvP v2 Promethium Promethium Kreyc's Waterworld Kreyc's Waterworld MysticalColonies MysticalColonies Vanilla Expansion Overhaul | veo Vanilla Expansion Overhaul | veo Arceus's Cobblemon and Create Arceus's Cobblemon and Create EaterSMP EaterSMP Decked Out Vanilla+ Decked Out Vanilla+ Prismatica Prismatica 2Gather [Aeronautics] 2Gather [Aeronautics] Creative Colonies - [Build, Automate, Thrive] Creative Colonies - [Build, Automate, Thrive] Cozy Animal Crossing - A Cozy Farming Adventure Cozy Animal Crossing - A Cozy Farming Adventure VOID-BOX2 VOID-BOX2 lightcraft season 2 lightcraft season 2 Vista Horizons Vista Horizons HugoSMP Modpack HugoSMP Modpack Pixelmon Adventures ( Server Pack ) Pixelmon Adventures ( Server Pack ) CreatingGregopolis CreatingGregopolis Xenith Xenith Wyrmfell Wyrmfell Snorland Cobblemon Snorland Cobblemon Create & Conquer Create & Conquer Beyond The Walls Beyond The Walls Nekocraft Nekocraft

External Resources

CurseForge Modrinth Source Code Issues