资源中心

**Xaero的小地图 (Xaero's Minimap)** 这款模组能够在你的屏幕角落展开一副详尽的战术图表，实时显示周边的地形地貌、玩家动向、生物群落以及各类实体信息。它赋予你创建“路径点”的能力，指引你从容寻回曾经涉足的地点。 ### 警示：切勿将 XaeroPlus 与本模组混用！ 请务必注意，XaeroPlus 并非本人开发，且与官方毫无关联。该第三方插件会引发难以追踪的严重错误乃至游戏崩溃。更令人担忧的是，据称它与某些服务器破坏团伙存在瓜葛，这可能会导致你在服务器中的建筑成果面临极大风险。 与市面上众多同类模组不同，Xaero的小地图极其注重保留 **原版 Minecraft 的美学风格**，旨在成为游戏界面中浑然天成的一部分，而非突兀的附加组件。值得一提的是，它是 **Minecraft 历史上首个采用旋转方形设计的地图模组**。在极其丰富的自定义选项中，你依然可以选择传统的 **圆形地图**，或者设定 **锁定地图旋转**（转而使用方向箭头来指示方位）。 雷达系统能够以 **自定义颜色的圆点** 或 **图标（通常是头像）** 的形式，精准显示周围的实体，涵盖 **玩家、生物及掉落物**。除了提供基础的 **指南针方位**，你还可以自行部署 **路径点**，这些标记将在小地图和游戏世界中同步显现。路径点不仅能助你重返旧地或抵达特定坐标，更支持 **传送功能**。此外，该模组具备透视能力，能够显示地表之上的结构以及地下的深邃环境（即 **洞穴模式**）。 这仅仅是该模组众多特性中的冰山一角。为了全面了解其潜能，请详细阅读下方的“小地图特性”章节。为了适应多人服务器的规则环境，本模组提供了两个版本：完整版与公平竞争版（Fair-play），后者专为公平 PVP 环境设计。**本模组主要在客户端运行。将其安装在服务端并非必须，但能解锁诸如“世界识别”等额外功能。** **特性概览** * **完美复刻原版 Minecraft 的视觉风格**。 * 提供多种小地图尺寸选项，包括自动调整模式。 * 具备多级缩放功能，视野掌控随心所欲。 * 两种地图形状可供选择：**方形或圆形**。 * **性能优化卓越**，运行流畅度超越市面上绝大多数同类竞品。 * 通过“更改位置”设置，你可以将地图安置在屏幕的任意角落。甚至支持以 1 像素为单位的微调，这在与其他 UI 模组共存时尤为实用。 * 两种方块颜色模式：**原版模式**（采用原版地图颜色）和 **精准模式**（直接采用方块纹理和生物群系的颜色）。你还可以在原版模式下单独开启生物群系着色。 * 支持自定义按键（默认为 Z 键）暂时放大地图，以便更清晰地观察周围环境。**所有按键绑定均位于原版控制菜单中。** 此外，你还可以定制放大时的行为，例如让地图居中显示或自动切换至最大缩放级别。 * 通过“地形深度”和“地形坡度”设置，你可以自定义地图的阴影效果，增强立体感。 * 与 **Xaero的世界地图 (Xaero's World Map)** 完美兼容。默认情况下，它会直接调用世界地图模组生成的纹理，而非重复加载，从而在使用双模组时显著提升性能。 * 支持服务端配置，并提供游戏内 UI 界面。你可以实时管控服务器上玩家使用模组的权限。支持基于等级/权限系统的管理（`xaero.minimap.enforced_server_profile`），兼容 FTB Ranks、Odyssey Roles、LuckPerms 以及通用权限 API。 * 支持通过绑定特定物品来限制小地图的使用。例如，在配置文件中添加 `minimapItemId:minecraft:compass`，即可实现只有当玩家在快捷栏持有或装备指南针时，小地图才会显示。 * 引入药水效果机制，用于控制服务器/地图中玩家的小地图功能权限。目前支持的效果包括：`xaerominimap:no_minimap`（禁用地图）、`xaerominimap:no_entity_radar`（禁用雷达）、`xaerominimap:no_waypoints`（禁用路径点）、`xaerominimap:no_cave_maps`（禁用洞穴图）。这些效果默认为中性，但你也可以通过在 ID 后添加 `_harmful`（如 `xaerominimap:no_entity_radar_harmful`）将其指定为有害类型。 * 已被翻译成多种语言，打破语言壁垒。 * 支持 **锁定北方** 选项，停止地图旋转，转而用箭头指示角色朝向。 * 得益于 **自动洞穴模式**，无论是地表还是地下探索均能应对自如。该模式在进入建筑物内部时也应能自动激活。你可以自定义触发洞穴模式所需的“实体屋顶”尺寸。例如，设置 3x3 及以上的屋顶尺寸，可以防止你在砍树站在原木下时误触洞穴模式。 * **路径点系统**。支持创建几乎无限数量的路径点。若拥有传送指令权限，可直接传送至路径点。这些标记将在游戏世界内渲染并在小地图上高亮。你可以隐藏全部或特定的路径点。按 **B** 键创建新路径点，按 **U** 键列出所有路径点。在列表中，你可以管理单点或多点，进行排序，或查看其他子世界/维度的路径点。 * **局部与全局路径点机制。** 为了避免屏幕杂乱，你可以创建受“最大绘制距离”限制的局部路径点。这允许你为大区域设置一个全局路径点，而在区域内部设置多个局部路径点。当你超出绘制距离时，仅全局路径点可见。 * **路径点集管理。** 你可以通过将路径点归类到不同的“集”中来组织它们，并通过按键快速切换当前的路径点集。**所有按键绑定均在原版控制菜单中。** * **路径点分享功能。** 你可以在游戏聊天栏中与服务器上的其他玩家分享你的路径点，此操作在路径点列表（按 U）中进行。 * **死亡标记**。每次角色死亡时，系统会自动在死亡地点创建一个 **骷髅形状的路径点**。旧的死亡点会自动转换为普通路径点，如果不希望保留，可以通过“保留旧死亡点”设置将其禁用。 * 支持显示来自 **Open Parties and Claims** 模组的区块声明和盟友玩家。 * 可切换的 **区块网格**。网格线将清晰标示区块的起始与结束位置。 * 可切换的 **史莱姆区块** 模式。能够生成史莱姆的区块将覆盖绿色显示。 * **自定义光照覆盖层**。你可以设置一个光照覆盖层，用自定义颜色标记特定光照范围内的方块（默认为 0 到 7）。此功能本来用于寻找怪物生成的温床，但你也可以将其用于任何用途。 * 多人游戏中的多世界检测。若在服务端同时也安装了本模组，每个服务器世界不仅会有独立的世界地图，还将拥有独立的路径点“子世界”。若未能安装服务端模组，则会采用基于世界出生点的可靠性较低的分离方案。如果服务器只有一个“单一世界”，建议关闭多世界检测。此选项位于 **路径点菜单（按 U） -> 选项** 界面。 * **生物雷达**：在地图上将 **生物** 显示为 **黄色圆点**。**敌对与友好** 生物可配置 **不同颜色**。亦支持显示为 **图标/头像**。请查阅 **“实体雷达”** 设置。 * **玩家雷达**：在地图上将 **玩家** 显示为 **白色圆点或玩家头像**。亦支持显示为 **图标/头像**。请查阅 **“实体雷达”** 设置。 * **物品雷达**：在地图上将 **掉落物** 显示为 **红色圆点**。请查阅 **“实体雷达”** 设置。 * 显示所有 **其他实体**（如箭矢和物品展示框）为 **紫色圆点**，且支持在设置中禁用特定类型的实体。请查阅 **“实体雷达”** 设置。 * 在“实体雷达”设置中，提供 **在小地图上显示实体名称** 的选项。 * 支持放大和缩小按键 **（默认为 I 和 O）**，以便高效调整缩放级别以适应你的使用场景。 * 小地图下方显示 **坐标**。 * 小地图下方显示 **当前生物群系名称**。默认禁用，需在设置中开启（按 Y）。 * 小地图下方显示 **光照等级**。同样默认禁用，需手动开启。 * 小地图下方显示 **当前游戏时间**。默认禁用，支持 12 小时制和 24 小时制。 * 小地图下方显示 **当前视角角度**。默认禁用。 * 支持一键隐藏/取消隐藏所有界面中的路径点坐标，这对于直播或视频录制非常有用。 * 支持完全隐藏/取消隐藏下拉菜单中提及的所有服务器地址。默认设置为“部分隐藏”，这在大多数情况下能够提供足够的隐私保护。 * **海量设置选项**。功能繁多，不胜枚举。请在游戏中按 **Y** 键打开设置界面亲自探索。 * 两个模组版本：完整版与公平竞争版。**完整版** 功能无限制。**公平竞争版** 不显示任何实体或洞穴地图，更适合与不使用小地图的玩家进行 PVP 对抗。 **常见问题解答 (FAQ)** **为何路径点传送功能对我失效？** 造成此现象的原因可能多种多样。该模组通过发送聊天命令来执行传送操作，默认指令为 `/tp @s x y z`，因此你必须拥有相应的权限。原版的 `/tp` 命令通常需要管理员权限（作弊开启），但在非原版服务器上，通过特定插件可能拥有独立的命令权限。如果是指令不匹配，你可以在小地图设置中的“默认传送命令”选项，或在路径点菜单的“传送聊天命令”选项中（针对特定服务器）进行更改。非原版传送指令通常不支持 `@s` 这样的选择器，因此你可能需要从配置的命令中移除它。此外，世界地图上的右键传送使用的是另一套独立设置，详情请参阅世界地图说明页面的 FAQ。 如果“传送”按钮呈现为灰色禁用状态，这也暗示了多种可能性。最常见的原因是你正在尝试使用并非来自当前“自动（auto）”子世界、但同属一个维度的路径点。如果当前的“自动”子世界并非你应该使用的那个，请手动选中正确的子世界，并在路径点菜单的选项中点击“设为自动子世界（Make Sub-world Auto）”。这将交换两个子世界的数据，使你能够传送到现已归入“自动”子世界的路径点。 若“自动”子世界选择无误但按钮依旧禁用，那很可能是服务器或该世界手动禁用了传送功能。请检查路径点菜单选项中的传送开关。如果确被禁用，你只能通过修改游戏目录下 `xaero/minimap`（旧版本为 XaeroWaypoints）文件夹中的服务器特定配置文件来启用它。强烈建议在编辑任何配置文件前退出 Minecraft，并养成定期备份的习惯。 **为何我的路径点在特定服务器上神秘消失了？** 请保持冷静，你的数据几乎肯定没有被删除。如果你同时使用了世界地图模组且地图也发生了重置，请务必先参照世界地图描述页面 FAQ 中的 *“为何我的世界地图在特定服务器‘重置’了？”* 一节进行恢复。如果已完成该步骤，请继续阅读。 首先，按 U 键打开完整的路径点菜单（若 U 键无效请检查原版控制设置）。浏览右上角下拉菜单中列出的子世界。当前服务器地址的所有路径点子世界都应罗列于此。如果其中没有任何一个包含你当前所在维度的数据，那么很可能是服务器地址发生了变更。请在 **左上角** 的下拉菜单中找到旧的服务器地址，选中它，然后执行 *选项 -> 设为当前世界/服务器（Make World/Server Auto）*。此时，你应该能在右上角的菜单中找到正确的子世界了。如果该子世界已被标记为 (auto)，意味着它已被自动选中，那么问题应当已解决。若标记为 (auto) 的是错误的子世界，请继续阅读。 *正在使用世界地图模组？* 导致错误子世界被自动选中的最常见原因之一，是在多人游戏中未能正确使用世界地图模组（自 1.6 版本起）。请务必在确认前为当前世界选择正确的地图，这直接决定了哪些路径点会对你可见。地图选择菜单位于世界地图界面的左下角图标（除非默认已打开）。如果服务器环境允许，建议将地图选择模式更改为自动模式之一。 你当前确认的地图决定了哪个路径点子世界被视为“自动”。这允许每个创建的地图拥有独立的数据。在任何时候，你都可以通过路径点菜单（按 U）右上角的下拉列表查看非自动的子世界。若要将任意子世界绑定到当前地图并设为自动，请选择 *选项 -> 设为自动子世界*。 *未使用世界地图模组？* 如果错误的子世界被视为 (auto) 并自动选中，这通常是由于服务器插件改变了原版指南针的行为，从而干扰了模组的“多世界”检测功能（如果已开启该功能，默认是关闭的）。在此类情况下，指南针通常指向玩家床的位置而非世界出生点。如果是睡在另一张床上导致路径点消失，只需重新睡回原本的床通常能修复问题。 如果是由于新添加的插件导致（且无法移除该插件），你可以按以下步骤恢复路径点： 1. 在路径点界面的右上角下拉菜单中找到包含你所需数据的正确“子世界”（先从主世界尝试）。 2. 使用 *选项 -> 设为自动子世界*。 3. 对每个维度重复此操作（操作前需先进入对应维度！）。 4. 如果这是一个简单的单世界服务器（没有大厅世界、小游戏世界、创造地皮世界等），请在同一 *选项* 菜单中关闭“多世界检测”。日后若有需要，可随时重新开启。 *如有疑问，请随时联系我！* **如何添加自定义实体图标或覆盖默认图标？** **首要前提是：请确保你已在 小地图设置 -> 实体雷达类别 中启用了实体图标/头像显示，无论是设为“总是”还是“玩家列表”。你必须先知道如何显示它们，本节内容才对你有意义。** 从模组版本 21.6.0 开始，你可以通过制作资源包（或将其包含在你自己的模组中）来用自定义精灵图/图像覆盖实体的默认图标。此外，你还可以通过编写简单的模组或代码，为实体变体（即同一种实体的不同形态拥有不同图标）添加或改进支持。不过，对于大多数简单的多变体实体类型而言，这通常是不必要的。 默认情况下，小地图模组使用绑定到实体的渲染器/模型来渲染所有图标。这支持所有原版生物以及一些头部模型部件易于识别（如头、耳、鼻等）的简单双足/四足生物。如果模组无法识别，则会退而求其次显示彩色圆点。 用于覆盖图标的相关资源目录位于 `/assets/xaerominimap/entity/icon/`。你可以在模组的 jar 文件中找到此路径并提取文件作为参考。jar 包内包含一个示例文件 `/assets/xaerominimap/entity/icon/definition/example_mod/example_entity.json`，用于演示如何覆盖模组实体的图标。该文件对应假设存在的实体类型 `example_mod:example_entity`。请仔细阅读 `example_entity.json` 中的注释，了解其结构，以便创建你自己的图标定义文件。 此外，`/assets/xaerominimap/entity/icon/definition/minecraft/` 目录下包含多个原版实体类型的示例文件，其中可能包含关于默认实体变体支持的额外说明。默认情况下，实体变体支持非常简单，变体 ID 仅仅是实体的主纹理资源位置。 如果你在小地图配置文件中将 `debugEntityVariantIds` 选项设为 true，那么新遇到的实体（变体）的变体 ID 将会打印在聊天栏和日志/控制台中。 从版本 21.8.0 开始，你还可以配置自定义的基于模型的渲染。请阅读示例文件 `/assets/xaerominimap/entity/icon/definition/example_mod/example_entity.json` 中的注释以获取所需的全部信息。 如果你想查看自定义图标的实际应用案例或直接使用它，请查看 babybluetit 的这个精彩项目：`https://www.curseforge.com/minecraft/texture-packs/xaeros-minimap-modded-support` **如何在我的服务器上禁止使用洞穴模式和/或实体雷达？** 要实现此目的，请在服务端安装本模组（撰写本文时需 NeoForge/Forge/Fabric/Quilt 服务端）。 **_如果你的小地图版本至少为 25.3.0，请设置并使用“小地图服务器设置”按键绑定来打开服务器设置界面。你可以在那里强制执行几乎任何选项，包括洞穴模式、实体雷达，甚至创建自定义实体雷达类别。_** 在旧版本模组中，当你启动服务器时，服务器目录（非世界文件夹）的 config 文件夹中通常会生成一个新的“common”配置文件。在该文件中，你可以找到多个选项来禁用玩家的特定模组功能。更改后需要重启服务器。 另外，如果你无法安装该模组，可以在玩家登录时发送包含以下字符串的服务器/系统消息，这些隐藏代码将触发相应功能： **`§f§a§i§r§x§a§e§r§o`** - 强制客户端禁用洞穴模式（包括世界地图）和实体雷达（公平竞争模式）。 **`§x§a§e§r§o§m§m§n§e§t§h§e§r§i§s§f§a§i§r`** - 允许小地图洞穴模式在下界工作，即便处于公平竞争模式下。世界地图有一个几乎相同的独立代码。 **`§n§o§m§i§n§i§m§a§p`** - 完全禁用小地图。 **`§r§e§s§e§t§x§a§e§r§o`** - 重置所有系统消息标记。 这里有一个第三方 Spigot 插件可简化此操作（非本人制作）：XMMForceFairPlay 以及一个具有类似功能的第三方数据包（非本人制作）：Xaero's Map Server Utils *使用任何第三方插件风险自负。* **安装了模组的服务器如何允许原版客户端玩家加入？** 请在服务器目录（非世界文件夹）下的 config 文件夹中找到“common”配置文件，通常路径为 `config/xaero/minimap`。其中有一个选项允许你 **禁用状态效果的注册**，正是这种状态效果注册阻止了原版玩家的加入。更改设置后需要重启服务器。如果使用了世界地图模组，也请执行相同的操作。 **开发者指南** 若想将你的模组与本模组挂钩，首先请将以下仓库添加到你的构建脚本中： ```javascript repositories { maven { url "https://chocolateminecraft.com/maven" name "Xaero's Maven" } } ``` 如果你使用的是 Forge，请确保在你的项目中应用了 Mixin gradle 插件 (`org.spongepowered.mixin`)，除非你的版本是 1.12.2。 最后，添加以下一个或多个依赖声明，请将 `` 和 `` 替换为 `https://chocolateminecraft.com/maven/xaero/minimap` 页面上显示的实际值。 Forge (使用 1.21.1 之前的官方 Mojang 映射): ```javascript implementation "xaero.minimap:xaerominimap-forge-::dev"//特意不进行反混淆！ ``` Forge (使用 1.21.1 及之后的官方 Mojang 映射): ```javascript implementation "xaero.minimap:xaerominimap-forge-:" ``` Forge (使用其他映射): ```javascript implementation fg.deobf("xaero.lib:xaerolib-forge-:+") implementation fg.deobf("xaero.minimap:xaerominimap-forge-:") ``` Fabric: ```javascript modImplementation "xaero.minimap:xaerominimap-fabric-:" ``` NeoForge: ```javascript implementation "xaero.minimap:xaerominimap-neoforge-:" ``` 在多加载器设置中的“common”项目里: ```javascript compileOnly "xaero.minimap:xaerominimap-common-:" ```

## Mod Menu (模组菜单) 概述 Mod Menu 旨在为你提供一个直观的界面，用于查看和管理已安装的模组列表。 该模组不仅能清晰地展示你当前环境下的模组清单，而且如果已安装的模组本身支持，Mod Menu 还能作为一个便捷的入口，让你快速访问并调整这些模组的配置界面。 此外，Mod Menu 还引入了一系列高级功能来增强用户体验和模组展示效果，包括： * **本地化支持**：允许对模组名称和描述进行翻译。 * **富文本描述**：得益于 Patbox 的 Text Placeholder API，模组描述中支持使用 QuickText 格式。 * **智能过滤**：能够区分并过滤掉基础的前置库模组，使列表更整洁。 * **更新检测**：针对托管在 Modrinth 上的模组或提供自定义更新源的模组，内置了更新检查器。 * **深度配置**：针对 Mod Menu 自身提供的所有功能，都给予了用户高度的配置自由。 ### 支持平台 目前，Mod Menu 适用于 Minecraft Java 版 1.14 及更高版本，并支持 Fabric 或 Quilt 加载器。 --- ## 开发者指南 Mod Menu 为开发者提供了一套丰富的 API 工具集，旨在优化模组在菜单中的呈现方式。这些工具涵盖了语言键（Language Keys）、JSON 元数据（JSON Metadata）以及通过代码实现的 Java API。 ### 翻译 API (Translation API) 你完全无需编写任何 Java 代码，即可对模组的名称、摘要和详细描述进行本地化处理。只需按照指定格式，将翻译键值添加到你所需的语言文件中即可。 **翻译 API 使用示例** 以下是一个展示 Mod Menu 被翻译成“海盗语”的示例。若要为你自己的模组创建翻译，只需将翻译键末尾的 `modmenu` 替换为你自己的模组 ID 即可（请注意，**不要**替换开头的 `modmenu`），例如：`modmenu.descriptionTranslation.traverse`。 文件：`en_pt.json` ```javascript "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）的翻译其实是多余的，因为它与描述（description）的内容完全一致。这里将其列出主要是为了演示一项功能：你可以将摘要（即对模组的一句话简短介绍）与详细描述分开独立翻译，哪怕是在英文原版中也是如此！ ### Fabric 元数据 API (Fabric Metadata API) 开发者可以通过在 `fabric.mod.json` 文件中添加特定的元数据来丰富模组的展示信息。 所有相关配置都需要放置在 `fabric.mod.json` 的自定义块（custom block）中。以下是一个集成了该 API 众多功能的配置示例： 文件：`fabric.mod.json` ```javascript { ... "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 } } } ``` #### 徽章系统 (`"badges": [ ]`) 虽然对于在 `fabric.mod.json` 中设置了 `"environment": "client"` 的模组，系统会自动添加 `Client`（客户端）徽章，但其他特殊徽章如 `Library`（前置库）和 `Deprecated`（已弃用）则需要在此处手动定义。 支持的徽章值包括： * `library`：应分配给那些纯粹作为其他模组依赖项存在的模组。默认情况下，这些模组不会向用户展示，除非用户手动切换显示开关。 * `deprecated`：应分配给那些仅出于历史兼容原因而存在的模组，例如旧版的 API 模块等。 请注意，任何非上述列出的值都将被忽略，且 Mod Menu 目前不支持开发者自定义徽章。如果你认为确实有必要添加新的徽章类型，可以在项目仓库中提交 Issue 进行讨论。 #### 链接系统 (`"links": { }`) `links` 对象允许模组作者在描述文本的末尾添加自定义超链接。值得一提的是，如果你在标准的 `fabric.mod.json` 元数据中指定了 `sources` 联系方式，它也会自动包含在链接区域中。 `links` 对象中的任何键都会被添加到链接部分，且该键会被直接用作翻译键。例如： 文件：`fabric.mod.json` ```javascript "custom": { "modmenu": { "links": { "modmenu.discord": "https://discord.gg/jEGF5fb" } } } ``` 上述代码将显示一个文本为“Discord”的链接，因为“Discord”是 Mod Menu 提供的 `modmenu.discord` 的英文翻译。 Mod Menu 内置了一些默认的链接翻译键，通常遵循 `modmenu.` 的格式。你可以查阅 Mod Menu 的语言文件以获取完整列表。 如果你希望添加自定义链接，也可以提供自己的翻译。对于任何自定义键，请务必使用**你自己的命名空间**（而不是 `modmenu`），以避免冲突。 #### 父级关系 (`"parent": "mod_id" or { }`) 父级关系用于将一个模组显示为另一个模组的子模组。这通常用于将拆分为多个模块的模组进行归类。 以下示例将当前模组定义为模组 'flamingo' 的子模组： 文件：`fabric.mod.json` ```javascript "custom": { "modmenu": { "parent": "flamingo" } } ``` 此外，如果你想将多个模组归类在一个父级下，但这个父级本身并不是一个真实存在的模组，你也可以通过定义虚拟父级来实现。如下例所示，一个模组定义了父级的元数据。请确保所有使用这个虚假/虚拟父级的子模组都包含这份元数据。若存在真实的父级模组，这些元数据将作为备选方案，会被真实模组的元数据覆盖。 文件：`fabric.mod.json` ```javascript "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 上查找最新版本。如果找到匹配的项目，它会进一步检查是否存在支持当前模组加载器和 Minecraft 版本的更新。如果新文件的哈希值与当前文件不同，它将提示用户进行更新。 如果你希望禁用此功能，可以在 Mod Menu 元数据中将 `update_checker` 设置为 `false`： 文件：`fabric.mod.json` ```javascript "custom": { "modmenu": { "update_checker": false } } ``` ### Quilt 元数据 API (Quilt Metadata API) 鉴于 Mod Menu 同样支持 Quilt 加载器，上一节 Fabric 元数据 API 中提到的所有功能同样适用于 Quilt 模组，但在自定义元数据的格式上存在细微差别。 在 Quilt 中，你不需要将 `"modmenu"` 块放置在 `"custom"` 块内，而是将其直接作为根对象的一个元素。结构如下： 文件：`quilt.mod.json` ```javascript { ... "modmenu": { // 在此处放置你的链接、徽章等配置信息 } } ``` ### Java API 若要利用 Java API 进行开发，你需要在 Gradle 项目中将 Mod Menu 添加为编译时依赖。这并不会强制你的模组在运行时依赖 Mod Menu，但能确保你在开发环境中可以使用它进行测试。 文件：`build.gradle` ```javascript // 在 repositories 块中添加 Terraformers Maven 仓库 repositories { maven { name = "Terraformers" url = "https://maven.terraformersmc.com/" } } // 在 dependencies 块中添加 Mod Menu 作为环境依赖 dependencies { // 对于 Minecraft 1.20.6 之前的版本，请使用 "modImplementation" implementation("com.terraformersmc:modmenu:${project.modmenu_version}") } ``` 接着，请在 `gradle.properties` 文件中定义你所使用的 Mod Menu 版本。建议查阅官方版本列表获取最新的版本号；请注意，如果你未使用最新版 Minecraft，可能需要选择对应的旧版 Mod Menu。 文件：`gradle.properties` ```javascript modmenu_version=VERSION_NUMBER_HERE ``` > **提示**：如果你不希望在测试环境中加载 Mod Menu，但仍需编译支持 Java API 的代码，可以使用 `modCompileOnly` 替代 `modImplementation`（即使 Mod Menu 未更新至你当前运行的 Minecraft 版本，此方法依然有效）。 ####以此开始 (Getting Started) 要开始使用 API，你需要在一个类上实现 `ModMenuApi` 接口，并在 `fabric.mod.json` 中将其添加为类型为 "modmenu" 的入口点（entry point）： 文件：`fabric.mod.json` ```javascript "entrypoints": { "modmenu": [ "com.example.mod.ExampleModMenuApiImpl" ] } ``` #### 模组配置屏幕 (Mod Config Screens) 模组可以提供一个屏幕工厂（Screen Factory），以便在用户点击配置按钮时打开自定义的配置界面。为此，请在你的 API 实现类中重写 `getModConfigScreenFactory` 方法。 此功能的预期用途是让模组能够提供其**自身**的配置界面。配置屏幕的模组 ID 将由可以自动确定该入口点来源的模组容器决定。 #### 提供的外部配置屏幕 (Provided Config Screens) 模组不仅可以为自己，还可以为**其他**模组提供屏幕工厂，以便通过配置按钮打开。为此，请在你的 API 实现类中重写 `getProvidedConfigScreenFactories` 方法。 此功能的典型应用场景是像 Cloth Config 这样的模组，它需要为那些使用了其 API 的其他模组提供配置界面。 #### 整合包徽章 (Modpack Badges) 模组可以通过实现 `attachModpackBadges` 方法，赋予其他模组 `Modpack`（整合包）徽章。示例如下： ```javascript @Override public void attachModpackBadges(Consumer consumer) { consumer.accept("modmenu"); // 声明 'modmenu' 是该整合包的一部分 } ``` 请注意，“内部”模组（如 Minecraft 本体和模组加载器）无法被赋予整合包徽章，因为它们通常不包含在常规的整合包分发文件中。 #### 静态辅助方法 (Static Helper Methods) `ModMenuApi` 还提供了一些便捷的静态辅助方法，方便那些希望与 Mod Menu进行更好集成的模组使用，例如创建自定义的“模组”按钮。 **创建模组屏幕实例** 调用此方法可直接获取模组列表屏幕的实例： ```javascript Screen createModsScreen(Screen previous) ``` **获取模组按钮文本** 调用此方法可获取 Mod Menu 风格的“模组”按钮上应显示的文本内容： ```javascript Text createModsButtonText() ```

Iris 光影加载器

重塑视觉体验的基石

在Minecraft的广阔世界中，光影效果往往是决定沉浸感的关键一环。Iris 光影加载器（Iris Shaders）正是为此而生的新一代图形引擎核心。它不仅仅是一个简单的工具，更是一把开启现代视觉盛宴的钥匙，专为那些追求极致画面与流畅体验的玩家量身打造。

兼容并蓄，无缝衔接

Iris 的设计哲学在于“传承与进化”。它天生具备强大的兼容性，能够完美支持现有的 OptiFine 光影包。这意味着，您无需抛弃那些钟爱的经典光影配置，便能在 Iris 的驱动下，让熟悉的光影焕发出前所未有的生机。无论是晨曦微露的柔和，还是末影龙息的震撼，Iris 都能以更高效的方式将其精准呈现。

现代化架构，性能飞跃

告别卡顿，拥抱丝滑。作为一个现代化的光影加载方案，Iris 采用了最前沿的代码架构，旨在打破传统加载器的性能瓶颈。它在确保画面绚丽的同时，极大地优化了帧率表现，让“高画质”与“高流畅度”不再是鱼与熊掌不可兼得的选择。

简而言之，Iris 光影加载器是连接原版画质与次世代视觉体验的桥梁，它既尊重过去的经典，又引领着未来的方向。

Cloth Config API (布料配置接口)

专为 Minecraft 模组打造的标准化配置库

Cloth Config API 不仅仅是一个简单的运行库，它是模组生态系统中至关重要的配置屏幕应用程序接口（API）。该工具旨在为模组开发者提供一套标准化的解决方案，用于构建清晰、易用的游戏内设置菜单，从而替代繁琐的配置文件编辑，大幅提升最终用户的交互体验。

开发者百科指南

https://shedaniel.gitbook.io/cloth-config/

钠 (Sodium) - 极致的渲染优化解决方案

这是Minecraft历史上最卓越的渲染优化模组之一，专为追求极致流畅体验的玩家打造。现在，无论是使用NeoForge还是Fabric模组加载器，你都能享受到它带来的性能飞跃。

这款模组是数千小时开发心血的结晶，它彻底重构了游戏的渲染管线，旨在让每一位玩家的硬件潜力得到最大释放。

核心特性：为何选择钠 (Sodium)？

钠 (Sodium) 是一个针对Minecraft客户端的强力优化引擎。它的核心使命非常明确：在显著提升游戏帧率（FPS）的同时，彻底根除恼人的微卡顿现象，并顺带修复原版游戏中存在的诸多图形渲染错误。

与其他专注于渲染的模组不同，钠 (Sodium) 在提供顶尖性能的同时，展现了惊人的兼容性。它能与现有的庞大模组生态系统和谐共存，并且严格恪守原版的美学风格——它不会擅自改变游戏的视觉效果，确保你看到的依然是那个原汁原味的方块世界，只是更加丝滑流畅。

安装指南

虽然钠 (Sodium) 支持多种模组加载环境，但为了获得最纯粹、轻量级的体验，我们强烈推荐在 Fabric Loader 环境下使用。

安装步骤： 如果你使用第三方的启动器（如Prism Launcher, HMCL等），它们通常内置了模组加载器的自动安装功能。一旦你的加载器准备就绪，安装过程就变得极其简单：只需将钠 (Sodium) 的文件放入你的 mods 文件夹即可，就像安装其他任何普通模组一样。

如何确认安装成功？ 进入游戏后，打开“视频设置”界面。如果你看到了一套全新的、布局更加现代且功能强大的用户界面，那就说明模组已经成功加载。

配置建议 对于绝大多数玩家来说，你可能根本不需要手动调整任何设置。钠 (Sodium) 内置了智能化的默认配置，它会自动开启所有你系统支持的优化选项。除非你遇到了特定的问题，或者你是需要微调性能的高级用户，否则保持默认即可享受最佳体验。

进阶性能优化：构建完整的优化矩阵

值得注意的是，钠 (Sodium) 专注于优化Minecraft的 图形渲染 代码。如果你的目标是全方位的性能提升，我们建议构建一个完整的优化体系：

锂 (Lithium)： 适用于MC 1.15及以上版本，用于优化游戏内部逻辑和服务器性能。 磷 (Phosphor)： 适用于MC 1.19以下版本，专注优化光照引擎。

这样的模块化设计让玩家可以根据需求自由选择，但作为游戏大师，我通常建议安装全套组件，以获得无懈可击的游戏体验。

硬件兼容性与系统要求

重要警告： 使用OpenGL转换层的设备（例如Android设备，也就是手机版运行Java模组，以及部分基于ARM架构的Windows设备）不仅不在官方支持范围内，而且极大概率会遭遇严重的性能崩溃。请避免在这些环境下使用。

官方支持范围： 我们仅确认为桌面级显卡提供官方支持。你的显卡驱动程序必须保持最新，且硬件需支持 OpenGL 4.5 或更高版本。值得庆幸的是，过去12年内发布的绝大多数主流显卡均满足此要求，包括但不限于：

Intel： HD Graphics 500系列 (Skylake架构) 及更新型号。 NVIDIA： GeForce 400系列 (Fermi架构) 及更新型号。 AMD： Radeon HD 7000系列 (GCN 1架构) 及更新型号。

简而言之： 如果你的台式机显卡能跑动原版Minecraft（要求OpenGL 3.3），它几乎肯定能运行钠 (Sodium)。但请注意，对于非常古老的硬件，开发团队无法保证其永久的兼容性。

故障排除首选方案： 如果你在游戏中遇到崩溃、渲染错误或性能异常，请首先检查一件事：你的显卡驱动是否是最新版本？ 过期的驱动程序是导致渲染故障和性能瓶颈的头号杀手。

问题反馈

如果你发现了BUG、遭遇了崩溃或其他技术难题，请务必使用页面顶部的链接前往问题追踪器进行反馈。在提交报告时，请养成良好的习惯：列出你正在使用的其他模组，并附上相关的崩溃日志文件，这将极大地帮助开发团队定位问题。

性能基准说明

注：使用钠 (Sodium) 获得的具体性能提升幅度，将取决于你个人的软硬件配置。为了提供具有参考价值的数据，我们在测试时特意选用了一台具有代表性的、配备集成显卡的普通电脑，以模拟广大休闲玩家的真实场景。

测试环境概览： 硬件：Intel Core i7-1165G7 (Intel Xe 核显, 2x16 GB双通道内存) 软件：Fedora Linux, OpenJDK 21, Fabric Loader

锂 (Lithium)

绝不妥协的通用游戏逻辑优化方案。适用于各类客户端与服务器。现已支持 Fabric 与 NeoForge 平台！

锂 (Lithium) 是一款现代化的、通用的 Minecraft 优化模组。它致力于改良游戏物理引擎、生物 AI、方块刻（Block Ticking）等多个关键系统，而其核心宗旨在于：在显著提升性能的同时，绝不改变原版游戏的任何机制。

该模组在客户端和服务端均能完美运行。特别值得一提的是，当其安装在服务器上时，玩家的客户端无需安装该模组即可加入（反之亦然），实现了无缝的兼容性。

显著的性能飞跃

对于多玩家服务器而言，管理员将见证每刻耗时（Tick Times）的显著降低，这意味着硬件能够承载更多的实体、加载更多的区块以及支持更多的在线玩家。

即便是在单人游戏中，锂同样能发挥巨大作用。它通过优化负责“计算”世界的内部集成服务端，释放了电脑处理器的算力以处理其他任务。这直接带来了帧率的提升和游戏响应速度的加快。

极致的兼容性

这种对维持原版行为的严格追求，使得锂模组几乎适用于所有运行 Fabric 的 Minecraft 服务器，即便是面对极其复杂的游戏玩法和红石机械也游刃有余。实际上，正是因为我们坚持“不改变原版游戏玩法”的原则，该模组甚至被官方批准用于 Minecraft 速通（Speedrunning）竞赛中。

安装指南

确保您已安装了最新版本的 Fabric Loader，随后只需将模组文件放入您的 mods 文件夹即可完成安装。

无需安装任何其他模组（甚至不需要 Fabric API！）。 无需进行额外设置。 无需为了享受性能提升而创建新世界，旧存档即装即用。

当您在进行安装时，不妨也了解一下 钠 (Sodium) 模组，它能为您进一步提升画面的渲染性能。

配置说明

锂采用了一套独特且灵活的配置系统，允许用户启用或彻底禁用模组提供的特定补丁。这种机制赋予了您对 Minecraft 代码修改的细粒度控制权。因此，若遇到罕见的漏洞或模组不兼容问题，您可以通过它来彻底排查并解决。

欲了解更多详细信息，请查阅关于修改配置文件的 Wiki 条目。

请注意： 如果您的配置文件是空的，这属于完全正常的现象。这仅代表您正在使用默认选项，而这些默认设置已经过精心调校，开箱即可为您提供模组所能达到的最佳性能。

Architectury API：构建多平台模组的桥梁

这是一个旨在简化多平台模组开发流程的中间层 API。

这是一个旨在简化多平台模组开发流程的中间层 API。

Architectury API 究竟是什么

Architectury API 的核心本质是一个用于抽象化 Fabric API 和 Forge API 调用的接口库。众所周知，这两个主流加载器虽然在实现相似功能时往往殊途同归，但其底层的代码实现却大相径庭，而本 API 便是为了消除这种差异、统一调用接口而生。

Architectury API 保持着极高频率的更新节奏，源源不断地引入新的钩子（Hooks）和特性以适应版本变化。截至目前，该库已囊括了超过 90 个事件钩子，并提供了针对网络发包、加载器调用以及游戏注册表的抽象层。除此之外，它还提供了一个极易上手且功能强大的 @ExpectPlatform 注解（需要注意的是，该功能目前仅适用于静态方法），这进一步简化了跨平台逻辑的编写难度。

我真的非要使用这个 API 不可吗？

这取决于您的具体需求。需要明确的是，Architectury API 仅仅是宏大的 Architectury 生态系统中的一环，真正赋予多平台构建能力、在幕后运筹帷幄的是 Architectury Plugin（Gradle 插件）。

对于构建在 Architectury 架构上的项目而言，本 API 实际上是可选的。这意味着，您完全拥有选择的自由，可以仅凭 Architectury Plugin 来创建您的 Architectury 项目，而不强制依赖此 API 库。

选择 Architectury 的优势

完全开源：透明的代码库，允许开发者深入研究与贡献。 代码精简：它能显著减少多平台模组开发中那些冗长且重复的“样板代码”，让您的代码结构更加清爽、高效。

开启您的多平台模组开发之旅

若您已准备好踏上多平台模组开发的征途，以下核心组件与资源将是您的得力助手：

Architectury Loom 这是 Fabric Loom 的一个分支版本，经过特别改造与增强，专门增加了强大的多平台开发能力。

Gradle Plugin 这一组件包含了 Architectury Injectables，它是实现 @ExpectPlatform 注解功能的关键所在，也是整个构建流程的核心插件。

Example Mod（示例模组） 这是一个曾经使用 Architectury 构建的示例模组仓库。请务必注意，该示例目前已停止维护，为了获得最佳的开发体验，建议优先使用下方的模组模板。

Mod Templates（模组模板） 这是一套现成的、结构完整的模板集合，旨在帮助开发者以最快的速度启动项目，并熟练使用 Architectury 工具链。

Fabric API

模组开发的基石与互通桥梁

在 Fabric 工具链的生态系统中，Fabric API 扮演着不可或缺的角色。作为一个轻量级且模块化的核心库，它为各类模组提供了通用的挂钩（Hooks）以及必要的互操作性措施，是构建稳定模组环境的基础设施。

核心功能解析

Fabric API 被定义为 Fabric 模组运行所需的必要挂钩与互通机制的集合库。其具体职能可以细分为以下几个关键领域：

解锁深层游戏机制 对于许多模组开发者而言，诸如粒子效果、生物群系生成以及维度管理等功能往往难以直接触及。本 API 将这些实用但深藏于底层的游戏功能进行了封装与公开，使得开发者能够更便捷地调用这些资源。

增强模组间的协同能力 通过引入标准化的事件系统、挂钩以及应用程序接口（API），它极大地改善了不同模组之间的兼容性，确保多个模组共存时能够协调运作，减少冲突。

提供关键的基础设施 该库包含了一系列核心特性，例如注册表同步机制，这对于多人游戏服务器至关重要。同时，它还能向崩溃报告中注入额外的诊断信息，辅助开发者和用户快速定位问题根源。

先进的渲染支持 内置了一套高级渲染 API（通常被称为 Indigo），这套系统的设计初衷是为了确保与各类性能优化模组及图形大修类模组保持高度的兼容性，从而在提升画质的同时保障流畅度。

与 Fabric Loader 的协同关系

值得注意的是，请务必区分 Fabric API 与 Fabric Loader。Fabric Loader 是一个在很大程度上独立于游戏版本的模组加载器，它是 Fabric 生态的动力核心。而 Fabric API 本质上也是一个模组，它像其他任何 Fabric 模组一样，必须依赖 Fabric Loader 才能被游戏识别并加载。

若需获取针对开发者或用户的详细技术支持与交流，建议前往 Fabric 官方的 Discord 服务器。

玩家安装指南

若想利用 Fabric API 体验丰富的模组内容，请遵循以下步骤：

首先，务必确认您的游戏客户端已正确安装了 Fabric Loader，这是运行一切的前提。关于安装加载器的详细教程，请查阅相关的官方文档。

当加载器环境准备就绪后，您只需将下载获得的 jar 格式文件直接放入游戏目录下的 mods 文件夹中即可完成安装。

实体剔除 (Entity Culling)

利用异步路径追踪技术，智能隐藏视线之外的方块与实体

虽然现代 Minecraft 的渲染引擎运行速度已经相当可观，但它并不总是足够“聪明”。试想一下，如果某些方块实体或生物完全被墙壁或天花板遮挡，处于玩家的视线盲区，为什么还要耗费宝贵的计算资源去渲染它们？如果能直接跳过这部分渲染，岂不是能极大地释放性能潜力？

本模组引入了异步路径追踪技术 (Asynchronous Path-Tracing)，旨在高效地判定哪些物体是真正对玩家可见的。通过充分利用多核 CPU 的性能，它能够实时计算视线可见性，从而剔除那些被遮挡的方块实体和实体，消除不必要的绘制调用。

这一改动带来了立竿见影的效果：更智能的渲染逻辑，更低的系统开销，以及更强劲的性能表现。

通过仅渲染真正重要的实体，你将解锁前所未有的流畅体验。本模组不仅仅是传统的优化手段，它带来了更高层次的可见性剔除算法，为您提供如丝般顺滑的游戏感受。

多线程路径追踪

压榨闲置性能：利用空闲的 CPU 线程来迅速进行可见性计算。 无阻塞运行：独立于游戏主线程之外运行，不会导致游戏卡顿。 实时数据更新：确保可见性数据始终与游戏画面同步。

智能遮挡剔除

视线阻挡判定：自动跳过渲染那些隐藏在地形或建筑物背后的方块实体和生物。 强化版剔除：工作原理类似于 Minecraft 原版的背面剔除，但更加智能、高效。 画质无损：在显著降低 GPU 负载的同时，完全不影响画面的视觉保真度。

实体运算节流

降低客户端压力：减少不可见实体对客户端造成的性能冲击。 按需更新：仅更新必要的数据，避免资源浪费。 高度兼容：完全可配置，并与大多数模组兼容。

版本支持状态

Minecraft 版本 加载器 (Loader) 状态 版本说明 备注 1.19.4 及以上 Fabric/Forge/NeoForge 支持 最新版 1.16.5 - 1.19.2 Fabric/Forge 不支持 过旧 未来可能会有更新 1.12.2 / 1.8.9 Forge 不支持 过旧 未来可能会有更新 1.7.10 Forge 不支持 过旧 无更新计划 b1.7.3 Babric 不支持 过旧 无更新计划

性能实测参考

本模组的效果对比测试在 Scarland（Hermitcraft 第九季存档）中进行，渲染距离设置为 16 个区块。测试环境为 Minecraft 1.21.5 (Fabric)，同时搭配了 Sodium (钠)、Iris 和 ImmediatelyFast 等优化模组，此时开启本模组依然能带来显著差异。

配置指南与兼容性说明

某些魔法类模组常用于制作特效的客户端实体，可能会因为被误剔除而表现异常。如果您遇到此类问题，请在配置界面中将相关实体加入白名单，以豁免 Tick 剔除或渲染剔除。

此外，对于那些渲染范围远超其自身碰撞箱大小的方块实体，您也需要将其列入白名单。常见的例子包括原版的信标光束、Create（机械动力）模组的滑轮、以及部分 Botania（植物魔法）的方块。

常见问题解答

这个模组需要安装在服务器端吗？

不需要。这是一个完全的客户端模组，无需安装在服务器上即可生效。

这会影响生物行为或刷怪塔效率吗？

不会。本模组仅仅跳过了画面的渲染过程，而不会干涉逻辑模拟。生物仍然会正常生成、移动、由于机制死亡并掉落物品。您的刷怪塔和其他基于游戏机制的设施将保持完全正常运作。

我在 Sodium (钠) 中已经启用了 "Use Entity Culling"，还需要这个模组吗？

是的，依然很有帮助！虽然 Sodium 基于加载的区块进行基础的可见性检查，但本模组的算法更加深入。它通过分析实际的视线路径（Line-of-Sight），能够剔除那些“虽然位于可见区块内，但实际上被墙壁或其他物体遮挡”的实体。这是一种更加激进且精确的优化方案，能够进一步提升性能。

FerriteCore (铁氧体核心)

内存占用优化方案

本模组旨在通过多种技术途径，大幅度降低 Minecraft 的内存占用率。对于希望深入探究其底层机制的技术型玩家，作者已另行提供了关于改动内容的高阶技术说明。

实测性能表现

内存节省的具体幅度将取决于你所运行的整合包环境。为了直观展示其效能，我们以 All Of Fabric 3 (版本 2.5.9) 进行了基准测试。结果显示，RAM 占用量（堆内存大小）从原始的 1,792 MB 惊人地降至 984 MB。作为横向对比，在相同的测试环境下，若使用 Hydrogen (氢) 模组替代本模组，内存占用量则为 1,335 MB。

上述数据均是在严格控制变量的条件下测得：生成一个固定种子的世界，并静置两分钟后记录数值。项目的展示图片正是源自该测试场景的裁剪版本。

常见问题解答 (FAQ)

Q：我应该将其安装在服务器端，还是仅安装在客户端？

A： 建议双端安装。虽然模组中包含了部分仅针对客户端的优化措施，但也存在一些影响力巨大且针对服务器环境的优化方案。因此，为了获得全方位的性能提升，你应当在客户端和服务器端同时安装本模组。

Q：本模组是否兼容其他模组？

A： 绝大多数情况下是兼容的。目前已知的唯一例外是 Hydrogen (氢) 模组。

具体兼容情况如下：在 Hydrogen 官方正式发布支持的 Minecraft 版本中，FerriteCore 的所有近期版本均能与其兼容。但是，在 Minecraft 1.18 及更高版本中，两者不再兼容。这是因为 Hydrogen 项目在这些高版本中已被官方归档，不再进行任何更新或版本发布。