README

An animation engine for explanatory math videos



Manim is an animation engine for explanatory math videos. It's used to create precise animations programmatically, as demonstrated in the videos of 3Blue1Brown.

 [!NOTE]
 The community edition of Manim (ManimCE) is a version maintained and developed by the community. It was forked from 3b1b/manim, a tool originally created and open-sourced by Grant Sanderson, also creator of the 3Blue1Brown educational math videos. While Grant Sanderson continues to maintain his own repository, we recommend this version for its continued development, improved features, enhanced documentation, and more active community-driven maintenance. If you would like to study how Grant makes his videos, head over to his repository (3b1b/manim).

 Table of Contents:

- Installation
- Usage
- Documentation
- Docker
- Help with Manim
- Contributing
- License

 Installation

 [!CAUTION]
 These instructions are for the community version _only_. Trying to use these instructions to install 3b1b/manim or instructions there to install this version will cause problems. Read this and decide which version you wish to install, then only follow the instructions for your desired version.

Manim requires a few dependencies that must be installed prior to using it. If you
want to try it out first before installing it locally, you can do so
in our online Jupyter environment.

For local installation, please visit the Documentation
and follow the appropriate instructions for your operating system.

 Usage

Manim is an extremely versatile package. The following is an example Scene you can construct:

python
from manim import 


class SquareToCircle(Scene):
    def construct(self):
        circle = Circle()
        square = Square()
        square.flip(RIGHT)
        square.rotate(-3  TAU / 8)
        circle.set_fill(PINK, opacity=0.5)

        self.play(Create(square))
        self.play(Transform(square, circle))
        self.play(FadeOut(square))


In order to view the output of this scene, save the code in a file called example.py. Then, run the following in a terminal window:

sh
manim -p -ql example.py SquareToCircle


You should see your native video player program pop up and play a simple scene in which a square is transformed into a circle. You may find some more simple examples within this
GitHub repository. You can also visit the official gallery for more advanced examples.

Manim also ships with a %%manim IPython magic which allows to use it conveniently in JupyterLab (as well as classic Jupyter) notebooks. See the
corresponding documentation for some guidance and
try it out online.

 Command line arguments

The general usage of Manim is as follows:

!manim-illustration

The -p flag in the command above is for previewing, meaning the video file will automatically open when it is done rendering. The -ql flag is for a faster rendering at a lower quality.

Some other useful flags include:

- -s to skip to the end and just show the final 

Top issues

Discussions

Latest release

See our rendered changelog.

 What's Changed
 Bug Fixes 🐛
 Fix ImageMobject rendering with Pillow 13 by @behackl in https://github.com/manimcommunity/manim/pull/5074
 Fix OpenGLImageMobject rendering by @behackl in https://github.com/manimcommunity/manim/pull/5081
 Fix Line bending when expanded from a near-zero length by @WhyTan00 in https://github.com/manimcommunity/manim/pull/5078

 Documentation 📚
 Fix doubled backslashes in raw docstrings by @ExploreMaths in https://github.com/manimcommunity/manim/pull/5063
 Warn against combining .animate on a group and its submobjects in one p