init repo
This commit is contained in:
86
README.md
Normal file
86
README.md
Normal file
@@ -0,0 +1,86 @@
|
||||
# Bevy + Local AI Template
|
||||
|
||||
Rust `1.95.0` target. Bevy `0.18.1`.
|
||||
|
||||
Recommended deep guide: [`CLAUDE.md`](./CLAUDE.md)
|
||||
|
||||
## Quickstart
|
||||
|
||||
Recommended setup (Nix):
|
||||
|
||||
```bash
|
||||
nix develop
|
||||
cargo run
|
||||
```
|
||||
|
||||
Host-native setup check:
|
||||
|
||||
```bash
|
||||
bash ./scripts/check-requirements.sh --mode native
|
||||
```
|
||||
|
||||
Nix setup check:
|
||||
|
||||
```bash
|
||||
bash ./scripts/check-requirements.sh --mode nix-host
|
||||
nix develop -c bash ./scripts/check-requirements.sh --mode nix-shell
|
||||
```
|
||||
|
||||
On macOS, if needed:
|
||||
|
||||
```bash
|
||||
xcode-select --install
|
||||
```
|
||||
|
||||
## Daily Loop
|
||||
|
||||
```bash
|
||||
# run game
|
||||
cargo run
|
||||
|
||||
# auto-rebuild + rerun
|
||||
cargo watch -x run
|
||||
|
||||
# required verification order
|
||||
cargo fmt --all
|
||||
cargo check
|
||||
cargo clippy --workspace --all-targets --all-features -- -D warnings
|
||||
|
||||
# tests
|
||||
cargo test
|
||||
|
||||
# refresh generated AI context
|
||||
just context
|
||||
```
|
||||
|
||||
## AI Context and Local Llama
|
||||
|
||||
`ai/context/project-context.md` is generated, not hand-authored.
|
||||
|
||||
Refresh it with:
|
||||
|
||||
```bash
|
||||
just context
|
||||
# or
|
||||
./ai/scripts/build-context.sh
|
||||
```
|
||||
|
||||
Local llama usage:
|
||||
|
||||
```bash
|
||||
export LLAMA_MODEL=/absolute/path/to/model.gguf
|
||||
just ai-chat
|
||||
just ai-plan "add player movement with WASD"
|
||||
just ai-fix "camera jitters when player moves"
|
||||
just ai-review "review ECS layout and plugin split"
|
||||
```
|
||||
|
||||
## VS Code Tasks
|
||||
|
||||
This repo includes `.vscode/tasks.json` for quick iteration:
|
||||
|
||||
- requirements checks (native and nix)
|
||||
- build check (native and nix)
|
||||
- lint (`fmt -> check -> clippy`, native and nix)
|
||||
- run/watch (native and nix)
|
||||
- release run (`--no-default-features`, native and nix)
|
||||
Reference in New Issue
Block a user