Metadata-Version: 2.4
Name: manim_extensions
Version: 1.0.4
Summary: A package for tools and extensions in Manim
Author: ExploreMaths
License: MIT
Project-URL: Homepage, https://github.com/ExploreMaths/manim_extensions
Project-URL: Issues, https://github.com/ExploreMaths/manim_extensions/issues
Keywords: manim,animation,math,latex,geometry
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Multimedia :: Video
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: manim>=0.19.1
Requires-Dist: Pillow
Requires-Dist: opencv-python
Requires-Dist: pymunk
Requires-Dist: kociemba
Requires-Dist: shapely
Requires-Dist: trimesh
Requires-Dist: xmltodict
Requires-Dist: numpy>=2.0
Requires-Dist: scipy
Requires-Dist: moderngl
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx>=7.0; extra == "docs"
Requires-Dist: furo>=2024.0; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints>=2.0; extra == "docs"
Requires-Dist: myst-parser>=3.0; extra == "docs"
Dynamic: license-file

﻿<div align="center">

# <img src="docs/source/_static/favicon.svg" align="top" width=45> Manim Extensions

**An extension toolkit for [Manim](https://www.manim.community/)** — reusable mobjects, geometric computations, and animations to help you build mathematical videos faster.

[![PyPI version](https://img.shields.io/pypi/v/manim-extensions.svg)](https://pypi.org/project/manim-extensions/)
[![Python versions](https://img.shields.io/pypi/pyversions/manim-extensions.svg)](https://pypi.org/project/manim-extensions/)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![Python package](https://github.com/ExploreMaths/manim_extensions/actions/workflows/python-package.yml/badge.svg)](https://github.com/ExploreMaths/manim_extensions/actions/workflows/python-package.yml)
[![Validate](https://github.com/ExploreMaths/manim_extensions/actions/workflows/validate.yml/badge.svg)](https://github.com/ExploreMaths/manim_extensions/actions/workflows/validate.yml)
[![Docs](https://readthedocs.org/projects/manim-extensions/badge/?version=latest)](https://manim-extensions.readthedocs.io/en/latest/)
[![Repo Size](https://img.shields.io/github/repo-size/ExploreMaths/manim_extensions?style=flat)](https://github.com/ExploreMaths/manim_extensions)
 [![Monthly Downloads](https://img.shields.io/pypi/dm/manim_extensions?style=flat)](https://pypi.org/project/manim_extensions/)

</div>

---

`manim_extensions` extends [Manim](https://www.manim.community/) with:

- **Chinese formula support** — render Chinese characters inside `MathTex` via `xelatex` / `xeCJK`
- **Reusable mobjects** — labelled dots, braces and arrows tied to formulas, file trees, motion trails, shadows, 3D vectors, tree diagrams, and more
- **Geometry helpers** — circle / line / arc intersections and tangent points
- **Common animations** — typewriting, random / reverse writes, highlights, sweep effects, and extra easing functions
- **Bundled toolkits** — involute gears, mind maps / timelines / catalog diagrams, compass-and-straightedge constructions, algorithm visualisation, automata, circuits, data structures, meshes, neural networks, physics, Rubik's cube, sequence diagrams, and TikZ integration

## Modules

| Package | Description |
|---------|-------------|
| `manim_extensions.mobjects`   | Custom mobjects (Basic) |
| `manim_extensions.geometry`   | Geometric calculation functions (Basic) |
| `manim_extensions.animations` | Animations and easing functions (Basic) |
| `manim_extensions.gearbox`    | Involute gears and racks |
| `manim_extensions.mindmap`    | Mind maps, timelines, catalog diagrams |
| `manim_extensions.compass`    | Compass, ruler, pencil, and construction animations |
| `manim_extensions.algorithm`  | Algorithm visualisation helpers |
| `manim_extensions.automata`   | Automata visualisation helpers |
| `manim_extensions.circuit`    | Circuit diagram animations |
| `manim_extensions.data_structures` | Data structure animations |
| `manim_extensions.meshes`     | Mesh and geometry visualisation |
| `manim_extensions.neural_network` | Neural-network visualisation |
| `manim_extensions.physics`    | Physics simulation helpers |
| `manim_extensions.rubikscube` | Rubik's Cube animation toolkit |
| `manim_extensions.sequence_diagram` | Sequence diagram animations |
| `manim_extensions.tikz`       | TikZ import helpers |

## Bundled plugins

The following third-party Manim plugins are bundled directly as subpackages
inside `manim_extensions`:

- `manim-algorithm` → `manim_extensions.algorithm`
- `manim-automata` → `manim_extensions.automata`
- `manim-circuit` → `manim_extensions.circuit`
- `manim-data-structures` → `manim_extensions.data_structures`
- `manim-meshes` → `manim_extensions.meshes`
- `manim-neural-network` → `manim_extensions.neural_network`
- `manim-physics` → `manim_extensions.physics`
- `manim-rubikscube` → `manim_extensions.rubikscube`
- `manim-sequence-diagram` → `manim_extensions.sequence_diagram`
- `manim-tikz` → `manim_extensions.tikz`

Installing `manim_extensions` lets you import them directly from the package
namespace and guarantees compatible versions. See the
[documentation](https://manim-extensions.readthedocs.io/) for details and
attribution to the original authors.

## Documentation

Full API reference: **[manim-extensions.readthedocs.io](https://manim-extensions.readthedocs.io/)**

## Installation

```bash
pip install manim_extensions
```

Requires [Manim](https://github.com/ManimCommunity/manim). For the Chinese-formula
features you also need `xelatex` with the `xeCJK` package installed.

## License

[MIT](LICENSE)
