Plugins are features that extend Manim’s core functionality. Since Manim is extensible and not everything belongs in its core, we’ll go over how to install, use, and create your own plugins.
The standard naming convention for plugins is to prefix the plugin with
manim-. This makes them easy for users to find on package
repositories such as PyPI.
The plugin feature is new and under active development. Expect updates
for the best practices on installing, using, and creating plugins; as
well as new subcommands/flags for
See https://plugins.manim.community/ for the list of plugins available.
Plugins can be easily installed via the
pip install manim-*
After installing a plugin, you may use the
manim plugins command to list
your available plugins, see the following help output:
manim plugins -h Usage: manim plugins [OPTIONS] Manages Manim plugins. Options: -l, --list List available plugins -h, --help Show this message and exit. Made with <3 by Manim Community developers.
You can list plugins as such:
manim plugins -l Plugins: • manim_plugintemplate
Using Plugins in Projects¶
For enabling a plugin
manim.cfg or command line parameters should be used.
The plugins should be module name of the plugin and not PyPi name.
Enabling plugins through
[CLI] plugins = manim_rubikscube
For specifying multiple plugins, command separated values must be used.
[CLI] plugins = manim_rubikscube, manim_plugintemplate
Plugins are intended to extend Manim’s core functionality. If you aren’t sure whether a feature should be included in Manim’s core, feel free to ask over on the Discord server. Visit manim-plugintemplate on PyPI.org which serves as an in-depth tutorial for creating plugins.
pip install manim-plugintemplate
The only requirement of manim plugins is that they specify an entry point
with the group,
"manim.plugins". This allows Manim to discover plugins
available in the user’s environment. Everything regarding the plugin’s
directory structure, build system, and naming are completely up to your
discretion as an author. The aforementioned template plugin is only a model
using Poetry since this is the build system Manim uses. The plugin’s entry
point can be
specified in poetry as:
[tool.poetry.plugins."manim.plugins"] "name" = "object_reference"
name is the name of the module of the plugin.
object_reference can point to either a function in a module or a module
itself. For example,
[tool.poetry.plugins."manim.plugins"] "manim_plugintemplate" = "manim_plugintemplate"
Here a module is used as
object_reference, and when this plugin is enabled,
Manim will look for
__all__ keyword defined in
everything as a global variable one by one.
object_reference is a function, Manim calls the function and expects the
function to return a list of modules or functions that need to be defined globally.
[tool.poetry.plugins."manim.plugins"] "manim_plugintemplate" = "manim_awesomeplugin.imports:setup_things"
Here, Manim will call the function
setup_things defined in
manim_awesomeplugin.imports and calls that. It returns a list of function or
modules which will be imported globally.