Skip to content

Commit 240ee37

Browse files
committed
Add Kitty frame renderer and shared random pool
1 parent fe49f8e commit 240ee37

5 files changed

Lines changed: 527 additions & 40 deletions

File tree

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,13 @@ The user-facing command is `yzs`
88
nix run github:luccahuguet/yazelix-screen#yzs
99
nix run github:luccahuguet/yazelix-screen#yzs -- mandelbrot
1010
nix run github:luccahuguet/yazelix-screen#yzs -- game_of_life_bloom --cell-style dotted
11+
nix run github:luccahuguet/yazelix-screen#yzs -- magician --kitty-frame-dir /path/to/frames --kitty-frame-count 198
1112
```
1213

1314
## What It Contains
1415

1516
- Animation engines for Boids, Mandelbrot, and Game of Life
17+
- File-backed Kitty PNG frame sequence rendering
1618
- Frame production through `ScreenFrameProducer`
1719
- Terminal sizing helpers and alternate-screen rendering helpers
1820
- A standalone `yzs` binary
@@ -27,6 +29,7 @@ yzs --help
2729
yzs
2830
yzs mandelbrot
2931
yzs game_of_life_bloom --cell-style dotted
32+
yzs magician --kitty-frame-dir /path/to/frames --kitty-frame-count 198
3033
```
3134

3235
Yazelix users get the integrated screen surface through the main command:
@@ -44,6 +47,7 @@ From this repository:
4447
cargo run --bin yzs -- --help
4548
cargo run --bin yzs -- mandelbrot
4649
cargo run --bin yzs -- game_of_life_bloom --cell-style dotted
50+
cargo run --bin yzs -- magician --kitty-frame-dir /path/to/frames --kitty-frame-count 198
4751
```
4852

4953
With Nix:
@@ -60,13 +64,18 @@ Supported styles:
6064
- `boids_predator`
6165
- `boids_schools`
6266
- `mandelbrot`
67+
- `magician`
6368
- `game_of_life_gliders`
6469
- `game_of_life_oscillators`
6570
- `game_of_life_bloom`
6671
- `random`
6772

6873
No style means `random`
6974

75+
`magician` requires a directory of PNG frame assets. With `--kitty-frame-count N`, `yzs` expects `frame_0.png` through `frame_N-1.png`; without a count, it uses every PNG in the directory
76+
77+
`random` uses the same four-family pool as Yazelix and can resolve to `magician`, so pass the Kitty frame arguments when standalone random playback should support that branch
78+
7079
## Library Examples
7180

7281
Render one frame without alternate-screen mode:

0 commit comments

Comments
 (0)