🚀 入门指南#

本指南将带你配置本地开发环境，用于构建、测试并为我们的模块做出贡献。

⚙️ 准备工作#

开始前，请完成以下步骤，确保系统环境就绪：

  1. 安装 UV，它是 Python 包和项目管理器。

  2. 克隆仓库。如果你还没有完成这一步，请参阅分步教程：首次贡献指南。克隆完成后，用你喜欢的代码编辑器打开项目文件夹。

🔨 构建模块#

modules 目录包含所有模块的源文件。使用以下命令管理和高效构建模块：

uv run modules build

构建所有模块

uv run modules watch

监视变更并自动重新构建模块

uv run modules <build|watch> <module1> ...

仅构建或监视指定模块

uv run link [world]

将生成的资源包和数据包连接到 Minecraft 世界

鐩戞帶妯″潡

构建模块可能需要一些时间。为获得更流畅的体验，建议只监视当前正在处理的模块：uv run modules watch <module>。

将模块连接到 Minecraft#

link 命令可以将生成的包直接集成到 Minecraft 世界中。该命令可用的选项如下：

world（可选）

要连接的 Minecraft 世界名称

--minecraft <DIRECTORY>

.minecraft 目录的路径（Minecraft 文件所在位置）

--data-pack <DIRECTORY>

存放数据包的目录路径

--resource-pack <DIRECTORY>

存放资源包的目录路径

下面的工作流演示如何在 Minecraft 中直接连接并持续测试模块：

# Link modules to a specific world
uv run link <world> --minecraft </path/to/.minecraft>

# Monitor changes and rebuild a module for the linked world
uv run modules watch <module>

🧪 测试模块#

测试是软件开发的重要环节，有助于确保代码正确，并避免未来出现潜在问题。

如需了解如何为模块编写和运行测试，请参阅调试章节。