О Placeholder API

Это компактный API, который можно встраивать JAR-в-JAR и который даёт возможность создавать и обрабатывать плейсхолдеры в строках и компонентах текста Minecraft. Мод использует простой формат %modid:type% или %modid:type data% (в версиях до 1.19 — %modid:type/data%). Кроме того, в него входит упрощённая текстовая разметка, которая упрощает пользователям ввод данных в конфигах, чатах и т.п.

Для игроков

API позволяет гибко настраивать разные моды одинаковым способом при сохранении их совместимости друг с другом. Плейсхолдеры позволяют указывать, какая информация и где должна отображаться в совместимых модах. Упрощённая текстовая разметка также избавляет от необходимости писать JSON вручную или пользоваться специальными генераторами, позволяя стилизовать текст в читаемом виде.

Видео по использованию:
- (Ссылки на YouTube должны сохраняться здесь)

Пример использования:

%my_mod:counter% - базовый плейсхолдер

В библиотеке уже имеется набор предустановленных плейсхолдеров для повседневных нужд.

Для разработчиков

Применение Placeholder API — лёгкий способ добиться высокой совместимости мода с другими, не реализуя для каждого отдельные API. Кроме того, система обработки плейсхолдеров может использоваться для замены статических или динамических заполнителей в текстах, созданных игроком или считанных из конфигурации. В совокупности с Упрощённой Текстовой Разметкой это даёт первоклассный пользовательский и административный опыт.

Начать работу с API совсем несложно:

• Создание и добавление плейсхолдеров задокументировано
• Процесс парсинга литералов расписан пошагово
• Доступны TextNodes и NodeParsers для тонкой настройки eПодробную документацию можно найти на сайте проекта

Если ваш мод раскрывает API для передачи GameProfile, то настраиваемые плейсхолдеры позволят контролировать отображение дополнительных свойств.