Skip to content

Commit 4547be6

Browse files
committed
docs: add portfolio context recovery note
1 parent 4def9cb commit 4547be6

1 file changed

Lines changed: 43 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
<!-- portfolio-context:start -->
2+
# Portfolio Context
3+
4+
## What This Project Is
5+
6+
Desktop Terrarium is a native Bevy desktop app that grows a layered 2D terrarium based on real keyboard activity and time. Plants advance through growth stages, weather cycles through particle-rich states, critters appear after focus streaks, and state persists locally.
7+
8+
## Current State
9+
10+
The repo is active local desktop/game work. Existing untracked folders are generated local artifacts, so this recovery pass should only add the new context file.
11+
12+
## Stack
13+
14+
| Layer | Technology |
15+
|-------|------------|
16+
| Language | Rust 2021 |
17+
| Engine | Bevy 0.15 |
18+
| Serialization | serde + serde_json |
19+
| Persistence | JSON via `dirs` (platform data dir) |
20+
| Idle detection | macOS CoreGraphics — CGEventSourceSecondsSinceLastEventType |
21+
22+
## How To Run
23+
24+
```bash
25+
# Run
26+
cargo run
27+
28+
# Release build
29+
cargo build --release
30+
```
31+
32+
## Known Risks
33+
34+
- Idle detection depends on macOS CoreGraphics, so cross-platform claims need explicit verification.
35+
- Terrarium state persists to the platform data directory; avoid destructive state resets without operator approval.
36+
- Generated `.artifacts` and `.perf-results` folders are local outputs and should not be swept into source commits.
37+
- Keep Bevy performance and 800x600/resizable window behavior intact when changing rendering.
38+
39+
## Next Recommended Move
40+
41+
Add only the context file for this recovery pass, then keep future work focused on activity-driven growth, local persistence, and Bevy rendering stability.
42+
43+
<!-- portfolio-context:end -->

0 commit comments

Comments
 (0)