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,910,401

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,034,008
Mouse Tweaks

Mouse Tweaks

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

Mod 550,390,492
Fabric API

Fabric API

Core API library for the Fabric toolchain

Mod 525,753,407
AppleSkin

AppleSkin

Adds some useful information about food/hunger to the HUD

Mod 520,905,727
GeckoLib

GeckoLib

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

Mod 505,444,873 354.7K this week
Architectury API

Architectury API

An intermediary api aimed to ease developing multiplatform mods.

Mod 461,823,473

Included in Modpacks (1,819)

Show fewer
MarchewkaSMP MarchewkaSMP ftehe's Vanilla+ ftehe's Vanilla+ AOR | All of the Random AOR | All of the Random Cobblemon - CobbleTowny Cobblemon - CobbleTowny Create - Brand New World Create - Brand New World ItzBuble's Create ItzBuble's Create Vivid Motions Vivid Motions GGPlays Cobblemon GGPlays Cobblemon Create: Physics And Aeronautics [Server-Side] Create: Physics And Aeronautics [Server-Side] IsekaiANewWorld IsekaiANewWorld Magic Expeditions Magic Expeditions CobbleAdventures Official Modpack CobbleAdventures Official Modpack Tropical Paradise Tropical Paradise [Tensura] Multiversal Origins [Tensura] Multiversal Origins Reinicio Desde De Zero (0 To Hero) Reinicio Desde De Zero (0 To Hero) SharkSquad - True Survivors SharkSquad - True Survivors Tales of Horizon Tales of Horizon spears spears FlatWorlds FlatWorlds EverUncomplete EverUncomplete 💎 Legend Infinity Project 💎 Legend Infinity Project Raven Create RP Raven Create RP Martinj Realistico Martinj Realistico Vanilla Revamped Vanilla Revamped Azeris Azeris Semarina Semarina Cobblemon Extended (LD16) Cobblemon Extended (LD16) Project Resonance - Ancient City Project Resonance - Ancient City Cobbled RPG Cobbled RPG The House Diablo Cobblemon Experience The House Diablo Cobblemon Experience Time To Work Time To Work Just Create Pluss Just Create Pluss riley is a furry riley is a furry Clarity Clarity Ronin Frontiers Ronin Frontiers Create - The Adventurer Create - The Adventurer HurleyCraft HurleyCraft Craft Colonies Craft Colonies Renderium Optimized Renderium Optimized Mundo Mitico Mundo Mitico AeroGelica AeroGelica Spiria Reincarnated Again! Spiria Reincarnated Again! Blue Moon SMP Blue Moon SMP Ascended Gear SMP Ascended Gear SMP Gorgeous Optimizations Gorgeous Optimizations Village Witch Village Witch Astryx Astryx OZPoke boys OZPoke boys Create: War and Economy Create: War and Economy Stahl und Sterne Stahl und Sterne Create: The Age of the Sky Create: The Age of the Sky MoJo's Cobblemon MoJo's Cobblemon Build n' Bake Build n' Bake LotaCraft: Lotaria LotaCraft: Lotaria CobblemonEvolution CobblemonEvolution Build and Thrive [Information Update Is out!] Build and Thrive [Information Update Is out!] Potato SMP (Survival Multi Player) Potato SMP (Survival Multi Player) Grietina Grietina Project Combat Project Combat Digital Dreamers Digital Dreamers Champions Ascent Official Champions Ascent Official Arkane 2 Arkane 2 Tensura - A Weakened Hierarchy Tensura - A Weakened Hierarchy Create UNSC version Create UNSC version Fatifers Cobblemon Fatifers Cobblemon Chris' Create Colonies Plus Chris' Create Colonies Plus Quadra Isles Quadra Isles Trambiquecraft Trambiquecraft Hotel de le Fresco Hotel de le Fresco KubeSMP KubeSMP The Real New World The Real New World Forge-rune.fr Forge-rune.fr Tycoon Tycoon Runeforge Chronicles Runeforge Chronicles Rural Factory Rural Factory Cozy Swords RPG 4.0 Cozy Swords RPG 4.0 Mine Attack Mine Attack A Winterly Christmas World - WCW A Winterly Christmas World - WCW Lumora Lumora CobbleSpirits CobbleSpirits Farbound Farbound Basically Bare Bones Basically Bare Bones NeoAdventure NeoAdventure PokeAurora Oficial PokeAurora Oficial Create-Acsended Create-Acsended Barely Modded Barely Modded Sakura Valley: Create & Beyond Sakura Valley: Create & Beyond STEFTOPIA SEASON 2 STEFTOPIA SEASON 2 Enhancemize Enhancemize TakoPack Colonies 2 TakoPack Colonies 2 Stormdal Colonies Stormdal Colonies Shroomcraft 2 Cobblemon Edition Shroomcraft 2 Cobblemon Edition VKRPG VKRPG Hephaestus Forge - Sky Hephaestus Forge - Sky The Maddest Son The Maddest Son Mechanical Cobblemons Mechanical Cobblemons De Grote Spelers Modpack De Grote Spelers Modpack BetterVanilla SMP ModPack BetterVanilla SMP ModPack Destiny's Kitchen Sink Destiny's Kitchen Sink Crimson Valley Crimson Valley

External Resources

CurseForge Modrinth Source Code Issues