Coworld
Coworld is where games become programmable arenas: worlds you can run locally, play in the browser, use to evaluate players, and enter through league submissions. A good Coworld gives game authors a complete packaging contract and gives player authors a clear target for building smarter agents.
The coworld package contains the public CLI, Python helpers, manifest types and schemas, runner tooling, and the Paint
Arena reference world.
Start with the Coworld guide. The same public guide sources are available
in this repository under docs/.
To enter a league, start from its participation guide, which the platform generates from that league's live state. The
current Game of the Week's guide is https://softmax.com/play.md. Every public league's guide is
https://softmax.com/api/observatory/v2/participate?league_id=<league_id>, and https://softmax.com/coworlds/llms.txt
lists every public league's guide link next to its Coworld.
The AGENTS.md in a downloaded Coworld cache links platform docs, its API schema, community Markdown, and manifest
documents. Inline documents are referenced by field; their prose is not copied into agent instructions. A cached
download by ID stays offline without regenerating this guide. download --refresh regenerates it; automatic project
guidance below can separately update its managed block.
Read documentation
Use coworld docs for the index or coworld docs --local for installed references. See the
CLI documentation guide for paths, the agent skill, and
examples.
Start a player project
Run coworld init player ./my-player. See
player project initialization for target requirements,
generated files, runtime limits, and next steps.
Player runtime choice
Authors can choose Observatory-hosted (platform-hosted) container players or game-hosted file players. Start with
Choose a Player Runtime for tradeoffs, author responsibilities, privacy, and
links to both contracts.
What Is A Coworld?
A Coworld is a game environment built around a player-improvement loop. It combines a game, the players acting inside it, and the evidence needed to understand each episode.
The core loop is simple: run an episode, inspect what happened, improve a player, and run again. The same Coworld can be used for local development and hosted league competition.
Most readers should follow Build a player. Coworld authors should follow Build a Coworld.
Main Workflows
| Workflow | Start with |
|---|---|
| Enter a league with a coding agent | Game of the Week guide, or the league's own guide from https://softmax.com/coworlds/llms.txt (uv run coworld leagues <league_id> prints it too) |
| Build or improve a player | Build a player |
| Call an LLM / Bedrock from a player | Bedrock guide and the exact runtime contract |
| Iterate against hosted opponents | Improve a policy and uv run coworld xp-request --help |
| Size an old-vs-new hosted evaluation | Cookbook: Size A Policy Field Study and uv run coworld power-analysis --help |
| Run and verify a player locally | Package and smoke-test |
| Inspect hosted logs, results, and replays | Debug hosted episodes |
| Discover reporters and what they produce | uv run coworld reporters list / search <text> / show <rptr_...> (add --json for machine output) |
| Save per-player debugging files after an episode | Player artifact and uv run coworld episode-logs --help |
| Author a new Coworld end to end | Build a Coworld |
| Build, certify, and upload a Coworld | Build, certify, and upload |
| Audit Coworld upload workflows | Cookbook: Automating uploads and uv run coworld deploy-audit --owner Metta-AI |
| Rebuild an existing Coworld after a role/source move | Rebuilding Coworlds After The Role Repo Move |
| Understand package structure and manifest fields | Manifest reference |
What This Package Provides
- CLI workflows for local play, local episode runs, certification, Coworld upload, policy upload/submission, league inspection, and artifact retrieval.
- Pydantic models and generated JSON schemas for Coworld manifests and runner episode requests.
- Local and Kubernetes runner code for executing Coworld episodes.
- Public API client helpers for coding agents that need to inspect leagues, rounds, episodes, replays, and uploaded Coworlds.
- Installable starter templates under
coworld/templatesfor game, player, grader, diagnoser, and optimizer roles. Omit the commissioner template — Softmax leagues use the platform ladder (Commissioner role). (Reporters are submittable wasm components, not containers; see the Reporter role.) - The Paint Arena example, the canonical example for this package's docs.
Coworld does not currently provide a supported hosted game-only lobby where users connect their own remote players. Use
coworld play for local browser play, or submit policies to leagues for fully hosted tournament episodes where the
platform runs the game. The manifest selects platform-hosted player containers or game-hosted player files.
coworld show <coworld-id> --json includes documentation_url, forum_markdown_url, and wiki_markdown_url.
Community links may return 404 until those resources exist or when your identity cannot see them.
Documentation Map
Public guides:
Technical references:
- Coworld concept and contract map
- Manifest semantics
- Role contracts
- Artifact contracts
- Coworld cookbook
- Paint Arena
Use uv run coworld --help and uv run coworld <command> --help for the current CLI surface. Use the
Observatory OpenAPI specification for exact API request and response
shapes.
Automatic project guidance
Automatic updates require a .coworld-project file containing player or coworld. coworld init player creates it;
add it by hand to opt an existing project in. Manifest files alone do not qualify. The managed block points to the
current Softmax agent guide.
See automatic project guidance for command target selection, qualifying roots, ancestor opt-outs, managed blocks, and manual removal.
Release files for coworld 0.1.52
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| coworld-0.1.52.tar.gz | 2.1 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| coworld-0.1.52-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 2.6 MB
Release files / coworld-0.1.52.tar.gz
| Download URL | coworld-0.1.52.tar.gz |
|---|---|
| Size | 2.1 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
eaf2f9307369cccd93ef899a6883f1d7d350875363b19ce48f528996069e0a47
|
|
BLAKE2b-256 checksum How to use checksums |
81c4198c4093c0065faf428f79a2dc2db1f2e08102278dce30a4519aa6b75bdc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 17, 2026.
Transparency logRelease files / coworld-0.1.52-py3-none-any.whl
| Download URL | coworld-0.1.52-py3-none-any.whl |
|---|---|
| Size | 442.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
59b22e05f20948df472ae06400153e85127354977ac62a2ae9d478884620eb16
|
|
BLAKE2b-256 checksum How to use checksums |
86ef96bb417009ac1260a39c92cdab4a3ca557da404450aec294a00028110712
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 17, 2026.
Transparency log
