Mod Menu

Меню Mod Menu позволяет просматривать установленные в игре модификации и при поддержке со стороны мода предоставляет быстрый доступ к его настройкам.

Возможности

Среди дополнительных функций можно выделить поддержку переводимых названий модов и их описаний, форматирование текста через Text Placeholder API, автоматическое скрытие библиотечных модов из общего списка, проверку обновлений через Modrinth или собственные источники, а также расширенные настройки всех доступных опций.

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

Mod Menu работает на платформах Fabric и Quilt для Minecraft: Java Edition версий 1.14 и новее.

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

Mod Menu предлагает разные способы улучшить отображение модов в меню: языковые ключи, JSON-метаданные и Java API.

Переводы

Вы можете локализовать название, краткое и полное описание мода без редактирования Java-кода, используя стандартные ключи перевода.

Пример перевода на пиратский английский:

"modmenu.nameTranslation.modmenu": "Меню модификаций!",
"modmenu.descriptionTranslation.modmenu": "Список установленных модификаций, дружище!"

Метаданные Fabric

В разделе custom файла fabric.mod.json можно указать различные параметры:

{
  "custom": {
    "modmenu": {
      "links": {
        "modmenu.discord": "https://discord.gg/jEGF5fb"
      },
      "badges": [ "library", "deprecated" ],
      "parent": {
        "id": "example-api",
        "name": "Example API",
        "description": "Модульная библиотека примеров",
        "icon": "assets/example-api-module-v1/parent_icon.png",
        "badges": [ "library" ]
      },
      "update_checker": true
    }
  }
}

Бейджики:

• library - для зависимостей, скрытых по умолчанию
• deprecated - для устаревших модов

Ссылки: В объекте links можно добавлять пользовательские ссылки с переводом ключей.

Родительские моды: Определяет модификацию как дочернюю по отношению к другой, с возможностью задания фиктивного родителя.

Проверка обновлений: Для отключения укажите "update_checker": false.

Метаданные Quilt

В случае Quilt структура немного отличается — блок modmenu располагается в корне JSON:

{
  "modmenu": {
    // Настройки аналогичны Fabric
  }
}

Java API

Для использования Java API добавьте Mod Menu в зависимости Gradle:

build.gradle

repositories {
  maven {
    name = "Terraformers"
    url = "https://maven.terraformersmc.com/"
  }
}

dependencies {
  modImplementation("com.terraformersmc:modmenu:${project.modmenu_version}")
}

gradle.properties

modmenu_version=VERSION_NUMBER_HERE

Настройте точку входа в файле конфигурации мода:

fabric.mod.json

"entrypoints": {
  "modmenu": [ "com.example.mod.ExampleModMenuApiImpl" ]
}

Экран настроек: Реализуйте getModConfigScreenFactory для создания интерфейса конфигурации.

Чужие экраны настроек: Используйте getProvidedConfigScreenFactories, чтобы предоставить экраны конфигурации для других модов.

Бейджи модпака: Присвойте модам отметку Modpack через метод attachModpackBadges.

Вспомогательные методы: ModMenuApi содержит методы для создания экрана модов и текста кнопки Mod Menu.