Guide-API VP (Village and Pillage)

Это форк оригинального мода Guide-API от TehNut и Tombenpotter, выпущенный под лицензией MIT для Minecraft 1.14 и выше. Использует другой пакет и идентификатор мода (guideapi-vp).

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

О чём речь

Мод позволяет легко создать книгу-гайд для вашего мода. Guide-API автоматически регистрирует книги, помещает их в свою креативную вкладку и управляет их отображением. В отличие от Patchouli, где всё строится на JSON, здесь большая часть реализуется через код. Это даёт ряд преимуществ:

• Динамическое содержимое: можно менять текст в зависимости от конфигурации мода.
• Автоперенос строк и страниц: локализованные строки не вылезают за границы.
• Ссылки на назначенные клавиши, внутренние константы и баланс - если меняете значения в моде, они автоматически обновляются в книге.
• Свои типы страниц, рецептов и т.д.
• Вспомогательные методы для автоматической генерации частей книги.

Что ещё?

• Нет жёсткой зависимости: если Guide-API отсутствует при запуске, книга просто не появится, но всё остальное работает.
• Поддерживает TextFormatting и ручные переносы строк.
• Уже есть готовые типы страниц: текст, с фокусом на предмет/блок, рецепты, изображения.

Как использовать?

Подключите Guide-API VP как зависимость в вашем проекте. Всю информацию по интеграции ищите в документации.

Лицензия

MIT - при необходимости можете форкнуть или включить в свою сборку. Без проблем.

Зачем это нужно?

В Minecraft куча модов, где игрокам нужны пояснения. Вместо того чтобы писать велосипед, Guide-API VP даёт готовую, гибкую и кодово-ориентированную систему. Особенно удобно для модов с кучей опций или динамическим контентом - книга всегда будет актуальной.