Mod Menu для Minecraft 1.20.1, 1.21.1

Mod Menu

Mod Menu дозволяє переглядати встановлені моди та, якщо мод це підтримує, забезпечує швидкий і зручний доступ до екранів налаштувань мода.

Mod Menu також підтримує деякі додаткові функції, як-от перекладні назви та описи модів, підтримку форматування QuickText в описах модів завдяки Text Placeholder API від Patbox, фільтрацію бібліотечних модів зі звичайних модів, перевірку оновлень для модів, розміщених на Modrinth або тих, що надають власні джерела оновлень, і глибоке налаштування всіх функцій, які ми пропонуємо.

Підтримувані платформи

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

Розробникам

Mod Menu містить низку API для розробників, щоб покращити те, як їхній мод виглядає в Mod Menu. Вони надаються у вигляді мовних ключів, метаданих JSON і навіть Java API.

API перекладів

Ви можете перекласти назву, стислий опис і опис вашого мода, не торкаючись жодного рядка коду Java. Просто додайте ключі перекладу в підтримуваному форматі будь-якою мовою, якою забажаєте.

Документація API перекладів

Ось приклад перекладів Mod Menu піратською говіркою. Щоб створити власні, просто замініть modmenu в кінці (НЕ той, що на початку) ключа перекладу на ваш власний ідентифікатор мода, наприклад modmenu.descriptionTranslation.traverse.

enpt.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!"

Стислий переклад тут надлишковий, і його не потрібно включати, оскільки він збігається з описом, але його було включено, щоб показати, що ви можете перекладати стислий опис (короткий опис мода в одному реченні) окремо від опису, навіть англійською!

API метаданих Fabric

Існує низка речей, які можна додати лише за допомогою метаданих у вашому fabric.mod.json.

Усе це додається до спеціального блоку у вашому fabric.mod.json для метаданих Mod Menu. Ось приклад використання багатьох функцій, які надає цей API:

fabric.mod.json

{ ... "custom": { "modmenu": { "links": { "modmenu.discord": "https://discord.gg/jEGF5fb" }, "badges": [ "library", "deprecated" ], "parent": { "id": "example-api", "name": "Example API", "description": "Modular example library", "icon": "assets/example-api-module-v1/parenticon.png", "badges": [ "library" ] }, "updatechecker": true } } }

Документація API метаданих Fabric

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

Хоча значок Client додається автоматично до модів, позначених як лише клієнтські (для цього встановіть "environment": "client" у fabric.mod.json.), інші значки, як-от Library і Deprecated, потребують визначення тут.

Підтримувані значення:

• library - має призначатися модам, які є виключно залежностями для інших модів і які не повинні показуватися користувачеві за замовчуванням, якщо він їх не увімкне.
• deprecated - має призначатися модам, які існують виключно зі спадкових причин, як-от старий модуль API тощо.

Будь-які інші значення буде проігноровано, і Mod Menu не підтримує додавання власних значків. Ви можете відкрити issue тут, якщо маєте переконливий випадок використання для нового значка.

Посилання ("links": { })

Об'єкт links дозволяє авторам модів додавати власні гіперпосилання в кінці їхнього опису. Якщо ви вкажете контакт sources в офіційних метаданих fabric.mod.json, він також буде включений до розділу посилань.

Будь-який ключ в об'єкті links буде включено до розділу посилань, причому ключ використовуватиметься як ключ перекладу. Наприклад, це:

fabric.mod.json

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

відображатиметься як посилання з текстом "Discord", оскільки "Discord" є англійським перекладом "modmenu.discord", наданим Mod Menu.

Mod Menu надає кілька стандартних перекладів, які можна використовувати для посилань. Повний список можна побачити у мовному файлі Mod Menu тут. Усі стандартні ключі перекладу посилань мають форму modmenu..

Ви також можете надати власні переклади, якщо хочете додати спеціальні посилання. Обов'язково використовуйте власний простір імен (а не modmenu) для будь-яких спеціальних ключів.

Батьківські моди ("parent": "modid" або { })

Батьківські моди використовуються для відображення мода як дочірнього до іншого. Це призначено для модів, розділених на різні модулі. Наступний елемент у fabric.mod.json визначить мод як дочірній до мода 'flamingo':

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 (String)
• name (String)
• description (String)
• icon (String)
• badges (Array of Strings)

Вимкнення перевірки оновлень ("updatechecker": false)

За замовчуванням перевірка оновлень Mod Menu використовує хеш jar-файлу вашого мода для пошуку останньої версії на Modrinth. Якщо вона знайде відповідний проєкт, вона перевірить останню версію, яка підтримує ваш завантажувач модів і версію Minecraft, і якщо вона матиме інший хеш, ніж ваш наявний файл, користувачеві буде запропоновано, що доступне оновлення.

Ви можете вимкнути перевірку оновлень, встановивши updatechecker у false у ваших метаданих Mod Menu ось так:

fabric.mod.json

"custom": { "modmenu": { "updatechecker": false } }

API метаданих Quilt

Оскільки Mod Menu також підтримує Quilt, ті самі API з розділу API метаданих Fabric також доступні для модів Quilt, але формат спеціальних метаданих трохи інший.

Замість блоку "modmenu" всередині блоку "custom" ви розміщуєте блок "modmenu" як елемент кореневого об'єкта. Тож це має виглядати так:

quilt.mod.json

{ ... "modmenu": { // Here's where your links, badges, etc. stuff goes } }

Java API

Щоб використовувати Java API, вам потрібно додати Mod Menu як залежність часу компіляції у ваш проєкт gradle. Це не зробить ваш мод залежним від Mod Menu, але він буде присутній у вашому середовищі для тестування.

build.gradle

// Add the Terraformers maven repo to your repositories block repositories { maven { name = "Terraformers" url = "https://maven.terraformersmc.com/" } }

// Add Mod Menu as a dependency in your environment dependencies { // Prior to Minecraft 26.x, use "modImplementation" instead implementation("com.terraformersmc:modmenu:${project.modmenuversion}") }

Потім визначте версію Mod Menu, яку ви використовуєте, у вашому gradle.properties. Ви можете отримати номер останньої версії тут, але вам може знадобитися інша версія, якщо ви не використовуєте останню версію Minecraft. Дивіться сторінку версій для повного списку версій.

gradle.properties

modmenuversion=VERSIONNUMBERHERE

Якщо ви не хочете мати його у своєму середовищі для тестування, але все одно хочете компілювати проти Mod Menu для використання Java API, ви можете використати modCompileOnly замість modImplementation (це працюватиме, навіть якщо Mod Menu не оновлено до версії Minecraft, яку ви використовуєте).

Документація Java API

Початок роботи

Щоб використовувати API, реалізуйте інтерфейс ModMenuApi у класі та додайте його як точку входу типу "modmenu" у вашому fabric.mod.json ось так:

fabric.mod.json

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

Екрани налаштувань модів

Моди можуть надавати фабрику Screen, щоб надати власний екран налаштувань для відкриття кнопкою налаштувань. Реалізуйте метод getModConfigScreenFactory у вашій реалізації API, щоб зробити це.

Призначення цього - дозволити модам надавати власні екрани налаштувань. Ідентифікатор мода екрана налаштувань автоматично визначається вихідним контейнером мода, з якого походить точка входу.

Надані екрани налаштувань

Моди можуть надавати фабрики Screen, щоб надати власні екрани налаштувань для відкриття кнопками налаштувань інших модів. Реалізуйте метод getProvidedConfigScreenFactories у вашій реалізації API для цього.

Призначення цього - дозволити такому моду, як Cloth Config, надавати екрани налаштувань для модів, які використовують його API.

Значки збірок модів

Моди можуть надавати іншим модам значок Modpack, реалізувавши метод attachModpackBadges, наприклад, так:

@Override public void attachModpackBadges(Consumer consumer) { consumer.accept("modmenu"); // Indicates that 'modmenu' is part of the modpack }

Зауважте, що 'внутрішні' моди, як-от сам Minecraft і завантажувач модів, не можуть отримати значок збірки модів, оскільки вони не розповсюджуються в типовій збірці модів.

Статичні допоміжні методи

ModMenuApi також пропонує кілька допоміжних методів для модів, які хочуть краще працювати з Mod Menu, як-от створення власних кнопок Mods.

Створення екземпляра екрана Mods

Ви можете викликати цей метод, щоб отримати екземпляр екрана Mods:

Screen createModsScreen(Screen previous)

Створення тексту кнопки Mods

Ви можете викликати цей метод, щоб отримати Text, який відображатиметься на кнопці Mods Mod Menu:

Text createModsButtonText()