Skip to main content

Crate botstadia_interface

Crate botstadia_interface 

Source
Expand description

BotStadia’s shared contracts.

  • declaration: what an arena says about itself, and its checks
  • payload: the per-turn input and output encoding, and the host’s validity rule for an output
  • bundle: a bot’s bundle and its manifest, botstadia.toml
  • policy: the policy shell’s ONNX contract
  • archive: the replay archive the player reads
  • metrics: the metrics file the site reads
  • copy: an arena’s arena.toml, its site copy
  • player: the messages between the site and an arena’s player

The WIT worlds ship in wit/: botstadia:arena for arenas’ engines and botstadia:agent for bots. Features generate bindings for them: arena-guest, agent-guest and host.

Modules§

archive
The replay archive: one session’s frames, for the player.
bundle
A bot’s bundle: what a builder uploads.
copy
An arena’s arena.toml: its registry row and everything the site says about it that isn’t in the declaration.
declaration
What an arena says about itself.
metrics
The metrics file: everything the site draws about a session, beside its replay archive.
payload
The payload: one binary message per turn, each way.
player
Messages between the site and an arena’s player.
policy
The policy shell’s ONNX contract, version 1: how a trained policy’s model must look so one generic program runs it in every arena.

Constants§

AGENT_WIT
The agent world’s WIT, for tools that generate a bot’s bindings (the CLI writes C bindings from it).
ARENA_WIT
The arena world’s WIT.
VERSION
This crate’s version: what generated bot projects depend on.