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,018,716
Mouse Tweaks

Mouse Tweaks

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

Mod 550,382,502
Fabric API

Fabric API

Core API library for the Fabric toolchain

Mod 525,735,264
AppleSkin

AppleSkin

Adds some useful information about food/hunger to the HUD

Mod 520,894,952
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
Totheron Totheron DracoNeo - Council of Wyrms DracoNeo - Council of Wyrms Eden Factory Eden Factory PureMash Tech PureMash Tech Create & Conquer: Last Light Create & Conquer: Last Light Tensura Rebirth Tensura Rebirth Enchantments Enchantments Millenaire Magics Millenaire Magics Corps Cobble - Cobblemon Path Of Adventure Corps Cobble - Cobblemon Path Of Adventure SC Final Adventure - Machines SC Final Adventure - Machines Cobbled Industries 2 Cobbled Industries 2 Cobblemon Generations SMP Cobblemon Generations SMP Elysium [ASCENSION] Elysium [ASCENSION] Vanilla Bloom Vanilla Bloom Manaeval Legacy (Black Clover) Manaeval Legacy (Black Clover) Cobblemon Survival with Friends Cobblemon Survival with Friends Zenith+ Zenith+ The Joaozin's Gayzown's Reforged - Guelcraft The Joaozin's Gayzown's Reforged - Guelcraft Cobblemon Quest made by Tuan Cobblemon Quest made by Tuan BluePrint SMP BluePrint SMP Only Create It Only Create It Survival Mode Tweaks Survival Mode Tweaks Pino 4 Pino 4 Swiss Squared Swiss Squared PixelLife PixelLife Triberean's Ultimate Furniturecraft Triberean's Ultimate Furniturecraft Pocky's Vanilla Pocky's Vanilla Create Vine & Wine Create Vine & Wine A Colony Survival A Colony Survival Tobinator Stream-Pack Tobinator Stream-Pack Crops And Cuisine Crops And Cuisine BuildUp (NeoForge) BuildUp (NeoForge) All About Alchemy - Magic & Potions All About Alchemy - Magic & Potions Tensura Industries Tensura Industries KaijuuCraft KaijuuCraft CloudCraft ModPack CloudCraft ModPack RatProject RatProject Arkobia 3 Arkobia 3 StormCore StormCore Gearfall Gearfall Haydenmon Evolved Haydenmon Evolved Pixelmon Adventure and RPG Pixelmon Adventure and RPG Sable Wood - Japan Sable Wood - Japan Royalty Cobblemon Royalty Cobblemon StealthCraft Season 2 StealthCraft Season 2 Xianxia and Magic++ Xianxia and Magic++ Tensura Restricted Tensura Restricted Mystical goo Mystical goo IkeTech 2.0 IkeTech 2.0 CatzyCraft CatzyCraft The Colony Network S2 The Colony Network S2 CreateCraft Aero SMP CreateCraft Aero SMP This Land of ours This Land of ours Tensura: Unbound (with Tensura: Reincarnated, Tensura: Unique Monsters and More Addons) Tensura: Unbound (with Tensura: Reincarnated, Tensura: Unique Monsters and More Addons) Aqua Cobblemon Aqua Cobblemon Vanilla+ (w Cobblemon) Vanilla+ (w Cobblemon) Hidecraft Modpack Hidecraft Modpack The Iron Frontier The Iron Frontier Socky's Create Modpack Socky's Create Modpack Karmunism-Refugee Karmunism-Refugee Cobblemon Champions Cobblemon Champions The Kindred's Cobblemon Adventures The Kindred's Cobblemon Adventures Magitechnical Mysticism 2 Magitechnical Mysticism 2 Create Aeronautics Survival Create Aeronautics Survival Best Survival Modpack For Latest Version Best Survival Modpack For Latest Version Lumin Origins Lumin Origins SVA Dragonfall SVA Dragonfall Factory Age Factory Age AllTheAvaritia ATA1 AllTheAvaritia ATA1 Cobblemon Tokai Construction Pack Cobblemon Tokai Construction Pack The Goons Lagoon The Goons Lagoon BlazeCraft Infinite BlazeCraft Infinite medieval smp S4 medieval smp S4 Project Solaris Modpack Project Solaris Modpack Goon Crew Collection Goon Crew Collection Enigmatica 10 - Bosses Unleashed Enigmatica 10 - Bosses Unleashed Technology Evolution TE Technology Evolution TE The lads on tour The lads on tour CleanCraft by ACUL [Neoforged] CleanCraft by ACUL [Neoforged] Cobble Lemon Cobble Lemon Eevee Isles Eevee Isles Old Scenery Old Scenery CAC Cobblemon Ars Create CAC Cobblemon Ars Create GearboundSMP S2 - Create Multiplayer GearboundSMP S2 - Create Multiplayer DivineRPG Plus DivineRPG Plus Yucataland Yucataland Cobbled Kingdom Mons Cobbled Kingdom Mons N-Tech RockBlock 4 N-Tech RockBlock 4 ROLO Edition ROLO Edition Glowstone Galaxy Create Edition Glowstone Galaxy Create Edition Valley Land Valley Land VACraft VACraft Alex's Pack 1.21.1 Alex's Pack 1.21.1 Guns, Vehicles and Food Guns, Vehicles and Food Fast and Better Vanilla Fast and Better Vanilla EasyColonies2 EasyColonies2 Random House - Interestelar Random House - Interestelar XAVIER Personal Pack XAVIER Personal Pack All Of Maces All Of Maces Eclipse Client Eclipse Client

External Resources

CurseForge Modrinth Source Code Issues