虫群之战API {#BWAPI}

[TOC]

项目信息 {#project}

概述 {#overview}

虫群之战应用程序编程接口（BWAPI, Brood War Application Programming Interface）是一个免费开源的 C++ 框架，用于与热门实时战略（RTS, Real Time Strategy）游戏《星际争霸：虫群之战》进行交互。通过 BWAPI，学生、研究人员和爱好者可以创建操控游戏的人工智能（AI, Artificial Intelligence）代理。

默认情况下，BWAPI 仅向 AI 模块显示游戏状态的可见部分。对于已进入战争迷雾的单位信息，AI 将无法获取。这使程序员能够编写在部分信息条件下进行规划和操作的竞争性非作弊 AI。BWAPI 默认还禁止用户输入，确保用户无法在 AI 运行时控制游戏单位。除非锦标赛模块（Tournament Module，AI 锦标赛的游戏裁判）强制执行，否则这些默认设置可更改以提高灵活性。更改后的默认设置将在比赛开始时公布。

功能 {#capability}

• 通过控制单个单位为《星际争霸：虫群之战》编写竞争性 AI。
• 读取游戏状态的所有相关方面。
• 逐帧分析回放，提取趋势、建造顺序和常见策略。
• 获取关于单位类型、升级、科技、武器等的全面信息。
• 在成熟的商业 RTS 环境中研究实时 AI 算法。

入门指南 {#getting-started}

• 使用 C++ 开发机器人？请下载最新版本。
• 如需使用 Java 开发机器人，请参考本教程。
• 想帮助改进 BWAPI？请 Fork develop 分支。

快速入门 {#quick-start}

1. 安装
   1. 安装 Visual Studio 2017
   2. 安装 StarCraft: Brood War
   3. 将 StarCraft: Brood War 更新至 1.16.1
   4. 安装 BWAPI
2. 编译
   1. 在 BWAPI 安装目录中打开 ExampleProjects.sln
   2. 以 RELEASE 模式构建 ExampleAIModule 项目
   3. 将 ExampleAIModule.dll 复制到 StarCraft 安装目录内的 bwapi-data/AI 文件夹
3. 通过 Chaoslauncher 运行 StarCraft
   1. 以管理员身份运行 Chaoslauncher.exe
      • Chaoslauncher 位于 BWAPI 安装目录的 Chaoslauncher 文件夹中
   2. 勾选 BWAPI Injector x.x.x [RELEASE]
   3. 点击 Start
      • 确保版本设置为 Starcraft 1.16.1，而非 ICCup 1.16.1
4. 与暴雪 AI 对战
   1. 进入 Single Player -> Expansion
   2. 选择任意用户并点击 OK
   3. 点击 Play Custom，选择地图并开始游戏
5. 与自己对战
   1. 以管理员身份运行 Chaoslauncher - MultiInstance.exe
   2. 启动
      1. 进入 Multiplayer -> Expansion -> Local PC
      2. 选择任意用户并点击 OK
      3. 点击 Create Game，选择地图并点击 OK
   3. 启动 -- 取消勾选 BWAPI Injector x.x.x [RELEASE] 以允许人类操作，保留勾选则使 AI 自对战
      1. 进入 Multiplayer -> Expansion -> Local PC
      2. 选择任意用户并点击 OK
      3. 加入另一客户端创建的现有游戏

重要链接与联系方式 {#contact}

• 文档： http://bwapi.github.io/
• 代码仓库： https://github.com/bwapi/bwapi
• 问题跟踪器： https://github.com/bwapi/bwapi/issues
• 版本发布： https://github.com/bwapi/bwapi/releases
• SSCAIT Discord： https://discord.gg/DqvHsq9
• IRC 频道： http://webchat.freenode.net/?channels=BWAPI
• Facebook： https://www.facebook.com/groups/bwapi/
• 竞赛、机器人等链接： https://github.com/bwapi/bwapi/wiki/Useful-Links

竞赛 {#competition}

多个平台举办远程竞争性 AI 竞赛，允许全球开发者参与。这些赛事通常每年举办，有时会为优胜者提供奖励。这也是测试机器人能力的绝佳方式。

• AAAI 人工智能与交互式数字娱乐会议 (AIIDE)
• IEEE 游戏会议 (CoG)
• 学生星际争霸 AI (SSCAI) 锦标赛
• BWAPI 机器人天梯

问题排查 {#issues}

使用 BWAPI 时可能会遇到问题。请按以下步骤尝试解决：

1. 检查 Starcraft/Errors/ 目录中的日志文件。
2. 在 IRC 频道询问是否有人遇到过相同问题。
3. 查看问题跟踪器，确认问题是否已被报告。
4. 向问题跟踪器提交问题。建议提交以下信息：

• 日志文件
• 截图
• 版本或修订号
• 操作系统
• 复现问题的步骤

前往问题跟踪器

法律声明 {#legal}

Starcraft 和 Starcraft: Broodwar 是 暴雪娱乐 的商标。BWAPI 是违反最终用户许可协议（EULA, End User License Agreement）的第三方"破解工具"。强烈建议在使用 BWAPI 前从暴雪娱乐购买正版《星际争霸：虫群之战》。

bwapi 快速上手指南

环境准备

• 操作系统：Windows 10 或更高版本（64 位）
• 前置依赖：
  • Visual Studio 2017（安装时需勾选 C++ 桌面开发 工作负载）
  • StarCraft: Brood War 原版游戏（必须更新至 1.16.1 版本）
  • BWAPI 框架（最新版）

安装步骤

1. 安装 Visual Studio 2017。
2. 安装 StarCraft: Brood War，并通过官方补丁更新至 1.16.1 版本。
3. 下载并安装 BWAPI：
   • 访问 BWAPI GitHub releases 下载最新 release。
   • 国内用户推荐：使用 FastGit 镜像 加速下载。
   • 解压下载的 ZIP 文件到 StarCraft 安装目录（例如 C:\Program Files (x86)\StarCraft）。
4. 编译示例 AI 模块：
   • 打开 BWAPI 安装目录中的 ExampleProjects.sln。
   • 在 Visual Studio 中，选择 RELEASE 配置，编译 ExampleAIModule 项目。
   • 将生成的 ExampleAIModule.dll 复制到 StarCraft 安装目录下的 bwapi-data/AI。

基本使用

1. 以管理员身份运行 Chaoslauncher.exe（位于 BWAPI 安装目录的 Chaoslauncher 子目录）。
2. 在 Chaoslauncher 界面中，勾选 BWAPI Injector x.x.x [RELEASE]（确保版本与安装一致）。
3. 点击 Start 按钮启动 StarCraft。
4. 在 StarCraft 主菜单中：
   • 进入 Single Player -> Expansion
   • 选择任意用户并点击 OK
   • 点击 Play Custom，选择一张地图（如 Birini Station），开始游戏
5. 游戏开始后，示例 AI 将自动运行，与 Blizzard 内置 AI 对战。观察 AI 控制单位执行基础操作（如采集资源、建造建筑）。