Work with game files

You edit a game's worktree: the last commit plus your pending changes. A pending change reaches players only after commit. These steps apply to every framework major.

1. Inspect the worktree

Call list_doc_sections with the game's gameDefinitionId: its frameworkVersion is the version the game is written for. Call list_files, and read each file you will change with read_file. Read the source files section of the game's major for its layout.

2. Make the edit

Use write_file to write a whole file and patch_file to replace part of one. Upload images, sounds and the cover and logo with their own tools. For a local file too large to pass inline, follow Upload local files. Edit the source files. Boardweaver writes the build outputs and generated files at each commit.

3. Check and commit

Run validate_code until it reports no errors. Start a session with start_game and play the changed behavior, viewing each seat it affects. A session keeps the code it started with, so start a new session after each edit. Then call commit.