Guide-API

Библиотека внутриигровой документации

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

Для обычного игрока это техническая зависимость. Сам файл не добавляет большое самостоятельное руководство обо всём модпаке: содержимое появляется, когда установлен совместимый мод, использующий его программный интерфейс.

Что делает Guide-API

Библиотека поддерживает жизненный цикл книг: регистрирует их, отображает в игре и помещает в собственную вкладку творческого режима. Автор зависимого проекта сосредотачивается на разделах и страницах, а общая система берёт на себя повторяемую инфраструктуру.

• Единая регистрация упорядочивает руководства разных модов.
• Внутриигровой формат позволяет читать справку без перехода в браузер.
• Общий интерфейс избавляет авторов от создания новой книжной системы.
• MIT-лицензия применяется к поздним выпускам проекта.

Ограничение JSON-книг

На странице Guide-API поддержка построения книг разработчиками модпаков через JSON обозначена как находившаяся в работе. Её не следует считать гарантированной готовой функцией последнего релиза. Основной сценарий библиотеки связан с интеграцией со стороны автора мода.

Сравнение с Patchouli

Patchouli также создаёт внутриигровые руководства, но делает акцент на data-driven содержимом, шаблонах, локализации и современных версиях Minecraft. Он не является прямой заменой jar-файла: мод, собранный с зависимостью Guide-API, обычно ожидает именно эту библиотеку и её интерфейсы.

Версии и состояние проекта

Последний основной файл Guide-API-1.12-2.1.8-63.jar предназначен для Minecraft 1.12.2 и выпущен в декабре 2018 года. На CurseForge также представлены старые ветки 1.9.4, 1.10, 1.11 и 1.12.

Современные версии Forge и NeoForge на странице проекта не заявлены. Guide-API следует рассматривать как компонент старых сборок, а не как универсальную библиотеку для актуального клиента.

Установка Guide-API

Нужно установить точную версию библиотеки, которую требует основной мод, и поместить jar в каталог mods соответствующего экземпляра Minecraft. Для ветки 1.12.2 потребуется совместимый Forge.

Если игра сообщает о пропущенной зависимости, нельзя подменять Guide-API похожей системой книг. Следует проверить номер Minecraft, выпуск зависимого мода и требуемый диапазон сборок, удалить дубликаты и повторить запуск.