Metadata-Version: 2.4
Name: mscene
Version: 0.1.2
Summary: A Python library for programming animation scenes with Manim in Google Colab.
Project-URL: Homepage, https://mscene.curiouswalk.com
Project-URL: Repository, https://github.com/curiouswalk/mscene
Author: CuriousWalk
Author-email: hello@curiouswalk.com
License: MIT License
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Education
Classifier: Topic :: Multimedia
Classifier: Topic :: Scientific/Engineering
Description-Content-Type: text/markdown

[![Mscene](https://mscene.curiouswalk.com/assets/github_banner.png)](https://mscene.curiouswalk.com)

# Mscene

A Python library for programming animation scenes with Manim in Google Colab to create science videos directly in the browser. &#10024;&nbsp;[mscene.curiouswalk.com](https://mscene.curiouswalk.com)

Manim is an animation engine designed to program precise animations for science videos.<br>Google Colab (Colaboratory) is a hosted Jupyter Notebook service that requires no setup and provides free access to computing resources, including GPUs and TPUs.

>The Manim Community Developers. Manim &mdash; Mathematical Animation Framework [Computer software].<br>[www.manim.community](https://www.manim.community)

<a href="https://mscene.curiouswalk.com/colab"><img align="center" height="24" src="https://img.shields.io/badge/Colab-silver?logo=googlecolab&labelColor=grey"></a>&emsp;<a href="https://mscene.curiouswalk.com/docs"><img align="center" height="24" src="https://img.shields.io/badge/Docs-silver?logo=readthedocs&logoColor=blue&labelColor=grey"></a>

## Quick Start

### Manim in Colab

Create a new Colab notebook at *[colab.new](https://colab.new)* and run the cells below.

**Install & Import Mscene**

```python
%pip install mscene
import mscene
```
**View Commands**

```python
%mscene -h
```
**Install & Import Manim**

```python
%mscene -l manim
```

**View Manim [Gallery](https://docs.manim.community/en/stable/examples.html)**

```python
%%manim -qm ExampleScene
class ExampleScene(Scene):
    def construct(self):
        banner = ManimBanner()
        self.play(banner.create())
        self.play(banner.expand())
        self.wait(1.5)
```

### Mscene Plugins

Plugins extend Manim with additional features.

**Add & Import Plugins**

```python
%mscene plugins
```

**View Mscene [Plugins](https://mscene.curiouswalk.com/plugins)**

```python
%%manim -qm PluginScene
class PluginScene(Scene):
    def construct(self):
        ks = KochSnowflake(2)
        self.add(ks)
        self.play(ks.animate.next_level())
        self.wait(1)
        self.play(ks.animate.prev_level())
        self.wait(1)
```
---
