mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-03 12:54:29 +00:00
WaterrrForever
b9be0b2625
* feat(studio,cli): per-frame board comments, self-refreshing storyboard, status-aware preview landing Per-frame comment boxes on the storyboard board batch into .hyperframes/frame-comments.json (a resubmit wins per frame; unconsumed comments on other frames are kept). Submitted-but-unconsumed comments stay visible — a toolbar banner plus a per-tile echo — until the agent consumes the file; the banner also says what to do next (reply anything in the agent chat). The board keeps itself current: GET /projects/:id/signature exposes the watcher-cached project signature, the storyboard payload carries the signature it was derived from, and the view polls at 2s (hidden tabs skipped, re-checked on visibility), refetching in place with no loading flash. Posters bake the signature into their URL so tiles fill in as sketches land and a poster that failed mid-write retries on the next version; the empty state upgrades itself when STORYBOARD.md appears, and its handoff prompt now points the agent at the review loop and uses the parser's real status vocabulary (outline, not planned). preview lands the browser on the storyboard view while the board is the review surface — any frame built, or pure planning (srcs declared, none on disk yet) — and on the timeline once the video is assembled. * feat(skills): the review loop — plan, sketch, build as one shared process hyperframes-core/references/review-loop.md is the single source for the three-pass collaborative review: the plan proposed on a live board (§ 1), wireframe sketches marked built with one layout question (§ 2 — real words on plain blocks, run no CLI; a confirmed board is itself a valid deliverable when the user asked for a storyboard, not a video), the build dressing confirmed layouts (§ 3, worker or inline), and the final look (§ 4). Autonomous runs skip every gate and keep one question before render. The three narrative workflows' Steps 3/4/6 collapse to references plus their sketch stand-ins (captured-asset blocks for product-launch-video, plain code panels for pr-to-video); the confirmed-sketch handoff stays in each frame-worker prompt. general-video plans on a board for multi-scene narrative pieces in collaborative mode — its sketch pass is layout-before-animation with the user watching. The router treats "I want a storyboard" as a process request rather than a route, and closes exploratory intake by recommending a route plus how the run will review. The supporting contracts land next door: the comments channel (silent submit, one reply picks it up, check the file before the words) in brief-contract § 1; the sidecar schema and the built status rung in storyboard-format; the mode question asked first and alone in the three workflows' Step 0. * feat(media-use): user memory — remembered preferences and frozen recipes Two tiers of memory on media-use's existing two-tier storage split. Preferences (lightweight): confirmed brief answers — destination, aspect, language, mode, voice, style preset — recorded to the project's .media/preferences.json (committed, the team inherits it) and promoted to the personal ~/.media/preferences.json once the same value is confirmed in two different projects (a sightings ledger accumulates the cross-project evidence user-side, since project files can't see each other). prefs.mjs get/record; merge reads project-over-user; a changed value restarts its provenance. Recipes (heavyweight): one approved run frozen as a named, versioned bundle — frame.md, the storyboard skeleton (structure kept: durations, transitions, srcs, Video direction; statuses reset to outline; content blanked to per-frame fill-ins naming the beat's role), and the confirmed brief values. Named folders, not content hashes: re-freezing bumps version and archives <name>@v<N>; a freeze is already confirmed, so it promotes to the user tier immediately. recipe.mjs freeze/list/use, plus resolve --type recipe --entity <name> delegating like grade/lut. 16 new node --test cases; the media-use lib suite is 168/168. * feat(skills): wire user memory into the brief and the review loop brief-contract § 2 gains Remembered defaults: read the merged preferences before Round 2 and let a remembered value become the recommended option with a receipt naming its source project. Memory changes the default, never the question — every ask-marked field still gets asked, and what the request says this time beats what was picked last time. Record only what the user actually confirmed (a defaulted voice nobody chose is not an answer; a "go" that accepts the recommended defaults is). The first record announces itself once; after that the receipts carry the reminder. In autonomous mode a remembered value becomes the decided value, receipt included. The three narrative workflows read the remembered defaults before Round 2, record the confirmed answers at the Step 0 gate, record the chosen preset at the Step 2 gate (pr-to-video excepted — its preset is fixed), and fall back to the remembered voice when the request names none. general-video's discovery reads the same defaults. Recipes wire in at both ends: Step 0 checks for a matching recipe before the mode question — one question, plural-aware, and adopting one fills the brief, skips the design step, and drafts the storyboard from the frozen skeleton while every review gate still runs. The review loop's final look (§ 4) offers the freeze once after approval, and the confirmation teaches the recall phrase — the name is something the system reminds the user of, never something they must remember. The router recognizes a named recipe or "like last time" as a route. * docs(skills): the sketch pass names check, not the deprecated validate * feat(skills): intent-layer references — process, route briefs, capability menu, BRIEF.md format * feat(media-use): brief skeleton as the recipe's fourth artifact; flow/storyboard preference keys * feat(skills): the intent layer conducts every brief — workflows execute BRIEF.md * feat(skills): retire the mode preference key; sync catalog surfaces for intent layer * refactor(skills): dedupe router vs intent-layer guidance — one owner per rule * feat(skills): the design ask — own spec, pick by eye from showcases, or defer * docs(skills): the design ask says the honest line on capture routes * feat(skills): product-launch-video absorbs website-to-video as the tour angle * refactor(skills): keep product-launch-video pristine — a tour is brief intent, not a pipeline branch * feat(skills): production loop + genre lenses; general-video goes freeform (route yours, laws hold) * refactor(skills): /hyperframes is the front door - route tables and scope lists leave the workflows * docs(skills): review-loop pass across skill catalog * fix(cli): pass project dir to openStudioBrowser in background-server path * feat(skills): add pitch-round reference - verbalized sampling concept gate * feat(skills): wire pitch round into intent layer - completeness triage + route eligibility * feat(skills): editorial capability recommendations, handoff disciplines, menu-probe split * feat(skills): pitches carry their machinery; source-only-formed requests pitch the telling * feat(skills): companion goes director - ceiling treatment plus blueprint/rule citation discipline * fix(scripts): sandbox npx-leak guard - private npm global prefix keeps npx on the branch CLI * chore(skills): resync manifest hash after formatter pass reflowed general-video tables * fix(skills): recipe freeze reads workflow from BRIEF.md; style_preset records require workflow scope Two holes found by a live companion-run freeze: the agent-supplied --workflow contradicted the run's actual workflow (recipe.json said faceless-explainer, brief-skeleton said general-video), and the style_preset lookup missed because the preference had been recorded under the bare key. - freezeRecipe resolves the workflow from BRIEF.md frontmatter; the flag is a fallback for briefless projects and a contradicting flag is ignored (noted). - recordPreference refuses a bare style_preset — the scoped key is the only writable shape; freeze tolerates legacy bare records via read fallback. - review-loop § 4 / media-use SKILL / brief-format wording follow the machinery.
230 lines
11 KiB
Markdown
230 lines
11 KiB
Markdown
---
|
|
name: hyperframes-keyframes
|
|
description: >
|
|
Use when a HyperFrames composition needs seek-safe 2D/3D keyframes, GSAP
|
|
timelines, CSS keyframes, Anime.js, WAAPI, FLIP, paths, masks, SVG morph/draw,
|
|
text trails, 3D depth, or `hyperframes keyframes` diagnostics.
|
|
Don't use for broad scene strategy, brand design, media sourcing, captions, or
|
|
general video planning.
|
|
---
|
|
|
|
# HyperFrames Keyframes
|
|
|
|
Keyframes are a pose contract: visible states, continuous subject identity, seek-safe runtime, verified pixels.
|
|
|
|
Use `hyperframes-animation` for broad scene recipes. Use `hyperframes-cli` for full command docs. Use `references/keyframe-patterns.md` only when choosing implementation mechanisms, not visual style.
|
|
|
|
## Procedure
|
|
|
|
1. Identify the animated subject, visible states, final state, and runtime.
|
|
2. Choose the smallest mechanism that proves the prompt. Read `references/keyframe-patterns.md` only if the mechanism is unclear.
|
|
3. Author seek-safe keyframes in the declared runtime. Build synchronously and register the runtime instance.
|
|
4. Verify with `hyperframes lint`, `hyperframes check`, `hyperframes keyframes`, one focused `--shot`, and snapshots at proof times.
|
|
5. If proof fails, fix the source keyframes and rerun the smallest failing diagnostic before rendering.
|
|
|
|
## Contract
|
|
|
|
- Name the moving subject.
|
|
- Name the poses needed to prove the intended motion, including the final state.
|
|
- Keyframe visible channels, not hidden helper state.
|
|
- Preserve object identity when continuity matters.
|
|
- Crossfade only when the intended motion is replacement or dissolve.
|
|
- Hold readable or semantic states long enough to see.
|
|
- Final frame is part of the animation, not cleanup.
|
|
- Do not reset to rest unless requested.
|
|
- Do not end on black unless requested.
|
|
- If editing a starter scene, preserve layout, copy, assets, colors, and final state unless asked to redesign.
|
|
|
|
## Runtime Rules
|
|
|
|
GSAP:
|
|
|
|
- build synchronously at page load
|
|
- use `gsap.timeline({ paused: true })`
|
|
- register as `window.__timelines[compositionId]`
|
|
- registry key must match `data-composition-id`
|
|
- do not call `tl.play()` for render-critical motion
|
|
- keep repeats finite
|
|
|
|
CSS keyframes:
|
|
|
|
- finite duration and iteration count
|
|
- deterministic delay
|
|
- `animation-fill-mode: both`
|
|
- use `data-start` when timing belongs to a clip
|
|
|
|
Anime.js:
|
|
|
|
- create synchronously
|
|
- `autoplay: false`
|
|
- finite duration and loops
|
|
- push every instance to `window.__hfAnime`
|
|
|
|
WAAPI:
|
|
|
|
- finite `duration`
|
|
- `fill: "both"`
|
|
- deterministic construction
|
|
- the text surface does not list WAAPI; verify with `--shot` (it seeks WAAPI) and snapshots
|
|
|
|
Never use for render-critical motion:
|
|
|
|
- `Date.now()`
|
|
- `performance.now()`
|
|
- unseeded `Math.random()`
|
|
- hover/scroll triggers
|
|
- timers
|
|
- async-created timelines
|
|
- unregistered `requestAnimationFrame`
|
|
- infinite loops
|
|
|
|
## GSAP Skeleton
|
|
|
|
```js
|
|
const root = document.querySelector("[data-composition-id]");
|
|
const compositionId = root.dataset.compositionId;
|
|
const tl = gsap.timeline({ paused: true });
|
|
|
|
tl.addLabel("state-a", 0);
|
|
tl.to(".subject", {
|
|
keyframes: [
|
|
{ x: 0, opacity: 1, duration: 0.2 },
|
|
{ x: 120, opacity: 1, duration: 0.4, ease: "power2.out" },
|
|
{ x: 100, opacity: 1, duration: 0.2, ease: "power2.inOut" },
|
|
],
|
|
ease: "none",
|
|
});
|
|
|
|
window.__timelines = window.__timelines || {};
|
|
window.__timelines[compositionId] = tl;
|
|
```
|
|
|
|
Use labels for semantic states. Use position parameters instead of chained delays. Use `immediateRender: false` for later `from()`/`fromTo()` tweens touching the same property.
|
|
|
|
## Keyframe Forms
|
|
|
|
- Array keyframes: pose ladder with per-step duration/ease.
|
|
- Percentage keyframes: exact timing inside one tween.
|
|
- Property arrays: compact multi-stop changes.
|
|
- `ease: "none"` on the parent when each stop carries its own easing.
|
|
- `easeEach` when every segment should share the same feel.
|
|
|
|
Do not copy numeric distances or timing from examples. Derive them from the actual composition geometry and duration.
|
|
|
|
For one subject moving between two boxes, prefer one continuous transform tween or FLIP. Split `x/y/scale` into multiple eased keyframes only when the viewer should feel distinct beats; every segment changes velocity and can read as a hitch.
|
|
|
|
## Channels
|
|
|
|
Prefer compositor/visual channels: `x/y/z`, `xPercent/yPercent`, `scale`, `rotationX/Y/Z`, `skew`, `transformOrigin`, `svgOrigin`, `opacity`, `autoAlpha`, `clip-path`, masks, CSS vars, SVG path/dash values, camera transforms, shader uniforms.
|
|
|
|
Avoid layout/lifecycle channels: `top/left/right/bottom`, `width/height`, `margin/padding`, `display`, `visibility`, late DOM creation, helper overlays doing subject motion.
|
|
|
|
For visibility changes, use `autoAlpha` on the registered seekable GSAP timeline, or a zero-duration `tl.set()` at an explicit boundary. Target only a non-clip element or a wrapper inside the clip; never target `.clip` itself. Never duration-tween raw `visibility`, and never tween `display`.
|
|
|
|
## Mechanism Choice
|
|
|
|
Choose the smallest mechanism that proves the prompt:
|
|
|
|
| Need | Mechanism |
|
|
| ------------------------------------- | -------------------------------------------------- |
|
|
| Same subject changes box or hierarchy | shared element / FLIP |
|
|
| Subject travels a visible route | path travel |
|
|
| Stroke grows or traces | stroke draw |
|
|
| Shape becomes another shape | shape interpolation |
|
|
| Reveal boundary is visible | clip, mask, or shader uniform |
|
|
| Many items move with order | stagger / indexed delay |
|
|
| Text itself moves | line, word, character, or band subdivision |
|
|
| Surface bends, stretches, or crops | parent/child counter-transform |
|
|
| UI has states | explicit state machine |
|
|
| Scene has depth | DOM 3D, Three.js, or WebGL camera/object keyframes |
|
|
|
|
Mechanisms can combine, but each one must clarify the idea. Decoration is not proof.
|
|
|
|
## Timing
|
|
|
|
- Anticipation only when it clarifies cause or direction.
|
|
- Acceleration leaves rest.
|
|
- Peak proof shows the mechanism unmistakably.
|
|
- Follow-through sells energy and direction.
|
|
- Overshoot only when the subject should feel elastic or tactile.
|
|
- Constant-speed path travel usually needs `ease: "none"`.
|
|
- Discrete UI states usually need a sharp ease-out.
|
|
- Repeated elements need ordered offsets, not identical timing.
|
|
- Final lockups need longer holds than transition poses.
|
|
- Smoothness means continuous velocity on the same subject.
|
|
- Do not overlap tweens that write the same transform property unless the overlap is intentional and verified.
|
|
- Avoid animating large `clip-path`/mask changes while the same hero surface is also scaling or traveling; use nested reveals after the main move settles.
|
|
|
|
## Text
|
|
|
|
Preserve line boxes, word spacing, readability, and final fit. If text moves internally, move the glyphs or masked bands, not only decorations around the text. Snapshot readable frames.
|
|
|
|
## SVG
|
|
|
|
For stroke growth prefer `DrawSVGPlugin`, then `stroke-dasharray`/`stroke-dashoffset`. For shape interpolation prefer `MorphSVGPlugin`; convert primitives to paths when needed and split complex silhouettes into simpler parts.
|
|
|
|
## 3D
|
|
|
|
Scale alone is fake depth. Use perspective on a stable parent, `transform-style: preserve-3d`, z travel, rotation, camera/world motion, occlusion, and layer order when objects cross.
|
|
|
|
Use one or two diagnostic angles that expose the depth relationship. If angled proof shows no depth crossing, improve z/camera/occlusion.
|
|
|
|
## Canvas / WebGL
|
|
|
|
Keyframe camera position, camera target, object transform, material opacity, shader uniforms, and postprocess intensity through deterministic state. Render from HyperFrames time. Use `--ghost` because marker boxes cannot see internal canvas motion.
|
|
|
|
## CLI Proof
|
|
|
|
```bash
|
|
npx hyperframes lint
|
|
npx hyperframes check
|
|
npx hyperframes keyframes .
|
|
npx hyperframes keyframes . --json
|
|
npx hyperframes keyframes . --runtime all
|
|
npx hyperframes keyframes . --selector "<selector>" --shot "<file>" --samples <n>
|
|
npx hyperframes keyframes . --selector "<selector>" --shot "<file>" --layout strip --from <t0> --to <t1>
|
|
npx hyperframes keyframes . --shot "<file>" --ghost --angle <angle>
|
|
npx hyperframes snapshot . --at <times>
|
|
```
|
|
|
|
Choose `<selector>` for the real animated subject. Choose `<times>` for first frame, proof poses, final-minus-hold, and exact final. Choose `<angle>` only when depth must be proven.
|
|
|
|
| Tool | Proves |
|
|
| ---------------- | --------------------------------------------------------------------------------------------------- |
|
|
| `keyframes` | targets, explicit stops, paths, traces, composed parent/child motion, CSS stops, Anime registration |
|
|
| `--shot` | ghosts, route shape, time spacing, DOM 3D projection, focused selector proof |
|
|
| `--layout strip` | in-place motion, overlaps, contact, subtle scale/opacity, text waves |
|
|
| `--ghost` | canvas, WebGL, shader motion, rendered 3D |
|
|
| `snapshot --at` | masks, text readability, full state, final lockup, black/reset tails |
|
|
|
|
If selector proof looks wrong:
|
|
|
|
1. rerun `--json`
|
|
2. find the actual animated target
|
|
3. shoot that target
|
|
4. snapshot full frames
|
|
5. trust painted pixels over logs
|
|
|
|
## Diagnostic Reading
|
|
|
|
`flat` means no explicit middle poses. `keyframes` means explicit stops exist. `motionPath` means a route exists. `trace` means multi-stroke drawing. `composed with` means child motion inherits parent motion.
|
|
|
|
Even ghost spacing means constant speed. Clustered ghosts mean slow-in or settle. Large gaps mean fast travel.
|
|
|
|
A helper-selector shot is not proof. An onion shot over a broken full frame is not proof.
|
|
|
|
## Error Handling
|
|
|
|
| Failure | Fix |
|
|
| ------------------ | ---------------------------------------------------------------------------------- |
|
|
| endpoint-only | add middle poses, hold peak proof, rerun `--shot` |
|
|
| identity break | keep one element alive, use shared source/final boxes, remove substitute crossfade |
|
|
| fake 3D | add z/camera travel, occlusion, angled proof |
|
|
| wrong final | add final hold, snapshot final-minus-hold and exact final |
|
|
| unseekable runtime | pause autoplay, register instance, remove timers, build synchronously |
|
|
| unreadable text | preserve line boxes, reduce displacement, add final hold, snapshot text frames |
|
|
|
|
## Done
|
|
|
|
Run `hyperframes lint`, `hyperframes check`, `hyperframes keyframes`, one focused `--shot`, and snapshots. Confirm first frame, proof poses, final-minus-hold, exact final, subject-owned motion, and no debug overlays.
|