xaero-world-map-bridge

一个客户端兼容库,为Xaero的世界地图提供与加载器无关的地图和UI叠加层API。

基础库

Xaero World Map Bridge

Xaero World Map Bridge 是一个客户端库,供在 Xaero's World Map 上绘制自定义内容的模组使用。它提供稳定、与加载器无关的 API,用于在 Fabric 和 NeoForge 上实现地图叠加层和 UI 叠加层。

本项目主要作为模组开发者的依赖项。单独安装它不会添加地图标记、声明或其他可见内容;依赖它的模组会注册由它渲染的叠加层。

特性

  • 在兼容的渲染钩子可用时,有序地图叠加层会渲染在地图纹理之上、Xaero 的地图元素之下。
  • UI 叠加层会渲染在 Xaero 界面之上。
  • 提供地图上下文,包含相机位置、缩放比例、尺寸以及世界坐标到屏幕坐标的转换辅助方法。
  • 提供地图叠加层的兼容性回退方案,并在 Xaero 更改其渲染内部实现时给出清晰的诊断信息。
  • 可选的 Fabric Mod Menu 设置,用于启用地图叠加层、UI 叠加层以及兼容性回退。

安装

  1. 安装 Xaero's World Map 以及与你的 Minecraft 版本匹配的 Fabric 或 NeoForge 加载器。
  2. 下载与你的 Minecraft 版本和加载器都匹配的 Xaero World Map Bridge 文件。
  3. 在 Fabric 上,还需安装 Fabric API。
  4. 将 Xaero World Map Bridge 及其必需依赖项放入客户端的 mods 文件夹。

它是仅客户端依赖项。除非其他模组明确要求,否则无需安装到专用服务器上。

兼容性

Minecraft Fabric NeoForge Xaero's World Map
1.21.11 是 实验性 1.40--1.44
26.1.2 是 实验性 1.40--1.44
26.2 是 实验性 1.41--1.44

Xaero's World Map 1.40 未针对 Minecraft 26.2 发布。不支持 Minecraft 26.3,因为缺少兼容的 Xaero Fabric 构建产物。

面向模组开发者

使用 XaeroWorldMapBridge.registerMapOverlay(...) 在地图坐标中绘制,或使用 XaeroWorldMapBridge.registerUiOverlay(...) 在 Xaero 的 UI 之上绘制。注册项均为 AutoCloseable,因此关闭某个注册项即可注销其叠加层。

XaeroWorldMapBridge.registerMapOverlay("example:claims", 100, context -> {
    int x = context.worldToScreenX(128.0);
    int y = context.worldToScreenY(-64.0);
    context.canvas().fill(x, y, x + 16, y + 16, 0x80FFAA00);
});

完整 API、构建说明和兼容性详情请参阅项目 README。

许可证

Xaero World Map Bridge 以 MIT 许可证提供。