Placeholder API: универсальный инструмент для текста в Minecraft

Если вы устали от ручного прописывания JSON для форматирования текста в конфигах модов или хотите, чтобы разные аддоны могли обмениваться данными через единый синтаксис, вам стоит обратить внимание на Placeholder API. Это компактная библиотека, которую можно встраивать в другие моды (Jar-in-Jar), и она решает две основные задачи: работу с плейсхолдерами и упрощённое текстовое форматирование.

Что умеет этот API?

Плейсхолдеры — это специальные метки в строке, которые динамически заменяются на актуальные данные. API использует простой формат: %modid:тип% или %modid:тип данные% (в версиях до 1.19 использовался слэш: %modid:тип/данные%). Например, плейсхолдер может подставлять имя игрока, его здоровье или данные из другого мода.

Вторая ключевая функция — Simplified Text Format. Это система, которая позволяет стилизовать текст (делать его цветным, жирным, добавлять события по клику) в удобочитаемом виде, без необходимости писать сложные JSON-структуры вручную или пользоваться внешними генераторами.

Зачем это игрокам и администраторам?

• Единый стандарт. Вы можете настраивать множество совместимых модов одним и тем же способом, используя знакомый синтаксис плейсхолдеров.
• Гибкость. Плейсхолдеры позволяют тонко настраивать, какая информация и где будет отображаться в интерфейсах совместимых модов.
• Простое форматирование. С помощью Simplified Text Format легко создавать красиво оформленные сообщения в чатах, названиях предметов или конфигурационных файлах, не углубляясь в JSON.

Полезные ссылки для пользователей:

• Общее руководство по использованию плейсхолдеров
• Список стандартных плейсхолдеров
• Плейсхолдеры, добавляемые другими модами
• Документация по QuickText
• Подробнее об Simplified Text Format

Обычно моды включают эту библиотеку самостоятельно, но при необходимости её всегда можно скачать отдельно.

Почему это полезно разработчикам модов?

Использование Placeholder API — это прямой путь к повышению совместимости вашего мода с экосистемой Minecraft. Вместо реализации поддержки API каждого конкретного мода вы можете интегрироваться с одним универсальным решением.

• Упрощённая совместимость. Не нужно подключать множество специфичных API других модов для обмена данными.
• Мощный парсинг. Вы можете использовать встроенную систему разбора не только для своих, но и для сторонних плейсхолдеров в тексте, который вводит игрок или который загружается из конфига.
• Улучшенный пользовательский опыт. Комбинация динамических плейсхолдеров и Simplified Text Format позволяет создавать по-настоящему гибкие и удобные настройки для администраторов и игроков.

Ресурсы для разработчиков:

• Начало работы
• Как добавить свои плейсхолдеры
• Как разбирать строки с плейсхолдерами
• Работа с TextNodes и NodeParsers
• Использование Simplified Text Format (TextParserV1)