Prickle Mod (26.1.2, 1.21.1) – Lightweight JSON-Based Config System

Prickle Mod is a JSON-based configuration format designed for Minecraft. It adds features like comments, decorators, and default values while remaining fully compatible with standard JSON.

Features:

• Comments: Add explanations to your config using the reserved // key. Can be single-line or multi-line.
  • Single-line example:
    {
"database_host": {
"//": "The IP address of the database to connect to.",
"value": "192.168.1.0"
}
}
  • Multi-line example:
    {
"database_host": {
"//": [
"The IP address of the database to connect to.",
"The port can be suffixed using a colon."
],
"value": "192.168.1.0"
}
}
• Decorators: Named comments that describe metadata for a property.
  • //default – default value
  • //reference – link to documentation
  • //range – allowed numeric range
  • //regex – regex validation pattern
  • //empty-allowed – whether empty values are allowed
• Full JSON Compatibility: Works with all existing JSON tools and syntax highlighting.

Example:

{
"host": {
"//default": "192.168.1.1",
"value": "192.168.1.1"
},
"logMessages": {
"//default": true,
"value": true
}
}

Advanced Options:

• Ranged Numbers: Use @RangedInt, @RangedFloat, etc. to define min and max.
  {
"ranged_int": {
"//range": ">=0 AND <=100",
"//default": 84,
"value": 22
}
}
• Regex Validation: Ensure string values follow a pattern.
  {
"logo_file": {
"//regex": "^.*.(jpg|png)$",
"//default": "logo.png",
"value": "resources/my_logo.png"
}
}
• Arrays: Use @Array for lists with optional inlining and empty rules.
  • intArray – inlined small arrays
  • charArray – multi-line arrays
• Custom Property Types: Add new types with IPropertyAdapter or @Adapter.

Usage:

• Create a config class with @Value fields for properties.
• Load the config using ConfigManager.load("example", new ExampleConfig()).
• Defaults, comments, and decorators will be automatically written to the JSON file.

Prickle Mod Download Links