Verification Guide
This page helps contributors choose the right check before calling a change done.
Fast Checks
Section titled “Fast Checks”| 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. |
Content And Modding Checks
Section titled “Content And Modding Checks”| 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. |
Runtime Smoke Checks
Section titled “Runtime Smoke Checks”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:
cargo runWhat 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
Release-Pack Checks
Section titled “Release-Pack Checks”If a runtime asset path changed, verify the packed path:
cargo run --bin asset_pack -- --dry-run --listFor release packaging work:
cargo run --bin asset_pack -- --out data.pak --inventory-out asset_inventory.md --verifyThe release scripts are the final packaging path:
pwsh -NoLogo -File scripts/dist.ps1or:
bash scripts/dist.shWiki Checks
Section titled “Wiki Checks”For Starlight pages:
npm run buildnpm run devThen 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
When A Check Fails
Section titled “When A Check Fails”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.