HyperFrames Registry
Die Registry stellt wiederverwendbare Blöcke und Komponenten bereit, die über hyperframes add <name> installiert werden können.
- Blöcke — eigenständige Unterkompositionen (eigene Maße, Dauer, Timeline). Einbindung via
data-composition-srcin einer Host-Komposition. - Komponenten — Effekt-Snippets (keine eigenen Maße). Werden direkt in das HTML einer Host-Komposition eingefügt.
Kurzreferenz
hyperframes add data-chart # einen Block installieren
hyperframes add grain-overlay # eine Komponente installieren
hyperframes add captions # jeden Block mit dem Tag ‚captions‘ installieren
hyperframes add shimmer-sweep --dir . # auf ein bestimmtes Projekt abzielen
hyperframes add data-chart --json # maschinenlesbare Ausgabe
hyperframes add data-chart --no-clipboard # Zwischenablage überspringen (CI/Headless)
Nach der Installation gibt die CLI aus, welche Dateien geschrieben wurden und liefert ein Snippet zum Einfügen in Ihre Host-Komposition. Das Snippet ist ein Ausgangspunkt – Sie müssen data-composition-id (muss mit der internen Kompositions-ID des Blocks übereinstimmen), data-start und data-track-index-Attribute beim Verdrahten von Blöcken hinzufügen.
Der Positionswert wird zuerst als exakter Elementname aufgelöst. Passt kein Element und der Wert ist ein Tag, installiert der Befehl jeden Block mit diesem Tag. Registry-Abhängigkeiten werden vor dem angeforderten Element installiert. hyperframes add funktioniert nur für Blöcke und Komponenten; für Beispiele verwenden Sie stattdessen hyperframes init <dir> --example <name>.
Installationsorte
Blöcke werden standardmäßig unter compositions/<name>.html installiert. Komponenten werden standardmäßig unter compositions/components/<name>.html installiert.
Diese Pfade sind in hyperframes.json konfigurierbar:
{
"registry": "https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry",
"paths": {
"blocks": "compositions",
"components": "compositions/components",
"assets": "assets"
}
}
Vollständige Details finden Sie unter install-locations.md.
Blöcke verdrahten
Blöcke sind eigenständige Kompositionen – binden Sie sie via data-composition-src in Ihre Host-index.html ein:
<div
data-composition-id="data-chart"
data-composition-src="compositions/data-chart.html"
data-start="2"
data-duration="15"
data-track-index="1"
data-width="1920"
data-height="1080"
></div>
Wichtige Attribute:
data-composition-src— Pfad zur Block-HTML-Dateidata-composition-id— muss mit der internen ID des Blocks übereinstimmendata-start— wann der Block in der Host-Timeline erscheint (Sekunden)data-duration— wie lange der Block abgespielt wirddata-width/data-height— Block-Leinwandmaßedata-track-index— Ebenen-Reihenfolge (höher = weiter vorne)
Vollständige Details finden Sie unter wiring-blocks.md.
Komponenten verdrahten
Komponenten sind Snippets – fügen Sie deren HTML in das Markup Ihrer Komposition, deren CSS in den Style-Block und deren JS (falls vorhanden) in Ihr Skript ein:
- Lesen Sie die installierte Datei (z. B.
compositions/components/grain-overlay.html) - Kopieren Sie die HTML-Elemente in Ihr
<div data-composition-id="..."> - Kopieren Sie den
<style>-Block in Ihre Kompositions-Styles - Kopieren Sie jeglichen
<script>-Inhalt in Ihr Kompositionsskript (vor Ihrem Timeline-Code) - Wenn die Komponente eine GSAP-Timeline-Integration bereitstellt (siehe Kommentarblock im Snippet), fügen Sie diese Aufrufe zu Ihrer Timeline hinzu
Vollständige Details finden Sie unter wiring-components.md.
Entdeckung
Verwenden Sie die CLI als primäre Oberfläche zur Entdeckung. Suchen Sie nach Absicht, bevor Sie browsen: Die Registry enthält mehr Elemente, als Sie mit bloßem Auge scannen können, daher ist das Auflisten und Vergleichen von Namen oder Tags ein langsamer Weg, der scheitert, sobald die Wortwahl des Autors von Ihrer abweicht.
# Den gesamten Katalog gegen das bewerten, was der Beat tun soll
npx hyperframes catalog --query "reveal a headline one line at a time"
npx hyperframes add caption-clip-wipe
Die Suche ist lokal und sendet nichts. Standardmäßig bewertet sie anhand des gemeinsamen Vokabulars mit dem Namen, Titel und der Beschreibung des Elements, findet also nur Elemente, die Ihre Wörter wiederverwenden; --on-device bewertet stattdessen nach Bedeutung, nach einem einmaligen Modell-Download. Mit --json enthalten die Envelope-Namen, welche Stufe geantwortet hat – überprüfen Sie dies, anstatt anzunehmen, dass eine Bewertung stattgefunden hat.
Fragen Sie immer auf Englisch, egal in welcher Sprache das Video ist. Der Katalog ist auf Englisch verfasst und beide Stufen indexieren ihn auf diese Weise (das On-Device-Modell ist ebenfalls nur englischsprachig). Eine Abfrage in einer anderen Schrift erzeugt keine durchsuchbaren Begriffe und liefert gar nichts zurück. Dies ist bei einem japanischen oder chinesischen Projekt leicht falsch zu machen, wo Briefing, Untertitel und Erzählung alle in dieser Sprache sind und die Abfrage natürlich folgt: Beschreiben Sie die Bewegung auf Englisch, schreiben Sie dann den Bildschirmtext in der Sprache, die das Video benötigt. Wenn eine Abfrage mit No searchable words in query zurückkommt, liegt dies an dieser Regel, nicht an einer fehlenden Komponente, und es ist keinen Lückenbericht wert.
Die Installierbarkeit wird nach der Bewertung angewandt, nicht davor: Ein Name, den die Vektoren tragen, den diese Registry aber nicht bedienen kann, wird aus den Ergebnissen entfernt und in dropped gezählt – ein dropped ungleich Null bedeutet also, dass die beiden unterschiedliche Generationen sind. Siehe /hyperframes-cli für die Offline-Stufe, die Zustimmungsgates und wie ein veralteter Index aktualisiert wird.
Zum Stöbern oder Filtern anstelle der Suche:
npx hyperframes catalog
npx hyperframes catalog --type block
npx hyperframes catalog --type component
npx hyperframes catalog --type block --tag social
npx hyperframes catalog --json
npx hyperframes catalog --human-friendly
Die normale Tabelle und der --json-Modus listen nur Treffer auf; installieren Sie einen ausgewählten Namen mit hyperframes add <name>. --human-friendly öffnet eine interaktive Auswahl und installiert das ausgewählte Element sofort. In CI- oder Agent-Workflows bevorzugen Sie --json gefolgt von einem expliziten add.
Melden, was der Katalog nicht hat
Wenn die Suche zurückkommt und nichts davon die Aufgabe erfüllt, sagen Sie dies, bevor Sie die Bewegung manuell erstellen:
npx hyperframes feedback --search-miss "<die von Ihnen ausgeführte Abfrage>" --wanted "<die benötigte Bewegung>" --tier on-device
catalog --query druckt diese Zeile für Sie aus, vorausgefüllt, und --json führt sie als report_gap mit – sie ist also bereits zur Hand, wenn Sie entscheiden, dass nichts passt.
Melden Sie immer, wenn nichts in den Ergebnissen die Aufgabe erfüllt, auf beiden Stufen. Warten Sie nicht, bis die On-Device-Stufe geantwortet hat: Sie benötigt einen zugestimmten 33 MB-Download, also läuft ein Agenten-Durchlauf auf words, sofern er nicht explizit zugestimmt hat, und die Beschränkung auf on-device würde fast jeden Bericht unterdrücken. Der --tier-Wert reist mit, sodass ein Vokabular-Treffer von einem Bedeutungs-Treffer unterscheidbar bleibt, wenn diese gelesen werden. Beschreiben Sie den gewünschten Effekt, nicht den erdachten Elementnamen: Was zurückkommt, ist eine Liste lohnenswerter Bewegungen, und ein Bericht, der ein nicht existierendes Element nennt, lehrt nichts. Dies ist der einzige Pfad, der eine Abfrage irgendwohin sendet, weshalb es genau ein separater bewusster Befehl ist und nicht etwas, das die Suche von selbst tut. Er trägt keine Bewertung und landet nie in der Bewertungsmetrik.
Dies ist das gesamte Nachfragesignal für den Katalog. Es zu überspringen bedeutet, dass die getroffene Lücke stattdessen aus Installationszahlen erraten wird, was eine Bewegung nicht sehen kann, die niemand installieren konnte.
Wenn die CLI die konfigurierte Registry nicht erreichen kann, überprüfen Sie das rohe Manifest als Fallback:
curl -s https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/registry.json
Eine Registry, die die CLI nicht erreichen kann, leert den Katalog für die Entdeckung nicht: Ein zuvor abgerufenes Manifest wird auch nach Ablauf des 24h-Aktualisierungsfensters weiter verwendet, wenn die erneute Validierung fehlschlägt, sodass catalog und catalog --query weiterhin auflisten und gegen die letzte Kopie auf der Festplatte bewerten.
add benötigt dennoch das Netzwerk, selbst für ein gestern installiertes Element. Nur Manifeste werden zwischengespeichert; die eigentlichen Dateien des Elements werden bei jeder Installation abgerufen. Offline können Sie also suchen und sehen, was ein Element ist, aber die Installation schlägt beim Dateiabruf fehl. Versprechen Sie einem Benutzer keine Offline-Installation.
Das registry-item.json jedes Elements enthält: Name, Typ, Titel, Beschreibung, Tags, Maße (nur Blöcke), Dauer (nur Blöcke) und Dateiliste.
Details zum Filtern nach Typ und Tags finden Sie unter discovery.md.
Einen neuen Block oder eine neue Komponente beitragen
Um einen NEUEN Registry-Eintrag (Untertitel-Stil, VFX-Block, Übergang, unteres Drittel oder eine wiederverwendbare Komponente) zu erstellen und als Upstream-PR zu versenden – nicht um einen vorhandenen zu installieren – folgen Sie dem vollständigen Workflow von Idee über Gerüst, Bauen, Validieren, Vorschau bis Versand in contributing.md. Copy-Paste-Startvorlagen (Untertitel / VFX / Komponente / registry-item.json) finden Sie in templates.md.