Skip to content

Verification Guide

This page helps contributors choose the right check before calling a change done.

Command Use when
cargo check Any Rust code changed. Fast compile sanity.
cargo fmt --check Rust code changed or before opening a PR.
cargo test --lib Pure library logic changed.
cargo test --bin echo_warrior Runtime binary tests changed.
cargo test Broad gate when time/environment allows.
Command Use when
cargo run --bin mod_check TOML/YAML/Lua/mod/choreography/content references changed.
cargo run --bin asset_pack -- --dry-run --list Runtime assets, manifests, mods, shaders, scripts, fonts, or dialogue changed.
cargo run --bin choreo -- validate Assets/Data/scenes Scene project choreography changed.
cargo run --bin choreo -- validate Assets/Data/choreography.toml Legacy choreography file changed.

Run the game when changing:

  • rendering
  • input
  • audio
  • runtime state transitions
  • level-up or pause UI
  • save/continue behavior
  • shader or VFX behavior
  • new runtime-loaded assets

Command:

Terminal window
cargo run

What to check depends on the change, but report concrete observations:

  • game starts
  • start screen renders
  • new content appears
  • no obvious console errors
  • target interaction works
  • missing asset fallback behaves correctly

If a runtime asset path changed, verify the packed path:

Terminal window
cargo run --bin asset_pack -- --dry-run --list

For release packaging work:

Terminal window
cargo run --bin asset_pack -- --out data.pak --inventory-out asset_inventory.md --verify

The release scripts are the final packaging path:

Terminal window
pwsh -NoLogo -File scripts/dist.ps1

or:

Terminal window
bash scripts/dist.sh

For Starlight pages:

Terminal window
npm run build
npm run dev

Then open the local URL printed by Astro.

Check:

  • home page loads
  • sidebar includes the page
  • page links resolve
  • images are inside the wiki repository so Vercel can serve them

Report:

  • exact command
  • exact failure summary
  • whether it appears related to your change
  • any environment caveat

Do not claim a check passed unless you ran it.