# {{project-name | title_case}}

A Bevy {{project-name}} project generated from a cargo-generate template.

## Layout

    src/lib.rs        game logic (testable library crate)
    src/main.rs       thin binary shim
    src/player.rs     example gameplay module (function-plugin)
    assets/           runtime assets (LFS-tracked, lockable)
    tests/            integration tests against the library crate
    book/             mdbook documentation (builds to build/book)
    build/            all build output (gitignored)

## Setting up

Run `./setup.sh` to check that the toolchain (Rust, pre-commit, Git LFS, ...) is
installed -- it prints install hints for your platform, then enables Git LFS and
installs the pre-commit hooks. Use `./setup.sh --check` to verify only, making no
changes. The manual equivalent of the wiring step is:

    git lfs install
    pre-commit install --install-hooks -t pre-commit -t commit-msg -t pre-push

## Develop

- `cargo run`                 launch the game (dev feature = fast iteration)
- `cargo test --all-features` run unit + integration tests
- `cargo fmt` / `cargo clippy` format and lint
- `mdbook build book`         build docs into build/book

Cargo output is redirected to `build/` via `.cargo/config.toml`.

## Committing

`git agent-commit -m "type(scope): subject"` with a scope from `SCOPES.md`. All
pre-commit hooks must pass (no `--no-verify`): ruff, mypy and codespell (Python
and prose), cargo fmt and clippy (Rust), a Conventional Commits check on the
message, and cargo test on push.