Que fait composants-manimater ?
Une bibliothèque de composants Manim testés et pilotés par JSON. Un composant est un nom associé à des paramètres ; vous n'avez jamais besoin de code d'animation. Dépôt : https://github.com/bishnt/manimater-components (MIT). L'application Manimater utilise la même bibliothèque.
Deux choses que l'on peut vous demander de faire :
- Utiliser des composants : choisir ceux qui conviennent à un sujet, écrire un storyboard valide, le prévisualiser.
- Ajouter un composant : en écrire un qui respecte les règles, le tester et le faire contribuer.
Déterminez ce que l'utilisateur souhaite. S'il décrit une animation qu'aucun composant existant ne peut réaliser, passez à "Ajouter un composant".
1. Utiliser des composants
Trouver le bon composant
- Lisez references/catalog.md : chaque composant avec une description d'une ligne et ses paramètres.
(Si vous êtes dans un clone du dépôt,
catalog.jsonà la racine contient les détails complets des paramètres et unexamplepour chacun.) - Choisissez le composant dont la description correspond à l'idée à montrer, pas seulement au sujet. Préférez un composant spécifique
à un composant générique (
synchronous_motorplutôt quebullet_pointspour expliquer un moteur), et combinez-en plusieurs pour une histoire :title_card, puis les composants du concept, puiscalloutcomme conclusion finale. - Lisez l'entrée du composant choisi dans
catalog.jsonpour connaître les noms exacts des paramètres, leurs types,choicesetexample.
Écrire un storyboard
Un storyboard est au format JSON ; la bibliothèque le vérifie pour vous :
{ "title": "Comment fonctionne un moteur synchrone",
"scenes": [
{ "component": "title_card", "params": { "title": "Moteurs synchrones" }, "narration": "Pourquoi ce moteur ne patine-t-il jamais ?" },
{ "component": "synchronous_motor", "params": { "poles": 2, "frequency_hz": 50 }, "narration": "Le rotor se verrouille sur le champ tournant." },
{ "component": "callout", "params": { "text": "La vitesse est fixée par la fréquence et le nombre de pôles.", "kind": "takeaway" }, "narration": "La vitesse ne dépend donc que de la fréquence." }
] }
Règles appliquées par le validateur : au maximum 12 scènes, chaînes jusqu'à 300 caractères, listes jusqu'à 8 éléments, les paramètres inconnus sont ignorés, les paramètres obligatoires doivent être présents, les choices doivent correspondre. N'inventez jamais un nom de composant ou un paramètre ; si quelque chose manque, dites-le et proposez d'écrire un nouveau composant.
Valider et prévisualiser
pip install -e ".[dev]" # dans un clone ; nécessite ffmpeg, Cairo et Pango pour Manim
python - <<'PY'
import json
from manimate.storyboard import validate
sb, errors = validate(json.load(open("storyboard.json")))
print(errors or "valide")
PY
python -m manimate.preview <composant> # rend previews/<composant>.mp4 à partir de son exemple
python -m manimate.preview <composant> --params '{"...": 1}' # avec vos propres paramètres
python -m manimate.preview --list
Si vous ne pouvez pas exécuter de code dans cet environnement, produisez le JSON du storyboard et les commandes exactes, et dites clairement que vous ne l'avez ni validé ni rendu.
2. Ajouter un composant
Lisez d'abord references/component-template.py. C'est un composant complet et fonctionnel.
Décider
- Une idée, réutilisable. "Comment fonctionne un transformateur" est une vidéo entière ; "poids d'attention entre deux mots" est un composant. Les paramètres (nombres, étiquettes, listes) doivent le rendre utile pour de nombreux exemples.
- Vérifiez references/catalog.md pour ne pas dupliquer un composant existant.
- Demandez à l'utilisateur tout ce que vous ne pouvez pas décider vous-même (à qui il est destiné, ce qui doit être ajustable) mais pas plus de deux questions ; sinon, faites des choix raisonnables et énoncez-les.
L'écrire
Sauvegardez sous manimate/components/community/<nom>.py (snake_case, unique). Il est enregistré automatiquement. Suivez le modèle
exactement, et ces règles :
- Au maximum 5 paramètres, chacun avec une description (une IA la lit), une valeur par défaut ou
required=True, et unvalidatorqui renvoie un message en français simple pour une entrée invalide. Limitez, ajustez, revenez à une valeur par défaut ; ne plantez jamais sur une entrée étrange. - Le dictionnaire
exampledoit être valide et doit pouvoir être rendu. - Les maths, algorithmes et la mise en page sont des fonctions Python pures sans Manim, afin de pouvoir être testés unitairement.
- Utilisez uniquement les couleurs de
manimate.theme(theme.ACCENT, ...), jamais de codes hexadécimaux. Texte court et simple à l'écran.ctx.fit(...)pour que rien ne sorte de la scène. - Fondu de l'image finale entière avec un seul
FadeIn, puis animer ce qui porte le sens. Utilisez le temps qui vous est donné (ctx.remaining,Ctx.beat). Utilisezctx.play/ctx.wait, jamaisscene.play. - Code de dessin pur : pas de réseau, fichiers, sous-processus,
eval,exec,getattr, ou accès dunder. Les imports sont limités àmanim,numpy, la bibliothèque standard et les propres modules de la bibliothèque. L'IC et un bot rejettent toute autre chose. - L'encapsulation d'un plugin Manim n'est autorisée que s'il est sous licence MIT ou Creative Commons ; suivez
docs/WRITING_A_COMPONENT.md.
Écrivez un test pour la logique Python pure dans tests/community/test_<nom>.py (cas limites : vide, un élément, le maximum, étiquettes longues). Le test générique exécute déjà à sec l'exemple de chaque composant communautaire.
Le vérifier
python -m manimate.preview <nom>
python -m pytest tests/community
python -m manimate.catalog > catalog.json
python scripts/gen_docs.py
Rapportez ce que vous avez exécuté et ce qui s'est passé. Si vous n'avez rien pu exécuter, dites-le.
Le contribuer
Dites à l'utilisateur, en termes simples, quel chemin lui convient :
- Il peut utiliser git/GitHub : forker le dépôt, commiter le(s) nouveau(x) fichier(s) et le
catalog.jsonrégénéré, ouvrir une pull request. VoirCONTRIBUTING.md(il contient la liste de vérification et les cinq questions de conception à répondre dans la description). - Il ne code pas (la plupart des gens) : donnez-lui le fichier Python dans un bloc de code (et le test dans un second), et dites-lui d'ouvrir le formulaire de Nouveau composant (depuis un LLM) à l'adresse https://github.com/bishnt/manimater-components/issues/new?template=new-component.yml et d'y coller le code. Un bot vérifie sans l'exécuter et ouvre la pull request pour lui, à son crédit ; un mainteneur la révise.
Terminez par un résumé de trois lignes que l'utilisateur peut coller dans le formulaire : ce qu'il enseigne, les paramètres et les cas d'échec que vous avez traités.
Limites
- N'affirmez pas qu'un composant existe s'il n'est pas dans le catalogue. N'affirmez pas qu'un rendu est correct à moins de l'avoir rendu.
- Ne copiez pas de code d'autres dépôts dans une contribution, sauf s'il est sous licence MIT ou compatible et que vous précisez d'où il vient.
Le code source, la documentation et les exemples de manim-eng ne doivent pas être utilisés comme données d'entraînement d'IA (voir
docs/THIRD_PARTY.md).