85453da49f
regression / regression-shards (style-16-prod style-9-prod style-17-prod iframe-render-compat variables-prod mp4-h265-sdr, shard-4) (push) Has been cancelled
regression / regression-shards (style-4-prod style-11-prod style-2-prod animejs-adapter typegpu-adapter parallel-capture-regression, shard-5) (push) Has been cancelled
regression / regression-shards (style-7-prod style-8-prod style-10-prod css-spinner-render-compat webm-transparency mp4-h264-sdr webm-vp9, shard-3) (push) Has been cancelled
regression / regression-shards (sub-composition-video style-18-prod raf-ball-render-compat font-variant-numeric sub-comp-t0 sub-comp-id-selector, shard-7) (push) Has been cancelled
Windows render verification / Detect changes (push) Has been cancelled
Windows render verification / Preflight (lint + format) (push) Has been cancelled
Windows render verification / Render on windows-latest (push) Has been cancelled
Windows render verification / Tests on windows-latest (push) Has been cancelled
CI / Detect changes (push) Has been cancelled
CI / Build (push) Has been cancelled
CI / Lint (push) Has been cancelled
CI / Fallow audit (push) Has been cancelled
CI / Format (push) Has been cancelled
CI / Typecheck (push) Has been cancelled
CI / Test (push) Has been cancelled
CI / Producer: integration tests (push) Has been cancelled
CI / Producer: unit tests (push) Has been cancelled
CI / File size check (push) Has been cancelled
CI / Test: skills (push) Has been cancelled
CI / Skills: manifest in sync (push) Has been cancelled
CI / CLI: npx shim (macos-latest) (push) Has been cancelled
CI / CLI: npx shim (ubuntu-latest) (push) Has been cancelled
CI / CLI: npx shim (windows-latest) (push) Has been cancelled
CI / SDK: unit + contract + smoke (push) Has been cancelled
CI / Test: runtime contract (push) Has been cancelled
CI / Studio: load smoke (push) Has been cancelled
CI / Smoke: global install (push) Has been cancelled
CI / CLI smoke (required) (push) Has been cancelled
CI / Semantic PR title (push) Has been cancelled
Player perf / Detect changes (push) Has been cancelled
Player perf / Preflight (lint + format) (push) Has been cancelled
Player perf / player-perf (push) Has been cancelled
Player perf / Perf: drift (push) Has been cancelled
Player perf / Perf: fps (push) Has been cancelled
Player perf / Perf: parity (push) Has been cancelled
Player perf / Perf: scrub (push) Has been cancelled
Player perf / Perf: load (push) Has been cancelled
preview-regression / Detect changes (push) Has been cancelled
preview-regression / Preflight (lint + format) (push) Has been cancelled
preview-regression / Preview parity (push) Has been cancelled
preview-regression / preview-regression (push) Has been cancelled
regression / regression (push) Has been cancelled
regression / Detect changes (push) Has been cancelled
regression / Preflight (lint + format) (push) Has been cancelled
regression / regression-shards (hdr-regression style-5-prod style-3-prod mov-prores, shard-1) (push) Has been cancelled
regression / regression-shards (overlay-montage-prod style-12-prod chat missing-host-comp-id png-sequence portrait-edge-bleed, shard-6) (push) Has been cancelled
regression / regression-shards (style-13-prod style-6-prod vignelli-stacking gsap-letters-render-compat audio-mux-parity, shard-8) (push) Has been cancelled
regression / regression-shards (style-15-prod hdr-hlg-regression style-1-prod many-cuts vfr-screen-recording render-symlinked-assets, shard-2) (push) Has been cancelled
CodeQL / Analyze (actions) (push) Has been cancelled
CodeQL / Analyze (javascript-typescript) (push) Has been cancelled
CodeQL / Analyze (python) (push) Has been cancelled
Docs / Validate docs (push) Has been cancelled
Sync skills to ClawHub / Publish changed skills (push) Has been cancelled
418 lines
11 KiB
Markdown
418 lines
11 KiB
Markdown
# Contribute Templates
|
|
|
|
Copy-paste starter templates for each component type. These embed the proven patterns that pass lint and validate.
|
|
|
|
## Caption Template
|
|
|
|
```html
|
|
<!doctype html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<link
|
|
href="https://fonts.googleapis.com/css2?family=Montserrat:wght@800;900&display=swap"
|
|
rel="stylesheet"
|
|
/>
|
|
<script src="https://cdn.jsdelivr.net/npm/gsap@3.14.2/dist/gsap.min.js"></script>
|
|
<style>
|
|
*,
|
|
*::before,
|
|
*::after {
|
|
margin: 0;
|
|
padding: 0;
|
|
box-sizing: border-box;
|
|
}
|
|
body {
|
|
background: #111;
|
|
overflow: hidden;
|
|
}
|
|
#root-BLOCKNAME {
|
|
position: relative;
|
|
width: 1920px;
|
|
height: 1080px;
|
|
overflow: hidden;
|
|
background: #111;
|
|
}
|
|
.cap-container {
|
|
position: absolute;
|
|
top: 0;
|
|
left: 0;
|
|
width: 100%;
|
|
height: 100%;
|
|
display: flex;
|
|
align-items: center;
|
|
justify-content: center;
|
|
}
|
|
.cg {
|
|
position: absolute;
|
|
display: flex;
|
|
align-items: center;
|
|
justify-content: center;
|
|
gap: 32px;
|
|
max-width: 1700px;
|
|
overflow: visible;
|
|
opacity: 0;
|
|
visibility: hidden;
|
|
}
|
|
.cw {
|
|
font-family: "Montserrat", sans-serif;
|
|
font-weight: 900;
|
|
font-size: 128px;
|
|
color: #ffffff;
|
|
text-transform: uppercase;
|
|
line-height: 1;
|
|
display: inline-block;
|
|
-webkit-text-stroke: 3px rgba(0, 0, 0, 0.8);
|
|
paint-order: stroke fill;
|
|
text-shadow: 0 4px 12px rgba(0, 0, 0, 0.5);
|
|
}
|
|
</style>
|
|
</head>
|
|
<body>
|
|
<div
|
|
id="root-BLOCKNAME"
|
|
data-composition-id="BLOCKNAME"
|
|
data-start="0"
|
|
data-duration="9"
|
|
data-width="1920"
|
|
data-height="1080"
|
|
>
|
|
<div class="cap-container" id="cc-BLOCKNAME"></div>
|
|
<div
|
|
id="drv-BLOCKNAME"
|
|
class="clip"
|
|
data-start="0"
|
|
data-duration="9"
|
|
data-track-index="0"
|
|
style="position:absolute;width:1px;height:1px;opacity:0;pointer-events:none"
|
|
></div>
|
|
</div>
|
|
<script>
|
|
(function () {
|
|
window.__timelines = window.__timelines || {};
|
|
|
|
// REPLACE with actual transcript data
|
|
var WORDS = [
|
|
{ text: "Welcome", start: 0.3, end: 0.65 },
|
|
{ text: "to", start: 0.65, end: 0.8 },
|
|
{ text: "the", start: 0.8, end: 0.95 },
|
|
{ text: "future", start: 0.95, end: 1.4 },
|
|
// ... add all words
|
|
];
|
|
|
|
var GROUPS = [
|
|
{ start: 0.3, end: 1.3, wordStart: 0, wordEnd: 3, text: "Welcome to the future" },
|
|
// ... add all groups
|
|
];
|
|
|
|
var container = document.getElementById("cc-BLOCKNAME");
|
|
|
|
GROUPS.forEach(function (g, gi) {
|
|
var groupEl = document.createElement("div");
|
|
groupEl.id = "PREFIX-cg-" + gi;
|
|
groupEl.className = "cg";
|
|
|
|
for (var wi = g.wordStart; wi <= g.wordEnd; wi++) {
|
|
var wordEl = document.createElement("span");
|
|
wordEl.id = "PREFIX-cw-" + wi;
|
|
wordEl.className = "cw";
|
|
wordEl.textContent = WORDS[wi].text;
|
|
groupEl.appendChild(wordEl);
|
|
}
|
|
|
|
// Pretext overflow prevention
|
|
if (window.__hyperframes && window.__hyperframes.fitTextFontSize) {
|
|
var _fit = window.__hyperframes.fitTextFontSize(g.text.toUpperCase(), {
|
|
fontFamily: "Montserrat",
|
|
fontWeight: 900,
|
|
maxWidth: 1550,
|
|
baseFontSize: 128,
|
|
minFontSize: 48,
|
|
});
|
|
if (_fit.fontSize < 128) {
|
|
for (var _fi = 0; _fi < groupEl.children.length; _fi++) {
|
|
groupEl.children[_fi].style.fontSize = _fit.fontSize + "px";
|
|
}
|
|
}
|
|
}
|
|
container.appendChild(groupEl);
|
|
});
|
|
|
|
var tl = gsap.timeline({ paused: true });
|
|
|
|
GROUPS.forEach(function (g, gi) {
|
|
var groupEl = document.getElementById("PREFIX-cg-" + gi);
|
|
|
|
// SHOW — set opacity to 1 (never use tl.from with opacity:0 here)
|
|
tl.set(groupEl, { opacity: 1, visibility: "visible" }, g.start);
|
|
|
|
// ENTRANCE — customize this per style
|
|
tl.from(groupEl, { scale: 1.3, duration: 0.15, ease: "back.out(2)" }, g.start);
|
|
|
|
// KARAOKE — highlight each word
|
|
for (var wi = g.wordStart; wi <= g.wordEnd; wi++) {
|
|
var wordEl = document.getElementById("PREFIX-cw-" + wi);
|
|
tl.to(wordEl, { color: "#FFD700", scale: 1.1, duration: 0.06 }, WORDS[wi].start);
|
|
tl.to(wordEl, { color: "#FFFFFF", scale: 1, duration: 0.08 }, WORDS[wi].end);
|
|
}
|
|
|
|
// EXIT
|
|
tl.to(groupEl, { opacity: 0, scale: 0.9, duration: 0.1 }, g.end - 0.1);
|
|
|
|
// HARD KILL (mandatory)
|
|
tl.set(groupEl, { opacity: 0, visibility: "hidden" }, g.end);
|
|
});
|
|
|
|
window.__timelines["BLOCKNAME"] = tl;
|
|
})();
|
|
</script>
|
|
</body>
|
|
</html>
|
|
```
|
|
|
|
**Replace checklist:**
|
|
|
|
- `BLOCKNAME` → your block name (e.g., `cap-swoosh`)
|
|
- `PREFIX` → short unique prefix for IDs (e.g., `sw`)
|
|
- Font family, weight, size → your style's typography
|
|
- Entrance animation → your style's entrance
|
|
- Karaoke highlight → your style's active word treatment
|
|
- Colors → your style's palette
|
|
|
|
---
|
|
|
|
## VFX Template
|
|
|
|
```html
|
|
<!doctype html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<script src="https://cdn.jsdelivr.net/npm/gsap@3.14.2/dist/gsap.min.js"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/three@0.147.0/build/three.min.js"></script>
|
|
<style>
|
|
*,
|
|
*::before,
|
|
*::after {
|
|
margin: 0;
|
|
padding: 0;
|
|
box-sizing: border-box;
|
|
}
|
|
body {
|
|
background: #030308;
|
|
overflow: hidden;
|
|
}
|
|
#root-BLOCKNAME {
|
|
position: relative;
|
|
width: 1920px;
|
|
height: 1080px;
|
|
overflow: hidden;
|
|
background: #030308;
|
|
}
|
|
#canvas-BLOCKNAME {
|
|
position: absolute;
|
|
top: 0;
|
|
left: 0;
|
|
width: 1920px;
|
|
height: 1080px;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body>
|
|
<div
|
|
id="root-BLOCKNAME"
|
|
data-composition-id="BLOCKNAME"
|
|
data-start="0"
|
|
data-duration="10"
|
|
data-width="1920"
|
|
data-height="1080"
|
|
>
|
|
<canvas id="canvas-BLOCKNAME" width="1920" height="1080"></canvas>
|
|
<div
|
|
id="drv-BLOCKNAME"
|
|
class="clip"
|
|
data-start="0"
|
|
data-duration="10"
|
|
data-track-index="0"
|
|
style="position:absolute;width:1px;height:1px;opacity:0;pointer-events:none"
|
|
></div>
|
|
</div>
|
|
<script>
|
|
(function () {
|
|
window.__timelines = window.__timelines || {};
|
|
|
|
// Seeded PRNG — NEVER use Math.random()
|
|
function mulberry32(a) {
|
|
return function () {
|
|
a |= 0;
|
|
a = (a + 0x6d2b79f5) | 0;
|
|
var t = Math.imul(a ^ (a >>> 15), 1 | a);
|
|
t = (t + Math.imul(t ^ (t >>> 7), 61 | t)) ^ t;
|
|
return ((t ^ (t >>> 14)) >>> 0) / 4294967296;
|
|
};
|
|
}
|
|
var rng = mulberry32(42);
|
|
|
|
var W = 1920,
|
|
H = 1080;
|
|
var canvas = document.getElementById("canvas-BLOCKNAME");
|
|
var renderer = new THREE.WebGLRenderer({ canvas: canvas, antialias: true });
|
|
renderer.setSize(W, H);
|
|
renderer.setPixelRatio(1);
|
|
renderer.toneMapping = THREE.ACESFilmicToneMapping;
|
|
renderer.toneMappingExposure = 1.1;
|
|
|
|
var scene = new THREE.Scene();
|
|
scene.background = new THREE.Color(0x030308);
|
|
var camera = new THREE.PerspectiveCamera(50, W / H, 0.1, 100);
|
|
camera.position.set(0, 0, 8);
|
|
|
|
// YOUR SCENE SETUP HERE
|
|
// - lights
|
|
// - geometry
|
|
// - materials
|
|
|
|
// State proxy — GSAP animates this, render reads it
|
|
var st = {
|
|
rotY: 0,
|
|
camZ: 8,
|
|
// add your animated properties
|
|
};
|
|
|
|
var tl = gsap.timeline({ paused: true });
|
|
|
|
// YOUR TWEENS HERE
|
|
tl.to(st, { rotY: Math.PI * 2, duration: 10, ease: "none" }, 0);
|
|
|
|
window.__timelines["BLOCKNAME"] = tl;
|
|
|
|
function renderScene() {
|
|
// Apply state to Three.js objects
|
|
camera.position.z = st.camZ;
|
|
// mesh.rotation.y = st.rotY;
|
|
|
|
renderer.render(scene, camera);
|
|
}
|
|
|
|
// Render via onUpdate — NO requestAnimationFrame
|
|
tl.eventCallback("onUpdate", renderScene);
|
|
renderScene();
|
|
})();
|
|
</script>
|
|
</body>
|
|
</html>
|
|
```
|
|
|
|
**Replace checklist:**
|
|
|
|
- `BLOCKNAME` → your block name (e.g., `vfx-chrome-blob`)
|
|
- Scene setup → your geometry, lights, materials
|
|
- State proxy → your animated properties
|
|
- Tweens → your animation timeline
|
|
- renderScene → apply state to your Three.js objects
|
|
|
|
---
|
|
|
|
## registry-item.json Templates
|
|
|
|
**For blocks:**
|
|
|
|
```json
|
|
{
|
|
"$schema": "https://hyperframes.heygen.com/schema/registry-item.json",
|
|
"name": "BLOCKNAME",
|
|
"type": "hyperframes:block",
|
|
"title": "Human-Readable Title",
|
|
"description": "One sentence: what it does and who uses it",
|
|
"dimensions": { "width": 1920, "height": 1080 },
|
|
"duration": 10,
|
|
"tags": ["category", "subcategory"],
|
|
"files": [
|
|
{
|
|
"path": "BLOCKNAME.html",
|
|
"target": "compositions/BLOCKNAME.html",
|
|
"type": "hyperframes:composition"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
**For components** (no `dimensions` or `duration`):
|
|
|
|
```json
|
|
{
|
|
"$schema": "https://hyperframes.heygen.com/schema/registry-item.json",
|
|
"name": "COMPONENTNAME",
|
|
"type": "hyperframes:component",
|
|
"title": "Human-Readable Title",
|
|
"description": "One sentence: what it does",
|
|
"tags": ["category"],
|
|
"files": [
|
|
{
|
|
"path": "COMPONENTNAME.html",
|
|
"target": "compositions/components/COMPONENTNAME.html",
|
|
"type": "hyperframes:snippet"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
Tags by category:
|
|
|
|
- Captions: `captions`, `viral`, `professional`, `karaoke`, `minimal`
|
|
- VFX: `three-js`, `particles`, `shader`, `gpu`
|
|
- Transitions: `transition`, `shader`, `wipe`, `dissolve`
|
|
- Blocks: `lower-third`, `social`, `title-card`, `data-viz`
|
|
- Components: `effect`, `overlay`, `text-treatment`
|
|
|
|
---
|
|
|
|
## Component Template
|
|
|
|
```html
|
|
<!doctype html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<script src="https://cdn.jsdelivr.net/npm/gsap@3.14.2/dist/gsap.min.js"></script>
|
|
<style>
|
|
*,
|
|
*::before,
|
|
*::after {
|
|
margin: 0;
|
|
padding: 0;
|
|
box-sizing: border-box;
|
|
}
|
|
body {
|
|
background: transparent;
|
|
overflow: hidden;
|
|
}
|
|
.COMPNAME-wrap {
|
|
position: absolute;
|
|
inset: 0;
|
|
overflow: hidden;
|
|
pointer-events: none;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body>
|
|
<div class="COMPNAME-wrap">
|
|
<!-- Your reusable effect/overlay here -->
|
|
</div>
|
|
<script>
|
|
(function () {
|
|
// Component snippet — no data-composition-id, no __timelines.
|
|
// The parent composition controls timing.
|
|
// Keep all class names and IDs prefixed with COMPNAME.
|
|
})();
|
|
</script>
|
|
</body>
|
|
</html>
|
|
```
|
|
|
|
**Replace checklist:**
|
|
|
|
- `COMPNAME` → your component name (e.g., `shimmer-sweep`)
|
|
- Background should be `transparent` so it overlays cleanly
|
|
- No `data-composition-id` or `window.__timelines` — the parent owns timing
|