插件安装: 在执行设置或刷新命令之前,请遵循插件执行规则(当此项技能位于 HyperFrames 插件内部时)。独立安装则按照下面的更新说明操作。
HyperFrames 核心
Agent 陷阱(先阅读):
- 使用 flex/
inset居中,而不是在节点上使用 CSStransform: translate(-50%,-50%)后再用 GSAP 操控x/y。 lint 检查:gsap_css_transform_conflict。请改用fromTo或xPercent/yPercent。 - 不要添加场景退出的
tl.set(..., {visibility:"hidden"})。运行时已经隐藏了计时剪辑。内部节点的透明度淡入(或.clip上的opacity)就足够了。字幕硬性移除是另一条规则。 window.__timelines["id"]必须与根元素的data-composition-id匹配。- 在
render之后,阅读摘要的第二行:beginframe与screenshot、GPU 模式、阶段计时。Linux 上的screenshot+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 回读中。没有豁免。 - 永远不要给
<video data-start>一个同样带有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>或包装器内部)查找并解码它们。一个硬性限制:lint会在<video data-start>位于另一个也带有data-start的普通元素内部时报错,并且失败是真实的(错误的源帧,然后剪辑在中间消失),因此请将时间放在包装器或视频上,永远不要放在两者上。子合成宿主是例外的:子合成内部的媒体可以正确渲染。另一个注意事项是时间线,而不是位置:子合成时间线不能动画宿主根元素。→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通过(0 个发现,涵盖 lint、运行时、布局、运动和对比度) - 带有子合成的项目:
npx hyperframes snapshot --at <midpoints>并目视检查每一帧 - 为了评审,
npx hyperframes preview --background(用户可以在 Studio 时间线上编辑任何内容,服务器在调用命令后保持运行) - 仅在用户批准后,才
npx hyperframes render