Documentation

Rules and presentation

Shared framework reference

Write rules pages

A rulebook explains the game to players. It does not implement game logic.

1. Outline the rulebook

Start with /src/rules/index.bwss. Decide where players will find the goal, setup, a turn, and the ending. Give each additional page one job.

Done when the index has a planned link to every supporting page.

2. Write and illustrate the pages

Write one JSON root node per file. Use the Rules page format and BWSS styles. Upload images before referring to their keys. Use the game theme for consistent appearance.

Done when each page contains the instructions and illustrations needed for its task.

3. Check the reading path

Run validate_code. Preview the rulebook in Studio at wide and phone sizes. Follow every page and fragment link manually; compilation does not prove its destination exists.

Done when validation passes and every link reaches readable content.

The Rules preview lets a designer read and navigate the game's rulebook.
The Rules preview lets a designer read and navigate the game's rulebook. Example data from the local development UI. Select the image to enlarge.

4. Commit

Call commit after checking the pages against the game behavior.

Done when the committed version contains the checked rulebook.

Need a hand with this?

Join our Discord