Prickle — это формат конфигурационных файлов для Minecraft, основанный на JSON.
Данный мод позволяет другим модам использовать формат Prickle для своих файлов конфигурации. В отличие от стандартного JSON, Prickle поддерживает комментарии и значения по умолчанию, при этом оставаясь полностью совместимым с JSON.
Описание формата
В Prickle каждое значение свойства помещается внутрь JSON-объекта с ключом value. Это даёт возможность добавлять к свойству метаданные и дополнительные атрибуты.
Например, стандартный JSON-файл:
{ "database_host": "192.168.1.222"
}В формате Prickle тот же файл будет выглядеть так:
{ "database_host": { "value": "192.168.1.222" }
}Комментарии
Ключ // используется для комментариев, которые не влияют на парсинг файла и служат лишь для пояснения. Комментарии могут быть строкой или массивом строк для многострочного описания.
{ "database_host": { "//": "IP-адрес базы данных.", "value": "192.168.1.0" }, "database_host_backup": { "//": [ "Резервный IP-адрес.", "Используется, если основной недоступен." ], "value": "192.168.1.0" }
}Декораторы
Декораторы — это специальные именованные комментарии, которые дают дополнительную информацию о свойстве. Они тоже не влияют на обработку файла и служат для описания.
Наиболее распространённые декораторы:
//default— значение по умолчанию;//reference— ссылка на документацию или справочный ресурс;//range— допустимый диапазон числового значения;//regex— регулярное выражение для проверки значения;//empty-allowed— разрешено ли пустое значение.
