Вот пример перевода Mod Menu на пиратский английский. Чтобы сделать свой, замени modmenu в конце (НЕ в начале) ключа на ID своего мода, например modmenu.descriptionTranslation.traverse.

en_pt.json

"modmenu.nameTranslation.modmenu": "Menu o' mods!",
"modmenu.descriptionTranslation.modmenu": "Menu o' mods ye installed matey!",
"modmenu.summaryTranslation.modmenu": "Menu o' mods ye installed matey!"

Перевод summary тут избыточен, но он показывает, что можно переводить краткое описание отдельно от полного.

Значки ("badges": [ ])

Значок Client ставится автоматически для клиентских модов (если указано "environment": "client"). А вот Library и Deprecated нужно прописывать вручную.

Допустимые значения:

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

Остальные значки игнорируются. Свои добавить нельзя, но можно предложить новую фичу через issue.

Ссылки ("links": { })

Объект links позволяет добавить гиперссылки в конец описания мода. Если указан контакт sources в стандартных метаданных fabric.mod.json, он тоже попадёт в раздел ссылок.

Ключи из links используются как ключи перевода. Например:

fabric.mod.json

"custom": {
    "modmenu": {
        "links": {
          "modmenu.discord": "https://discord.gg/jEGF5fb"
        }
    }
}

Будет показана ссылка с текстом "Discord", потому что это английский перевод ключа modmenu.discord.

У Mod Menu есть несколько стандартных переводов для ссылок. Все ключи имеют формат modmenu.<тип>.

Можно добавлять и свои ссылки, но используй СВОЁ пространство имён (не modmenu) для кастомных ключей.

Родители ("parent": "mod_id" или { })

Родители нужны, чтобы показать мод как дочерний для другого. Это удобно для модов, разбитых на модули. Например:

fabric.mod.json

"custom": {
    "modmenu": {
        "parent": "flamingo"
    }
}

Если родитель - не настоящий мод, а виртуальный, можно задать его метаданные прямо тут:

fabric.mod.json

"custom": {
    "modmenu": {
        "parent": {
            "id": "this-mod-isnt-real",
            "name": "Fake Mod",
            "description": "Do cool stuff with this fake mod",
            "icon": "assets/real-mod/fake-mod-icon.png",
            "badges": [ "library" ]
        }
    }
}

Виртуальный родитель поддерживает только:

• id (строка)
• name (строка)
• description (строка)
• icon (строка)
• badges (массив строк)

Отключение проверки обновлений ("update_checker": false)

По умолчанию Mod Menu проверяет обновления через хеш jar-файла на Modrinth. Если найдёт совпадение, то сравнивает версию и сообщает о наличии апдейта.

Отключить можно так:

fabric.mod.json

"custom": {
    "modmenu": {
        "update_checker": false
    }
}

Начало работы

Реализуй интерфейс ModMenuApi на классе и добавь его как точку входа типа "modmenu" в fabric.mod.json:

fabric.mod.json

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

Экраны конфигурации модов

Моды могут предоставить фабрику экранов для кастомной конфигурации через кнопку настроек. Реализуй метод getModConfigScreenFactory.

ID мода определяется автоматически по контейнеру, из которого пришла точка входа.

Предоставленные экраны конфигурации

Моды могут предоставлять фабрики экранов для других модов через метод getProvidedConfigScreenFactories. Это нужно, например, для Cloth Config, который может показывать настройки для модов, использующих его API.

Значки модпаков

Моды могут назначать другим модам значок Modpack, реализовав метод attachModpackBadges. Например:

@Override
public void attachModpackBadges(Consumer<String> consumer) {
	consumer.accept("modmenu"); // Указывает, что 'modmenu' часть модпака
}

Внутренние моды (сам Minecraft и загрузчик) получить этот значок не могут - они не распространяются в составе типичного модпака.

Статические вспомогательные методы

У ModMenuApi есть несколько методов для работы с меню модов.

Создание экрана со списком модов:

Screen createModsScreen(Screen previous)

Создание текста для кнопки меню модов:

Text createModsButtonText()