PySC2 项目教程

1. 项目的目录结构及介绍

PySC2 项目的目录结构如下：

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

目录结构介绍

• bazel/: 包含 Bazel 构建工具的相关配置文件。
• docs/: 包含项目的文档文件，如环境配置、地图配置等。
• pysc2/: 项目的主要代码目录，包含以下子目录：
  • agents/: 包含各种代理（agent）的实现，如随机代理、脚本代理等。
  • bin/: 包含可执行脚本，如运行代理、播放游戏等。
  • lib/: 包含项目依赖的库文件。
  • maps/: 包含地图配置文件和自定义地图。
  • run_configs/: 包含运行配置文件。
  • tests/: 包含项目的测试文件。
  • init.py: Python 包初始化文件。
• .gitignore: Git 忽略文件配置。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用指南。
• WORKSPACE: Bazel 工作区配置文件。
• setup.py: Python 项目安装配置文件。

2. 项目的启动文件介绍

PySC2 项目的启动文件主要位于 pysc2/bin/ 目录下，常用的启动文件包括：

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

启动示例

# 启动一个随机代理在 Simple64 地图上
python -m pysc2.bin.agent --map Simple64

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

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

3. 项目的配置文件介绍

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

• setup.py: 项目的安装配置文件，定义了项目的依赖和安装方式。
• WORKSPACE: Bazel 工作区配置文件，定义了 Bazel 构建工具的依赖和配置。
• pysc2/maps/: 包含地图配置文件，定义了地图的属性和规则。
• pysc2/run_configs/: 包含运行配置文件，定义了运行时的配置选项。

配置文件示例

setup.py

from setuptools import setup, find_packages

setup(
    name="pysc2",
    version="4.0.0",
    packages=find_packages(),
    install_requires=[
        "absl-py",
        "numpy",
        "pygame",
        "portpicker",
        "six",
        "websocket-client",
    ],
    entry_points={
        "console_scripts": [
            "pysc2_play=pysc2.bin.play:main",
            "pysc2_agent=pysc2.bin.agent:main",
            "pysc2_map_list=pysc2.bin.map_list:main",
        ],
    },
)

pysc2/maps/simple64.py

from pysc2.maps import lib

class Simple64(lib.Map):
    directory = "mini_games"
    players = 2
    score_index = 0
    game_steps_per_episode = 0
    step_mul = 8
    game_type = "MELEE"

通过这些配置文件，可以自定义项目的安装、运行和地图配置。