Guide-API

Guide-API - простая библиотека для Майнкрафт, которая решает давнюю проблему: как объяснить игроку механику мода, не выходя из игры. Больше не нужно лезть в вики или гуглить - вся документация прямо под рукой, в интерфейсе.

Что это и зачем нужно

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

Для сборщиков модов есть приятная новость: поддержка JSON-файлов в разработке (на момент последней версии). Это значит, что можно будет создавать книги-гайды без программирования, просто редактируя текстовые файлы. Удобно, когда в сборке 100+ модов и каждому нужно хоть краткое описание.

Совместимость и legacy

Мод разрабатывался под Forge для Minecraft 1.11.2 (сборка 2.1.0-51). Проект давно заброшен - создатель TehNut опубликовал его в 2015 году, а последнее обновление вышло в марте 2017. Сейчас Guide-API хранится в архиве под аккаунтом ModrinthArchives с разрешения автора. Лицензия с версии 2.1.0-51 - MIT (до этого была MMPLv2), так что используй спокойно, если твой проект подходит под эти условия.

На современных версиях Майнкрафт (1.16+) мод, скорее всего, не запустится. Для актуальных сборок лучше смотреть в сторону Patchouli - он делает примерно то же самое и активно обновляется. Но если ты собираешь ретро-сборку под 1.11.2 или старее - Guide-API может пригодиться.

Важно знать

• Мод не делает ничего сам по себе - это библиотека. Её смысл раскрывается только когда другой мод использует её API для создания гайдов.
• Примеры галереи можно посмотреть в самой игре, после установки.
• Разрешения на использование: "Go for it" (дерзайте) для модпаков. Автор не запрещает.

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