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,913,841

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,041,654
Mouse Tweaks

Mouse Tweaks

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

Mod 550,397,647
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,912,147
GeckoLib

GeckoLib

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

Mod 505,459,734 354.7K this week
Architectury API

Architectury API

An intermediary api aimed to ease developing multiplatform mods.

Mod 461,830,465

Included in Modpacks (1,819)

Show fewer
Full Scale Full Scale KimServer KimServer New Eden AzeSoupiPack AzeSoupiPack MUNI SMP MUNI SMP Cobbleish Cobbleish Perpetual Motion Perpetual Motion Better Adventure Enhanced Better Adventure Enhanced Expanded Adventures: Vanilla+ Expanded Adventures: Vanilla+ Iron Sky: TurboClocked Iron Sky: TurboClocked Dinguz's Survival Ultimate Dinguz's Survival Ultimate Fyxe's Classic+ Fyxe's Classic+ RothCraft RothCraft Smolder's Ultimatum Smolder's Ultimatum Truly Vanilla Truly Vanilla DiamondFire Modpack PlasmicMC PlasmicMC Darkness to Dawn Darkness to Dawn Realms of Old Pixel Earth's Enchanted Survival Pixel Earth's Enchanted Survival IOOMNI 8 IOOMNI 8 Onyx Onyx SkyForge (Member Edition) SkyForge (Member Edition) 永遠 EIEN 永遠 EIEN Vaelor semiRPG Vaelor semiRPG JUSTCREATE_byzemzemsuyu JUSTCREATE_byzemzemsuyu TinyN TinyN Virimon Virimon XenCraft [First Night] [First Night] Official Yakuza modpack Official Yakuza modpack SilentTech SilentTech Seed & Stock: Swords to Plowshares Seed & Stock: Swords to Plowshares Liye Liye Lush Lands Lush Lands NEOptimized NEOptimized Cobblemon Cobalt Edition Cobblemon Cobalt Edition aLFa_iq aLFa_iq MC Sooty Edition MC Sooty Edition LumaVale LumaVale ZenCobblemon ZenCobblemon xXCAMPXx xXCAMPXx Teushitties Revenge 3D: Dorfeldt Fucking Dies Teushitties Revenge 3D: Dorfeldt Fucking Dies Foreverworld Essentials Foreverworld Essentials ZoeyNeko's Create Modpack ZoeyNeko's Create Modpack Felix′s Survival Modpack Creatine Creatine Veloz Veloz Aeronautic Adventures Create Zerene Create Zerene Sensible Perfected Sensible Perfected Difficulty-10 Difficulty-10 Domo's Cozy Adventure Domo's Cozy Adventure Hero Enhanced Vanilla Hero Enhanced Vanilla Bungis Pack Bungis Pack QuikPak QuikPak THE SAME MINE THE SAME MINE Smooth n' Sleek Smooth n' Sleek KSMP PacPack Aroma PacPack Aroma Create Automata Create Automata Cakeman's Enhanced Vanilla Cakeman's Enhanced Vanilla Many Many Mods I - MMM1 Many Many Mods I - MMM1 RW's Cobblemon Create LITE RW's Cobblemon Create LITE Create Techno Create Techno Mediumcore Enhanced+ Mediumcore Enhanced+ Omnia Omnia LeafSMP LeafSMP Super0ptimizati0n ForgiaCraft 11 ForgiaCraft 11 M2C M2C Tales of Folks Optimeta Optimeta IRLcraft Lite Edition FoxAndCraft FoxAndCraft Surviving The Spiral Surviving The Spiral Voidered Blaqua Voidered Blaqua The 100 Year Video Game Create: Survival Plus Create: Survival Plus lilacs lilacs Robikov's Cobblemon Robikov's Cobblemon Create: No Man's Land Create: No Man's Land Dolle Mods Dolle Mods PacPack Voxydized Server PacPack Voxydized Server MineboundSMP MineboundSMP Fabulous Fabric+ Fabulous Fabric+ Vanilla PLUS PLUS Vanilla PLUS PLUS oOZelephOo's Modpack oOZelephOo's Modpack GuSchu's Create Project 3 (GCP 3) GuSchu's Create Project 3 (GCP 3) Slairian SMP Core {Client} Slairian SMP Core {Client} Custom cobble pack by crow Better Than Ever [BTE] Better Than Ever [BTE] Nexo's MC Renewed Nexo's MC Renewed Cobblemon Create RPG Cobblemon Create RPG LymeHibry LymeHibry WILDMON WILDMON BearQuackers' Adventures BearQuackers' Adventures ferrox's qol ferrox's qol Create: Diminutive Create: Diminutive Technological Sandbox Technological Sandbox

External Resources

CurseForge Modrinth Source Code Issues