Repository navigation
Expose a bot/agent API for Zero Hour, in the spirit of BWAPI #3328
Description
Activity
I like the idea, and keeping the existing command machinery and keeping bot implementations outside the engine sound like the right moves. Which frame boundary does the bot observe? When do its actions execute, and what happens if it stalls? We'd have to build out a bunch of headless stuff that is currently skipped/dummy, eg ghost-objects, all of the game ending stuff. We'd also need to check that all getters only get and don't change state or we'll end up with mismatches. And it's one thing to have the local human player played by a bot - but to have more than one bot on a machine would need us to change a bunch of stuff. And some things in code are possible that aren't possible in the UI, like MSG_DO_ATTACK_OBJECT on a shrouded thing - people could abuse this, so we'd want to find these spots in the code and harden them.
I still think something like this is going to get put on the back burner. Maybe start with an experimental replay-observation interface and a minimal external client, prove that one live bot-controlled match can be recorded and replayed correctly? Your best bet imho is to keep TSH changes minimal and make a working demo that gets people excited about it.- Is this something the project wants at all, or is it out of scope? Worth knowing before any design work.
It sounds useful long term.
- Should it live in-tree, or as a separate repo under the org consuming a small set of hooks added here? I lean toward the second — it keeps this repo's diff tiny and lets the API iterate at its own pace.
The piping makes sense. Keep simple communications to the game client, and the bot itself lives in a separate process making its calls to the game client. Yes the bot machinery can be a separate repository then, targeted for any programming language. The game client just gives the contact for interacting with it.
- Zero Hour first, per the precedence rule in
CONTRIBUTING.md, with Generals to follow — is that right here, or is this one where sharing viaCore/from the start makes more sense?
New files go into Core. Code that touches files not yet merged into Core goes to GeneralsMD first, and then is replicated to Generals before its merged into main branch.
- Is there any appetite for the observation API to also serve the existing skirmish
AIPlayer/AISkirmishPlayer, or should those stay entirely separate?
I think the classic scripted AI players are kept seperate from the new machine learned AI players. They are controlled by different mechanisms.
- Anything in the 1.04 compatibility rules that a bot API would trip over that isn't obvious from outside?
If the bot can only post GameMessages and observe game states, then it should not change game logic. I think there needs to be some though put into how a bot can observe the world and how that is implemented nicely across many classes. He should not see whats in the shroud (and maybe also not what is not in camera view, bot needs to scroll like a human?), but he should see everything a human player would see and use that data for decision making.
AI disclosure: this comment was drafted with Claude (Claude Code) and posted at my direction; I stand behind it and will answer follow-ups myself.
Thanks @xezon and @bobtista, that feedback was very useful. Following it, I've written a spec only, no code so we can agree on the design before anything is implemented: #3338.
docs/plans/2026/09/21/101-bot-agent-api/overview.mdhas a table that maps each of your points to where it's answered. Short version:- Frame semantics / stalls: the bot observes the end of frame N. Its orders execute at N+1 in skirmish and N+run-ahead in network games, exactly like a human's. In realtime mode the game never waits for the bot; step mode (the game waits) only runs in skirmish/headless.
- Getters that mutate: the spec lists the ones found so far (
Object::getShroudedStatuswrites partition/ghost caches,WeaponTemplate::getDelayBetweenShotsadvances the logic RNG,createGroupbumps a CRC'd counter). It proposes a pure snapshot writer, plus a replay test with a CRC every frame to prove purity. - Shrouded targets: confirmed that
onDoAttackObjectonly checks the target exists. The spec proposes UI-parity checks in the bridge before a message is created (no CRC impact), and treats logic-side hardening as separate optional PRs behindRETAIL_COMPATIBLE_CRC. - More than one bot per machine: one bot per game process. Two people each run their own bot on their own machine in an ordinary LAN game, and nothing in the engine needs to support multiple local players.
- Separate repo + Core: the engine side is a small, off-by-default bridge in
Core/; SDKs, Gym env, MCP server and referee live elsewhere. - Visibility: fog-respecting by default, a
cameramode as you suggested, andfullonly for replays/analysis — refused in network games. Bot-controlled players get a[BOT]tag in their name.
Two things I learned while researching:
- NewShoes (https://github.com/Agusx1211/NewShoes, see its issue Game can crash when clicking on player icon in Replay Mode #75) already has a working, fog-respecting agent bridge for the Zero Hour WebAssembly port. I'd like to align with it rather than invent a second, incompatible protocol.
- A correction to my original post: Pluto is not the only neural-network Brood War bot, and its 64-bit process is its own sidecar, not BWAPI's client bridge. It did win CoG 2026 (4–1 over PurpleWave in the final). The widely reported wins over pro players came from an unauthorized copy on the Remastered ladder that reportedly used a maphack — a good argument for enforcing fog on the engine side.
Also, in case it's useful: at developerz-ai, where I work, we've distilled about two years of building software with AI agents into https://github.com/developerz-ai/gold-standards-in-ai. It goes beyond the plan layout used in the PR: how to organize a repo so AI coding agents work well in it (
CLAUDE.md, guard rails and lint checks, fast feedback loops, planning conventions, MCP design). No expectation to adopt any of it, but some ideas might fit this repo.- Where do orders enter? Inject into
TheCommandListright afterpropagateMessages()(GeneralsMD/Code/GameEngine/Source/Common/GameEngine.cpp:910) — bypassing UI translators — or intoTheMessageStreamso translators see them? Plan assumes the former.
The regular path (TheMessageStream) is safest, because then a human can observe the bot in a client. Headless could go through TheCommandList, but is not strictly needed if TheMessageStream also works for it.
- Observation hook: end of
GameLogic::updatejust beforem_frame++(GeneralsMD/Code/GameEngine/Source/GameLogic/System/GameLogic.cpp:3935) so it also fires in headless replay simulation, which never callsGameEngine::update. OK?
Yes at the end of a logic update it makes sense.
- Object visibility:
Object::getShroudedStatusmutatesPartitionDatacaches. Reimplement its rules as a pure read, or accept calling it from logic in fixed order? Plan prefers pure.
Yes all bot observations of game state must not mutate game state.
- UI-parity hardening in logic (reject attacks on shrouded targets etc.) — separate PRs behind
RETAIL_COMPATIBLE_CRC, or bridge-side only until retail compatibility can be broken?
We can harden this yes so that the bot really cannot do illegal attacks. Must be behind RETAIL_COMPATIBLE_CRC and keep the checks simple at the injection points if possible.
Other than that, game state observation should hide targets that are not visible, so the bot should not be able to react to it, unless it tries to cheat on its own (by remembering old target ids and figuring that it can still target them when assumed hidden).
- Camera-bound mode as xezon suggested — required, optional, or later?
Optional. It naturally nerfs the effectiveness of the bot.
- Wire format: length-prefixed JSON first (C++98/VC6-friendly, no new deps) with a binary encoding later — acceptable?
Json is fine.
- Separate repo name/ownership under the org, or a personal repo until it proves itself?
You can create the Bot stuff on your own repository until it has matured.
- Build gating: CMake option (off by default) + command-line flag, or command-line flag only?
Cmake option. It must be possible to compile out for builds that aim at competitive play and do not want to be cheated. What is the command line for?
- Disclosure:
[BOT]suffix in the player name (visible to retail clients and in replays) — OK, or another form?
Yes ideally bots are marked as such.
- One agent, several slots: is a skirmish/headless-only multi-seat mode (one process, orders stamped per seat) acceptable later, or should it always be one process per slot? See 05 §One agent, several player slots.
I don't know. What speaks for and what against the options?
- Plan location: keep
docs/plans/…in-tree, move to the wiki, or keep only in the external repo?
Plans are your own. You can link them in this topic.
- Where do orders enter? Inject into
Idea: a bot/agent API for Zero Hour, in the spirit of BWAPI
The short version
StarCraft: Brood War has had BWAPI since 2009 — a C++ framework that lets external programs observe game state and issue unit commands. It turned a 1998 game into the standard testbed for RTS AI research, and it is still generating activity in 2026: AIIDE and IEEE CoG competitions, the SSCAIT ladder, dozens of open-source bots, and a steady stream of academic papers. None of that was planned by the game's developers; it happened because somebody exposed a stable API.
Generals: Zero Hour is now in a better position than Brood War ever was — the actual source is here, it builds, it's GPLv3, and it's actively maintained. BWAPI had to do all of this by injecting into a closed binary and reverse-engineering memory offsets. We wouldn't have to.
I'd like to gauge whether there's appetite for a first-class agent API, and if so, agree on a shape before anyone writes code.
(Filing here rather than in Discussions > Ideas because it's as much an architecture question as a feature request — happy for a maintainer to move it if Ideas is the better home.)
Why this repo is unusually well suited to it
The hard part of a bot API is usually determinism and a headless mode. This project already has both, for its own reasons:
Core/GameEngine/Source/Common/ReplaySimulation.cpp—ReplaySimulation::simulateReplays()already runs replays without graphics, across worker processes, and returns non-zero on mismatch..github/workflows/reusable-check-replays.ymlalready runs that in CI against a corpus of replays.GameMessageParser,NetCommandMsg,NetCommandList).So the expensive infrastructure — a deterministic, graphics-free simulation you can run many of in parallel — exists. A bot API is substantially "expose what's already there", not "build a new engine mode".
Proposed shape
The design goal is that a bot is indistinguishable from a human player at the engine boundary. That's what protects everything this project cares about.
1. Commands go through the existing
GameMessagepath.Bot orders would be enqueued as the same
GameMessages that mouse and keyboard input produce, dispatched viaGameLogicDispatch. Consequences that matter here:2. Observation is a read-only view, fog-respecting by default.
A versioned, read-only snapshot of what the controlled player can legitimately see: objects, positions, health, states, resources, upgrades, supply, map/terrain, visibility. BWAPI's equivalent lesson is worth copying exactly — its
CompleteMapInformationflag is off by default, so bots see only what a player sees, and a tournament module can pin it. Same for aUserInputequivalent. Get the default right on day one and the "is this bot cheating" argument never has to happen.3. Out-of-process bridge, not just an in-process DLL.
BWAPI started in-process only and later added a shared-memory client bridge, because in-process has two chronic problems: a crashing or hanging bot takes the game with it, and everyone is locked to one language and ABI. Starting with a bridge means bots can be written in Python, Rust, Java or anything else, and a misbehaving bot is a dead pipe rather than a crash report filed against this repo. Notably, the one BW bot that currently uses a neural network (Pluto) runs its inference engine as a separate 64-bit process talking to a 32-bit DLL over stdio pipes — precisely because in-process wasn't an option.
4. A headless + uncapped-speed mode for training and tournaments.
Mostly a matter of reusing the
ReplaySimulationpath with a live agent driving instead of a recorded command stream.Suggested staging
Deliberately incremental, because per
CONTRIBUTING.mdthis shouldn't land as one enormous pull request:GameMessage, skirmish only, behind a build flag and an off-by-default command-line switchStage 1 alone is already independently useful: a stable read-only observation API over replays gives the project replay analytics, balance telemetry and regression tooling, whether or not anyone ever writes a bot.
Open questions for maintainers
CONTRIBUTING.md, with Generals to follow — is that right here, or is this one where sharing viaCore/from the start makes more sense?AIPlayer/AISkirmishPlayer, or should those stay entirely separate?Offer to help
I'm willing to do the implementation work, starting with the smallest useful slice (Stage 1) so there's something concrete to react to rather than a wall of text.
On tooling, to be straightforward about it up front since
AI_POLICY.mdasks: I use AI-assisted development in my workflow. I've read the policy and I'm not proposing to point an agent at the codebase and open pull requests — that's explicitly out of bounds and I agree with the reasoning. Anything I submit would be disclosed per section 2, scoped small enough to actually review, and I'd be accountable for explaining every line of it in review, in my own words. If the project would rather this area stay entirely hand-written, say so and I'll respect that.Happy to take this to Discord instead if that's a better venue for hashing out the design.