模组菜单

模组

原名 Mod Menu · 作者 Prospector

添加一个模组菜单,用于查看已安装的模组列表。

32 本站下载 0 关注 更新于 2 天前

需要前置:Fabric API、文本占位符 API

最新 22.0.0-alpha.6 · Fabric / Quilt

一键开服(送7天)

Mod Menu

模组屏幕截图,左侧搜索栏和过滤按钮下方显示少量模组列表,其中 Mod Menu 处于选中状态。屏幕右侧显示关于该模组的更多详情,例如作者、描述、链接、鸣谢以及一个配置该模组的按钮。

Mod Menu 让你可以查看已安装的模组,并且如果模组支持,还能快速便捷地访问该模组的配置界面。

Mod Menu 还支持一些更高级的功能,例如可翻译的模组名称与描述;得益于 Patbox 的 Text Placeholder API,模组描述中支持 QuickText 格式化;从常规模组中过滤出库模组;针对托管在 Modrinth 上或提供自有更新源的模组进行模组更新检查;以及对我们提供的所有功能进行深度配置。

支持的平台

Mod Menu 目前适用于 Minecraft: Java 版 1.14 或更新版本上的 Fabric 或 Quilt。

开发者

Mod Menu 包含若干 API,供开发者改善其模组在 Mod Menu 中的展示方式。这些 API 以语言键、JSON 元数据乃至 Java API 的形式提供。

翻译 API

你可以翻译模组的名称、摘要和描述,全程无需改动任何 Java 代码。只需按支持的格式,将翻译键添加到你想要的任意语言中即可。

翻译 API 文档

以下是 Mod Menu 翻译为海盗腔(Pirate Speak)的示例。若要创建你自己的翻译,只需将翻译键末尾的 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!"

此处的摘要翻译是多余的,无需包含,因为它与描述相同。但这里仍将其包含进来,是为了说明你可以将摘要(对模组的一句简短描述)与描述分开翻译,即使是在英文中也是如此!

Fabric 元数据 API

仅通过 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/parent_icon.png",
        "badges": [ "library" ]
      },
      "update_checker": true
    }
  }
}
Fabric 元数据 API 文档

徽章("badges": [ ])

虽然 Client 徽章会自动添加到被设为仅客户端(在 fabric.mod.json 中设置 "environment": "client" 即可)的模组上,但诸如 Library 和 Deprecated 之类的其他徽章则需要在此处定义。

支持的值:

  • library - 应分配给纯粹作为其他模组依赖的模组,除非用户手动开启,否则默认不应向用户显示。
  • deprecated - 应分配给纯粹因历史遗留原因而存在的模组,例如旧版 API 模块之类。

其他任何值都将被忽略,并且 Mod Menu 不支持添加你自己的徽章。如果你对新徽章有令人信服的使用场景,可以在此处提交 issue。

链接("links": { })

links 对象允许模组作者在其描述末尾添加自定义超链接。如果你在官方的 fabric.mod.json 元数据中指定了 sources 联系方式,它也会被包含在链接区域中。

links 对象中的任何键都会被包含在链接区域中,该键将用作翻译键。例如,下面这段:

fabric.mod.json

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

将显示为文本为"Discord"的链接,因为"Discord"是 Mod Menu 提供的"modmenu.discord"的英文翻译。

Mod Menu 提供了若干可用于链接的默认翻译。完整列表可在 Mod Menu 的语言文件中查看,点此查看。所有默认链接翻译键的形式均为 modmenu.<type>。

如果你想要添加自定义链接,也可以提供你自己的翻译。请务必为任何自定义键使用你自己的命名空间(而非 modmenu)。

父级("parent": "mod_id" 或 { })

父级用于将某个模组显示为另一个模组的子级。这旨在用于划分为不同模块的模组。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)

禁用更新检查器("update_checker": false)

默认情况下,Mod Menu 的更新检查器会使用你模组 jar 的哈希值在 Modrinth 上查找最新版本。如果它找到了匹配的项目,就会检查支持你的模组加载器和 Minecraft 版本的最新版本;如果该版本的哈希与你现有文件的哈希不同,就会提示用户有可用更新。

你可以通过在 Mod Menu 元数据中将 update_checker 设为 false 来禁用更新检查器,如下所示:

fabric.mod.json

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

Quilt 元数据 API

由于 Mod Menu 也支持 Quilt,Fabic 元数据 API 部分中的相同 API 同样适用于 Quilt 模组,但自定义元数据的格式略有不同。

"modmenu" 块不再放在 "custom" 块内部,而是作为根对象中的一个元素。因此它应该看起来像这样:

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.modmenu_version}")
}

然后,在 gradle.properties 中定义你正在使用的 Mod Menu 版本。你可以在这里获取最新版本号,但如果你使用的不是最新 Minecraft 版本,可能需要其他版本。完整版本列表请参见版本页面。

gradle.properties

modmenu_version=VERSION_NUMBER_HERE

如果你不想将它放入环境中用于测试,但仍希望针对 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 工厂,以便提供自定义配置界面,供配置按钮打开。在你的 API 实现中实现 getModConfigScreenFactory 方法即可做到这一点。

其预期用例是让模组提供自己的配置界面。配置界面的模组 ID 会由入口点来源的源模组容器自动确定。

提供的配置界面

模组也可以提供 Screen 工厂,以为其他模组提供自定义配置界面,供其配置按钮打开。在你的 API 实现中实现 getProvidedConfigScreenFactories 方法即可做到这一点。

其预期用例是让 Cloth Config 之类的模组为使用其 API 的模组提供配置界面。

整合包徽章

模组可以通过实现 attachModpackBadges 方法为其他模组授予 Modpack 徽章,例如通过以下方式:

@Override
public void attachModpackBadges(Consumer<String> 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

你可以调用此方法获取将显示在 Mod Menu 的 Mods 按钮上的 Text:

Text createModsButtonText()

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源