# AGENTS.md

A refreshingly simple data-driven game engine built in Rust

## Setup

```
# TODO: the install command. No lockfile was found, so this could not be inferred.
```

## Commands

```
cargo test   # run the test suite
```

## Layout

- `crates/`   1272 source files
- `examples/` 455 source files
- `benches/`  99 source files
- `tools/`    34 source files
- `tests/`    10 source files
- `errors/`   1 source file

## Conventions

- Tests live alongside the code they cover, following `.github/start-mobile-example/specs/screenshot.js`.
- CI defines what passing means. See `.github/workflows/action-on-PR-labeled.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `crates/bevy_pbr/src/render/mesh.rs` is 194KB. It will not fit comfortably in context, so read it in parts.
- No lockfile is committed, so an install here may not match what CI produced.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.