Plugin-Installation: Bevor Sie Setup- oder Aktualisierungsbefehle ausführen, befolgen Sie bei Verwendung dieser Fähigkeit innerhalb eines HyperFrames-Plugins die Plugin-Ausführungsregeln. Bei eigenständigen Installationen gelten die unten stehenden Aktualisierungshinweise.
HyperFrames Registry
Die Registry bietet wiederverwendbare Blöcke und Komponenten, die über hyperframes add <name> installiert werden können.
- Blöcke — eigenständige Sub-Kompositionen (eigene Maße, Dauer, Timeline). Eingebunden über
data-composition-srcin einer Host-Komposition. - Komponenten — Effekt-Snippets (keine eigenen Maße). 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 jeden Block 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 # Zwischenablage überspringen (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 beim Verknüpfen von Blöcken die Attribute data-composition-id (muss mit der internen Kompositions-ID des Blocks übereinstimmen), data-start und data-track-index hinzufügen.
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. 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 in compositions/<name>.html installiert. Komponenten werden standardmäßig in 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 in install-locations.md.
Verknüpfen von Blöcken
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 HTML-Datei des Blocksdata-composition-id— muss mit der internen ID des Blocks übereinstimmendata-start— Zeitpunkt, zu dem der Block in der Host-Timeline erscheint (Sekunden)data-duration— wie lange der Block abgespielt wirddata-width/data-height— Canvas-Abmessungen des Blocksdata-track-index— Studio-Timeline-Zeile; nur zur Anzeige. Verwenden Sie CSSz-indexfür die Überlagerung
Vollständige Details finden Sie in wiring-blocks.md.
Verknüpfen von Komponenten
Komponenten sind Snippets – fügen Sie ihr HTML in Ihr Kompositions-Markup, ihr CSS in Ihren Style-Block und ihr JS in Ihr Skript ein (falls vorhanden):
- Lesen Sie die installierte Datei (z. B.
compositions/components/grain-overlay.html) - Kopieren Sie die HTML-Elemente in Ihr Kompositions-
<div data-composition-id="..."> - Kopieren Sie den
<style>-Block in die Styles Ihrer Komposition - Kopieren Sie eventuelle
<script>-Inhalte in Ihr Kompositions-Skript (vor Ihrem Timeline-Code) - Wenn die Komponente eine GSAP-Timeline-Integration bereitstellt (siehe Kommentarblock im Snippet), fügen Sie diese Aufrufe Ihrer Timeline hinzu
Vollständige Details finden Sie in wiring-components.md.
Entdeckung / Discovery
Verwenden Sie die CLI als primäre Oberfläche für die Entdeckung. Suchen Sie nach Absicht, bevor Sie stöbern: Die Registry enthält mehr Elemente, als Sie mit dem Auge erfassen können. Daher ist das Auflisten und Abgleichen von Namen oder Tags der langsame Weg, und er scheitert immer dann, wenn die Wortwahl des Autors von Ihrer abweicht.
# Rangfolge des gesamten Katalogs basierend auf der Absicht des Beats
npx hyperframes catalog --query "reveal a headline one line at a time"
npx hyperframes add caption-clip-wipe
Die Suche erfolgt lokal und sendet nichts. Standardmäßig bewertet sie basierend auf dem gemeinsamen Vokabular mit dem Namen, Titel und der Beschreibung des Elements. Sie findet daher nur Elemente, die Ihre Wörter verwenden; --on-device bewertet stattdessen nach Bedeutung, nach einem einmaligen Modell-Download. Mit --json gibt der Umschlag an, welche Stufe geantwortet hat – überprüfen Sie dies, anstatt anzunehmen, dass eine Rangfolge stattgefunden hat.
Fragen Sie immer auf Englisch, unabhängig von der Sprache des Videos. Der Katalog ist auf Englisch verfasst und beide Stufen indizieren ihn so (das On-Device-Modell ist ebenfalls nur auf Englisch). Eine Abfrage in einer anderen Schrift erzeugt keine durchsuchbaren Begriffe und liefert überhaupt nichts zurück. Dies kann bei einem japanischen oder chinesischen Projekt leicht falsch gemacht werden, bei dem das Briefing, die Untertitel und die Erzählung alle in dieser Sprache sind und die Abfrage natürlich folgt: Beschreiben Sie die Bewegung auf Englisch und schreiben Sie dann den Text auf dem Bildschirm in der Sprache, die das Video benötigt. Wenn eine Abfrage mit "Keine durchsuchbaren Wörter in der Abfrage" zurückkommt, liegt dies an dieser Regel, nicht an einer fehlenden Komponente, und es lohnt sich nicht, eine Lückenmeldung zu erstellen.
Die Installierbarkeit wird nach der Rangfolge angewendet, nicht davor: Ein Name, den die Vektoren transportieren, den diese Registry aber nicht bereitstellen 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 Zustimmungsgate und die Aktualisierung eines veralteten Index.
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
Die normale Tabellen- und die --json-Modi listen nur Übereinstimmungen 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 darin die Aufgabe erfüllt, sagen Sie dies, bevor Sie die Bewegung von Hand erstellen:
npx hyperframes feedback --search-miss "<Ihre durchgeführte Abfrage>" --wanted "<Die benötigte Bewegung>" --tier <Die antwortende Stufe>
catalog --query gibt 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, unabhängig von der Stufe. Warten Sie nicht darauf, dass die On-Device-Stufe geantwortet hat: Sie benötigt einen zugelassenen 33 MB Download, daher läuft ein Agenten-Durchlauf auf words, es sei denn, er hat sich explizit angemeldet. Die Beschränkung auf on-device würde fast jede Meldung zum Schweigen bringen. Der Wert --tier wird mitgeliefert, sodass eine Vokabular-Fehlanzeige von einer Bedeutungs-Fehlanzeige unterschieden werden kann. 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 eine Meldung, die 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. Das Überspringen bedeutet, dass die getroffene Lücke stattdessen aus Installationszahlen geschätzt wird, was eine Bewegung, die niemand installieren konnte, nicht erkennen kann.
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 nicht für die Entdeckung: Ein zuvor abgerufenes Manifest wird weiterhin nach Ablauf des 24-Stunden-Aktualisierungsfensters verwendet, wenn die Erneuerung fehlschlägt. Daher listen catalog und catalog --query immer noch die letzte Kopie auf der Festplatte auf und ordnen sie ein.
add benötigt trotzdem das Netzwerk, selbst für ein gestern installiertes Element. Nur Manifeste werden zwischengespeichert; die eigentlichen Dateien des Elements werden bei jeder Installation abgerufen. Sie können also offline 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, Maße (nur Blöcke), Dauer (nur Blöcke) und Dateiliste.
Details zum Filtern nach Typ und Tags finden Sie in discovery.md.
Beitragen eines neuen Blocks oder einer neuen Komponente
Um ein NEUES Registry-Element (Caption-Stil, VFX-Block, Übergang, Lower Third oder eine wiederverwendbare Komponente) zu erstellen und als Upstream-PR einzureichen – nicht um ein vorhandenes zu installieren –, befolgen Sie den vollständigen Workflow (Idee → Gerüst → Bauen → Validieren → Vorschau → Versand) in contributing.md. Kopierfertige Starter-Vorlagen (Caption / VFX / Komponente / registry-item.json) finden Sie in templates.md.