Prickle — это формат конфигураций на основе JSON. Данный мод позволяет другим модам использовать Prickle для своих конфигурационных файлов! Техническую документацию можно найти на странице GitHub.
Частые вопросы
Почему формат называется Prickle?
Prickle — это коллективное существительное для группы ежей. Ежи — одни из моих любимых животных, и они хорошо подходят в качестве метафоры для конфигурационных файлов. Например, и ежи, и конфиги могут показаться сложными на первый взгляд, но становятся понятными при ближайшем рассмотрении.
Почему не используется существующий формат?
Раньше я использовал стандартный JSON для конфигов, но у него есть недостатки: отсутствие комментариев и значений по умолчанию. Prickle добавляет эти возможности в JSON, сохраняя полную совместимость. Я пробовал другие форматы вроде TOML, но их реализации на Java имели ошибки и не обновлялись. Кроме того, Minecraft использует 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 — разрешены ли пустые значения.