Documentation

Start

Shared framework reference

Framework versions

Framework Game logic Client Availability
2 TypeScript Authored React client Stable default for new games.
3 Rust Authored React client Opt-in preview available to everyone.
1 TypeScript Platform-rendered BWSS board Deprecated for new games; existing games remain editable and playable.

Match the game's contract

Read the game's framework pin before editing. Pass its gameDefinitionId to list_doc_sections and get_doc_section. Boardweaver serves the authoring version, including a pending upgrade when applicable.

A game commit records its framework version. A match keeps the commit it started with. A new framework release does not silently port existing code.

Upgrade deliberately

Use upgrade_framework to prepare a supported upgrade. Follow the target major's upgrade procedure, validate, preview, then commit. Framework v3 is available by opting in; new games still default to v2.

Shared articles describe contracts common to every major. Source layouts, game logic, client hooks, and runtime limits belong to each major's catalog.

Need a hand with this?

Join our Discord