Documentation

Rules and presentation

Shared framework reference

Game page format

Item Contract
Entry /src/marketing/index.bwss.
Additional page /src/marketing/<slug>.bwss.
Shared nodes Box, Image, Svg, Anchor.
Action nodes PlayButton, RulesButton, ThemeToggle.
Text String children inside containers.

Action destinations

Boardweaver constructs the Play and Rules destinations. Supply their labels and styles, not an href. Play follows the channel of the served version. Rules opens the game's rulebook.

{
  "type": "Box",
  "children": [
    { "type": "PlayButton", "children": ["Play now"] },
    { "type": "RulesButton", "children": ["Read the rules"] }
  ]
}

ThemeToggle changes the page's light or dark appearance. Provide both theme variants before adding it. It is a marketing-page node, not a rules-page node.

Anchors link within the marketing pages or to fragments. Use named gameplay image keys inside page content. Cover and logo slots are separate listing assets.

Translated pages use /src/marketing/<locale>/<slug>.bwss and require the corresponding default page. Missing page translations fall back to the default. Follow the game's framework for locale availability.

Use BWSS styles. Validate the page before committing and check link destinations manually.

Need a hand with this?

Join our Discord