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
The aether of create The aether of create MacedCraft MacedCraft WildLight WildLight Erstwhile Journey 2 Erstwhile Journey 2 Rise of Power Rise of Power Stormdal Cobblemon journey's 2 Stormdal Cobblemon journey's 2 Solar Fantasy Solar Fantasy Zebatkowo Zebatkowo Fajita's Enhanced Minecraft Fajita's Enhanced Minecraft Lowfog Lowfog Stargates, Colonies, And Ridiculous Tech Stargates, Colonies, And Ridiculous Tech Vanilla Ventures Vanilla Ventures Community Made Community Made TurtleCraftSMP TurtleCraftSMP CraftToMuck: Sky CraftToMuck: Sky Dwarfz 5 Dwarfz 5 Quick Vanilla+ Quick Vanilla+ NotPack - Performance NotPack - Performance V-Cube V-Cube Cobblemon Irisian Edition Cobblemon Irisian Edition Creative Drawers Producer 2 Creative Drawers Producer 2 Da Boys Craft - DBC Da Boys Craft - DBC MaidApocalypse MaidApocalypse Redstoner's Paradise Redstoner's Paradise Create: New Horizons (CNH) Create: New Horizons (CNH) John Hall CEu Pack John Hall CEu Pack Opticraft - Improve performance and experience Opticraft - Improve performance and experience DLCraft! DLCraft! Steam and Stardust Steam and Stardust Var's Just Create+ SMP Var's Just Create+ SMP All Cobblemon in your world All Cobblemon in your world Arcadia Unlimited Arcadia Unlimited Chime Mon Chime Mon MotM - Sodium Edition MotM - Sodium Edition Mirabilis - Vanilla Plus Plus! Mirabilis - Vanilla Plus Plus! Nostalgized Nostalgized Effortless RPG Effortless RPG Mustard Virus NeoForged Mustard Virus NeoForged Vampiric Realms Vampiric Realms SL Quantum Factory SL Quantum Factory Savaru IV - Kohtalon Mies Savaru IV - Kohtalon Mies BACKPORT LOVERNITE BACKPORT LOVERNITE YeSMP YeSMP Cobblemon histories Cobblemon histories Ages Reimagined Ages Reimagined Best Mods (BM) Best Mods (BM) The Copper Age The Copper Age Smooth Journey (Lite Version) Smooth Journey (Lite Version) Planet Helios Planet Helios AestheticCraft - Cozy Adventure | MC Cozy 1.21.1 AestheticCraft - Cozy Adventure | MC Cozy 1.21.1 Steamon Steamon Prisms Create Prisms Create Dark Matter: To The Sky! Dark Matter: To The Sky! ComboTech 4 ComboTech 4 Grinding and industrialization GANDI 1 Grinding and industrialization GANDI 1 A Lll Modpark A Lll Modpark Da Boys Craft - Create Edition Da Boys Craft - Create Edition UnstableCraft SMP UnstableCraft SMP Atzlk MC: Official Modpack Plus+ Atzlk MC: Official Modpack Plus+ Xomaps Potato Sky Xomaps Potato Sky CreaTRIM CreaTRIM The Convergence I The Convergence I Cobbled Saint Cobbled Saint introverts island Server introverts island Server World of Minecolonies World of Minecolonies StupiClient StupiClient Odysseum Odysseum DungeonCraft Adventures [PHTB] DungeonCraft Adventures [PHTB] Vibrant N' Visuals Vibrant N' Visuals Realms Of Reverie Realms Of Reverie GameGarden Ultimate GameGarden Ultimate LUI BATTLE PACK LUI BATTLE PACK SleepySMP Season 2 SleepySMP Season 2 Nogla and Terroriser Reacts Patreon Nogla and Terroriser Reacts Patreon Cogs & Cobblemon Cogs & Cobblemon Fennix RPG - Fantasy Horizons Fennix RPG - Fantasy Horizons Wrath of Herobrine Wrath of Herobrine New Age 1 New Age 1 Usefully Optimized Usefully Optimized Dragon's Ultimate Tensura Adventure Dragon's Ultimate Tensura Adventure Tensura - rebuild Tensura - rebuild Gänseteich Gänseteich Bubble Cobble Redux Bubble Cobble Redux Fortnite 3: Victory Royale Fortnite 3: Victory Royale Knights of the Eve Knights of the Eve StoneBlock Project Matter StoneBlock Project Matter Cobblemon Gotta Cobble 'Em All Cobblemon Gotta Cobble 'Em All Pixelmon's LuckyBlock Arena Pixelmon's LuckyBlock Arena Continuity Error SMP Modpack Continuity Error SMP Modpack FrenchCube FrenchCube Beta Decay Beta Decay LongPlay Origins LongPlay Origins Create Aerodynamic Create Aerodynamic [FMCS-M] fps X media X crystal x survival Optimized MEDIUM [FMCS-M] fps X media X crystal x survival Optimized MEDIUM Create RPG+ Create RPG+ Happy Sandwich Happy Sandwich Fritz's RPG Fritz's RPG CreatingGregopolis CreatingGregopolis Endless Sky 2 Endless Sky 2 All About Cobblemon - Pokemon World ( Catch, Build, Explore ) All About Cobblemon - Pokemon World ( Catch, Build, Explore )

External Resources

CurseForge Modrinth Source Code Issues