manimater-components は何をしますか?
JSON駆動のテスト済みManimコンポーネントライブラリ。コンポーネントは名前とパラメータの組み合わせであり、アニメーションコードは一切必要ありません。リポジトリ: https://github.com/bishnt/manimater-components (MIT)。Manimaterアプリも同じライブラリを使用しています。
あなたに依頼される可能性のある2つのタスク:
- コンポーネントを使用する: トピックに適したコンポーネントを選び、有効なストーリーボードを作成し、プレビューする。
- コンポーネントを追加する: ルールに従ってコンポーネントを作成し、テストし、貢献する。
ユーザーがどちらを望んでいるかを判断してください。既存のコンポーネントで実現できないアニメーションをユーザーが説明した場合は、「コンポーネントを追加する」に進んでください。
1. コンポーネントを使用する
適切なコンポーネントを見つける
- references/catalog.md を読む: 各コンポーネントの1行説明とパラメータが記載されています。
(リポジトリのクローン内にいる場合、ルートの
catalog.jsonに完全なパラメータ詳細と各コンポーネントのexampleが含まれています。) - トピックだけでなく、説明したいアイデアに合致する説明を持つコンポーネントを選びます。汎用的なコンポーネントよりも特定のコンポーネントを優先します(モーターの説明には
bullet_pointsよりsynchronous_motor)。ストーリーを構築するために複数を組み合わせることもできます:title_card、次にコンセプトコンポーネント、最後にcalloutで最終的な要点を示す。 - 選択したコンポーネントの
catalog.json内のエントリを読み、正確なパラメータ名、型、choices、exampleを確認します。
ストーリーボードを作成する
ストーリーボードはJSONです。ライブラリが自動的にチェックします:
{ "title": "同期モーターの仕組み",
"scenes": [
{ "component": "title_card", "params": { "title": "同期モーター" }, "narration": "なぜこのモーターは決して滑らないのか?" },
{ "component": "synchronous_motor", "params": { "poles": 2, "frequency_hz": 50 }, "narration": "回転子が回転磁界にロックオンします。" },
{ "component": "callout", "params": { "text": "速度は周波数と極数によって決まる。", "kind": "takeaway" }, "narration": "つまり速度は周波数のみに依存します。" }
] }
バリデーターが強制するルール: シーンは最大12、文字列は300文字まで、リストは最大8項目、未知のパラメータは削除、必須パラメータは存在しなければならない、choices は一致しなければならない。コンポーネント名やパラメータを決して捏造してはいけません。不足しているものがあればその旨を伝え、新しいコンポーネントを作成することを提案してください。
検証とプレビュー
pip install -e ".[dev]" # クローン内で実行; Manimに必要なffmpeg、Cairo、Pangoが必要
python - <<'PY'
import json
from manimate.storyboard import validate
sb, errors = validate(json.load(open("storyboard.json")))
print(errors or "有効")
PY
python -m manimate.preview <コンポーネント名> # そのexampleから previews/<コンポーネント名>.mp4 をレンダリング
python -m manimate.preview <コンポーネント名> --params '{"...": 1}' # 独自のパラメータで
python -m manimate.preview --list
この環境でコードを実行できない場合は、ストーリーボードJSONと正確なコマンドを生成し、検証もレンダリングも行っていないことを明確に伝えてください。
2. コンポーネントを追加する
最初に references/component-template.py を読んでください。完全に動作するコンポーネントのテンプレートです。
判断する
- 1つのアイデア、再利用可能。 「変圧器の仕組み」は1本の動画全体ですが、「2つの単語間のアテンション重み」はコンポーネントです。パラメータ(数値、ラベル、リスト)は多くの例で役立つように設定します。
- references/catalog.md を確認し、既存のコンポーネントと重複しないようにします。
- 自分で判断できないことはユーザーに尋ねます(誰のためのものか、何を調整可能にするかなど)。ただし質問は2つまでにし、それ以外は妥当な選択をしてその旨を明示します。
作成する
manimate/components/community/<名前>.py として保存します(スネークケース、ユニーク)。自動的に登録されます。テンプレートに正確に従い、以下のルールを守ります:
- パラメータは最大5つまで。各パラメータに説明(AIが読む)、デフォルト値または
required=True、不正な入力に対して平易な英語のメッセージを返すvalidatorが必要。値をクランプ、トリム、フォールバックし、変な入力でもクラッシュしない。 example辞書は有効であり、レンダリングできなければならない。- 数学、アルゴリズム、レイアウトは Manimを使わないプレーンなPython関数 で記述し、単体テスト可能にする。
- 色は
manimate.themeのものだけを使用(theme.ACCENTなど)、16進数は不可。画面上のテキストは短く平易に。ctx.fit(...)を使用して何もステージからはみ出さないようにする。 - 完成した絵全体を1つの
FadeInでフェードインし、その後意味を伝えるアニメーションを行う。与えられた時間(ctx.remaining、Ctx.beat)を使用する。ctx.play/ctx.waitを使用し、scene.playは使用しない。 - 純粋な描画コード: ネットワーク、ファイル、サブプロセス、
eval、exec、getattr、ダンダーアクセスは禁止。インポートはmanim、numpy、標準ライブラリ、およびライブラリ自身のモジュールに限定。CIとボットがこれら以外を拒否する。 - Manimプラグインのラップは、MITまたはクリエイティブ・コモンズライセンスの場合のみ許可。
docs/WRITING_A_COMPONENT.mdに従うこと。
プレーンPythonロジックのテストを tests/community/test_<名前>.py に作成します(エッジケース: 空、1項目、最大値、長いラベル)。汎用テストですでに全コミュニティコンポーネントのexampleをドライランしています。
確認する
python -m manimate.preview <名前>
python -m pytest tests/community
python -m manimate.catalog > catalog.json
python scripts/gen_docs.py
実行した内容と結果を報告してください。何も実行できなかった場合はその旨を伝えます。
貢献する
ユーザーに、どちらの方法が適しているかを平易な言葉で伝えてください:
- git/GitHubを使える場合: リポジトリをフォークし、新しいファイルと再生成した
catalog.jsonをコミットし、プルリクエストを開きます。CONTRIBUTING.mdを参照(チェックリストと説明に記載する5つのデザイン質問があります)。 - コードを書かない場合(ほとんどの人): Pythonファイルを1つのコードブロックで(テストは別のコードブロックで)提供し、New component (from an LLM) Issueフォーム(https://github.com/bishnt/manimater-components/issues/new?template=new-component.yml)を開いてコードを貼り付けるよう伝えます。ボットがコードを実行せずにチェックし、代わりにプルリクエストを開きます(貢献者としてクレジットされます)。メンテナーがレビューします。
最後に、ユーザーがフォームに貼り付けられる3行の要約を提供します: 何を教えるか、パラメータ、処理した失敗ケース。
制限事項
- カタログに存在しないコンポーネントが存在すると主張しないでください。レンダリングしていないのに見た目が正しいと主張しないでください。
- MITライセンスまたは互換性のあるライセンスで、かつ出典を明記する場合を除き、他のリポジトリからのコードを貢献にコピーしないでください。manim-engのソース、ドキュメント、例はAIトレーニングデータとして使用してはいけません(
docs/THIRD_PARTY.mdを参照)。