MineStudio 开发者指南

1. 项目目录结构及介绍

MineStudio 是一个用于 Minecraft AI 代理开发的项目，其目录结构如下：

• assets/: 包含项目的资源文件，如 Dockerfile。
• docs/: 存放项目的文档。
• minestudio/: 核心代码目录，包括模拟器、数据结构、模型、训练和推理相关模块。
  • simulator/: Minecraft 模拟器相关代码。
  • data/: 存储和管理轨迹数据的模块。
  • models/: 包含各种 Minecraft 策略模型的模板和基线模型。
  • offline_training/: 离线数据预训练相关模块。
  • online_training/: 在线强化学习训练模块。
  • inference/: 推理框架模块。
  • benchmark/: 自动化和批量测试不同 Minecraft 任务模块。
• tests/: 测试代码目录。
• .gitignore: 指定 Git 忽略的文件和目录。
• LICENSE: 项目的许可证文件。
• README.md: 项目的说明文档。
• pyproject.toml: Python 项目配置文件。

2. 项目的启动文件介绍

项目的启动主要依赖于 minestudio/simulator/entry.py 文件。以下是启动文件的简要介绍：

• entry.py: 这是启动 Minecraft 模拟器的主要入口文件。它负责初始化模拟器环境，加载配置，以及开始模拟过程。

启动模拟器的示例命令：

python -m minestudio.simulator.entry

如果你使用的是支持 NVIDIA 显卡的系统，可以通过以下命令启用 GPU 渲染：

MINESTUDIO_GPU_RENDER=1 python -m minestudio.simulator.entry

3. 项目的配置文件介绍

项目的配置文件主要用于设置模拟器和其他模块的参数。以下是配置文件的简要介绍：

• config.yaml: 这是模拟器的配置文件，其中包含了模拟器运行时所需的各种参数，如观察者大小、渲染设置等。

配置文件示例：

simulator:
  obs_size: [128, 128]
  render: true
  ...

在项目开发过程中，可以根据需要修改这些配置以适应不同的开发场景和要求。