Was macht manimater-components?
Eine Bibliothek getesteter, von JSON gesteuerter Manim-Komponenten. Eine Komponente ist ein Name plus Parameter; du brauchst nie selbst Animationscode zu schreiben. Repository: https://github.com/bishnt/manimater-components (MIT). Die Manimater-App verwendet dieselbe Bibliothek.
Zwei mögliche Aufgaben:
- Komponenten verwenden: die richtigen für ein Thema auswählen, ein gültiges Storyboard schreiben, es in der Vorschau ansehen.
- Komponente hinzufügen: eine schreiben, die den Regeln folgt, testen und beitragen.
Finde heraus, was der Benutzer möchte. Wenn er eine Animation beschreibt, die keine vorhandene Komponente umsetzen kann, gehe zu „Komponente hinzufügen".
1. Komponenten verwenden
Die richtige Komponente finden
- Lies references/catalog.md: jede Komponente mit einer einzeiligen Beschreibung und ihren Parametern.
(Wenn du in einem Klon des Repos arbeitest, enthält
catalog.jsonim Wurzelverzeichnis vollständige Parameterdetails und einexamplefür jede Komponente.) - Wähle die Komponente, deren Beschreibung zur darzustellenden Idee passt – nicht nur zum Thema. Bevorzuge eine spezifische Komponente gegenüber einer allgemeinen (
synchronous_motorstattbullet_pointsfür eine Motorenerklärung) und kombiniere mehrere für eine Geschichte:title_card, dann die Konzeptkomponenten, danncalloutals abschließende Erkenntnis. - Lies den Eintrag der gewählten Komponente in
catalog.jsonfür die genauen Parameternamen, -typen,choicesund dasexample.
Ein Storyboard schreiben
Ein Storyboard ist JSON; die Bibliothek prüft es für dich:
{ "title": "Wie ein Synchronmotor funktioniert",
"scenes": [
{ "component": "title_card", "params": { "title": "Synchronmotoren" }, "narration": "Warum rutscht dieser Motor nie durch?" },
{ "component": "synchronous_motor", "params": { "poles": 2, "frequency_hz": 50 }, "narration": "Der Rotor koppelt sich an das Drehfeld." },
{ "component": "callout", "params": { "text": "Die Drehzahl ist fest durch Frequenz und Polzahl.", "kind": "takeaway" }, "narration": "Die Drehzahl hängt also nur von der Frequenz ab." }
] }
Regeln, die der Validator durchsetzt: maximal 12 Szenen, Zeichenketten bis zu 300 Zeichen, Listen bis zu 8 Elemente, unbekannte Parameter werden entfernt, erforderliche Parameter müssen vorhanden sein, choices müssen übereinstimmen. Erfinde niemals einen Komponentennamen oder einen Parameter; fehlt etwas, sage dies und biete an, eine neue Komponente zu schreiben.
Validieren und Vorschau anzeigen
pip install -e ".[dev]" # in einem Klon; benötigt ffmpeg, Cairo und Pango für Manim
python - <<'PY'
import json
from manimate.storyboard import validate
sb, errors = validate(json.load(open("storyboard.json")))
print(errors or "valid")
PY
python -m manimate.preview <component> # rendert previews/<component>.mp4 aus dem Beispiel
python -m manimate.preview <component> --params '{"...": 1}' # mit eigenen Parametern
python -m manimate.preview --list
Wenn du in dieser Umgebung keinen Code ausführen kannst, erstelle das Storyboard-JSON und die genauen Befehle und sage deutlich, dass du es weder validiert noch gerendert hast.
2. Komponente hinzufügen
Lies zuerst references/component-template.py. Es ist eine vollständige, funktionierende Komponente.
Entscheiden
- Eine Idee, wiederverwendbar. „Wie ein Transformator funktioniert" ist ein ganzes Video; „Aufmerksamkeitsgewichte zwischen zwei Wörtern" ist eine Komponente. Parameter (Zahlen, Beschriftungen, Listen) sollten sie für viele Beispiele nützlich machen.
- Prüfe references/catalog.md, damit du keine vorhandene Komponente duplizierst.
- Frage den Benutzer nach allem, was du nicht selbst entscheiden kannst (für wen es ist, was einstellbar sein soll), aber maximal zwei Fragen; ansonsten triff sinnvolle Entscheidungen und teile sie mit.
Schreiben
Speichere als manimate/components/community/<name>.py (Snake_case, eindeutig). Es wird automatisch registriert. Folge exakt der Vorlage und diesen Regeln:
- Maximal 5 Parameter, jeder mit einer Beschreibung (eine KI liest sie), einem Standardwert oder
required=Trueund einemvalidator, der eine verständliche Fehlermeldung in einfachem Englisch für ungültige Eingaben zurückgibt. Begrenze, kürze, falle zurück; stürze niemals bei ungewöhnlichen Eingaben ab. - Das
example-Dict muss gültig sein und rendern. - Mathematik, Algorithmen und Layout sind reine Python-Funktionen ohne Manim, sodass sie mit Unit-Tests geprüft werden können.
- Verwende nur Farben aus
manimate.theme(theme.ACCENT, ...), niemals Hex-Codes. Kurzer, einfacher Text auf dem Bildschirm.ctx.fit(...), damit nichts die Bühne verlässt. - Blende das fertige Bild als Ganzes mit einem
FadeInein, animiere dann das Bedeutungsvolle. Nutze die dir gegebene Zeit (ctx.remaining,Ctx.beat). Verwendectx.play/ctx.wait, niemalsscene.play. - Reiner Zeichencode: keine Netzwerke, Dateien, Subprozesse,
eval,exec,getattroder Dunder-Zugriffe. Importe beschränken sich aufmanim,numpy, die Standardbibliothek und die eigenen Module der Bibliothek. CI und ein Bot lehnen alles andere ab. - Das Einbinden eines Manim-Plugins ist nur erlaubt, wenn es unter MIT oder Creative Commons lizenziert ist; folge
docs/WRITING_A_COMPONENT.md.
Schreibe einen Test für die pure-Python-Logik in tests/community/test_<name>.py (Randfälle: leer, ein Element, das Maximum, lange Beschriftungen). Der generische Test führt bereits einen Trockentest für jedes Beispiel einer Community-Komponente durch.
Prüfen
python -m manimate.preview <name>
python -m pytest tests/community
python -m manimate.catalog > catalog.json
python scripts/gen_docs.py
Berichte, was du ausgeführt hast und was passiert ist. Wenn du nichts ausführen konntest, sage es.
Beitragen
Sage dem Benutzer in einfachen Worten, welcher Weg für ihn passt:
- Sie können git/GitHub verwenden: Forke das Repo, committe die neue(n) Datei(en) und die neu generierte
catalog.json, öffne einen Pull Request. SieheCONTRIBUTING.md(dort sind die Checkliste und die fünf Designfragen, die in der Beschreibung beantwortet werden müssen). - Sie programmieren nicht (die meisten Leute): Gib ihnen die Python-Datei in einem Codeblock (und den Test in einem zweiten) und sage ihnen, sie sollen das Issue-Formular New component (from an LLM) unter https://github.com/bishnt/manimater-components/issues/new?template=new-component.yml öffnen und den Code dort einfügen. Ein Bot prüft den Code, ohne ihn auszuführen, und öffnet für sie den Pull Request, der ihnen gutgeschrieben wird; ein Maintainer überprüft ihn.
Beende mit einer dreizeiligen Zusammenfassung, die der Benutzer in das Formular einfügen kann: was die Komponente lehrt, die Parameter und die von dir behandelten Fehlerfälle.
Grenzen
- Behaupre nicht, dass eine Komponente existiert, wenn sie nicht im Katalog steht. Behaupre nicht, dass ein Render korrekt aussieht, wenn du es nicht gerendert hast.
- Kopiere keinen Code aus anderen Repositories in einen Beitrag, es sei denn, er ist MIT oder kompatibel, und du sagst, woher er stammt. Die Quellen, Dokumente und Beispiele von manim-eng dürfen nicht als KI-Trainingsdaten verwendet werden (siehe
docs/THIRD_PARTY.md).