@milenyumai/film-kit 2.3.6 → 2.3.7

package/README.md

@@ -126,6 +126,109 @@ When the active model is not Kling, generated runtime files intentionally render
 
 Use this mode when the source material is a character reference image plus a brief rather than explicit start/end frames. Film-Kit first prepares character-sheet prompts, then per-shot storyboard prompts. Optional storyboard images can be supplied as loose composition/timing guides.
 
+### Storyboard Mode Setup For Supported Tools
+
+Storyboard-reference mode is installed from the same canonical package for every tool:
+
+```bash
+npm install --save-dev @milenyumai/film-kit
+```
+
+You can also skip local install and use package-direct `npx` commands. Do not install or run old standalone preset package names.
+
+Create your input files first:
+
+```bash
+mkdir -p refs
+# Put the exact character identity image here:
+# refs/character.png
+#
+# Put the video brief here:
+# scenario.md
+```
+
+Install the storyboard runtime for all supported tools at once:
+
+```bash
+npx @milenyumai/film-kit init \
+  --preset single \
+  --model seedance-2.0 \
+  --reference-mode storyboard-reference \
+  --platforms codex,claude,cursor,copilot,antigravity \
+  --max-storyboard-phases 4
+```
+
+Supported tool-specific setup commands:
+
+| Tool | Setup command | Main files created |
+|---|---|---|
+| OpenAI Codex App | `npx @milenyumai/film-kit init --preset single --model seedance-2.0 --reference-mode storyboard-reference --platforms codex --max-storyboard-phases 4` | `AGENTS.md`, `.codex/config.toml`, `.codex/agents/*.toml`, `.agents/skills/storyboard-reference/SKILL.md` |
+| Claude Code | `npx @milenyumai/film-kit init --preset single --model seedance-2.0 --reference-mode storyboard-reference --platforms claude --max-storyboard-phases 4` | `CLAUDE.md`, `.claude/CLAUDE.md`, `.claude/rules/*`, `.claude/agents/prompt-engineer.md` |
+| Cursor | `npx @milenyumai/film-kit init --preset single --model seedance-2.0 --reference-mode storyboard-reference --platforms cursor --max-storyboard-phases 4` | `.cursorrules`, `.cursor/rules/global.mdc`, `.agent/workflows/generate-storyboard.md` |
+| GitHub Copilot | `npx @milenyumai/film-kit init --preset single --model seedance-2.0 --reference-mode storyboard-reference --platforms copilot --max-storyboard-phases 4` | `.github/copilot-instructions.md`, `.github/instructions/shotforge.instructions.md` |
+| Antigravity | `npx @milenyumai/film-kit init --preset single --model seedance-2.0 --reference-mode storyboard-reference --platforms antigravity --max-storyboard-phases 4` | `.agent/skills/shotforge-generate/SKILL.md`, `.agent/workflows/generate-storyboard.md`, `.agent/skills/storyboard-reference/SKILL.md` |
+
+For a studio-style project with refs and render-stage metadata, use `studio` instead:
+
+```bash
+npx @milenyumai/film-kit init \
+  --preset studio \
+  --model seedance-2.0 \
+  --reference-mode storyboard-reference \
+  --platforms codex,claude,cursor,copilot,antigravity \
+  --refs-dir ./refs \
+  --gpt-image-size 2048x1152 \
+  --gpt-image-quality medium \
+  --gpt-image-format png \
+  --max-storyboard-phases 4
+```
+
+After setup, open the Git project root in your tool. Use this as the first prompt in Codex, Claude Code, Cursor, Copilot Chat, or Antigravity:
+
+```text
+Read the Film-Kit storyboard-reference instructions in AGENTS.md and .agent/workflows/generate-storyboard.md.
+
+Use refs/character.png as the exact character identity reference.
+Use scenario.md as the video brief.
+Target model: seedance-2.0.
+Duration: 15 seconds.
+Aspect ratio: 16:9.
+
+Generate the storyboard-reference package only:
+- one GPT Image 2 character sheet prompt
+- one 12-panel raw-pencil GPT Image 2 storyboard prompt
+- one Seedance 2.0 video prompt that uses the generated storyboard as @Image2
+- outputs/storyboard-prompt.md
+- outputs/storyboard-prompts/SHOT01-GPT-IMAGE-2-STORYBOARD.md
+- outputs/prompt-bundles/SHOT01.bundle.json
+- outputs/shots/SHOT01.md
+- outputs/reports/STORYBOARD-REFERENCE-QA.md
+
+Do not create ILK FRAME, İLK FRAME, SON FRAME, SHOT_START, or SHOT_END sections.
+Do not render images or video yet; first produce and QA the prompt package.
+```
+
+If your tool supports slash-style workflow prompts, this shorter first prompt is also valid:
+
+```text
+/generate
+Storyboard-reference mode. Character reference: refs/character.png. Brief: scenario.md. Model: seedance-2.0. Duration: 15s. Aspect: 16:9. Generate the 12-panel raw-pencil storyboard prompt and Seedance video prompt package only. No ILK/SON frames. No rendering yet.
+```
+
+Terminal-only generation is available when you want the package files without opening an agent tool:
+
+```bash
+npx @milenyumai/film-kit generate-storyboard \
+  --character-ref ./refs/character.png \
+  --brief ./scenario.md \
+  --models seedance-2.0 \
+  --duration 15 \
+  --aspect 16:9 \
+  --output-dir ./outputs
+```
+
+After the command finishes, start with `outputs/storyboard-prompt.md`. It is the ready-to-use GPT Image 2 storyboard image prompt. Then use `outputs/shots/SHOT01.md` or `outputs/prompt-bundles/SHOT01.bundle.json` for the Seedance 2.0 prompt.
+
 Initialize a Seedance storyboard-reference runtime:
 
 ```bash

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@milenyumai/film-kit",
-  "version": "2.3.6",
+  "version": "2.3.7",
   "description": "Single-package Film-Kit distribution with preset-driven cinematic runtime setup for OpenAI Codex App, Claude Code, Cursor, Copilot, and Antigravity.",
   "type": "module",
   "main": "./build/index.js",