Source and version policy
Current release
| Item | Value |
|---|---|
| Public contract | v0.1 |
| Server repository | arena-hero/arena-hero |
| Reviewed server commit | d66476a26f4713c5fe91cd40ae8a21098a576638 |
| Python SDK | arena-hero/arena-hero-python, v0.1.0 |
| Reviewed SDK commit | b784c8122f8cfc2435fc58a28ddc40a7db615970 |
| Server review date | 27 July 2026 |
| SDK review date | 28 July 2026 |
| Documentation repository | arena-hero/arena-hero-doc |
| Languages | English, Simplified Chinese |
If the docs and server disagree
These pages describe the public rules and game API, but what actually happens at runtime is decided by the server code, the database constraints, and the tests.
So when published prose and released implementation part ways:
- do not treat the discrepancy as an implied rule and exploit it;
- write down the exact server version and what you observed;
- open an issue in the documentation or server repository;
- update both repositories once the intended behavior has been decided.
Changes that affect compatibility
Touch any of these and you may break an existing client, so each one needs an explicit contract-version decision:
- the 15-second global command window, and
stateas the action trigger; - deterministic resolution phases and atomic commit;
- complete source-plan replacement and Manual precedence;
- action field rules and idempotency;
- WebSocket message types and the reconnect snapshot;
- the fog-of-war privacy boundary;
- the map generator contract;
- core balance rules that determine replayed outcomes.
Everything else — copy, layout, diagrams, examples, the order things are explained in — can improve freely, because none of it changes the game contract.
Why there is no version picker yet
The public API is still v0.1, so this site publishes exactly one current version, in English and Simplified Chinese. Once there is a first stable compatibility release, older contracts can be kept around as Docusaurus versions.
What a protocol change must update
Any gameplay or game API change has to bring all of this with it:
- implementation and tests in the server repository;
- matching models, behavior, and tests in the official Python SDK;
- updated English and Simplified Chinese pages here;
- an updated OpenAPI or AsyncAPI schema, where one applies;
- verified bilingual production builds;
- a clear compatibility note whenever existing clients may break.