Chunker项目使用教程

1. 项目目录结构及介绍

Chunker项目的目录结构如下：

Chunker/
├── app/              # 包含 electron 前端应用的相关代码
├── cli/              # 包含命令行界面应用的相关代码
├── gradle/           # 包含 Gradle 构建脚本
├── .github/          # 包含 GitHub 工作流和其他 GitHub 相关配置
├── .gitattributes    # 定义 Git 的一些属性
├── .gitignore        # 定义 Git 忽略的文件和目录
├── CODE_OF_CONDUCT.md # 项目行为准则
├── CONTRIBUTING.md   # 贡献指南
├── LICENSE           # 项目许可证信息
├── README.md         # 项目说明文件
├── SECURITY.md       # 安全策略
├── SUPPORT.md        # 支持信息
├── gradlew           # Gradle Wrapper 脚本
├── gradlew.bat       # Gradle Wrapper 脚本（Windows 版本）
└── settings.gradle.kts # Gradle 设置文件

目录说明：

• app/: 包含了 Chunker 的电子前端应用代码，使用 Electron 框架开发。
• cli/: 包含了 Chunker 的命令行界面（CLI）应用代码，提供了转换功能。
• gradle/: 包含了构建项目所需的 Gradle 配置文件。
• .github/: 包含了 GitHub Actions 工作流文件和其他 GitHub 相关配置。
• CODE_OF_CONDUCT.md: 规定了参与项目开发者的行为准则。
• CONTRIBUTING.md: 提供了贡献代码的指南和流程。
• LICENSE: 项目的 MIT 许可证文本。
• README.md: 项目的介绍和基本使用说明。
• SECURITY.md: 项目的安全策略和漏洞报告流程。
• SUPPORT.md: 提供了项目支持和帮助的信息。
• gradlew 和 gradlew.bat: Gradle Wrapper 脚本，用于简化构建过程，无需安装 Gradle。

2. 项目的启动文件介绍

CLI 启动

Chunker 的命令行界面可以通过以下方式启动：

java -jar chunker-cli-VERSION.jar -i "输入世界文件夹路径" -o "输出世界文件夹路径" -f "输出格式"

其中 VERSION 应替换为你下载的 Chunker CLI 版本号。参数 -i 指定输入世界的路径，-o 指定输出世界的路径，-f 指定输出格式，例如 JAVA_1_20 或 BEDROCK_1_20_80。

Electron 前端启动

Chunker 的电子前端应用通常通过以下步骤启动：

1. 克隆项目到本地。
2. 进入项目目录。
3. 使用 Gradle 构建项目。

git clone git://github.com/HiveGamesOSS/Chunker.git
cd Chunker
./gradlew build

构建完成后，在 build/libs/ 目录下可以找到可执行文件，运行即可启动电子前端应用。

3. 项目的配置文件介绍

Chunker 使用 JSON 格式的配置文件来定义各种设置。以下是一些主要的配置文件和它们的作用：

• blockMappings.json: 定义了方块映射，用于在不同版本和版次之间转换方块。
• worldSettings.json: 定义了世界的设置，如游戏规则和世界生成选项。
• pruningSettings.json: 定义了转换过程中的修剪设置，用于优化世界数据。
• converterSettings.json: 定义了转换器设置，包括一些特定选项和参数。
• dimensionMappings.json: 定义了维度的映射，用于转换维度相关的数据。

这些配置文件通常位于输入目录中，并且可以在电子前端应用的“高级设置”中生成。在命令行界面中，可以通过相应的命令行参数指定这些文件的路径。