winzik/skeleton/AGENTS.md
David Nurdin 8ceaad03c7 Apps in apps/ beside games/, config/project.yaml beside config/game.yaml (both read)
Apps, CLI apps, graphic apps and IDE plugins are made in apps/<id>; bin/jumphp, the tools, the
workflows, the IDE and the docs find a project in games/ or apps/. New projects get
config/project.yaml (under project:); the engine, bin/jumphp, the tools and the IDE still read
config/game.yaml (under game:). JUMPHP_APP is read before JUMPHP_GAME.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Claude-Session: https://claude.ai/code/session_01X3cUrphmz1MoDiCrUbAHuo
2026-11-03 23:30:23 +01:00

24 lines
1.2 KiB
Markdown

# {{GAME_ID}} — notes for agents
This game is built with JumPHP. **Read `../../AGENTS.md` first** (rules, commands, API).
## Checklist
```bash
bin/jumphp test {{GAME_ID}} # lint + phpstan + headless smoke test (must pass)
bin/jumphp shot {{GAME_ID}} 60 # title screen -> games/{{GAME_ID}}/var/screenshots/shot.png
JUMPHP_INPUT='[[5,"confirm"]]' bin/jumphp shot {{GAME_ID}} 240 var/screenshots/play.png
bin/jumphp build {{GAME_ID}} && bin/jumphp webshot {{GAME_ID}} 6 '[[1,"Enter"]]' # browser (needs bin/jumphp engine:build)
```
## This game
Started from the JumPHP skeleton (a small platformer). Update this section as the game grows:
- **What it is**: ...
- **Scenes**: `TitleScene` (menu) → `PlayScene` (level) ; overlays `PauseScene` ; `OptionsScene` (pushed).
- **Entities**: `Player` (Sprite + Gravity + TileCollision), `Coin`.
- **Controls** (`config/input.yaml`): arrows / WASD move, Space jumps, Escape pauses.
- **Smoke test** (`config/project.yaml` smoke): `PlayScene` with `demo: true` (a bot runs and jumps).
- **Non-obvious**: the tileset is drawn with GD in `PlayScene::makeTileset()`; replace it with a PNG
(`assets/tiles/`) or a Tiled map (`TiledJsonLoader`).