插件安装: 在执行设置或更新命令前,如果此技能位于HyperFrames插件内部,请遵循插件执行规则。独立安装则保留下方更新说明。
HyperFrames 核心
AI agent 注意事项(先阅读):
- 使用 flex/
inset居中,而非在节点上使用 CSStransform: translate(-50%,-50%)后再对该节点进行 GSAPx/y动画。Lint 检查:gsap_css_transform_conflict。使用fromTo或xPercent/yPercent。 - 不要添加场景退出的
tl.set(..., {visibility:"hidden"})。运行时已自动隐藏定时片段。在内层节点(或.clip上的opacity)进行透明淡出即可。字幕硬关闭是另一条规则。 window.__timelines["id"]必须与根元素的data-composition-id匹配。- 在
render后,读取摘要的第二行:beginframevsscreenshot、GPU 模式、阶段时间。screenshot+ Linux 上的software gpu是慢路径。
HyperFrames 从 HTML 渲染视频。合成是一个 HTML 文件,其 DOM 通过 data-* 属性声明时间,动画运行时是可寻帧的,媒体播放由框架拥有。
此技能是技术契约——如何构建一个 HyperFrames 项目。以下内容是构建指南;各主题详情位于 references/(参考索引在下一个目录),按需阅读。流程文档(简报、故事板、评审、制作、分发、帧工单)位于 /hyperframes → references/。其他关注点位于同级的领域技能中——hyperframes-animation、hyperframes-creative、media-use、hyperframes-cli、hyperframes-registry。/hyperframes 中的能力映射说明了每个技能覆盖的范围。
参考文档
| 文件 | 阅读目的 |
|---|---|
references/minimal-composition.md | 从最小的可渲染合成骨架开始 |
references/composition-patterns.md | 选择单体 vs 模块化;构建模块化 index.html;选择子合成原型 |
references/data-attributes.md | 查询任何 data-* 属性(根 / 片段 / 子合成宿主 / 遗留别名);使用 class="clip" |
references/tracks-and-clips.md | 理解 data-track-index 控制(以及不控制)的内容、z-index、相对另一个片段的时间设置;使用 npx hyperframes timeline 列出所有轨道和片段 |
references/creator-editing-recipes.md | 复制真实的剪切/裁剪/重排序/重定时/冻结/摄像机/遮罩/交叉淡入淡出/音频编辑配方及其限制 |
references/sub-compositions.md | 连接子合成(宿主属性、<template>、每实例变量)并在其内部进行动画 |
references/variables-and-media.md | 声明变量;放置 <video>/<audio>、设置音量、修剪 |
references/determinism-rules.md | 构建可寻帧时间线;确定性禁止项;布局/文本适配 |
references/full-screen-motion.md | 使用共享背景制作全帧运动动画 |
references/tailwind.md | 在 Tailwind v4 项目中工作(init --tailwind;运行时契约与 Studio 的 v3 不同) |
关于动画运行时细节(GSAP API、Lottie、Three.js 等),请前往 hyperframes-animation → adapters/<runtime>.md。
构建合成
两种根形式(不可互换)
- 独立合成(顶层
index.html):根<div data-composition-id="…">直接位于<body>中,没有<template>包装。包装独立合成的根会隐藏所有内容,且lint会拒绝(standalone_composition_wrapped_in_template,错误)。 - 子合成(通过
data-composition-src加载):将根包装在<template>中。这是推荐编写的形式:加载器也接受纯完整文档并回退到其<body>,但模板形式是示例和工具所假设的。
⚠ 传输规则:对于模板化的子合成,组装器会丢弃文件自身的
<head>中的<style>/<script>(位于packages/core/src/compiler/compositionAssembly.ts,hasTemplate门控),因此请将<style>/<script>放在模板内部。<link>无论如何都会被提升。 ⚠ 宿主 ID 约定:给宿主槽位、内部模板和window.__timelines["<id>"]键使用相同的 ID。支持不同的本地 ID(组装器会回退到文件中的第一个根),但不匹配是静默的,因此请匹配它们,除非你有理由不这样做。
文件结构、宿主连接及预渲染检查清单 → references/sub-compositions.md。
根必须设置尺寸(静默布局错误)
独立合成的根设置 width/height: 100%。画布尺寸为 data-width/data-height。运行时会将这些像素值应用到合成根上。不要在 #root 上硬编码 1920px/1080px。骨架 → references/minimal-composition.md。
一个暂停的时间线
每个合成注册恰好一个 gsap.timeline({ paused: true }) 在 window.__timelines["<id>"](键 = 根的 data-composition-id)。在异步回调(document.fonts.ready)内部构建它是支持的;重要的是你仅在构建完成后注册。渲染长度是根的 data-duration,而不是时间线的长度:超过该长度的时间线会被截断,提前结束的时间线会保持其最后一帧。省略根的 data-duration 则长度改为推断(来自时间线、媒体窗口或适配器)。你不需要 window.__timelines = window.__timelines || {}:运行时会先于你的内联脚本创建注册表,且 lint 不再要求它。不要手动将子时间线嵌套到宿主中;运行时会自动嵌套注册的子时间线。完整契约(包括非 GSAP 运行时) → references/determinism-rules.md + hyperframes-animation/adapters/。
首轮 lint 陷阱(保证第一次构建失败)
lint 确实会捕获的规则,但仅在事后。第一次就正确编写:
- 永远不要将 CSS 初始
transform与 GSAP 在相同属性上的补间动画配对——CSS 值和补间的起始值会冲突,lint会以gsap_css_transform_conflict拒绝。使用gsap.fromTo(el, { x: -40 }, { x: 0 })在补间内设置初始状态,而不是使用 CSStransform: translateX(-40px)。 - 永远不要在
<video>/<audio>上放置crossorigin。lint无条件拒绝media_crossorigin_breaks_preview(错误),包括用于 canvas/WebGL/WebAudio 读回。没有替代方法。 - 永远不要给带有
data-start的<video>一个也带有data-start的祖先元素。lint会以video_nested_in_timed_element(错误)拒绝。对包装器或视频设置时间,而不是两者都设。 - 每个
<audio>都需要一个id。lint会以media_missing_id拒绝,且没有 ID 的<audio>永远不会被混音器拾取,因此渲染是静默的。 - 永远不要用
autoAlpha或visibility对.clip进行补间动画——lint会以gsap_animates_clip_element拒绝。改为对子元素进行动画。 - 命名的 CSS
font-family需要在文件中包含一个指向已提供本地文件的@font-face,否则lint会触发font_family_without_font_face。 - 子合成的
#root使用width/height: 100%(或inset: 0),而不是硬编码的1920px/1080px。画布尺寸为data-width/data-height。
lint 错误还会关闭布局和对比度审核:check 随后报告 0 sample(s) 和 0/0 text checks,这看起来像干净的输出,但实际上意味着没有任何检查运行。在信任这些数字之前,先清除 lint 错误。
不可协商的规则(自动化门控可能遗漏的静默错误)
在此列出;完整理由在链接的参考文档中。请勿违反:
- 禁止运行时时钟 / 未播种的
Math.random/ 网络 / 输入状态;repeat: -1仅在有有限的根data-duration下允许(导出片段会截断它——否则使用有限计数)。 →determinism-rules.md - 永远不要在
.clip元素上补间display、visibility或autoAlpha。框架拥有片段可见性,lint会拒绝(gsap_animates_clip_element)。改为动画子元素。 →determinism-rules.md - 正文中不能有
<br>;被变换的元素必须是块级且设置尺寸;脉动的绝对定位装饰元素需要峰值间隔。 →determinism-rules.md <video>/<audio>通过平面文档查询找到,因此框架在任何嵌套深度(包括在子合成<template>或包装器内部)都能寻址和解码。一个硬限制:如果<video data-start>位于另一个也带有data-start的普通元素内部,lint会报错,且失败是真实的(源帧错误,然后片段在槽位中间消失),因此将时间设置在包装器或视频上,但永远不要同时设置。子合成宿主是例外:子合成内部的媒体能正确渲染。另一个注意事项是时间线,而非位置:子合成时间线不能动画宿主根元素。 →variables-and-media.md- 确保每个
id在组装后的页面中保持唯一(用组合 ID 前缀子合成 ID,如#<id>-hero),以便你自己的#idCSS 和getElementById调用能正确解析。帧注入不再依赖于此:编译器会在每个video[src]/audio[src]/img[src]上打上文档唯一的data-hf-render-id。使用<source>子元素而不是src属性的媒体不会被打上标记,因此唯一 ID 在那里仍然重要。 →composition-patterns.md - 在常规渲染中,对合成根进行全屏填充是可以的。它只有在分层合成路径(HDR 内容,或使用着色器转场的合成)上才会被丢弃,此时引擎强制每个合成根透明,以便底层显示出来。如果你的合成使用着色器转场或 HDR 媒体,请将填充放在一个全出血的子元素上(
position:absolute; inset:0)。 →composition-patterns.md
编辑现有合成
- 先阅读文件。保留不相关的时间、轨道、ID、变量、媒体路径。
- 要了解项目时间线上的内容(轨道、片段、开始、结束、播放内容),运行
npx hyperframes timeline [--json]而不是读取index.html和每个子合成文件。 - 匹配现有合成 ID 和时间线键。
- 添加片段:根据周围片段有意识地设置其
data-start/data-duration。data-track-index是 Studio 的显示通道,不是时间约束,因此不需要空闲。 - 超过根
data-duration的片段会被截断:在同一编辑中将根data-duration扩展到片段结束(lint会警告clip_ends_past_root_duration)。 - 任何合成元素上的
data-hidden会在预览和渲染中同时隐藏它,覆盖其时间窗口;它是非破坏性/可逆的,由 Studio 的时间线眼睛图标切换。 - 添加子合成:在连接宿主之前验证其内部
data-composition-id。
验证
使用 hyperframes-cli 获取命令详情
-
npx hyperframes check通过(lint、运行时、布局、动效和对比度 0 结果) - 包含子合成的项目:
npx hyperframes snapshot --at <midpoints>并目视检查每一帧 - 用于评审的
npx hyperframes preview --background(用户可以在 Studio 时间线中编辑任何内容,服务器在运行命令期间持续存在) - 仅在用户批准后才执行
npx hyperframes render