manim README

The project's README from github.com/3b1b/manim. As one markdown file: README.md.

pypi version MIT License Manim Subreddit Manim Discord docs

Manim is an engine for precise programmatic animations, designed for creating explanatory math videos.

Note, there are two versions of manim. This repository began as a personal project by the author of 3Blue1Brown for the purpose of animating those videos, with video-specific code available here. In 2020 a group of developers forked it into what is now the community edition, with a goal of being more stable, better tested, quicker to respond to community contributions, and all around friendlier to get started with. See this page for more details.

Installation

[!Warning] WARNING: These instructions are for ManimGL only. Trying to use these instructions to install Manim Community/manim or instructions there to install this version will cause problems. You should first decide which version you wish to install, then only follow the instructions for your desired version.

[!Note] Note: To install manim directly through pip, please pay attention to the name of the installed package. This repository is ManimGL of 3b1b. The package name is manimgl instead of manim or manimlib. Please use pip install manimgl to install the version in this repository.

Manim runs on Python 3.10 or higher.

System requirements are FFmpeg, OpenGL and LaTeX (optional, if you want to use LaTeX). For Linux, Pango along with its development headers are required. See instruction here.

Directly

# Install manimgl
pip install manimgl

# Try it out
manimgl

For more options, take a look at the Using manim sections further below.

If you want to hack on manimlib itself, clone this repository and in that directory execute:

# Install manimgl
pip install -e .

# Try it out
manimgl example_scenes.py OpeningManimExample
# or
manim-render example_scenes.py OpeningManimExample

Linux (Ubuntu/Debian)

  1. Install system dependencies.
sudo apt update

sudo apt install ffmpeg
sudo apt install python3-pip
sudo apt install libpango1.0-dev
  1. Install a lightweight LaTeX distribution (optional, for LaTeX rendering).
sudo apt install texlive-science texlive-fonts-extra texlive-latex-extra

This lightweight setup is significantly smaller than installing texlive-full while still supporting most Manim projects.

  1. Clone and install ManimGL.
git clone https://github.com/3b1b/manim.git
cd manim

python3 -m pip install -e .

manimgl example_scenes.py OpeningManimExample
💡 Optional: Using a virtual environment (venv)

It is recommended to use a virtual environment to avoid conflicts with system packages.

sudo apt install python3-venv

python3 -m venv venv
source venv/bin/activate

python3 -m pip install -e .

If python3-venv is unavailable on your system, try installing the version-specific package instead:

sudo apt install python3.12-venv

Directly (Windows)

  1. Install FFmpeg.
  2. Install a LaTeX distribution. MiKTeX is recommended.
  3. Install the remaining Python packages.
    git clone https://github.com/3b1b/manim.git
cd manim
pip install -e .
manimgl example_scenes.py OpeningManimExample

Mac OSX

  1. Install FFmpeg, LaTeX in terminal using homebrew.

    brew install ffmpeg mactex
    💡 An alternative to heavyweight MacTeX bundle.

    To avoid installing the full MacTeX bundle, which is ~6GB, you can alternatively install the lightweight BasicTeX and then gradually add only the LaTeX packages you actually need. A list of packages sufficient to run examples can be found here. For an overview of the MacTeX installer bundles, see https://www.tug.org/mactex/.

  2. If you are using an ARM-based processor, install Cairo. 

    arch -arm64 brew install pkg-config cairo

  3. Install latest version of manim using these command.

    git clone https://github.com/3b1b/manim.git
cd manim
pip install -e .
manimgl example_scenes.py OpeningManimExample

    If the last command is not found, make sure the directory pip installed manimgl into is on your PATH.

Anaconda Install

  1. Install LaTeX as above.
  2. Create a conda environment using conda create -n manim python=3.10.
  3. Activate the environment using conda activate manim.
  4. Install manimgl using pip install -e ..

Using manim

Try running the following:

manimgl example_scenes.py OpeningManimExample

This should pop up a window playing a simple scene.

Look through the example scenes to see examples of the library's syntax, animation types and object types. In the 3b1b/videos repo, you can see all the code for 3blue1brown videos, though code from older videos may not be compatible with the most recent version of manim. The readme of that repo also outlines some details for how to set up a more interactive workflow, as shown in this manim demo video for example.

When running in the CLI, some useful flags include:

Take a look at custom_config.yml for further configuration. To add your customization, you can either edit this file, or add another file by the same name "custom_config.yml" to whatever directory you are running manim from. For example this is the one for 3blue1brown videos. There you can specify where videos should be output to, where manim should look for image files and sounds you want to read in, and other defaults regarding style and video quality.

Documentation

Documentation is in progress at 3b1b.github.io/manim. And there is also a Chinese version maintained by @manim-kindergarten: docs.manim.org.cn (in Chinese).

manim-kindergarten wrote and collected some useful extra classes and some codes of videos in manim_sandbox repo.

Contributing

Is always welcome. As mentioned above, the community edition has the most active ecosystem for contributions, with testing and continuous integration, but pull requests are welcome here too. Please explain the motivation for a given change and examples of its effect.

License

This project falls under the MIT license.

manim (3b1b/manim)

Searching Database…

95.2K ·GitHub
Manim
What is this?ManimGL is a Python engine for precise programmatic animations, designed for creating explanatory math videos — the tool built by 3Blue1Brown's author to animate his videos.
Is it a Python library I write code with, or a standalone app?A code-first library: you write scenes as Python code and run them, which pops up a window playing the scene; the example scenes double as a tour of the syntax and animation types.
pip install manim — is that the right command here?Not quite: this repo installs as pip install manimgl. The plain manim package is the community edition, forked from this code in 2020 — mixing the two versions' install instructions causes problems.
What has to be on my machine besides Python?FFmpeg and OpenGL are required, LaTeX is optional and only needed if you want LaTeX rendering, and Linux additionally needs Pango with its development headers. Python 3.10 or higher is the floor.
If I grab code from real 3Blue1Brown videos, will it still run?The full code for the videos lives in the 3b1b/videos repo, but code from older videos may not be compatible with the most recent version of manim, so treat old scenes as starting points to adapt.
Does it run on Windows and Mac, or is this Linux-only?All three — the README walks through installs for Ubuntu/Debian, Windows (FFmpeg plus MiKTeX for LaTeX) and macOS via Homebrew, and ARM-based Macs additionally need Cairo.
How do I get a video file out of it?Command-line flags handle output: -w writes the scene to a file, -o writes it and opens the result, -s skips to the end and just shows the final frame, -so saves that frame as an image, -n jumps ahead to the n'th animation, and -f makes the playback window fullscreen.
Is there an interactive mode, or is it render-only?There is a more interactive workflow: the readme of the 3b1b/videos repo outlines how to set it up, and a manim demo video shows it in action.
Can I control where videos are saved and where assets are read from?Yes — put a customconfig.yml in the directory you run manim from (or edit the existing one) to set the video output location, where manim looks for image files and sounds, and defaults for style and video quality.
What are similar projects?manim, Gource, fframes, videos, mpv, world-execute-me-dsh-pv, live-panel-skill, effectcraft
Which topics is it in?mit-license, latex, mathematics, opengl, interactive, python-library, youtube, rendering, visualization, ffmpeg, graphics, video
Creator
3b1b
Size
75.5 MB
Stars
95.2K
Updated
CommitSep 09Releasev1.7.2Dec 13
Age
11y
Commits · 90 Days