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
MacedCraft MacedCraft Shattered Skies [LC] Shattered Skies [LC] Cook in Skyland Elegant Feast Cook in Skyland Elegant Feast Arcane Empires & Ancient Evils Arcane Empires & Ancient Evils Trial of the Void Trial of the Void Jelly&Co Jelly&Co Create chillax Create chillax Fr3shpack - TooManyMods Fr3shpack - TooManyMods MHG: Cities! MHG: Cities! Remnants - Ashen Legacy Remnants - Ashen Legacy The Bright Side Of Create The Bright Side Of Create MC Enhanced [FABRIC] MC Enhanced [FABRIC] Steamon Steamon Tensura: Luminous Tensura: Luminous SkyTech Evolution SkyTech Evolution The Next Tomorrow Cobblemon (NO LONGER IN USE) The Next Tomorrow Cobblemon (NO LONGER IN USE) DragLed Optimized DragLed Optimized HT1: Velocity modpack HT1: Velocity modpack Sylix Cobblemon Sylix Cobblemon Tensura Final Resolve Tensura Final Resolve Multiversal Misadventures - The Blockhead's Guide to the Galaxy Multiversal Misadventures - The Blockhead's Guide to the Galaxy ImmersiveMC - IMC2 ImmersiveMC - IMC2 Most Of The Mods Most Of The Mods Dynamic Odyssey Dynamic Odyssey Atzlk MC: Official Modpack Plus+ Atzlk MC: Official Modpack Plus+ Best Mods (BM) Best Mods (BM) Unique Block 1 - UB 1 Unique Block 1 - UB 1 Simplicity Refabricated: Vanilla+ Simplicity Refabricated: Vanilla+ Aeronautics-The Create Dream Aeronautics-The Create Dream SubCraft Rebirth SubCraft Rebirth DLCraft! DLCraft! Farmtastic! Farmtastic! SIMPLY: Survival SIMPLY: Survival Cobblemon Empire Cobblemon Empire Tensura Tainted Grace Tensura Tainted Grace TussleCraft - Forgotten Age TussleCraft - Forgotten Age Catch, Create, Conquer Catch, Create, Conquer The Odyssey (Create Aeronautics & Weather mods) The Odyssey (Create Aeronautics & Weather mods) MC Vanilla Shaders MC Vanilla Shaders Galaxy Sky Galaxy Sky Lowfog Lowfog Everwild (Cobblemon) Everwild (Cobblemon) Vanilla Optimized Plus Vanilla Optimized Plus Create: Cogs & Cataclysm Create: Cogs & Cataclysm Our Antarchy Craft Our Antarchy Craft Cobblemon Vulkan (Performance Pack) Cobblemon Vulkan (Performance Pack) Better MC [ PACK ] Better MC [ PACK ] SpHiNxX's Technical Overhaul SpHiNxX's Technical Overhaul Maid Service Maid Service Create SMP Addons+extra Create SMP Addons+extra On Ancient Ground On Ancient Ground Applied Energestic 2 vs Refined Storage Neoforged Applied Energestic 2 vs Refined Storage Neoforged Awakened Server Awakened Server Gundustry Gundustry Ultimate Neodium Ultimate Neodium Dracium Create Edition Dracium Create Edition Legacized Legacized Overclock - Tech Automation with Quests | Create, Aeronautics, AE2, Modern Industrialization & More Overclock - Tech Automation with Quests | Create, Aeronautics, AE2, Modern Industrialization & More Zecoar Modpack Zecoar Modpack Ancient Kingdoms 4 Ancient Kingdoms 4 Create Vanilla+ (THEO) Create Vanilla+ (THEO) Bakumon Official Bakumon Official Create RPG+ Create RPG+ Quick Vanilla+ Quick Vanilla+ Bingus SMP Season 9 Aeronautics Bingus SMP Season 9 Aeronautics HARDCORE EVOLUTIONS HARDCORE EVOLUTIONS Dragon create Dragon create Almost enough content Almost enough content Cobblemon Journeys End Cobblemon Journeys End Zebatkowo Zebatkowo Winter Arc Winter Arc Pixelmon's LuckyBlock Arena Pixelmon's LuckyBlock Arena Create Perfectionn Create Perfectionn KrzakiPudlo_3.5: Pixelmon Edition KrzakiPudlo_3.5: Pixelmon Edition Cobblefam Cobblefam ComboTech 4 ComboTech 4 Smooth Journey (Lite Version) Smooth Journey (Lite Version) Cobbled Saint Cobbled Saint SleepySMP Season 2 SleepySMP Season 2 Create: New Horizons (CNH) Create: New Horizons (CNH) Solar Fantasy Solar Fantasy DungeonCraft Adventures [PHTB] DungeonCraft Adventures [PHTB] One Cobble Block One Cobble Block theArcadia theArcadia Path to Exile - Next Generation Path to Exile - Next Generation All About Create - Automation & Mechanicals Tech All About Create - Automation & Mechanicals Tech Bombastic Fantastic World Experience Bombastic Fantastic World Experience RareLabs Colonies RareLabs Colonies RPG-LITE RPG-LITE NPLX - Modern Beta NPLX - Modern Beta ISKRA ISKRA WildLight WildLight Cobblemon: Path Of Legends Cobblemon: Path Of Legends Realms Of Reverie Realms Of Reverie The Sift [Enhanced Adventure] The Sift [Enhanced Adventure] Community Made Community Made FrenchCube FrenchCube Rise of Power Rise of Power TurtleCraftSMP TurtleCraftSMP Tensura - rebuild Tensura - rebuild

External Resources

CurseForge Modrinth Source Code Issues