# ManimGX

> The animation engine for agents: blazingly fast math and 3D videos with Manim's Python API, on a Rust GPU core.

manimgx is a self-contained animation engine for AI agents: it makes mathematical and 3D
videos from Python scenes. Scenes use the API of Manim Community Edition, and manimgx
annotates all of it with types, so a type checker finds errors before a render. A Rust core
draws each frame on the GPU, typesets text and LaTeX mathematics with Typst, and encodes the
video and its sound to MP4. The engine calculates each frame at its exact time, so a scene
is the same at all frame rates. A check command runs a scene without video, prints its
timeline and layout problems, for example text over other text, and writes a storyboard. In
a web browser, Pyodide runs the same scenes in a Web Worker, and a WebAssembly build of the
core draws them with WebGPU.

These are instructions for an AI agent asked to make a video with manimgx. Follow them in order.

## 1. Install

```sh
uv tool install --python 3.14 manimgx   # puts `manimgx` on PATH
manimgx --version
```

- Keep `--python 3.14`: manimgx needs Python 3.13 or 3.14, and uv downloads one if the machine has none. Without it, uv takes the machine's default Python (macOS's is 3.9) and finds no manimgx.
- No `uv`? Install it: `curl -LsSf https://astral.sh/uv/install.sh | sh`, then `source $HOME/.local/bin/env` (or call `~/.local/bin/uv`).
- Without installing: `uvx --python 3.14 manimgx <command>` runs the same CLI.
- pip works in a virtual environment with Python 3.13 or 3.14 (older Pythons find no manimgx): `python3.14 -m venv .venv && .venv/bin/pip install manimgx`.
- manimgx is not the `manim` package: do not install `manim`, ffmpeg or LaTeX, and do not `import manim`.
- It draws on the GPU: Metal on macOS, Direct3D 12 on Windows, Vulkan on Linux. With no GPU (a server, a container) it draws on the CPU, with nothing more to install: the Linux wheels bring Mesa's lavapipe.

## 2. Write a scene

Save as `scene.py`:

```python
import manimgx as m


class SquareToCircle(m.Scene):
    def construct(self) -> None:
        square = m.Square(side_length=3, color=m.BLUE, fill_opacity=0.5)
        circle = m.Circle(radius=1.6, color=m.PINK, fill_opacity=0.5)
        self.play(m.Create(square))
        self.play(m.Transform(square, circle))
        self.wait()
```

- The API is Manim CE's, and every name is on the package: `m.Circle`, `m.MathTex`, `m.Create`, `m.UP`, `m.BLUE`.
- Time passes only in `self.play(...)` (1 s unless `run_time=`) and `self.wait(seconds)`; `self.add(...)` shows a mobject without animating it.
- The frame is 14.2 × 8 units centred on the origin: keep everything within x ∈ [-7, 7], y ∈ [-4, 4].

## 3. Check, then render

```sh
manimgx check scene.py       # the timeline and layout problems, no video; exit 1 if there are problems
manimgx render scene.py      # writes SquareToCircle.mp4 beside scene.py and prints its path
```

- `check` lists each play with its line of code, then the problems a viewer would see: text the frame cuts off, texts that overlap, lines through a text, text too small to read. Fix them and check again. It also writes `<Scene>.storyboard.png`, the frame at the end of each play with problems outlined: look at it if you can view images.
- `manimgx still scene.py -t 1.5,end` draws the frames at 1.5 s and at the end into `<Scene>.png`.
- `render` makes 1920×1080 at 60 fps; `-r 1280x720 --fps 30` is quicker for drafts. A file with several scenes needs the scene's name: `manimgx render scene.py MyScene`.
- An error prints the scene's line that failed and, for a wrong name, a hint (`ShowCreation is Create in manimgx`).
- `no GPU adapter` means the command ran in a sandbox that hides the GPU: run it outside the sandbox (ask the user if your tool needs approval).

## 4. Show it

Open the video for the user, and tell them its path: `open SquareToCircle.mp4` on macOS, `xdg-open SquareToCircle.mp4` on Linux.

## 5. API cheat sheet

- Shapes: `Square`, `Circle`, `Rectangle`, `Triangle`, `Polygon([x, y, 0], ...)`, `Line`, `Arrow`, `Dot`, `Brace(mob, m.DOWN)`, `NumberPlane`. Points are `[x, y, 0]`.
- Text: `Text("plain words")`, `MathTex(r"a^2 + b^2 = c^2")` (LaTeX math), `Tex(r"words and $x^2$")`. Use raw strings.
- Animations: `Create`, `Write`, `FadeIn(mob, shift=m.UP)`, `FadeOut`, `Transform`, `ReplacementTransform`, `TransformMatchingTex`, `GrowFromCenter`, `Indicate`, `Circumscribe`, `Rotate(mob, m.PI / 2)`; combine with `AnimationGroup`, `LaggedStart`, `Succession`. `mob.animate.shift(m.RIGHT).scale(2)` animates any method call.
- Placement: `.to_edge(m.UP)`, `.next_to(other, m.RIGHT, buff=0.3)`, `.move_to([x, y, 0])`, `.shift(2 * m.LEFT)`, `.scale(k)`, `m.VGroup(a, b).arrange(m.DOWN)`.
- Style: `color=m.YELLOW`, `fill_opacity=0.5`, `stroke_width=6`, `font_size=48`. A white background: `m.config.background_color = m.WHITE` after the import.
- Graphs: `axes = m.Axes(x_range=[-3, 3], y_range=[-2, 2])`, then `axes.plot(lambda x: x**2, color=m.BLUE)`.
- Sound: `self.add_sound("click.wav")` starts a sound now; `self.play(m.FadeIn(mob), m.Sound("whoosh.mp3"))` plays one with an animation.
- Narration: `self.say("The derivative of [x squared] is [two x].", m.Indicate(a), m.Write(b))` speaks and plays each animation during its bracketed words; a scene's voice is `voice = m.voices.Fal("<model>", ...)` (fal.ai's text-to-speech, keyed by the environment variable FAL_KEY), by default ElevenLabs' Eleven v3, or any function from text to `m.Speech`.
- Slides: `self.next_section("name")` between plays; `manimgx present scene.py` opens them in the browser.

## 6. Look it up

The docs follow, each page as Markdown. The User Guide tells how a scene works. The Reference
gives each class, the keywords it takes and examples. The Gallery gives the code of thirty
films. https://manimgx.academa.ai/llms-full.txt has every page in one file.

## User Guide

- [Welcome](<https://manimgx.academa.ai/index.md>)
- [Quickstart](<https://manimgx.academa.ai/user-guide/quickstart/index.md>)
- [Animations](<https://manimgx.academa.ai/user-guide/animations/index.md>)
- [Camera and 3D](<https://manimgx.academa.ai/user-guide/camera-and-3d/index.md>)
- [Coming from Manim CE](<https://manimgx.academa.ai/user-guide/coming-from-manim-ce/index.md>)
- [Graphs](<https://manimgx.academa.ai/user-guide/graphs/index.md>)
- [Mobjects](<https://manimgx.academa.ai/user-guide/mobjects/index.md>)
- [Positions](<https://manimgx.academa.ai/user-guide/positions/index.md>)
- [Rendering and sharing](<https://manimgx.academa.ai/user-guide/rendering/index.md>)
- [Sound and voice](<https://manimgx.academa.ai/user-guide/sound-and-voice/index.md>)
- [Text and math](<https://manimgx.academa.ai/user-guide/text-and-math/index.md>)
- [The basics](<https://manimgx.academa.ai/user-guide/the-basics/index.md>)
- [Updaters](<https://manimgx.academa.ai/user-guide/updaters/index.md>)

## Reference

- [Overview](<https://manimgx.academa.ai/reference/index.md>)
- [Animate a change](<https://manimgx.academa.ai/reference/animations/animate/index.md>)
- [Appear and disappear](<https://manimgx.academa.ai/reference/animations/appear-and-disappear/index.md>)
- [Emphasis](<https://manimgx.academa.ai/reference/animations/emphasis/index.md>)
- [Overview](<https://manimgx.academa.ai/reference/animations/index.md>)
- [Move and deform](<https://manimgx.academa.ai/reference/animations/move-and-deform/index.md>)
- [Rate functions](<https://manimgx.academa.ai/reference/animations/rate-functions/index.md>)
- [Together and in turn](<https://manimgx.academa.ai/reference/animations/together-and-in-turn/index.md>)
- [Transforms](<https://manimgx.academa.ai/reference/animations/transforms/index.md>)
- [Camera](<https://manimgx.academa.ai/reference/camera-and-3d/camera/index.md>)
- [Overview](<https://manimgx.academa.ai/reference/camera-and-3d/index.md>)
- [Lights and materials](<https://manimgx.academa.ai/reference/camera-and-3d/lights-and-materials/index.md>)
- [Surfaces and solids](<https://manimgx.academa.ai/reference/camera-and-3d/surfaces-and-solids/index.md>)
- [3D scenes](<https://manimgx.academa.ai/reference/camera-and-3d/three-d-scenes/index.md>)
- [Annotations](<https://manimgx.academa.ai/reference/mobjects/annotations/index.md>)
- [Colors](<https://manimgx.academa.ai/reference/mobjects/colors/index.md>)
- [Copies and states](<https://manimgx.academa.ai/reference/mobjects/copies-and-states/index.md>)
- [Axes](<https://manimgx.academa.ai/reference/mobjects/graphs/axes/index.md>)
- [Charts](<https://manimgx.academa.ai/reference/mobjects/graphs/charts/index.md>)
- [Curves](<https://manimgx.academa.ai/reference/mobjects/graphs/curves/index.md>)
- [Overview](<https://manimgx.academa.ai/reference/mobjects/graphs/index.md>)
- [Number lines](<https://manimgx.academa.ai/reference/mobjects/graphs/number-lines/index.md>)
- [Planes](<https://manimgx.academa.ai/reference/mobjects/graphs/planes/index.md>)
- [Plotting](<https://manimgx.academa.ai/reference/mobjects/graphs/plotting/index.md>)
- [Vector fields](<https://manimgx.academa.ai/reference/mobjects/graphs/vector-fields/index.md>)
- [Groups](<https://manimgx.academa.ai/reference/mobjects/groups/index.md>)
- [Images and SVG](<https://manimgx.academa.ai/reference/mobjects/images-and-svg/index.md>)
- [Overview](<https://manimgx.academa.ai/reference/mobjects/index.md>)
- [Matrices and tables](<https://manimgx.academa.ai/reference/mobjects/matrices-and-tables/index.md>)
- [Networks](<https://manimgx.academa.ai/reference/mobjects/networks/index.md>)
- [Paths](<https://manimgx.academa.ai/reference/mobjects/paths/index.md>)
- [Point clouds](<https://manimgx.academa.ai/reference/mobjects/point-clouds/index.md>)
- [Positions](<https://manimgx.academa.ai/reference/mobjects/positions/index.md>)
- [Circles and arcs](<https://manimgx.academa.ai/reference/mobjects/shapes/circles-and-arcs/index.md>)
- [Combining shapes](<https://manimgx.academa.ai/reference/mobjects/shapes/combining-shapes/index.md>)
- [Overview](<https://manimgx.academa.ai/reference/mobjects/shapes/index.md>)
- [Lines and arrows](<https://manimgx.academa.ai/reference/mobjects/shapes/lines-and-arrows/index.md>)
- [Polygons](<https://manimgx.academa.ai/reference/mobjects/shapes/polygons/index.md>)
- [Size and angle](<https://manimgx.academa.ai/reference/mobjects/size-and-angle/index.md>)
- [Style](<https://manimgx.academa.ai/reference/mobjects/style/index.md>)
- [Overview](<https://manimgx.academa.ai/reference/mobjects/text-and-math/index.md>)
- [Math](<https://manimgx.academa.ai/reference/mobjects/text-and-math/math/index.md>)
- [Numbers](<https://manimgx.academa.ai/reference/mobjects/text-and-math/numbers/index.md>)
- [Text](<https://manimgx.academa.ai/reference/mobjects/text-and-math/text/index.md>)
- [Command line](<https://manimgx.academa.ai/reference/rendering/command-line/index.md>)
- [Configuration](<https://manimgx.academa.ai/reference/rendering/configuration/index.md>)
- [From Python](<https://manimgx.academa.ai/reference/rendering/from-python/index.md>)
- [Overview](<https://manimgx.academa.ai/reference/rendering/index.md>)
- [Overview](<https://manimgx.academa.ai/reference/scenes/index.md>)
- [Ready-made scenes](<https://manimgx.academa.ai/reference/scenes/ready-made-scenes/index.md>)
- [Scene](<https://manimgx.academa.ai/reference/scenes/scene/index.md>)
- [Overview](<https://manimgx.academa.ai/reference/sound/index.md>)
- [Voice](<https://manimgx.academa.ai/reference/sound/voice/index.md>)
- [Overview](<https://manimgx.academa.ai/reference/updaters/index.md>)
- [Value trackers](<https://manimgx.academa.ai/reference/updaters/value-trackers/index.md>)

## Gallery

- [All films](<https://manimgx.academa.ai/gallery/index.md>)
- [Period doubling in the Mandelbrot set](<https://manimgx.academa.ai/gallery/bifurcation-mandelbrot/index.md>)
- [Bending without stretching](<https://manimgx.academa.ai/gallery/catenoid-helicoid/index.md>)
- [Cherenkov light](<https://manimgx.academa.ai/gallery/cherenkov-cone/index.md>)
- [A torus turned inside out](<https://manimgx.academa.ai/gallery/clifford-torus/index.md>)
- [A coral of random walkers](<https://manimgx.academa.ai/gallery/dla-coral/index.md>)
- [A harmonic drive](<https://manimgx.academa.ai/gallery/harmonic-drive/index.md>)
- [A spinning top](<https://manimgx.academa.ai/gallery/heavy-top/index.md>)
- [The Hopf fibration](<https://manimgx.academa.ai/gallery/hopf-fibration/index.md>)
- [A kaleidoscope on the sphere](<https://manimgx.academa.ai/gallery/kaleidoscope-sphere/index.md>)
- [Fireflies in sync](<https://manimgx.academa.ai/gallery/kuramoto-fireflies/index.md>)
- [Lagrange points](<https://manimgx.academa.ai/gallery/lagrange-points/index.md>)
- [The Game of Life in spacetime](<https://manimgx.academa.ai/gallery/life-spacetime/index.md>)
- [Cubes and the arctic circle](<https://manimgx.academa.ai/gallery/lozenge-cubes/index.md>)
- [Stars in the Menger sponge](<https://manimgx.academa.ai/gallery/menger-slice/index.md>)
- [Miura-ori](<https://manimgx.academa.ai/gallery/miura-ori/index.md>)
- [A network untangles spirals](<https://manimgx.academa.ai/gallery/neural-untangle/index.md>)
- [Steering a beam with phase](<https://manimgx.academa.ai/gallery/phased-array/index.md>)
- [Where √z lives](<https://manimgx.academa.ai/gallery/riemann-surfaces/index.md>)
- [Prince Rupert's cube](<https://manimgx.academa.ai/gallery/rupert-cube/index.md>)
- [Noise into a word](<https://manimgx.academa.ai/gallery/score-diffusion/index.md>)
- [Stacking oranges](<https://manimgx.academa.ai/gallery/sphere-packing/index.md>)
- [Circle or square?](<https://manimgx.academa.ai/gallery/sugihara-cylinder/index.md>)
- [Why a Taylor series stops](<https://manimgx.academa.ai/gallery/taylor-poles/index.md>)
- [The tennis racket flip](<https://manimgx.academa.ai/gallery/tennis-racket/index.md>)
- [A traffic jam from nowhere](<https://manimgx.academa.ai/gallery/traffic-helix/index.md>)
- [Turing patterns on a torus](<https://manimgx.academa.ai/gallery/turing-torus/index.md>)
- [The Van Allen belts](<https://manimgx.academa.ai/gallery/van-allen/index.md>)
- [Crystals and cones](<https://manimgx.academa.ai/gallery/voronoi-cones/index.md>)
- [Leapfrogging smoke rings](<https://manimgx.academa.ai/gallery/vortex-rings/index.md>)
- [Quantum tunneling](<https://manimgx.academa.ai/gallery/wave-packet/index.md>)

## Optional

- [Setup](<https://manimgx.academa.ai/developer-guide/index.md>)
- [Documentation](<https://manimgx.academa.ai/developer-guide/documentation/index.md>)
- [The engine](<https://manimgx.academa.ai/developer-guide/engine/index.md>)
- [GitHub workflows](<https://manimgx.academa.ai/developer-guide/github-workflows/index.md>)
- [Project management](<https://manimgx.academa.ai/developer-guide/project-management/index.md>)
- [Testing](<https://manimgx.academa.ai/developer-guide/testing/index.md>)
- [Understanding manimgx](<https://manimgx.academa.ai/developer-guide/understanding-manimgx/index.md>)
- [Changelog](<https://manimgx.academa.ai/changelog/index.md>)