Have more questions? Join our

Build a v3 game (admin-only preview)

Framework v3 is an admin-only preview. Only Boardweaver admins can create or expose a v3 game. For a game players depend on, use framework v2 and its build-react-game-instructions.

A v3 game cannot be committed yet. Boardweaver does not build Rust yet, and it takes no module built elsewhere. Until its build service exists, every v3 game is the tic-tac-toe seed it was created from, and this workflow changes when the build service arrives.

Before you start

Call list_doc_sections with the game's id and confirm it reports framework 3. A v3 game's source is Rust: the TypeScript tools (validate_code, commit, start_game, render_game) refuse it.

What you can do now

  1. Read the example. Call get_example with tic-tac-toe-rust. A new v3 game starts from exactly this code, already built, so it is playable before you change anything.
  2. Write a game in Rust against boardweaver-sdk, in a crate of the SDK's workspace (packages/framework-core-v3/rust) with crate-type = ["cdylib", "rlib"], ending in export_game!(YourGame);. Read v3-overview first: intents are the most important rule.
  3. Test it on your machine. Every game's tests run checks::walk_intents::<YourGame>(&players, seed, steps) over several seeds. It fails, naming the action, when a choice returns its decision to a state it already had, when an open decision offers no choice or confirm, or when a result depends on HashMap order.
  4. Play the seed. Start a match on the v3 game's beta channel. It plays tic-tac-toe, the game every v3 game is until it can be committed.