Prickle

Prickle — это формат конфигурации на основе JSON. Этот мод позволяет использовать этот формат в Minecraft! Техническую документацию можно найти на странице GitHub.

Часто задаваемые вопросы

Какие преимущества предлагает Prickle? Prickle основан на JSON, но добавляет несколько полезных функций, таких как комментарии и декораторы. Prickle на 100% обратно совместим с JSON и поддерживает все его функции, инструменты и подсветку синтаксиса.

Почему это называется «Колючка»? «Колючка» — это собирательное существительное для группы ежей. Ежи — одни из моих любимых животных, и я думаю, что они являются подходящей метафорой для конфигурационных файлов. Например, поначалу они могут показаться пугающими, но со временем становятся приятными, когда узнаешь и понимаешь их поближе.

Почему бы не использовать уже существующий формат? Раньше я использовал JSON для своих конфигурационных файлов, но сталкивался с рядом проблем, таких как отсутствие комментариев и значений по умолчанию. Prickle добавляет эти возможности в JSON, оставаясь при этом на 100% обратно совместимым. Я пробовал другие форматы, например TOML, но был разочарован многими их реализациями на Java. В них часто отсутствуют функции, которые я считаю важными, есть серьёзные ошибки, и они больше не поддерживаются. Minecraft уже использует JSON для датапаков и команд, что делает его привычным выбором для большинства игроков.

Характеристики формата

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

Например, стандартный JSON-файл будет выглядеть так: ```json { "database_host": "192.168.1.222" } ``` Тот же JSON-файл в формате Prickle будет выглядеть так: ```json { "database_host": { "//": "IP-адрес базы данных для подключения."", "value": "192.168.1.222" } } ```

Комментарии

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

```json { "database_host": { "//": [ "IP-адрес базы данных для подключения."", "Порт можно указать в конце с помощью двоеточия ], "value": "192.168.1.222:1273" } } ```

Декораторы

Декораторы — это именованные комментарии, которые передают определённый атрибут свойства. Распространённый пример декоратора — `//default`, который можно использовать для отображения значения свойства по умолчанию. Как и комментарии, декораторы не влияют на то, как будет обрабатываться файл, они лишь описывают, как будет обрабатываться свойство.

В файлах Prickle Files вы можете встретить некоторые из следующих декораторов.

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

Спонсоры

Этот проект спонсируется компанией Nodecraft. Используйте код DARKHAX, чтобы получить скидку 30% на первый месяц обслуживания!