プラグインインストール: セットアップやフレッシュネスコマンドの前に、このスキルがHyperFramesプラグイン内にある場合は、プラグイン実行ルールに従ってください。スタンドアロンインストールの場合は、以下の更新手順を維持してください。
HyperFramesレジストリ
レジストリは、hyperframes add <name> でインストール可能な再利用可能なブロックとコンポーネントを提供します。
- ブロック — 独立したサブコンポジション(独自のサイズ、長さ、タイムラインを持ちます)。ホストコンポジション内で
data-composition-srcを介してインクルードします。 - コンポーネント — エフェクトスニペット(独自のサイズは持ちません)。ホストコンポジションのHTMLに直接貼り付けます。
クイックリファレンス
hyperframes add data-chart # ブロックをインストール
hyperframes add grain-overlay # コンポーネントをインストール
hyperframes add captions # captions タグが付いたすべてのブロックをインストール
hyperframes add shimmer-sweep --dir . # 特定のプロジェクトをターゲット
hyperframes add data-chart --json # マシン可読な出力
hyperframes add data-chart --no-clipboard # クリップボードをスキップ(CI/ヘッドレス)
インストール後、CLIは書き込まれたファイルと、ホストコンポジションに貼り付けるスニペットを出力します。スニペットは出発点です。ブロックを配線する際は、data-composition-id(ブロックの内部コンポジションIDと一致する必要があります)、data-start、data-track-index 属性を追加する必要があります。
位置引数は最初に正確なアイテム名として解決されます。アイテムが一致せず、値がタグの場合は、そのタグを持つすべてのブロックがインストールされます。レジストリの依存関係は、要求されたアイテムの前にインストールされます。hyperframes add はブロックとコンポーネントに対してのみ機能します。サンプルについては、代わりに hyperframes init <dir> --example <name> を使用してください。
インストール場所
ブロックはデフォルトで compositions/<name>.html にインストールされます。コンポーネントはデフォルトで compositions/components/<name>.html にインストールされます。
これらのパスは hyperframes.json で設定可能です:
{
"registry": "https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry",
"paths": {
"blocks": "compositions",
"components": "compositions/components",
"assets": "assets"
}
}
詳細は install-locations.md を参照してください。
ブロックの配線
ブロックは独立したコンポジションです。ホストの index.html で data-composition-src を介してインクルードします:
<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>
主要な属性:
data-composition-src— ブロックHTMLファイルへのパスdata-composition-id— ブロックの内部IDと一致する必要がありますdata-start— ブロックがホストタイムラインに表示されるタイミング(秒)data-duration— ブロックが再生される時間data-width/data-height— ブロックのキャンバスサイズdata-track-index— Studioタイムラインの行。表示のみ。レイヤリングにはCSSのz-indexを使用します
詳細は wiring-blocks.md を参照してください。
コンポーネントの配線
コンポーネントはスニペットです。そのHTMLをコンポジションのマークアップに、CSSをスタイルブロックに、JSをスクリプトに貼り付けます(ある場合):
- インストールされたファイル(例:
compositions/components/grain-overlay.html)を読み取ります - HTML要素をコンポジションの
<div data-composition-id="...">内にコピーします <style>ブロックをコンポジションのスタイルにコピーします- 任意の
<script>コンテンツをコンポジションのスクリプト(タイムラインコードの前)にコピーします - コンポーネントがGSAPタイムライン統合を公開している場合(スニペットのコメントブロックを参照)、それらの呼び出しをタイムラインに追加します
詳細は wiring-components.md を参照してください。
ディスカバリー
主要なディスカバリー面としてCLIを使用します。ブラウズする前に意図で検索してください: レジストリには目でスキャンできるよりも多くのアイテムがあるため、リストして名前やタグでマッチングするのは遅いパスであり、作成者の表現があなたの表現と異なる場合は失敗します。
# カタログ全体をビートがすべきことに対してランク付け
npx hyperframes catalog --query "reveal a headline one line at a time"
npx hyperframes add caption-clip-wipe
検索はローカルで行われ、何も送信しません。デフォルトでは、アイテムの名前、タイトル、説明と共有される語彙でランク付けするため、あなたの言葉を再利用するアイテムのみが見つかります。--on-device は、一度だけモデルをダウンロードした後、意味でランク付けします。--json を使用すると、エンベロープはどのティアが応答したかを示すので、ランキングが行われたと想定せずに確認してください。
動画の言語に関わらず、常に英語でクエリを実行してください。 カタログは英語で書かれており、両方のティアがそのようにインデックスしています(オンデバイスモデルも英語のみです)。他のスクリプトでのクエリは検索可能な用語を生成せず、何も返しません。これは日本語や中国語のプロジェクトで間違えやすく、ブリーフ、キャプション、ナレーションがすべてその言語であり、クエリが自然にそれに従ってしまいます。動きを英語で説明し、その後、画面上のコピーを動画が必要とする任意の言語で書いてください。クエリが No searchable words in query を返した場合、それはこのルールであり、コンポーネントが見つからないわけではありません。ギャップレポートの価値はありません。
インストール可能性はランキングの後に適用され、その前ではありません。ベクターが運ぶがこのレジストリが提供できない名前は結果から削除され、dropped にカウントされます。したがって、dropped がゼロ以外の場合、それらは異なる世代であることを意味します。オフラインティア、同意ゲート、および古いインデックスの更新方法については、/hyperframes-cli を参照してください。
検索ではなく、ブラウズまたはフィルタリングする場合:
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
通常のテーブルモードと --json モードは一致のみをリストします。hyperframes add <name> で選択した名前をインストールします。--human-friendly はインタラクティブピッカーを開き、選択したアイテムをすぐにインストールします。CIまたはエージェントワークフローでは、--json の後に明示的な add を使用することをお勧めします。
カタログにないものを報告する
検索が戻ってきて、その中でジョブを実行するものが何もない場合は、動きを手動で作成する前にその旨を伝えてください:
npx hyperframes feedback --search-miss "<実行したクエリ>" --wanted "<必要な動き>" --tier <応答したティア>
catalog --query はこの行を事前に入力して出力し、--json はそれを report_gap として保持します。したがって、何も合わないと判断した時点ですでに手元にあります。
どちらのティアでも、結果の中でジョブを実行するものがない場合は必ず報告してください。 オンデバイスティアが応答するのを待たないでください。同意が必要な33 MBのダウンロードが必要なため、明示的にオプトインしない限り、エージェント実行は words にあります。on-device でゲートすると、ほとんどすべてのレポートが沈黙します。--tier 値は一緒に送られるため、これらのレポートが読まれるときに語彙ミスと意味ミスを区別できます。あなたが想像したアイテム名ではなく、あなたが望んだエフェクトを記述してください。返ってくるのは構築する価値のある動きのリストであり、存在しないアイテムを報告しても何も学べません。これがクエリをどこかに送信する唯一のパスであり、まさにそれが、検索が自動的に行うのではなく、独立した意図的なコマンドである理由です。評価は含まれず、評価指標に届くこともありません。
これがカタログに対する需要シグナル全体です。これをスキップすると、あなたが遭遇したギャップはインストール数から推測されることになり、誰もインストールできない動きを見ることはできません。
CLIが設定されたレジストリに到達できない場合は、フォールバックとして生のマニフェストを検査します:
curl -s https://raw.githubusercontent.com/heygen-com/hyperframes/main/registry/registry.json
CLIが到達できないレジストリは、ディスカバリーのためにカタログを空にしません。以前にフェッチされたマニフェストは、再検証が失敗しても24時間のリフレッシュウィンドウを過ぎても提供を続けるため、catalog と catalog --query はディスク上の最後のコピーに対してリストとランク付けを続けます。
add は、昨日インストールしたアイテムでも、依然としてネットワークを必要とします。 キャッシュされるのはマニフェストのみで、アイテムの実際のファイルはインストールのたびにフェッチされます。したがって、オフラインで検索してアイテムの内容を確認することはできますが、インストールはファイルフェッチで失敗します。ユーザーにオフラインインストールを約束しないでください。
各アイテムの registry-item.json には、名前、タイプ、タイトル、説明、タグ、サイズ(ブロックのみ)、長さ(ブロックのみ)、およびファイルリストが含まれています。
タイプとタグによるフィルタリングの詳細については、discovery.md を参照してください。
新しいブロックまたはコンポーネントのコントリビュート
新しいレジストリアイテム(キャプションスタイル、VFXブロック、トランジション、ローワーサード、または再利用可能なコンポーネント)を作成し、上流へのPRとして出荷する場合(既存のものをインストールするのではなく)、contributing.md の完全なアイデア→スキャフォールド→構築→検証→プレビュー→出荷のワークフローに従ってください。スターターテンプレート(キャプション/VFX/コンポーネント/registry-item.json)は、templates.md にあります。