テンプレート
テンプレートは再利用可能なデザインです。shotプロップスと解決済みトークンのみを読み取り、それ以外は読み取りません。タイミングやイージングを選択する前にmotion-styleを読んでください。Remotion APIの詳細については、インストールされているRemotionスキルを使用するか(npx remotion skills add)、https://www.remotion.dev/docs を参照してください。
配置場所
- クライアント固有:
pnpm mg new-template <client> <name>で開始します。これにより、clients/<client>/templates/<name>/index.tsxに動作するスターターが作成されます(IDは<client>/<name>)。このスターターは以下の契約に従います。デザインを置き換えてください。 - ハウス(全クライアント): motion-toolkitリポジトリ内の
templates/<name>/index.tsxに配置し、templates/index.tsに登録し、新しいツールキットバージョンでリリースします。node_modulesに書き込まないでください。
アニメーションコードを書く前に、スキーマ(ユーザーがエージェントなしで変更できるプロップス)を提案し、ユーザーと確認してください。
契約
import { interpolate, useCurrentFrame } from "remotion";
import { z } from "zod";
import { color, defineTemplate, font, motion, px, safeArea } from "motion-toolkit/engine";
const schema = z.object({
headline: z.string().min(1).default("Headline"),
holdSeconds: z.number().positive().default(3),
accent: z.string().default("accent").describe("Color token name or #hex"),
});
export const template = defineTemplate({
title: "Title card",
schema,
durationSeconds: ({ props, tokens }) => {
const m = motion(tokens, 1);
return m.seconds("enter") + props.holdSeconds + m.seconds("exit");
},
check: ({ props, tokens }) => {
color(tokens, props.accent); // throws on unknown token names; runs in `mg check`
},
component: ({ props, tokens, video }) => {
const frame = useCurrentFrame();
const m = motion(tokens, video.fps);
// ...
},
});
要件:
defineTemplateで構築されたtemplate(クライアントテンプレート)をエクスポートします。- すべてのスキーマフィールドには
。default()が必要で、新しいshotとStudioが有効な状態で開始されるようにします。Studioフォーム用に.describe()を追加します。 - 色は
color(tokens, nameOrHex)、フォントはfont(tokens, role)、期間とイージングはmotion(tokens, fps)、safeArea(tokens, video)内の位置、サイズはpx(sizeAt1080, video)を使用します。 useCurrentFrame()からinterpolate/springでのみアニメーションします。CSSトランジション、setTimeout、Date.now()、Math.random()は使用しないでください(代わりにremotionのrandom(seed)を使用)。レンダリングは毎回同一でなければなりません。- テンプレートが全フレームでない限り、背景は透明のままにします。ローワーサードとオーバーレイはアルファ付きでレンダリングします。すべての要素は最後のフレームで消えている必要があります。
- 大きな失敗: テキストが収まらない場合やトークンが見つからない場合は、修正ヒントとともに
Errorをスローします。エンジンのassertFits/wrapLinesを使用します。これらは読み込まれたフォントで測定し、オーバーフロー時にスローします。 - トークン(色、ロゴ、フォント、サウンド)を指定するプロップスは、
checkRefsを使用してcheckで検証されるため、mg checkはレンダリング前にタイプミスをキャッチします。 durationSecondsとcheckはNode(mg check)で実行され、フォントが読み込まれる前にも実行されます。そこでテキストを測定しないでください。- 画像とロゴ:
<Img src={staticFile(tokens.logos[name])} />またはstaticFile(props.someAsset)。サウンド:<Html5Audio src={staticFile(file)} />を<Sequence from={frame}>内に配置。ファイルはtokens.sounds[name]から取得します。CLIがファイルをステージングします。
ルック
ハウステンプレート、およびそれらに一致させることを意図したクライアントテンプレートは、look: lookSchemaを受け取り、resolveLook(props.look, tokens)で解決します。3つのルックすべてで一貫性を保つために、共有ヘルパーから構築します(motion-styleを参照)。
choreo(tokens, look, fps)は、エントリ順の各要素に対してbeat(frame, index, exitStart, steps)を提供します →{ inP, outP }。choreoSeconds(...)は一致する期間を提供します。reveal(look, beat, video)は要素のルックのエントランススタイルです(corporateの場合はoverflow: hiddenでラップします)。typo(tokens, look, "display" | "title" | "body" | "label", size)はルックのタイプスタイルです。onColor(hex)はカラーブロック上で読みやすいテキストを選択します。cornerPlacement(corner, inset)はコーナーグラフィックを配置します。
実際の例として、node_modules/motion-toolkit/templates/title-card/index.tsx などのハウステンプレートを読んでください。
検証
- テストプロジェクトで
pnpm mg new-shot <client>/<project> <shot> --template <client>/<name>を実行し、さらに2つ目のshotを最も長い現実的なテキストで実行します。 pnpm mg check <client>/<project>を実行します。pnpm mg still <client>/<project> <shot>を実行してフレームを確認します。次にpnpm mg renderを実行します。motion-qaに従います。
参照クリップからの作業
ユーザーが参照ビデオを提供する場合、デザインする前にフレームを抽出します。最初に renders/reference/ を作成します。バンドルされている ffmpeg はフィルターのない最小限のビルドであるため、フレームレートには -r を使用します。
pnpm mg ffmpeg -i reference.mp4 -r 10 renders/reference/f_%03d.png
フレームから、何が、どの順序で、各フェーズの長さ(10 fps でフレームをカウント)、そしてイージングの感触を説明します。その分析をユーザーと確認してから、トークンにマッピングします。期間は motion.durations に、カーブは motion.easings にマッピングします。