Prickle

Prickle - это формат конфигурационных файлов, построенный на JSON, который привносит в Майнкрафт удобные фишки для настройки модов. Если вы когда-нибудь правили конфиги вручную, то знаете, как бесит отсутствие комментариев и подсказок. Prickle решает эту проблему, оставаясь при этом полностью совместимым с обычным JSON.

Зачем это нужно в Minecraft

В ванильном Майнкрафте конфиги обычно пишутся на JSON - это касается датапаков, команд и настроек сервера. Но у JSON есть недостатки: нельзя оставить пояснение к параметру, нет значений по умолчанию, а если мод сложный - разобраться в настройках без документации сложно. Prickle добавляет к JSON комментарии и декораторы, которые помогают понять, что делает каждый параметр, не заглядывая в вики.

Как это работает

В Prickle каждое значение свойства оборачивается в JSON-объект. Это позволяет прикрепить к нему метаданные - например, комментарий. Выглядит это так:

{
  "database_host": {
    "//": "IP-адрес базы данных для подключения.",
    "value": "192.168.1.222"
  }
}

Ключ // зарезервирован для комментариев. Они никак не влияют на парсинг файла, только дают подсказку читающему. Комментарий может быть строкой или массивом строк для многострочных заметок.

Декораторы

Декораторы - это именованные комментарии, которые описывают свойство. Например, //default показывает значение по умолчанию. Вот что можно встретить в Prickle-файлах:

• //default - значение по умолчанию.
• //reference - ссылка на ресурс (например, страницу вики).
• //range - допустимый диапазон (например, >=5).
• //regex - регулярное выражение, которому должно соответствовать значение.
• //empty-allowed - может ли значение быть пустым (по умолчанию true).

Декораторы, как и комментарии, не влияют на парсинг - они просто описывают свойство, чтобы разработчик или игрок понимал, что от него ждут.

Почему Prickle, а не TOML или YAML

Автор мода перепробовал другие форматы вроде TOML, но столкнулся с проблемами: баги в Java-реализациях, отсутствие нужных фич, заброшенные библиотеки. А JSON в Майнкрафте уже родной - его используют для датапаков и команд. Prickle просто расширяет JSON, не ломая совместимости. То есть любой инструмент, который умеет читать JSON, справится и с Prickle.

Что по практичности

Если вы собираете модпак или настраиваете сервер - Prickle упрощает жизнь. Вместо того чтобы гадать, что значит тот или иной параметр, вы видите комментарий прямо в файле. А декораторы вроде //range или //default помогают не выставить кривое значение. Правда, сам мод не добавляет в игру никаких блоков или механик - это чисто техническая прослойка для разработчиков. Но если мод, который вы ставите, использует Prickle - вы это оцените.

Совместимость

Prickle работает на Fabric, Forge, NeoForge и Quilt. Поддерживает Minecraft 1.19 и новее. Для установки просто киньте мод в папку mods - он сам подхватится, если какой-то другой мод использует его формат.

Скачайте Prickle и забудьте про головную боль с конфигами - теперь у каждого параметра будет подсказка.