PySC2 项目使用指南

1. 项目目录结构及介绍

PySC2 项目的目录结构如下：

pysc2/
├── bazel/
├── docs/
│   ├── environment.md
│   └── ...
├── pysc2/
│   ├── agents/
│   ├── bin/
│   ├── lib/
│   ├── maps/
│   └── ...
├── .gitignore
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── WORKSPACE
└── setup.py

目录介绍

• bazel/: 包含 Bazel 构建工具的相关配置文件。
• docs/: 包含项目的文档文件，如 environment.md 等。
• pysc2/: 项目的主要代码目录，包含以下子目录：
  • agents/: 包含一些预定义的代理（agent）脚本。
  • bin/: 包含一些可执行脚本，如 run_tests.py 等。
  • lib/: 包含项目的核心库文件，如 actions.py、features.py 等。
  • maps/: 包含地图配置文件。
• .gitignore: Git 忽略文件配置。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• WORKSPACE: Bazel 工作区配置文件。
• setup.py: Python 安装脚本。

2. 项目启动文件介绍

PySC2 项目的启动文件主要集中在 pysc2/bin/ 目录下。以下是一些常用的启动脚本：

• run_tests.py: 用于运行项目的测试用例。
• agent.py: 用于启动一个代理（agent），可以指定地图和代理类型。
• play.py: 用于以人类玩家的身份启动游戏，可以用于调试和可视化。
• map_list.py: 用于列出所有可用的地图。

示例启动命令

# 运行测试
python -m pysc2.bin.run_tests

# 启动一个代理
python -m pysc2.bin.agent --map Simple64

# 以人类玩家身份启动游戏
python -m pysc2.bin.play --map Simple64

# 列出所有地图
python -m pysc2.bin.map_list

3. 项目的配置文件介绍

PySC2 项目的配置文件主要包括以下几个部分：

3.1 setup.py

setup.py 是 Python 项目的安装脚本，用于定义项目的依赖和安装方式。可以通过以下命令安装项目：

pip install .

3.2 WORKSPACE

WORKSPACE 是 Bazel 工作区配置文件，用于定义 Bazel 构建工具的工作环境。

3.3 .gitignore

.gitignore 文件用于指定 Git 版本控制系统忽略的文件和目录，避免将不必要的文件提交到代码仓库。

3.4 CONTRIBUTING.md

CONTRIBUTING.md 文件提供了项目的贡献指南，指导开发者如何为项目贡献代码。

3.5 LICENSE

LICENSE 文件包含了项目的许可证信息，说明项目的开源许可证类型。

3.6 README.md

README.md 文件是项目的介绍和使用说明，包含了项目的概述、安装方法、使用示例等内容。

通过以上配置文件和启动脚本，开发者可以方便地安装、配置和运行 PySC2 项目。