# squaremap
## squaremap 是什么
squaremap 是一个简约轻量级的 Minecraft 服务器实时世界地图查看器。
squaremap 作为插件或模组在 [支持的平台](#supported-platforms) 上钩入你的 Minecraft 服务器，然后生成和管理你的服务器的实时地图，可以在任何 Web 浏览器中查看。
## 功能
* 超快渲染时间。 立即获取你的地图渲染，而不是下周。
* 简单的类似原版的俯视 2D 视图，专为导航设计。
* 玩家标记，显示偏航旋转、生命值和护甲。
* 易于 [设置](https://github.com/jpenilla/squaremap/wiki/Installation) 和 [配置](https://github.com/jpenilla/squaremap/wiki/Default-config.yml)。
* 及时更新的 Leaflet 前端。
* 许多流行的插件的 [插件和集成](https://github.com/jpenilla/squaremap/wiki/Addons)。
## 支持的平台
- [Paper](https://papermc.io/)
- [Sponge](https://www.spongepowered.org/)
- [Fabric](https://fabricmc.net/) （需要 [Fabric API](https://www.curseforge.com/minecraft/mc-mods/fabric-api)）
- [NeoForge](https://neoforged.net/)
## 下载
可以在 Modrinth 或 [GitHub 发布](https://github.com/jpenilla/squaremap/releases) 上获取所有支持平台的下载。
## 演示
官方 squaremap 演示：https://squaremap-demo.jpenilla.xyz/
## 许可证
本项目采用 [MIT 许可证](https://github.com/jpenilla/squaremap/blob/master/LICENSE) 许可。
Leaflet（Web UI 前端）采用 [2-clause BSD 许可证](https://github.com/Leaflet/Leaflet/blob/master/LICENSE) 许可。
## API
squaremap 提供了简单的 API，用于在渲染的地图上绘制标记、形状、图标等。 Java 文档托管在 Maven 仓库中，与二进制文件一起，并且应该被你的 IDE 自动下载。 更多关于 API 的细节请参见 [README](https://github.com/jpenilla/squaremap/blob/master/README.md) 和 [Wiki](https://github.com/jpenilla/squaremap/wiki)。