Prickle Мод для Minecraft 1.21, 26.3

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

Часті питання

Які переваги пропонує Prickle? Prickle базується на JSON, але додає кілька корисних функцій, як-от коментарі та декоратори. Prickle на 100% сумісний із JSON і підтримує всі його функції, інструменти та підсвічування синтаксису.

Чому це називається Prickle? Prickle — це збірна назва для групи їжаків. Їжаки — одні з моїх улюблених тварин, і я вважаю, що вони є вдалою метафорою для файлів конфігурації. Наприклад, спочатку вони можуть здаватися грізними, але можуть бути приємними, коли ви з ними познайомитеся та зрозумієте їх.

Чому б не використати наявний формат? У минулому я використовував JSON для своїх файлів конфігурації, але було кілька проблем, як-от відсутність коментарів і значень за замовчуванням. Prickle додає ці функції до JSON, залишаючись на 100% сумісним. Я пробував інші формати, як-от TOML, але був розчарований багатьма їхніми реалізаціями для Java. Вони часто не мають функцій, які я вважаю важливими, мають серйозні помилки та більше не підтримуються. Minecraft уже використовує JSON для датапаків і команд, що робить його звичним вибором для більшості гравців.

Специфікації формату

У Prickle значення властивостей обгорнуті в об'єкт JSON. Це дозволяє приписувати цій властивості метадані, як-от коментарі.

Наприклад, стандартний файл JSON виглядає так.

{ "databasehost": "192.168.1.222" }

Той самий JSON як файл Prickle виглядатиме так.

{ "databasehost": { "//": "The IP address of the database to connect to.", "value": "192.168.1.222" } }

Коментарі

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

{ "databasehost": { "//": [ "The IP address of the database to connect to.", "The port can be defined at the end using an :" ], "value": "192.168.1.222:1273" } }

Декоратори

Декоратори — це іменовані коментарі, які передають певний атрибут властивості. Поширеним прикладом декоратора є //default, який можна використовувати для відображення значення властивості за замовчуванням. Як і коментарі, декоратори не впливають на те, як обробляється файл, вони лише описують, як властивість буде оброблено.

У файлах prickle ви можете зустріти деякі з наведених нижче декораторів.

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

Спонсори

Цей проєкт спонсорується Nodecraft. Використовуйте код DARKHAX, щоб отримати 30% знижки на перший місяць обслуговування!