`mcmap` 技术文档

本文档将详细介绍如何安装和使用 mcmap 工具，以及如何通过其 API 进行操作。mcmap 是一个用于创建 Minecraft 保存文件等距渲染的工具。

1. 安装指南

mcmap 支持在 Windows、Linux 和 macOS 上运行。以下是不同操作系统下的安装方式：

Windows

1. 下载预编译的二进制文件，可以从 发布页面 获取。
2. 解压下载的文件到一个文件夹。
3. 打开终端（或 PowerShell）并导航到该文件夹。
4. 使用 mcmap 命令。

Linux/macOS

1. 克隆或下载项目源代码。
2. 编译源代码（需要安装 zlib、PNG 和 fmt 库）。
3. 在终端中运行编译后的 mcmap。

2. 项目使用说明

mcmap 的基本调用格式如下：

mcmap <options> path/to/<your save>

保存文件的默认路径根据操作系统而异：

• Linux: $HOME/.minecraft/saves
• macOS: ~/Library/Application Support/minecraft/saves
• Windows: %AppData%\.minecraft\saves

3. 项目 API 使用文档

mcmap 提供了多种命令行选项来控制渲染过程。以下是一些常用选项：

名称	描述
-from X Z	设置起始渲染块的坐标
-to X Z	设置结束渲染块的坐标
-center X Z	设置圆形渲染的中心点
-radius VAL	设置圆形渲染的半径值
-file NAME	设置输出文件名，默认为 ./output.png
-colors NAME	设置自定义颜色文件名，用于调整方块颜色
-nowater	不渲染水
-shading	开启阴影效果，使高度不同的块亮度不同
-lighting	开启光照效果，使块根据光线亮度变化
-nether	渲染下界
-end	渲染末地
-mb VAL	设置最大内存使用量，默认为 3.5G
-fragment VAL	设置渲染区域的大小，默认为 1024x1024 块
-tile VAL	生成指定像素大小的方形输出图块，默认为 0（禁用）
-padding	设置图像周围的填充像素，默认为 5

更多选项可以通过 -h 或 -help 查看帮助信息。

4. 项目安装方式

编译安装（Linux/macOS）

1. 安装依赖库：

   对于 Debian/Ubuntu 系统运行：

   sudo apt-get install zlib1g-dev libpng-dev libfmt-dev
   

   对于其他系统，请确保安装相应的开发库。

2. 克隆或下载项目源代码。

3. 编译源代码：

   mkdir build && cd build
   cmake ..
   make
   

4. 运行 mcmap。

预编译二进制文件（Windows）

1. 从 发布页面 下载预编译的二进制文件。

2. 解压下载的文件到一个文件夹。

3. 打开终端（或 PowerShell）并导航到该文件夹。

4. 运行 mcmap。

以上就是 mcmap 的安装和使用方法。通过这些步骤，您可以轻松地创建出高质量的 Minecraft 地图渲染。