Mod Menu

Mod Menu: меню установленных модов и API для разработчиков

Mod Menu — это утилита для Minecraft на загрузчиках Fabric и Quilt, которая добавляет в меню модов удобный интерфейс для просмотра списка установленных дополнений. Мод позволяет быстро открывать экраны конфигурации других модов, если они это поддерживают. Также он предоставляет инструменты для разработчиков: API на Java, возможность добавлять ссылок и бейджей в описание через JSON-метаданные, а также поддержку перевода названий и описаний без изменения кода.

📋 Основное меню модов

При запуске игры Mod Menu добавляет новый раздел в меню модов. Здесь отображается список всех установленных дополнений, отсортированных по категориям. В правой части экрана можно увидеть подробную информацию о выбранном моде: авторов, описание, ссылки на сторонние ресурсы и кнопку для открытия настроек. Если мод поддерживает это, Mod Menu автоматически предложит открыть его экран конфигурации при нажатии на соответствующую кнопку. В отличие от стандартного списка, здесь можно фильтровать моды, скрывая те, что помечены как библиотеки, чтобы не загромождать обзор основными играбельными дополнениями.

🌐 Перевод названий и описаний

Разработчики могут сделать свои моды доступными для игроков, не владеющих английским языком, используя Translation API. Это позволяет переводить название, краткое описание и полное описание мода, добавив в файл fabric.mod.json или quilt.mod.json пару ключей перевода. Например, для перевода названия можно использовать ключ modmenu.nameTranslation. , а для описания — modmenu.descriptionTranslation. . Ключи могут быть добавлены для любого языка, и Mod Menu автоматически подставит соответствующий текст в интерфейсе. Это избавляет от необходимости писать отдельные строки кода для каждого языка.

🏷️ Бейджи и метаданные

Через раздел custom в файле конфигурации можно настроить отображение модов. В поле badges можно добавить специальные значки. Значок library помечает мод как чистую зависимость, скрывая его из основного списка по умолчанию (полезно для библиотек вроде Fabric API). Значок deprecated помечает мод как устаревший, чтобы игроки знали, что он больше не поддерживается. Также можно настроить отображение родительского мода, если проект разбит на модули, чтобы в меню они группировались вместе. Например, если у вас есть модуль flamingo, вы можете указать parent: "flamingo", и все его дети будут отображаться вложенными под ним.

🔗 Ссылки в описании

Разработчики могут добавить к описанию своего мода дополнительные ссылки на Discord, GitHub или документацию. Для этого в секции links файла fabric.mod.json указываются ключи и значения URL. Ключ используется как переводимый текст ссылки. Например, запись modmenu.discord: "https://discord.gg/..." создаст ссылку с текстом "Discord". Mod Menu автоматически добавляет ссылки на официальные источники, если они указаны в стандартных полях fabric.mod.json. Это позволяет быстро найти поддержку или документацию прямо из меню модов.

🔧 Java API для разработчиков

Для разработчиков других модов доступен полноценный Java API. Чтобы использовать его, нужно добавить Mod Menu как зависимость в build.gradle (например, modImplementation). Затем в классе реализации интерфейса ModMenuApi можно реализовать методы для создания кастомных экранов конфигурации. Метод getModConfigScreenFactory позволяет создать собственный экран настроек для своего мода, который откроется при нажатии кнопки конфигурации. Также можно реализовать getProvidedConfigScreenFactories, чтобы предоставить экраны настроек для других модов, использующих API Cloth Config.

📦 Встроенные функции API

API Mod Menu включает несколько полезных вспомогательных методов. Метод createModsScreen(Screen previous) возвращает экземпляр экрана списка модов, что позволяет разработчикам создавать свои собственные вкладки или кнопки для перехода к списку. Метод createModsButtonText() возвращает объект Text с надписью "Mods", который можно использовать для создания кастомных кнопок. Также есть метод attachModpackBadges, позволяющий автоматически добавлять бейдж Modpack к моде, если он является частью популярного сборника. Внутренние моды (сама игра и загрузчик) не могут получить этот бейдж.

🔄 Проверка обновлений

Mod Menu автоматически проверяет наличие обновлений для установленных модов. По умолчанию он использует хеш файла JAR для поиска последней версии на Modrinth или других источниках, указанных в моде. Если версия отличается, пользователю предлагается скачать обновление. Эта функция особенно полезна для пользователей сборников модов, так как позволяет быстро найти актуальные версии всех дополнений. Проверку можно отключить, добавив в метаданные update_checker: false, если мод обновляется вручную или использует другую систему.

📜 Поддержка Quilt

Кроме Fabric, Mod Menu работает с загрузчиком Quilt. Однако формат метаданных для Quilt отличается: вместо вложенного блока custom.modmenu используется корневой элемент modmenu в файле quilt.mod.json. Это упрощает структуру файла, но требует от разработчиков знать, какой загрузчик они используют. Все функции Fabric API (ссылки, бейджи, переводы) доступны и для Quilt, но с другой структурой JSON. Это делает Mod Menu универсальным инструментом для обоих популярных загрузчиков на Java Edition.

Автор: gniftygnome · Автор: Prospector · Автор: modmuss50 · Лицензия: MIT