storyink 0.2.0 → 0.2.1

package/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+## 0.2.1
+
+- **Fix:** `storyink_snapshot` no longer inlines the full-resolution contact sheet. Tall beat
+  sheets (1440 px wide, thousands of px tall) could stall the next model request and bloat
+  session context. It now returns **one compact JPEG preview**, with its longest side at most
+  1024 px and a 300 KB budget. Beat sheets are reflowed into 3–8 columns so they fit in one
+  image.
+  - New tool options: `image: "overview" | "full" | "none"` (default `overview`; `full` returns
+    at most 3 parts) and `maxImageSize` (default 1024).
+  - Full-resolution PNGs stay on disk and are listed in the text result.
+- CLI: `storyink snapshot … --preview out.jpg [--preview-size 1024]` writes the same preview.
+- Snapshot receipts include `previews` (path, size, bytes, what the image shows).
+- The beat-sheet page accepts `#cols=N`, `#range=a-b` and `#zoom=z`.
+- SKILL.md: guidance on keeping image reads few and on using `at` frames for detail.
+
+## 0.2.0
+
+- Storyboard mode: `story` steps and `"story": "auto"`, the pure `storyState(t)`, the viewer
+  transport and counters. Snapshot gets `--at`, `--sheet beats` and the static gates.
+- Fixes: captions belong to their own step, humanised beat titles, warm light-theme glow,
+  beat sheets sized to their content.
+
+## 0.1.0
+
+- First release: spec, validation, Mermaid import, layout, SSR/viewer, CLI, OpenCode plugin.

package/README.md

@@ -38,6 +38,7 @@ storyink render <in.json|in.mmd|-> [-o out.html] [--svg out.svg] [--theme light|
 storyink mermaid <in.mmd> [-o out.json]
 storyink validate <in> [--json]
 storyink snapshot <out.html> [--theme light,dark] [--width N] [--sheet [themes|beats]|--no-sheet] [--at 0.5,1.2,end] [--scale 2] [-o dir] [--json]
+                  [--preview out.jpg [--preview-size 1024]]
 storyink skill
 ```
 
@@ -74,8 +75,14 @@ read `package.json` `main`, which is why the repo ships a root `server.js` that
 Rebuild after changes, then restart the server (or touch the config) to reload.
 
 This adds the tools `storyink_render`, `storyink_from_mermaid`, `storyink_validate` and
-`storyink_snapshot`. `storyink_snapshot` returns the contact sheet as an image, so the model can
-see its own render. The plugin also adds the `storyink` skill (`skill/SKILL.md`), which covers
+`storyink_snapshot`. `storyink_snapshot` returns **one compact preview image** so the model can see its
+own render: a JPEG no larger than `maxImageSize` (1024 px by default) on its longest side, and
+usually well under 300 KB.
+- Beat sheets are reflowed into more columns so they fit in that single image.
+- Set `image: "full"` to get the normal sheet layout instead, split into at most 3 parts, or
+  `image: "none"` to get paths only.
+- Full-resolution PNGs are never inlined; they stay on disk and their paths are listed. The CLI
+  equivalent is `--preview out.jpg`. The plugin also adds the `storyink` skill (`skill/SKILL.md`), which covers
 choosing a diagram type, writing the spec, and the render → look → fix loop. If you already have
 a skill with the id `storyink`, yours is kept. Relative paths resolve against the project
 directory.