mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-04 16:42:27 +00:00
feat(skills): add changelog-video skill for repo-native CC + Codex discovery (#2552)
Packages Jake Moran's changelog-video pipeline (v1, validated end-to-end
by Home on the Jun 23-29 range) as a repo-native skill set that Claude
Code (.claude/skills/) and Codex CLI (.agents/skills/) auto-discover the
moment the repo is opened. No install step; run the skill against a
changelog markdown for a given git range and it produces a lint-clean,
seam-gate-green 1080x1080 MP4 (~45-60s, Annie VO, mock-UI visualizations,
caption rail) end-to-end.
Six skills added byte-identical in both mirror dirs:
- changelog-video (pipeline entry point)
- motion-doctrine (carries seam-stamp.mjs + seam-gate.mjs)
- cut-the-curve, captions-overlay, seam-craft, oversized-cursor
Layout:
- .claude/skills/ - Claude Code project-local auto-discover
- .agents/skills/ - Codex CLI project-local auto-discover (verified via
Magi's clean-home Codex 0.144.3 repro; NOT .codex/skills/)
Fonts, animated background (12 MB), house BGM (5 MB), lexicon, and
align-captions ship inside the skill dirs. .gitattributes routes only
.claude/skills/**/*.{mp4,mp3} + .agents/skills/**/*.{mp4,mp3} through
LFS — narrowly scoped so unrelated Player, Studio, registry, and
marketplace media stay put. HeyGen CLI auth is the one credential the
skill needs; Node >= 22, ffmpeg, and headless Chrome are documented
alongside in both READMEs.
.gitignore: rewrites .claude/ and .agents/ blocks to keep agent-installed
skill hygiene while re-including the six repo-native skill dirs plus
README.md.
CI:
- Extends changes.skills filter to match .claude/skills/**,
.agents/skills/**, scripts/lint-skills.ts, and scripts/check-skill-mirror.mjs.
- New 'Skills: project-native lint + mirror' job runs the extended
lint-skills.ts (schema-driven; required { name, description } + optional
{ license, allowed-tools, metadata }, name pattern check, description
length check) plus a new check-skill-mirror.mjs byte-integrity script
(24 mirrored files must match; README.md deliberately per-CLI).
- Wired into 'bun run lint' locally.
Frontmatter validator:
- Rejects unsupported top-level keys (catches category:-style drift).
- Requires name + description.
- Validates name pattern (^[a-z][a-z0-9-]{0,63}$) and description shape
(non-empty, <=1024 chars).
- Missing frontmatter block itself is a first-class error.
Also strips unsupported top-level 'category:' frontmatter from Jake's
motion-doctrine and cut-the-curve SKILL.mds (both mirrors), rewrites the
TTS invocation from ~/.claude/skills/media-use/... to the tracked
skills/hyperframes-media/scripts/heygen-tts.mjs, swaps npx hyperframes@latest
for the repo-local CLI in the gate step, and fixes a lint issue in Jake's
seam-gate.mjs (ternary-for-side-effect -> if/else).
Validated end-to-end by Home on Jun 23-29 (MP4 posted in C0ACCNHLG3U
thread 1784181166.041319). Independently reviewed R1/R2/R3 by Magi.
Co-authored-by: Jake Moran <jake@heygen.com>
This commit is contained in:
co-authored by
Jake Moran
parent
172f2757f0
commit
e96ebd74de
@@ -0,0 +1,127 @@
|
||||
---
|
||||
name: changelog-video
|
||||
description: Turn a weekly changelog .md into a finished branded changelog video (square 1080, ~45-60s, Annie VO, animated brand background, mock-UI visualizations, lowkey captions). Use when the user provides a changelog/digest markdown and wants the weekly video, or says "changelog video". Self-contained — fonts, background, lexicon, and scripts ship in this skill.
|
||||
---
|
||||
|
||||
# Changelog → Branded Video
|
||||
|
||||
Input: a changelog .md (themes + items, like the weekly HyperFrames digest).
|
||||
Output: a lint-clean, seam-gate-green HyperFrames project in
|
||||
`projects/active/weekly-changelog-<range>/`. Render only when asked.
|
||||
|
||||
**Load first, non-negotiable:** `motion-doctrine` (+ `cut-the-curve`,
|
||||
`oversized-cursor` if a cursor appears, `seam-craft`) and `captions-overlay`.
|
||||
This skill supplies the changelog-specific pipeline; the doctrine supplies the
|
||||
motion law.
|
||||
|
||||
## The prime directive: visualize, don't list
|
||||
|
||||
Every theme is illustrated by an **animated mock of the actual UI or a
|
||||
faithful analog** acting out the change in experience — never text bullets.
|
||||
Route every theme/item through `references/visualization-registry.md` BEFORE
|
||||
writing the script; the registry decides ui-recreate / ui-analog / terminal /
|
||||
checklist. Text checklist is the LAST resort, reserved for genuinely
|
||||
non-visual items (reliability fix lists).
|
||||
|
||||
## Pipeline
|
||||
|
||||
### 1 · Parse + editorial cut
|
||||
|
||||
- Extract: week range, headline stats (releases, commits), themes, items.
|
||||
- **Budget: 45-60s total.** Title ≤2s, outro ≤3.5s, 4 themes ≈ 9-12s each.
|
||||
- Per theme keep ONE hero visualization + at most 3 spoken items. Everything
|
||||
else exists only as the outro's "full digest" pointer. Cutting is the job:
|
||||
a changelog with 30 items still yields ≤14 spoken beats.
|
||||
- Order themes by story: marquee feature → product surface → performance →
|
||||
reliability (the digest usually already reads this way).
|
||||
|
||||
### 2 · Visualization routing
|
||||
|
||||
For each theme, pick the surface from `references/visualization-registry.md`
|
||||
and write one line: `theme → surface → the 2-4 sequenced actions the mock
|
||||
performs, each tied to a script phrase`. If no registry surface fits and no
|
||||
faithful analog exists, it's a checklist scene — don't invent fake UI for
|
||||
something we can't represent honestly.
|
||||
|
||||
### 3 · Two-layer script (spoken vs display)
|
||||
|
||||
Write the script as **token lines** per `references/script-voice.md`:
|
||||
conversational register, every technical term carrying a `spoken` phonetic
|
||||
form from `references/lexicon.json` while `display` keeps standard spelling.
|
||||
Captions show `display`; the VO reads `spoken`. Any term not in the lexicon:
|
||||
STOP and ask the user how it's pronounced, then add it to the lexicon.
|
||||
Save as `script-tokens.json` in the project.
|
||||
|
||||
### 4 · VO — Annie (HeyGen, pinned)
|
||||
|
||||
```bash
|
||||
# spoken-layer text only; words JSON = ground-truth timestamps of the SPOKEN text
|
||||
# Repo-native path: the changelog-video skill runs from the hyperframes repo root,
|
||||
# so it uses the tracked hyperframes-media TTS helper directly (no `npx hyperframes
|
||||
# skills` install step). If you've copied the skill into another repo, swap in
|
||||
# your own path to the media-use / hyperframes-media heygen-tts.mjs.
|
||||
node skills/hyperframes-media/scripts/heygen-tts.mjs ./vo-spoken.txt \
|
||||
-o voiceover.mp3 --words vo-words.json \
|
||||
--voice 330290724a1b470fb63153f34d4c0183 # Annie — lifelike (do not substitute)
|
||||
```
|
||||
|
||||
Requires `heygen` CLI ≥0.3.0 authenticated (`heygen auth login --oauth`).
|
||||
Then align spoken timestamps back to display tokens:
|
||||
|
||||
```bash
|
||||
node <SKILL_DIR>/scripts/align-captions.mjs \
|
||||
--tokens script-tokens.json --words vo-words.json --out captions.json
|
||||
```
|
||||
|
||||
`captions.json` is the caption-rail input (display spelling, spoken timing).
|
||||
The aligner prints `MISMATCH` warnings — resolve every one before building
|
||||
(usually a lexicon spelling the TTS renders as multiple words). **The audio
|
||||
is the clock**: all beat times come from `vo-words.json`; a VO regen re-opens
|
||||
every seam.
|
||||
|
||||
### 5 · Build
|
||||
|
||||
Follow `references/build-spec.md` exactly: brand tokens + fonts (bundled in
|
||||
`<SKILL_DIR>/assets/`), the animated background encode, scene scaffold,
|
||||
chrome, caption rail, one rationed green moment per scene. Then the doctrine
|
||||
order: `ledger.json` (all ordinary seams cut-the-curve LEFT) → seam-stamp →
|
||||
internal beats on VO words → seam-gate verify.
|
||||
|
||||
### 6 · Gates (all green before presenting)
|
||||
|
||||
1. `bun run --cwd packages/cli hyperframes check` (or the installed
|
||||
`hyperframes` CLI from the repo-local `skills/hyperframes-cli/` skill) —
|
||||
0 errors (contrast: dim text ≥ .66 alpha). Do NOT reach for
|
||||
`npx hyperframes@latest`; the tracked repo-local CLI is the source of
|
||||
truth for the composition contract this skill produces against.
|
||||
2. `seam-gate.mjs verify` — 0 fail.
|
||||
3. Restart the preview server (it caches the bundle), spot-check 3-4 beats
|
||||
via `__player.seek` on the raw comp page.
|
||||
4. Do NOT render unless the user asks. After a requested render, verify
|
||||
frames from the MP4 (`ffmpeg -ss <t> … -frames:v 1`): captions present,
|
||||
background video not black, no tiny/frozen frames.
|
||||
|
||||
## Project layout
|
||||
|
||||
```
|
||||
projects/active/weekly-changelog-<range>/
|
||||
├── index.html # single-doc master (scenes as slides, stamped seams)
|
||||
├── ledger.json # vector ledger (seam-stamp input)
|
||||
├── script-tokens.json # two-layer script (source of truth for VO + captions)
|
||||
├── vo-spoken.txt # generated: spoken layer, one line
|
||||
├── voiceover.mp3 + vo-words.json + captions.json
|
||||
├── bgm.mp3 # copy from <SKILL_DIR>/assets/bgm.mp3 (the house track) unless the user supplies one
|
||||
└── assets/fonts/ + assets/bg-pattern-<dur>s.mp4
|
||||
```
|
||||
|
||||
## Anti-patterns
|
||||
|
||||
| Don't | Instead |
|
||||
| ---------------------------------------- | ---------------------------------------------- |
|
||||
| Bullet-point slides for UI changes | Mock the surface acting out the change |
|
||||
| Fake UI for un-representable items | Honest checklist scene |
|
||||
| Plain "JSON"/"CLI" in the TTS text | Lexicon spoken forms; display stays standard |
|
||||
| Phonetic spellings in captions | Captions always render the display layer |
|
||||
| Guessing an unknown term's pronunciation | Ask, then grow the lexicon |
|
||||
| Speaking every changelog item | ≤3 per theme; the digest link carries the rest |
|
||||
| Green accents everywhere | One green moment per scene (#5ef17c) |
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:e6cdd36e1e57f0b8349088db97d813863e87a7b7974d472ad9efc904737039f2
|
||||
size 12817182
|
||||
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:5e86390155022691fa09a31a28e256a717aaf079d5f9ccbb5561d52ab8a49300
|
||||
size 5318438
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -0,0 +1,118 @@
|
||||
<!DOCTYPE html>
|
||||
<!-- master-skeleton — the verbatim scaffold for a changelog master. Mirrors the
|
||||
proven build. Replace <RANGE>, <TOTAL>, scene bodies; keep the mechanics. -->
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=1080, height=1080">
|
||||
<title>HyperFrames Weekly — <RANGE></title>
|
||||
<script src="https://cdn.jsdelivr.net/npm/gsap@3.14.2/dist/gsap.min.js"></script>
|
||||
<style>
|
||||
@font-face { font-family:'ABC Solar Display'; src:url('assets/fonts/ABCSolarDisplay-Bold.woff2') format('woff2'); font-weight:700; font-display:block; }
|
||||
@font-face { font-family:'TT Norms Pro'; src:url('assets/fonts/TT_Norms_Pro_Normal.woff2') format('woff2'); font-weight:400; font-display:block; }
|
||||
@font-face { font-family:'TT Norms Pro'; src:url('assets/fonts/TT_Norms_Pro_Medium.woff2') format('woff2'); font-weight:500; font-display:block; }
|
||||
@font-face { font-family:'TT Norms Mono'; src:url('assets/fonts/tt_norms_pro_mono_regular-webfont.woff2') format('woff2'); font-weight:400; font-display:block; }
|
||||
* { margin: 0; padding: 0; box-sizing: border-box; }
|
||||
html, body { width: 1080px; height: 1080px; background: #0a0c0b; overflow: hidden;
|
||||
font-family: 'TT Norms Pro', sans-serif; color: #f5f6f4; }
|
||||
#bg-video { position: absolute; inset: 0; width: 1080px; height: 1080px; object-fit: cover; }
|
||||
#bg-scrim { position: absolute; inset: 0; background: rgba(8,10,9,.25); }
|
||||
.chrome { position: absolute; z-index: 6; }
|
||||
#kicker-chip { top: 44px; left: 76px; font-family: 'TT Norms Mono', monospace; font-size: 20px;
|
||||
letter-spacing: .06em; color: rgba(245,246,244,.72); background: rgba(255,255,255,.05);
|
||||
border: 1px solid rgba(255,255,255,.14); border-radius: 12px; padding: 10px 18px; }
|
||||
#progress { top: 58px; right: 76px; display: flex; gap: 10px; }
|
||||
#progress .dot { width: 8px; height: 8px; border-radius: 50%; background: rgba(245,246,244,.18); }
|
||||
.slide { position: absolute; inset: 0; opacity: 0; }
|
||||
.sec-chip { position: absolute; top: 128px; left: 76px; font-family: 'TT Norms Mono', monospace;
|
||||
font-size: 22px; letter-spacing: .05em; color: rgba(245,246,244,.72);
|
||||
background: rgba(255,255,255,.05); border: 1px solid rgba(255,255,255,.14);
|
||||
border-radius: 12px; padding: 10px 16px; }
|
||||
.sec-head { position: absolute; top: 186px; left: 76px; font-family: 'ABC Solar Display', sans-serif;
|
||||
font-weight: 700; font-size: 54px; letter-spacing: -.01em; color: #f5f6f4; }
|
||||
.glass { background: rgba(10,12,11,.78); border: 1px solid rgba(190,255,205,.32);
|
||||
border-radius: 22px; box-shadow: 0 24px 60px rgba(0,0,0,.5); }
|
||||
/* caption rail — overlay on top of the film, never a reserved band */
|
||||
#cap-line { position: absolute; left: 0; right: 0; top: 1002px; height: 40px; text-align: center;
|
||||
z-index: 7; font-family: 'TT Norms Pro', sans-serif; font-weight: 500; font-size: 25px;
|
||||
letter-spacing: .01em; color: rgba(245,246,244,.92);
|
||||
text-shadow: 0 2px 14px rgba(0,0,0,.85), 0 0 3px rgba(0,0,0,.6);
|
||||
white-space: nowrap; pointer-events: none; }
|
||||
.cap-phrase { position: absolute; left: 0; right: 0; }
|
||||
.cap-w { display: inline-block; margin: 0 4px; }
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div id="root" data-composition-id="main" data-start="0" data-duration="<TOTAL>" data-width="1080" data-height="1080">
|
||||
<video id="bg-video" class="clip" src="assets/bg-pattern-<TOTAL>s.mp4" muted data-start="0" data-duration="<TOTAL>" data-track-index="0"></video>
|
||||
<div id="bg-scrim"></div>
|
||||
<div id="kicker-chip" class="chrome">HYPERFRAMES WEEKLY <span style="color:rgba(245,246,244,.66)">· <RANGE></span></div>
|
||||
<div id="progress" class="chrome"><span class="dot" id="dot1"></span><!-- one per theme --></div>
|
||||
<div id="cap-line" class="chrome" data-layout-allow-overlap></div>
|
||||
|
||||
<!-- Title (film open — authors its OWN entry; exit is stamped) -->
|
||||
<div id="s-title" class="slide clip" data-start="0" data-duration="<CUT1>" data-track-index="1">
|
||||
<!-- mono kicker date · ABC Solar h1 · green rule -->
|
||||
</div>
|
||||
|
||||
<!-- One slide per theme. data-start = EXACTLY the ledger cut time.
|
||||
Shell composed at local t=0; internal beats ≥0.4s after the cut,
|
||||
done ≥0.45s before the next. data-layout-allow-overlap on mock slides. -->
|
||||
<div id="s-t1" class="slide clip" data-start="<CUT1>" data-duration="<DUR1>" data-track-index="1" data-layout-allow-overlap>
|
||||
<div class="sec-chip">01 · <THEME></div>
|
||||
<div class="sec-head"><HEADLINE></div>
|
||||
<!-- the mock, from references/visualization-registry.md, y ∈ [288, 944] -->
|
||||
</div>
|
||||
|
||||
<!-- s-t2..tN, then outro (kicker · "See what shipped." · green rule · URL chip) -->
|
||||
|
||||
<audio id="bgm" src="bgm.mp3" data-start="0" data-duration="<TOTAL>" data-track-index="2" data-volume="0.14" data-media-start="0"></audio>
|
||||
<audio id="vo" src="voiceover.mp3" data-start="0" data-duration="<TOTAL>" data-track-index="3" data-volume="1.0"></audio>
|
||||
</div>
|
||||
|
||||
<script>
|
||||
gsap.defaults({ overwrite: 'auto' });
|
||||
const tl = gsap.timeline({ paused: true });
|
||||
tl.to({}, { duration: /*<TOTAL>*/ 47 }, 0);
|
||||
|
||||
// chrome in; progress dots via tl.set at each cut (never tl.call)
|
||||
gsap.set('#kicker-chip', { autoAlpha: 0, y: -10 });
|
||||
tl.to('#kicker-chip', { autoAlpha: 1, y: 0, duration: 0.5, ease: 'power3.out' }, 0.1);
|
||||
// tl.set('#dot1', { backgroundColor: '#f5f6f4' }, <CUT1>); …
|
||||
|
||||
// ══ per-scene internal beats ══
|
||||
// init states: gsap.set(...) at build time; motion: sequential tl.to(...) only.
|
||||
// Every beat lands on a vo-words.json timestamp (local = master − scene start).
|
||||
// One green (#5ef17c) moment per scene.
|
||||
|
||||
// ══ CAPTION RAIL — paste captions.json "lines" from align-captions.mjs ══
|
||||
(function () {
|
||||
const LINES = /* paste captions.json lines — [{id, end, w:[[display, start],…]},…] */ [];
|
||||
const host = document.getElementById('cap-line');
|
||||
LINES.forEach((line, li) => {
|
||||
const ph = document.createElement('div');
|
||||
ph.className = 'cap-phrase'; ph.id = 'cap-p' + li;
|
||||
line.w.forEach(([txt], wi) => {
|
||||
const s = document.createElement('span');
|
||||
s.className = 'cap-w'; s.id = 'cap-p' + li + '-w' + wi; s.textContent = txt;
|
||||
ph.appendChild(s);
|
||||
});
|
||||
host.appendChild(ph);
|
||||
});
|
||||
gsap.set('.cap-phrase', { autoAlpha: 0 });
|
||||
gsap.set('.cap-w', { autoAlpha: 0 });
|
||||
LINES.forEach((line, li) => {
|
||||
tl.set('#cap-p' + li, { autoAlpha: 1 }, line.w[0][1]);
|
||||
tl.set('#cap-p' + li, { autoAlpha: 0 }, line.end);
|
||||
line.w.forEach(([txt, at], wi) => {
|
||||
tl.to('#cap-p' + li + '-w' + wi, { autoAlpha: 1, duration: 0.12, ease: 'power1.out' }, at);
|
||||
});
|
||||
});
|
||||
})();
|
||||
|
||||
window.__timelines = window.__timelines || {};
|
||||
window.__timelines["main"] = tl;
|
||||
// seam-stamp.mjs inserts the <seams:auto> block after the registration above.
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,34 @@
|
||||
{
|
||||
"_readme": "Two-layer script example. Bare string = display and spoken identical; object = they diverge (display for captions, spoken for TTS). One line = one caption phrase (≤ ~40 display chars). vo-spoken.txt = all spoken forms joined.",
|
||||
"lines": [
|
||||
{ "id": "l1", "tokens": ["This", "week", "at", "HyperFrames", "—"] },
|
||||
{ "id": "l2", "tokens": ["fifteen", "releases,", "and", "one", "big", "story."] },
|
||||
{ "id": "l3", "tokens": ["Feed", "it", "a", "Figma", "frame,"] },
|
||||
{ "id": "l4", "tokens": ["get", "a", "working", "composition", "back", "—"] },
|
||||
{ "id": "l5", "tokens": ["tokens,", "components,", "and", "motion", "all", "mapped."] },
|
||||
{
|
||||
"id": "l6",
|
||||
"tokens": [
|
||||
"Even",
|
||||
"the",
|
||||
{ "display": "JSON", "spoken": "jay-sawn" },
|
||||
"manifest",
|
||||
"comes",
|
||||
"along."
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "l7",
|
||||
"tokens": ["And", "it's", "all", "one", { "display": "CLI", "spoken": "C L I" }, "command."]
|
||||
},
|
||||
{
|
||||
"id": "l8",
|
||||
"tokens": [
|
||||
"See",
|
||||
"everything",
|
||||
"at",
|
||||
{ "display": "hyperframes.heygen.com", "spoken": "hyperframes dot hey-jen dot com" }
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,115 @@
|
||||
# Build Spec — square 1080 changelog master
|
||||
|
||||
Single-doc `index.html`: scenes are absolutely-positioned `.slide` clips on
|
||||
track 1; the master timeline `tl` (MUST be named `tl` — seam-stamp emits
|
||||
`tl.*`) is paused, padded to total duration, registered as
|
||||
`window.__timelines["main"]`. See `examples/master-skeleton.html` for the
|
||||
verbatim scaffold.
|
||||
|
||||
## Brand tokens (HeyGen for Developers)
|
||||
|
||||
```css
|
||||
@font-face {
|
||||
font-family: "ABC Solar Display";
|
||||
font-weight: 700;
|
||||
src: url(assets/fonts/ABCSolarDisplay-Bold.woff2) format("woff2");
|
||||
}
|
||||
@font-face {
|
||||
font-family: "TT Norms Pro";
|
||||
font-weight: 400;
|
||||
src: url(assets/fonts/TT_Norms_Pro_Normal.woff2) format("woff2");
|
||||
}
|
||||
@font-face {
|
||||
font-family: "TT Norms Pro";
|
||||
font-weight: 500;
|
||||
src: url(assets/fonts/TT_Norms_Pro_Medium.woff2) format("woff2");
|
||||
}
|
||||
@font-face {
|
||||
font-family: "TT Norms Pro";
|
||||
font-weight: 700;
|
||||
src: url(assets/fonts/TT_Norms_Pro_Bold.woff2) format("woff2");
|
||||
}
|
||||
@font-face {
|
||||
font-family: "TT Norms Mono";
|
||||
font-weight: 400;
|
||||
src: url(assets/fonts/tt_norms_pro_mono_regular-webfont.woff2) format("woff2");
|
||||
}
|
||||
/* ink #f5f6f4 · ink2 rgba(245,246,244,.72) · dim rgba(245,246,244,.66) —
|
||||
NOT .45: the contrast gate fails small text under 4.5:1 over the glass.
|
||||
green #5ef17c (RATIONED: one moment per scene) · bg #0a0c0b ·
|
||||
chip-bg rgba(10,12,11,.78) · glass-line rgba(190,255,205,.32) */
|
||||
```
|
||||
|
||||
Copy fonts from `<SKILL_DIR>/assets/fonts/` into the project's
|
||||
`assets/fonts/` (local @font-face with format('woff2') embeds at render).
|
||||
Glass card: chip-bg fill, 1px glass-line border, radius 22,
|
||||
`box-shadow: 0 24px 60px rgba(0,0,0,.5)`. NO backdrop-filter. Chips: mono
|
||||
18-22px, radius 12, 1px rgba(255,255,255,.14) border on rgba(255,255,255,.05).
|
||||
Display type: ABC Solar Display 700. Body: TT Norms Pro. Everything
|
||||
code/UI-label: TT Norms Mono. Safe margins x/y ∈ [76, 1004].
|
||||
|
||||
## Animated background (the house pattern)
|
||||
|
||||
Encode the bundled source to the film's exact duration — the render
|
||||
compiler shortens a video's slot to the media length, so the encode must be
|
||||
≥ total:
|
||||
|
||||
```bash
|
||||
ffmpeg -y -stream_loop 15 -i <SKILL_DIR>/assets/bg-pattern.mp4 -t <TOTAL> \
|
||||
-vf "scale=1080:1080,fps=30,eq=saturation=0.72,drawbox=c=black@0.5:t=fill" \
|
||||
-an -c:v libx264 -crf 20 -pix_fmt yuv420p assets/bg-pattern-<TOTAL>s.mp4
|
||||
```
|
||||
|
||||
Keep the darkening crush — the raw pattern is far too loud. Mount as
|
||||
`<video id="bg-video" class="clip" muted>` on track 0 + a static
|
||||
`rgba(8,10,9,.25)` scrim div. `<video>` needs the id (silent/black
|
||||
otherwise) and must stay flat 2D (no 3D ancestors).
|
||||
|
||||
## Scene anatomy
|
||||
|
||||
- Chrome (untimed, z 6): kicker chip top-left `HYPERFRAMES WEEKLY · <RANGE>`,
|
||||
progress dots top-right (one per theme; `tl.set` backgroundColor at each
|
||||
cut — active #f5f6f4, done .45; never tl.call for state).
|
||||
- Title (≤2s): mono kicker date, ABC Solar h1 ~104px, green rule sweep.
|
||||
- Theme scene: sec-chip `0N · THEME NAME` (top 128) + ABC Solar headline
|
||||
~54px (top 186) + the mock (from the visualization registry) filling
|
||||
y ∈ [288, 944].
|
||||
- Outro (≤3.5s): kicker FULL DIGEST, "See what shipped." ~96px, green rule,
|
||||
mono URL chip, tag line. Fade all + chrome ~0.5s before end.
|
||||
- Caption rail per `script-voice.md` (top: 1002).
|
||||
|
||||
## Seams + internal life (doctrine mechanics)
|
||||
|
||||
- `ledger.json`: every ordinary seam `cut-the-curve LEFT` (x, dir −1), exit
|
||||
and entry selectors = the slide wrappers. Outro entry `travel: 8`.
|
||||
- `seam-stamp.mjs --ledger ledger.json --write index.html` owns ALL wrapper
|
||||
entries/exits — author none yourself. Title (film open) authors its own
|
||||
entry only.
|
||||
- Slides: CSS `opacity: 0` base; `data-start` = exactly the cut time.
|
||||
- Each scene's shell (chip, headline, mock chrome, initial state) is
|
||||
COMPOSED at local t=0 — the wrapper flies it in. Internal reveals start
|
||||
≥0.4s after the cut and end ≥0.45s before the next cut (stamped exits
|
||||
begin at cut −0.34s).
|
||||
- Every internal beat lands on a VO word from `vo-words.json`. Name each
|
||||
scene's sustained-motion route in the plan (sequenced UI life for mocks,
|
||||
staged reveals for checklists). One green moment per scene.
|
||||
- Init states via `gsap.set(...)` at build time; animation via sequential
|
||||
`tl.to(...)` only (no plain-object keyframes, no repeat:-1, no tweening
|
||||
left/top — set base position in CSS, tween x/y). Counters: object tween
|
||||
with an `onUpdate` in the tween config (cache DOM refs; never
|
||||
`tl.eventCallback`).
|
||||
|
||||
## Lint/check gotchas (all hit before, all pre-solved)
|
||||
|
||||
- Mock containers with intentional stacking: `data-layout-allow-overlap` on
|
||||
the slide root; elements a playhead/line crosses:
|
||||
`data-layout-allow-occlusion`.
|
||||
- Dim text: `rgba(245,246,244,.66)` minimum (contrast gate).
|
||||
- Audio: every `<audio>` carries an `id`. BGM: the house track ships at
|
||||
`<SKILL_DIR>/assets/bgm.mp3` (159s instrumental) — copy it to the project
|
||||
as `bgm.mp3` and mount on its own track:
|
||||
`<audio id="bgm" src="bgm.mp3" data-start="0" data-duration="<TOTAL>" data-track-index="2" data-volume="0.14" data-media-start="0">`
|
||||
(0.14 sits under the VO; use a user-supplied track only when given one).
|
||||
- Preview server caches the bundle — RESTART after edits, then verify on the
|
||||
raw comp page (`/api/projects/<id>/preview/comp/index.html`) via
|
||||
`window.__player.seek(t)`.
|
||||
@@ -0,0 +1,66 @@
|
||||
{
|
||||
"_readme": "display → spoken. Plain-text phonetics for HeyGen TTS (no SSML). Grow this file; never guess a missing term — ask, add, then listen to the generated line. Slash commands: caption /name, speak 'slash <name>'.",
|
||||
"/figma": "slash Figma",
|
||||
"/hyperframes": "slash hyper-frames",
|
||||
"JSON": "jay-sawn",
|
||||
"GSAP": "jee-sap",
|
||||
"CLI": "C L I",
|
||||
"CDP": "C D P",
|
||||
"API": "A P I",
|
||||
"SDK": "S D K",
|
||||
"UI": "U I",
|
||||
"UX": "U X",
|
||||
"CSS": "C S S",
|
||||
"HTML": "H T M L",
|
||||
"SVG": "S V G",
|
||||
"URL": "U R L",
|
||||
"TTS": "T T S",
|
||||
"ASR": "A S R",
|
||||
"MCP": "M C P",
|
||||
"LRU": "L R U",
|
||||
"GC": "G C",
|
||||
"VFR": "V F R",
|
||||
"CFR": "C F R",
|
||||
"SDR": "S D R",
|
||||
"HDR": "H D R",
|
||||
"GPU": "G P U",
|
||||
"CPU": "C P U",
|
||||
"PNG": "P N G",
|
||||
"MP4": "em pee four",
|
||||
"MP3": "em pee three",
|
||||
"WebM": "web em",
|
||||
"WebGL": "web G L",
|
||||
"wav": "wave",
|
||||
"ffmpeg": "ff-mpeg",
|
||||
"ffprobe": "ff-probe",
|
||||
"OAuth": "oh-auth",
|
||||
"SSML": "S S M L",
|
||||
"OOM": "out of memory",
|
||||
"e2e": "end to end",
|
||||
"DX": "developer experience",
|
||||
"QA": "Q A",
|
||||
"npm": "N P M",
|
||||
"npx": "N P X",
|
||||
"regen": "ree-jen",
|
||||
"repo": "repo",
|
||||
"HeyGen": "hey-jen",
|
||||
"heygen.com": "hey-jen dot com",
|
||||
"hyperframes.heygen.com": "hyperframes dot hey-jen dot com",
|
||||
"MusicGen": "music-jen",
|
||||
"Kokoro": "koh-koh-roh",
|
||||
"Figma": "Figma",
|
||||
"drawElement": "draw element",
|
||||
"DrawElement": "draw element",
|
||||
"moveElement": "move element",
|
||||
"storyboard": "storyboard",
|
||||
"keyframes": "key-frames",
|
||||
"sub-compositions": "sub compositions",
|
||||
"WSL": "W S L",
|
||||
"Linux": "linnucks",
|
||||
"symlink": "sim-link",
|
||||
"lint": "lint",
|
||||
"toast": "toast",
|
||||
"vite": "veet",
|
||||
"Chromium": "chromium",
|
||||
"headless": "headless"
|
||||
}
|
||||
@@ -0,0 +1,111 @@
|
||||
# Script + Voice: the two-layer contract
|
||||
|
||||
The script is the single source of truth for BOTH the VO and the captions,
|
||||
written as token lines. The VO reads the `spoken` layer; captions render the
|
||||
`display` layer. This is a hard quality gate: a caption showing "jay-sawn" or
|
||||
a VO saying "juh-son" ("JSON" read literally) are both build failures.
|
||||
|
||||
## Register (how it should sound)
|
||||
|
||||
- Conversational, not release-notes. "The big one this week —" beats
|
||||
"Theme 1:". Contractions welcome. Second person allowed ("your clips").
|
||||
- Informational, never salesy; no superlatives the changelog doesn't earn.
|
||||
- One breath per beat: sentences ≤ ~14 words; let punctuation pace the read.
|
||||
- Numbers with meaning stay ("fifteen releases"); commit hashes, PR numbers,
|
||||
and version micro-detail are never spoken.
|
||||
- Open with the week + the marquee, close with the digest pointer
|
||||
("See everything at hyperframes dot heygen dot com").
|
||||
- **Teach the simple command.** When a feature has a one-line invocation (a
|
||||
slash command, a CLI one-liner), the script says it verbatim ("start your
|
||||
prompt with /figma…") and the mock shows it being typed — the command is
|
||||
the visible CAUSE of the result. Slash commands speak as "slash <name>",
|
||||
caption as `/name`.
|
||||
|
||||
## Token-line format (`script-tokens.json`)
|
||||
|
||||
```json
|
||||
{
|
||||
"lines": [
|
||||
{
|
||||
"id": "l1",
|
||||
"tokens": ["This", "week", "at", "HyperFrames,", { "display": "JSON", "spoken": "jay-sawn" }]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
- A bare string = display and spoken identical.
|
||||
- An object = the layers diverge. `display` keeps standard spelling AND the
|
||||
punctuation captions should show; `spoken` is what the TTS reads.
|
||||
- One line = one caption phrase (≤ ~40 chars of display text). Line grouping
|
||||
is an authoring decision made here, not downstream.
|
||||
- Build `vo-spoken.txt` by joining every token's spoken form with spaces,
|
||||
lines joined into sentences/paragraphs as punctuated.
|
||||
|
||||
## Phonetics rules (ElevenLabs-style best practices, plain-text)
|
||||
|
||||
HeyGen TTS takes plain text (no SSML), so pronunciation is controlled by
|
||||
spelling, hyphens, and spacing:
|
||||
|
||||
1. **Initialisms** (each letter said): space or hyphen the letters —
|
||||
`CLI → "C L I"`, `CDP → "C D P"`, `API → "A P I"`.
|
||||
2. **Acronyms said as words**: respell phonetically —
|
||||
`JSON → "jay-sawn"`, `GSAP → "jee-sap"`.
|
||||
3. **Mixed / pronounceable compounds**: hyphenated LOWERCASE phonetics, one
|
||||
fluid run — `ffmpeg → "ff-mpeg"` (ear-tested; the TTS reads "ff" as a
|
||||
fluid "eff-eff"), `WebM → "web em"`, `OAuth → "oh-auth"`. Never spaced
|
||||
capitals here: the TTS reads spaced caps as isolated letter names with
|
||||
hard stops ("F F em-peg" comes out "eff… eff… em-peg"). Reserve spaced
|
||||
capitals for TRUE initialisms (CLI, API) where a deliberate
|
||||
letter-by-letter read is the goal. When candidates are close, generate
|
||||
A/B takes of the real sentence and let the user pick by ear.
|
||||
4. **Versions/numbers**: expand — `v0.7.36 → "version zero point seven
|
||||
point thirty-six"` (usually: don't speak versions at all),
|
||||
`1080×1080 → "ten-eighty by ten-eighty"`.
|
||||
5. **URLs**: `hyperframes.heygen.com → "hyperframes dot hey-jen dot com"`.
|
||||
6. **Filenames/extensions**: `.mp4 → "dot em pee four"` — or rephrase so the
|
||||
extension isn't spoken.
|
||||
7. **Emphasis/pauses**: commas and em-dashes, never caps. Ellipses are
|
||||
unreliable in TTS — use an em-dash.
|
||||
|
||||
The shared vocabulary lives in `references/lexicon.json`
|
||||
(`display → spoken`). Consult it for EVERY technical term; if a term is
|
||||
missing, ask the user for the pronunciation and add the entry — never guess,
|
||||
never ship unheard. New entries: listen to that line in the generated VO
|
||||
before accepting.
|
||||
|
||||
## Alignment (spoken timestamps → display captions)
|
||||
|
||||
`heygen-tts.mjs --words` returns word timestamps of the SPOKEN text.
|
||||
`scripts/align-captions.mjs` walks the spoken stream against the token lines
|
||||
(one display token may cover several spoken words — "C L I" is three) and
|
||||
emits `captions.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"lines": [
|
||||
{
|
||||
"end": 3.1,
|
||||
"w": [
|
||||
["This", 0.22],
|
||||
["week", 0.4],
|
||||
["JSON", 1.1]
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Each display word carries the start time of its FIRST spoken word; a line's
|
||||
`end` = the next line's start (last line: last word end + 0.6). The aligner
|
||||
warns `MISMATCH` when the heard word doesn't fuzzy-match the expected spoken
|
||||
form — every warning must be resolved (fix the lexicon spelling or the
|
||||
transcript) before the captions are trusted.
|
||||
|
||||
## Caption rail (rendering)
|
||||
|
||||
Per `captions-overlay`: a quiet OVERLAY, never a reserved band. One line,
|
||||
bottom-center (top: 1002px on 1080-square), TT Norms Pro 500 25px,
|
||||
ink .92, soft dark text-shadow, words fading in (0.12s) on their timestamps,
|
||||
phrase swaps as sets. Keep critical small text out of the bottom ~80px
|
||||
center span; everything else may run under the rail.
|
||||
@@ -0,0 +1,48 @@
|
||||
# Visualization Registry
|
||||
|
||||
The routing table for "show, don't tell". Classes, strongest first:
|
||||
|
||||
1. **ui-recreate** — the change lives in a surface we can faithfully mock.
|
||||
2. **ui-analog** — no exact surface, but an honest UI metaphor exists
|
||||
(panel, meter, pipeline) whose behavior IS the change.
|
||||
3. **terminal** — the change is a CLI command/flag; type it, show the result.
|
||||
4. **checklist** — non-visual (fix lists, dependency bumps). Last resort.
|
||||
|
||||
Never invent UI that implies a screen that doesn't exist — an analog must
|
||||
depict the _behavior_ (speed, batching, caching), not a fake product page.
|
||||
|
||||
## Known surfaces (ui-recreate)
|
||||
|
||||
| Surface | Mock anatomy | Proven choreography |
|
||||
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| **Studio editor / timeline** | glass app frame: titlebar (traffic dots, mono app name, Export pill), preview strip w/ gradient art, ruler + ticks, lanes, playhead, mono-labeled clips | clips drop/stack into lanes; drag→edge/playhead snap w/ green snap-line flash; marquee → group move → group resize; playhead scrub drives preview art (hue-rotate) |
|
||||
| **Inspector / design panel** | panel: MONO section headers (INSPECTOR / VARIABLES), key-value rows, hairline dividers, dashed empty slot | binding pill (`{{ var }}`) flies into a property slot; value swap via masked slide (old up-out, new up-in); selection box draws on canvas |
|
||||
| **Canvas + element** | mini stage card, dashed selection box, live text element | text updates same-frame with panel edits (green underline pulse = the live-preview moment) |
|
||||
| **Variant renders** | small cards: display-font title + mono filename | cascade out diagonally, stagger ≤0.15s |
|
||||
| **Storyboard view** | row of scene thumbnails w/ mono scene labels | thumbnails file in as a waterfall; one gets dragged to reorder |
|
||||
| **Terminal / CLI** | glass strip, mono 19-20px, `$ ` prompt dim | chars type (stagger .02), result line lands after a 0.3-0.5s beat |
|
||||
| **Render panel** | RENDER header, big tabular-nums frame counter, progress bar (green fill = the moment), status chips | bar + counter run with `power2.in` (slow→fast reads as "faster"); chips land on their VO words |
|
||||
|
||||
## Proven analogs (ui-analog)
|
||||
|
||||
| Change type | Analog | Behavior |
|
||||
| -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------- |
|
||||
| Color grading / LUT | slider rows (label + track + knob) beside footage art | each knob move re-filters the art SAME frame (causal) |
|
||||
| Render/extraction speed | render panel counter + bar | ease tells the story; add a before/after time chip if the claim is numeric |
|
||||
| Batching (frames, requests) | row of small ticks | brackets draw around groups; ticks nudge into clusters |
|
||||
| Caching | two identical request rows | first row runs a full bar; second short-circuits instantly to ✓ with a `cache` chip |
|
||||
| Import/translation pipelines (e.g. Figma→HF) | source artifact card morphs/docks into a HF comp card — a pure DOM/CSS mock of the source (NO Figma API, no tokens, nothing fetched) | staged: source card → arrow/flight of extracted chips (tokens, components, motion) → assembled comp; chips are the carriers |
|
||||
| One-pass / dedupe | N parallel item rows collapse onto one shared lane | rows glide onto one bar; count chip decrements |
|
||||
| Concurrency caps / locks | queue of chips entering a gate | first k pass, rest hold; gate chip shows the cap |
|
||||
| Error surfacing (toast, reason) | the surface's corner grows a toast card | action fails subtly → toast slides in, mono reason text |
|
||||
|
||||
## Checklist scene (last resort)
|
||||
|
||||
Glass card, ≤6 mono rows, green ✓ ticks landing on each item's VO word
|
||||
(back.out(1.5), 0.3s) + row brightness pulse. Items beyond 6: cut, they live
|
||||
in the digest link.
|
||||
|
||||
## Adding a surface
|
||||
|
||||
When a new UI area ships, add a row here (anatomy + choreography) the first
|
||||
time it's mocked, so the next changelog reuses it instead of re-deriving it.
|
||||
@@ -0,0 +1,127 @@
|
||||
#!/usr/bin/env node
|
||||
// align-captions.mjs — map SPOKEN-layer word timestamps back onto DISPLAY tokens.
|
||||
//
|
||||
// node align-captions.mjs --tokens script-tokens.json --words vo-words.json \
|
||||
// --out captions.json [--tail 0.6]
|
||||
//
|
||||
// tokens: { lines: [{ id, tokens: [ "word" | {display, spoken} ] }] }
|
||||
// words: [ { text, start, end } ] — timestamps of the spoken text (heygen-tts --words)
|
||||
// out: { lines: [{ id, end, w: [[display, start], ...] }] } — caption-rail input
|
||||
//
|
||||
// Each display token consumes the spoken words of its `spoken` form (one display
|
||||
// token may be several spoken words: "C L I" = 3). The display word's time = its
|
||||
// FIRST spoken word's start. Line end = next line's first word start (last line:
|
||||
// last spoken end + tail). Fuzzy matching absorbs TTS/timestamp quirks; anything
|
||||
// it can't absorb prints MISMATCH — resolve every one before trusting captions.
|
||||
|
||||
import { readFileSync, writeFileSync } from "node:fs";
|
||||
|
||||
const argv = process.argv.slice(2);
|
||||
const flag = (n, d) => {
|
||||
const i = argv.indexOf("--" + n);
|
||||
return i >= 0 ? argv[i + 1] : d;
|
||||
};
|
||||
const die = (m) => {
|
||||
console.error("align-captions:", m);
|
||||
process.exit(2);
|
||||
};
|
||||
|
||||
const tokensFile = flag("tokens", null) ?? die("--tokens required");
|
||||
const wordsFile = flag("words", null) ?? die("--words required");
|
||||
const outFile = flag("out", "captions.json");
|
||||
const tail = parseFloat(flag("tail", "0.6"));
|
||||
|
||||
const script = JSON.parse(readFileSync(tokensFile, "utf8"));
|
||||
const stream = JSON.parse(readFileSync(wordsFile, "utf8"));
|
||||
if (!script.lines?.length) die("tokens file has no lines[]");
|
||||
if (!stream.length) die("words file is empty");
|
||||
|
||||
const norm = (s) => s.toLowerCase().replace(/[^a-z0-9]/g, "");
|
||||
const lev = (a, b) => {
|
||||
if (a === b) return 0;
|
||||
const m = a.length,
|
||||
n = b.length;
|
||||
if (!m || !n) return Math.max(m, n);
|
||||
let prev = Array.from({ length: n + 1 }, (_, j) => j);
|
||||
for (let i = 1; i <= m; i++) {
|
||||
const cur = [i];
|
||||
for (let j = 1; j <= n; j++)
|
||||
cur[j] = Math.min(prev[j] + 1, cur[j - 1] + 1, prev[j - 1] + (a[i - 1] === b[j - 1] ? 0 : 1));
|
||||
prev = cur;
|
||||
}
|
||||
return prev[n];
|
||||
};
|
||||
const close = (a, b) => {
|
||||
if (!a || !b) return false;
|
||||
if (a === b || a.startsWith(b) || b.startsWith(a)) return true;
|
||||
return lev(a, b) <= Math.max(1, Math.floor(Math.min(a.length, b.length) / 3));
|
||||
};
|
||||
|
||||
let si = 0; // stream cursor
|
||||
let mismatches = 0;
|
||||
const outLines = [];
|
||||
|
||||
// Greedily consume stream words from `from` whose concatenated norm builds the
|
||||
// token's full spoken norm ("hey-jen" may arrive as one word or several; "C L I"
|
||||
// as three). Returns { start, next } or null.
|
||||
function consume(from, spokenNorm) {
|
||||
let acc = "",
|
||||
start = null,
|
||||
k = from;
|
||||
while (k < stream.length) {
|
||||
const wn = norm(stream[k].text);
|
||||
if (!wn) {
|
||||
k++;
|
||||
continue;
|
||||
}
|
||||
const cand = acc + wn;
|
||||
if (spokenNorm.startsWith(cand) || close(cand, spokenNorm)) {
|
||||
if (start === null) start = stream[k].start;
|
||||
acc = cand;
|
||||
k++;
|
||||
if (close(acc, spokenNorm)) return { start, next: k };
|
||||
continue;
|
||||
}
|
||||
break;
|
||||
}
|
||||
return acc && close(acc, spokenNorm) ? { start, next: k } : null;
|
||||
}
|
||||
|
||||
for (const line of script.lines) {
|
||||
const w = [];
|
||||
for (const tok of line.tokens) {
|
||||
const display = typeof tok === "string" ? tok : tok.display;
|
||||
const spoken = typeof tok === "string" ? tok : tok.spoken;
|
||||
const spokenNorm = norm(spoken);
|
||||
if (!spokenNorm) {
|
||||
w.push([display, si < stream.length ? stream[si].start : 0]);
|
||||
continue;
|
||||
}
|
||||
// try at the cursor, then resync up to 4 words ahead
|
||||
let hit = null;
|
||||
for (let off = 0; off <= 4 && !hit; off++) hit = consume(si + off, spokenNorm);
|
||||
if (!hit) {
|
||||
console.error(
|
||||
`MISMATCH line=${line.id} display="${display}" expected~"${spoken}" heard="${stream[si]?.text ?? "<eof>"}" @${stream[si]?.start?.toFixed(2) ?? "?"}s`,
|
||||
);
|
||||
mismatches++;
|
||||
w.push([display, si < stream.length ? stream[si].start : stream.at(-1).end]);
|
||||
continue;
|
||||
}
|
||||
si = hit.next;
|
||||
w.push([display, +hit.start.toFixed(2)]);
|
||||
}
|
||||
outLines.push({ id: line.id, w });
|
||||
}
|
||||
|
||||
for (let i = 0; i < outLines.length; i++) {
|
||||
outLines[i].end =
|
||||
i + 1 < outLines.length ? outLines[i + 1].w[0][1] : +(stream.at(-1).end + tail).toFixed(2);
|
||||
}
|
||||
|
||||
writeFileSync(outFile, JSON.stringify({ lines: outLines }, null, 1));
|
||||
const status = mismatches ? `${mismatches} MISMATCH(ES) — resolve before building` : "clean";
|
||||
console.log(
|
||||
`aligned ${outLines.length} lines / ${stream.length} spoken words → ${outFile} (${status})`,
|
||||
);
|
||||
process.exit(mismatches ? 1 : 0);
|
||||
Reference in New Issue
Block a user