Surveyor Map Framework

为世界地图和航点模组提供的开源后端（及 API）！
**在 (neo)forge 上需要安装 Connector 和 FFAPI。
**

Surveyor 是 Antique Atlas 4、Hoofprint 和 Via Romana 等模组的地图后端。
除了负责生成和保存地形、航点等地图数据外，Surveyor 还可以：

• 在地图上显示其他玩家的位置，即使他们身处数百个区块之外！
• 追踪你的探索进度；如果地图数据丢失或你更换了电脑，还能从服务器恢复数据！
• 支持与指定的其他玩家实时共享地图——包括地形、航点等所有内容！
• 随时切换地图前端，而不会丢失地图数据！
• 从 Xaero’s Minimap 导入航点，并与 传送石碑 和 OPAC 等模组集成。
• 采用完全模块化设计，因此 Atlas HUD 等模组可以使用航点，而无需启用地形扫描。

命令

如果你是服务器管理员，或者没有安装地图前端，Surveyor 提供了一些实用命令：

• /surveyor 显示你探索过的区块和结构数量，以及记录的航点数量。
• /surveyor share [player] 和 /surveyor unshare 用于加入或退出地图共享组。
• /waypoints 用于查看和编辑已记录的航点。
• /landmarks 用于查看和编辑全局航点（需要 op 2 或更高权限才能编辑）。

Surveyor 数据以纯文本 NBT 格式存储在 data/surveyor 下（单人游戏和服务器中按维度分别存储；客户端数据存储在 .minecraft 中）。

配置

可以在 config/surveyor.toml 中编辑 Surveyor 的配置，也可以在游戏内使用 McQoy 进行配置。可调整的内容包括：

• 启用或禁用地形、结构和地标子系统（客户端上则由已安装的前端设置）
• 要向客户端或服务器，以及组成员之间同步哪些数据。
• 是否将服务器上的所有玩家视为同一个全局地图共享组的成员。
• 向客户端发送玩家位置更新的频率，以及向客户端同步缺失地形的速度。

模组开发者

如果你想基于 Surveyor 开发内容，欢迎联系我们——或者直接动手开发！我们很期待看到：

• 针对 [surveyor 改进和错误](https://github.com/sisby-folk/surveyor/issues?q=is:issue state:open (label:bug OR label:enhancement)) 提交的 PR。
• 将版本移植到较早的稳定版本（1.4.7、1.17.10、1.12.2、1.16.5、1.18.2）的 PR——或者按政策移植到最新版本
• 添加你会用到的 API 功能的 PR——最好先提交一个 issue，我们可以一起讨论完善！
• 利用 surveyor 制作的兼容附属模组、世界地图、小地图和路径点前端！
  服务端、网页地图、不需要 Minecraft……我们只希望能为地图模组领域带来更多有趣的新东西。

查看前端开发指南，了解内部实现中较复杂部分的说明。

许可协议与致谢

如果可以，请将你的附属模组许可协议设为 LGPLv3——这有助于壮大 surveyor 生态！
（LGPLv3 是一种著佐权许可协议，因此，直接改编自 Surveyor 的内容必须使用该协议。）

如果你做出了什么新东西，欢迎联系我们，我们可能会在这里添加链接！我们也会解答正在开发中的项目相关问题。
开发者可以通过 mastodon 或 电子邮件 联系我们。

后记

Surveyor 的开发凝聚了社区中许多模组开发者的想法、建议、观点和过往作品。

感谢每一位帮助这个项目得以实现的人，即使只是在一旁默默关注——这对我们意义重大。

我们开发 surveyor 只是因为觉得它很酷——希望它也能帮助其他创作者和模组开发者做出酷炫的作品！