HyperFrames-Registrierung
Die Registrierung bietet wiederverwendbare Blöcke und Komponenten, die über hyperframes add <name> installiert werden können.
- Blöcke — eigenständige Subkompositionen (eigene Abmessungen, Dauer, Timeline). Eingebunden über
data-composition-srcin einer Host-Komposition. - Komponenten — Effekt-Snippets (keine eigenen Abmessungen). Direkt in das HTML einer Host-Komposition eingefügt.
Kurzreferenz
hyperframes add data-chart # Installiere einen Block
hyperframes add grain-overlay # Installiere eine Komponente
hyperframes add captions # Installiere alle Blöcke mit dem Tag 'captions'
hyperframes add shimmer-sweep --dir . # Ziel ein bestimmtes Projekt
hyperframes add data-chart --json # Maschinenlesbare Ausgabe
hyperframes add data-chart --no-clipboard # Überspringe Zwischenablage (CI/headless)
Nach der Installation gibt die CLI aus, welche Dateien geschrieben wurden und ein Snippet, das Sie in Ihre Host-Komposition einfügen können. Das Snippet ist ein Ausgangspunkt – Sie müssen die Attribute data-composition-id (muss mit der internen Kompositions-ID des Blocks übereinstimmen), data-start und data-track-index hinzufügen, wenn Sie Blöcke verdrahten.
Der Positionswert wird zuerst als exakter Elementname aufgelöst. Wenn kein Element übereinstimmt und der Wert ein Tag ist, installiert der Befehl jeden Block mit diesem Tag. Registrierungsabhä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 über 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-Canvas-Abmessungendata-track-index— Ebenenreihenfolge (höher = weiter vorne)
Vollständige Details finden Sie unter wiring-blocks.md.
Komponenten verdrahten
Komponenten sind Snippets – fügen Sie ihr HTML in das Markup Ihrer Komposition, ihr CSS in Ihren Style-Block und ihr JS in Ihr Skript (falls vorhanden) ein:
- Lesen Sie die installierte Datei (z.B.
compositions/components/grain-overlay.html) - Kopieren Sie die HTML-Elemente in das
<div data-composition-id="...">Ihrer Komposition - Kopieren Sie den
<style>-Block in die Styles Ihrer Komposition - Kopieren Sie jeglichen
<script>-Inhalt in das Skript Ihrer Komposition (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 zuerst nach Absicht, nicht durch Stöbern: Die Registrierung enthält mehr Elemente, als Sie manuell überfliegen können. Das Auflisten und Abgleichen von Namen oder Tags ist der langsame Weg und scheitert, wenn die Wortwahl des Autors von Ihrer abweicht.
# Den gesamten Katalog gegen das, was der Beat tun soll, bewerten
npx hyperframes catalog --query "Enthülle eine Überschrift Zeile für Zeile"
npx hyperframes add caption-clip-wipe
Die Suche ist lokal und sendet nichts. Standardmäßig bewertet sie basierend auf dem gemeinsamen Vokabular 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 geben die Umschläge an, 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 indizieren ihn auf diese Weise (das On-Device-Modell ist ebenfalls nur auf Englisch). Eine Abfrage in einer anderen Schrift erzeugt keine durchsuchbaren Begriffe und gibt überhaupt nichts zurück. Dies ist bei einem japanischen oder chinesischen Projekt leicht falsch zu machen, bei dem das Briefing, die Untertitel und der Voice-Over alle in dieser Sprache sind und die Abfrage natürlich folgt: Beschreiben Sie die Bewegung auf Englisch, schreiben Sie dann den Text auf dem Bildschirm 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 lohnt sich nicht, einen Lückenbericht zu erstellen.
Die Installierbarkeit wird erst nach der Bewertung angewendet, nicht davor: Ein Name, den die Vektoren transportieren, den diese Registrierung aber nicht ausliefern kann, wird aus den Ergebnissen entfernt und unter dropped gezählt. Ein Wert ungleich Null bei dropped bedeutet, dass die beiden unterschiedliche Generationen sind. Siehe /hyperframes-cli für die Offline-Stufe, die Zustimmungs-Gates und wie ein veralteter Index aktualisiert wird.
Zum Stöbern oder Filtern anstatt zu suchen:
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
Der normale Tabellenmodus und der --json-Modus listen nur Übereinstimmungen auf; installieren Sie einen ausgewählten Namen mit hyperframes add <name>. --human-friendly öffnet einen interaktiven Picker 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 darin die Aufgabe erfüllt, sagen Sie dies, bevor Sie die Bewegung von Hand erstellen:
npx hyperframes feedback --search-miss "<die von Ihnen ausgeführte Abfrage>" --wanted "<die benötigte Bewegung>" --tier on-device
catalog --query gibt diese Zeile für Sie vorausgefüllt aus, und --json führt sie als report_gap mit – sie liegt also bereits in dem Moment vor, in dem Sie entscheiden, dass nichts passt.
Melden Sie jedes Mal, wenn nichts in den Ergebnissen die Aufgabe erfüllt, auf beiden Stufen. Warten Sie nicht darauf, dass die On-Device-Stufe geantwortet hat: Sie benötigt einen zugestimmten 33-MB-Download, daher läuft eine Agent-Ausführung auf words, es sei denn, sie hat sich explizit dafür entschieden. Die Beschränkung auf on-device würde fast jeden Bericht zum Schweigen bringen. Der --tier-Wert wird mitgeliefert, sodass ein Vokabular-Fehltreffer von einem Bedeutungs-Fehltreffer unterscheidbar bleibt, wenn diese gelesen werden. Beschreiben Sie den gewünschten Effekt, nicht den von Ihnen vorgestellten Elementnamen: Was zurückkommt, ist eine Liste von Bewegungen, die es wert sind, erstellt zu werden, und ein Bericht, der ein nicht existierendes Element nennt, lehrt nichts. Dies ist der einzige Pfad, der eine Abfrage irgendwohin sendet, weshalb es ein separater, bewusster Befehl ist und nicht etwas, das die Suche von selbst tut. Er enthält keine Bewertung und landet nie in der Bewertungsmetrik.
Dies ist das gesamte Nachfragesignal für den Katalog. Wenn Sie es überspringen, wird die von Ihnen getroffene Lücke stattdessen anhand der Installationszahlen geschätzt, was eine Bewegung, die niemand installieren konnte, nicht erkennen kann.
Wenn die CLI die konfigurierte Registrierung 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 Registrierung, die die CLI nicht erreichen kann, leert den Katalog für die Entdeckung NICHT: Ein zuvor abgerufenes Manifest wird weiterhin nach Ablauf des 24-Stunden-Aktualisierungsfensters verwendet, wenn die Revalidierung fehlschlägt, sodass catalog und catalog --query immer noch auflisten und gegen die letzte Kopie auf der Festplatte bewerten.
add benötigt dennoch das Netzwerk, selbst für ein Element, das Sie gestern installiert haben. 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.
Jede registry-item.json enthält: Name, Typ, Titel, Beschreibung, Tags, Abmessungen (nur Blöcke), Dauer (nur Blöcke) und Dateiliste.
Details zum Filtern nach Typ und Tags finden Sie unter discovery.md.
Beitrag eines neuen Blocks oder einer neuen Komponente
Um ein NEUES Registrierungselement zu erstellen (Untertitel-Stil, VFX-Block, Übergang, unteres Drittel oder eine wiederverwendbare Komponente) und es als Upstream-PR bereitzustellen – nicht um ein vorhandenes zu installieren – befolgen Sie den vollständigen Workflow (Idee → Gerüst → Build → Validieren → Vorschau → Versand), der in contributing.md beschrieben ist. Kopierfertige Startervorlagen (Untertitel / VFX / Komponente / registry-item.json) finden Sie in templates.md.