Surveyor Map Framework

Surveyor Map Framework

和朋友一起使用地图！一个带有多人共享、自动结构/兴趣点标记和统一模组兼容性的世界地图后端。

基础库

Surveyor Map Framework预览查看大图
surveyor 横幅
一个用于支持联机世界地图和路径点模组的开源后端（及 API）！
在（新）Forge 上需要 Connector 和 FFAPI。

Surveyor 是诸如 Antique Atlas 4、Hoofprint 和 Dead Reckoning 等地图模组的后端。

在客户端安装时，Surveyor 允许你：

  • 查看已探索的地形，并通过路径点标记兴趣点
  • 通过兼容性附加组件（如 Waystones 和 OPAC）在地图上查看其他模组的地标
  • 随时更换地图前端，并保留所有地图数据
  • 自动从现有的 Xaero 小地图存档中直接迁移路径点

在两端均安装时，Surveyor 允许你：

  • 在协作小组中探索地图地形和编辑路径点 （默认为服务器范围）
  • 在地图上查看其他玩家，即使他们很远或在其他维度
  • 更换实例或电脑，地图数据将从服务器恢复
  • 使用管理员命令为出生点、商店、传送枢纽等兴趣点创建服务器范围的标志
  • 通过潜行并使用制图台（样式可配置）在普通地图之间复制探索数据

普通地图集成预览

作为模组开发者，Surveyor 允许你：

  • 创建纯地图前端，由自身处理所有地图数据 - 地形、结构和路径点
  • 创建用于自定义地图地标的附加组件，采用灵活的组件式数据系统
  • 创建任何类型的前端 - 可选的服务器端、游戏内/混合端、外部/基于浏览器的等
  • 单独利用路径点系统，制作轻量的小型路径点/指南针模组

配置

Surveyor 可以通过 config/surveyor.toml、McQoy 或 QoMC 进行配置。大多数更改需要重启。

  • 通过设置 globalSharing=false 禁用服务器范围的协作 （推荐用于公共服务器）
  • 在 Networking 部分调整玩家、小组和服务器之间同步的数据
  • 在 Builtins 部分切换内置的自动路径点（例如下界传送门、坟墓标记）

命令

Surveyor 主要通过地图前端进行交互，但也附带了一些有用的命令：

  • 当 globalSharing=false 时，使用 /surveyor share/unshare 组成小组以共享路径点和地图数据
  • 使用 /surveyor、/waypoints 和 /landmarks 查看你的路径点和已探索的地图数据
  • 使用 /waypoints new/remove 创建/编辑自定义路径点（例如，如果未安装前端时）
  • 使用 /landmarks new/remove（管理员权限 2）创建/编辑操作员级别的全局路径点（例如，用于服务器出生点）

故障排除

如果将任何独特的可复现问题报告到问题页面，请尽可能附带日志、截图和复现步骤。

客户端数据存储在 .minecraft/data/surveyor/[world]/[dim]，单人/服务器数据存储在 [world]/[dim]/data/surveyor
c.X.X 文件包含地形区域，s.X.X 文件包含结构，landmarks.dat 包含路径点数据。

遇到问题时，你可以尝试以下操作：

  • 备份受影响的数据并删除它（例如，对于与结构相关的错误，清除结构数据）
  • 禁用某个子系统的网络功能（例如，对于地形数据包导致客户端被踢，将 networking.terrain 设置为 NONE）
  • 禁用某个子系统（例如，对于服务器内存使用过高，在服务器上将 terrain 设置为 DISABLED）

贡献 / 附加组件

如果你想使用 surveyor 开发某些功能，欢迎联系我们——或者直接动手吧！我们欣赏：

  • 针对 surveyor 改进和错误 的 PR
  • 包含移植到较旧稳定版本（1.4.7、1.17.10、1.12.2、1.16.5、1.18.2）的 PR - 或根据政策移植到最新版
  • 包含你受益的 API 功能的 PR - 最好先发布一个问题，我们可以一起讨论
  • 利用 surveyor 的兼容性附加组件、世界地图、小地图和路径点前端！

查看前端开发指南了解内部复杂部分的详解。

许可 / 致谢

如果可能，请将你的附加组件许可证匹配为 LGPLv3 —— 这有助于改善 surveyor 生态系统！
（LGPLv3 是一个 copyleft 许可证，因此任何直接改编自 Surveyor 的内容都需要它）

如果你编写了某些内容，请联系我们，我们可能会在这里链接它！我们也会回答进行中项目的问题。
开发者可以通过 mastodon 或 电子邮件 联系我们。

后记

Surveyor 建立在社区中许多模组制作者的想法、建议、意见和过往作品之上。

感谢所有帮助这个项目实现的人，即使只是在旁边默默支持——这意义重大。

我们制作 surveyor 是因为它听起来很酷——我们希望它能帮助其他艺术家/模组制作者制作出酷炫的东西！