Text Placeholder API - библиотека для модов Майнкрафт

Text Placeholder API - это небольшая, но очень полезная библиотека для Майнкрафт, которая позволяет разработчикам создавать и обрабатывать плейсхолдеры (заполнители) внутри строк и текстовых компонентов. Если вы когда-нибудь настраивали плагины на сервере, то наверняка встречали что-то вроде %player_name% или %server_time%. Этот мод приносит аналогичную гибкость в моддинг, позволяя модификациям динамически подставлять нужные значения прямо в текст, конфиги или чат.

Библиотека использует простой формат: %modid:type% или %modid:type data% (в версиях до Minecraft 1.19 использовался синтаксис с косой чертой). Плюс ко всему, в комплекте идет Simplified Text Format - упрощенный формат текста, который избавляет от необходимости писать громоздкий JSON вручную или использовать сторонние генераторы для стилизации сообщений.

Чем это полезно для обычных игроков?

Если вы собираете сборку модов для Майнкрафт, будь то на Fabric, Forge или Quilt, Text Placeholder API становится своеобразным мостом между разными проектами.

• Позволяет настраивать разные моды по одному шаблону, не теряя при этом совместимость.
• Дает возможность менять то, где и какая информация отображается в поддерживаемых модах.
• Simplified Text Format помогает стилизовать текст удобочитаемым способом без боли с JSON.

Обычно моды, использующие этот API, уже включают его в себя (спасибо технологии Jar-in-Jar или JIJ), но если нужна более свежая версия - скачать Text Placeholder API можно прямо отсюда.

Список возможностей и документация для пользователей:

• Using placeholders
• Default placeholder list
• Mod placeholder list
• QuickText
• Simplified Text Format

Зачем это нужно разработчикам?

Для создателей модов Text Placeholder API - это отличный способ обеспечить совместимость с другими проектами без необходимости внедрять кучу специфичных API под каждый мод. Система парсинга плейсхолдеров легко заменяет статические или динамические данные в тексте, созданном игроком или считанном из конфига. А связка с Simplified Text Format (TextParserV1) вообще делает пользовательский и админский опыт работы с модом в разы приятнее.

• Getting Started
• Adding placeholders
• Parsing placeholders
• TextNodes and NodeParsers
• Using Simplified Text Format (TextParserV1)

Важный нюанс: если вы пишете свой мод под Minecraft 1.20.1 или новее на Fabric, обязательно присмотритесь к этой библиотеке. Технология JIJ позволяет зашить API прямо в ваш jar-файл, так что игрокам не придется качать его отдельно. Но вот версия библиотеки всегда должна быть актуальной во избежание конфликтов с другими модами из вашей сборки.