imjasonh/nescript
1
0
Fork 0
mirror of https://github.com/imjasonh/nescript synced 2026-07-08 00:45:38 +00:00
Code Activity

docs: add docs/pong.gif demo to README

Browse source 
Record a 6-second gif of examples/pong.nes running in jsnes and
embed it alongside docs/platformer.gif and docs/war.gif as the
third project demo. The gif opens on Pong's title menu (CPU VS
CPU / 1 PLAYER / 2 PLAYERS) — warmup = 4 frames keeps the menu
as the thumbnail the way war's recording does, and then the
headless autopilot advances to gameplay partway through the
clip.

- docs/pong.gif committed (128 KB)
- README.md links it under the war demo
- scripts/pre-commit rebuilds it when examples/pong* or the
  recorder/harness change
- .github/workflows/ci.yml fails if the committed copy is stale
- CLAUDE.md and tests/emulator/record_gif.mjs reference the new
  gif in the "how to regenerate" sections

https://claude.ai/code/session_0134F5uwDEVTes2Ee9S7JeXy
This commit is contained in:
Claude 2026-04-16 10:44:57 +00:00
parent 21b91f6398
commit 6d9ebc7d7b
No known key found for this signature in database
6 changed files with 48 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

35
CLAUDE.md
View file

@ -22,28 +22,31 @@ re-derive the project conventions from scratch.
tmp path and fails if the committed version differs, pointing at
the exact `cargo run -- build examples/<name>.ne` to run. The
pre-commit hook under `scripts/pre-commit` catches this locally.
- **`docs/platformer.gif` and `docs/war.gif` are committed** and
embedded in the top-level README as the project demos. `gifenc` +
`jsnes` are deterministic, so each gif's bytes are a function of
the compiler, the runtime, the harness, and the underlying `.ne`
source(s). Any change to those that affects the first ~6 seconds
of observable gameplay must be followed by regenerating the
affected gif:
- **`docs/platformer.gif`, `docs/war.gif`, and `docs/pong.gif` are
committed** and embedded in the top-level README as the project
demos. `gifenc` + `jsnes` are deterministic, so each gif's bytes
are a function of the compiler, the runtime, the harness, and
the underlying `.ne` source(s). Any change to those that affects
the first ~6 seconds of observable gameplay must be followed by
regenerating the affected gif:
```bash
node tests/emulator/record_gif.mjs platformer 360 2 docs/platformer.gif
node tests/emulator/record_gif.mjs war 360 2 docs/war.gif 4
node tests/emulator/record_gif.mjs pong 360 2 docs/pong.gif 4
```
(The trailing `4` on the war command is the warmup-frames
override — war's title menu is the gif thumbnail, so we don't
skip past it the way the platformer recording does.) Commit the
regenerated gif in the same change. CI's `emulator` job renders
fresh gifs and fails if either committed copy doesn't byte-match.
The pre-commit hook rebuilds whichever gif is affected when
`platformer.ne`, `platformer.nes`, any file under `examples/war/`,
`war.ne`, `war.nes`, `record_gif.mjs`, or `harness.html` is
staged (and `tests/emulator/node_modules` is installed).
(The trailing `4` on the war and pong commands is the
warmup-frames override — both open on a title menu that we want
as the gif thumbnail, so we don't skip past it the way the
platformer recording does.) Commit the regenerated gif in the
same change. CI's `emulator` job renders fresh gifs and fails if
any committed copy doesn't byte-match. The pre-commit hook
rebuilds whichever gif is affected when `platformer.ne`,
`platformer.nes`, any file under `examples/war/`, `war.ne`,
`war.nes`, any file under `examples/pong/`, `pong.ne`,
`pong.nes`, `record_gif.mjs`, or `harness.html` is staged (and
`tests/emulator/node_modules` is installed).
- `docs/future-work.md` lists the remaining gaps. If you implement
something from that file, update the doc in the same PR.