Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/yu314-coder/manim_app


https://github.com/yu314-coder/manim_app

Last synced: 5 months ago
JSON representation

Awesome Lists containing this project

README 

          
# 🎬 Manim Animation Studio



**Professional Desktop Environment for Creating Mathematical Animations**



A powerful, feature-rich desktop application for creating stunning mathematical animations using [Manim Community Edition](https://www.manim.community/). Built with Python, PyWebView, and modern web technologies.



![Version](https://img.shields.io/badge/version-1.0.9.0-blue)

![Python](https://img.shields.io/badge/python-3.8+-green)

![Platform](https://img.shields.io/badge/platform-Windows-lightgrey)

![License](https://img.shields.io/badge/license-MIT-orange)



---



## ✨ Features



### 🎨 **Professional Code Editor**

- **Monaco Editor** (VS Code's editor) with full Python syntax highlighting

- IntelliSense and autocomplete for Manim classes

- Real-time error detection and linting

- Line numbers, code folding, and multiple cursors

- Customizable font size and themes



### ⚡ **Dual Render Modes**

- **Quick Preview (F6)**: Fast, low-quality preview (480p, 15fps) for rapid iteration

- **Final Render (F5)**: High-quality output up to 8K resolution at 120fps

- GPU acceleration support (OpenGL renderer)

- Real-time progress tracking with live terminal output



### 📁 **Integrated Asset Management**

- Drag & drop file uploads

- Support for videos, images, fonts, audio, and subtitles

- Built-in asset preview with media player

- Organized asset library with file metadata

- Easy access to custom fonts and media files



### 📦 **Visual Package Manager**

- Install Python packages with one click

- Check for package updates

- Uninstall packages safely

- View installed packages and versions

- No terminal commands needed



### 🖥️ **Full-Featured Terminal**

- Real Windows cmd.exe integration with xterm.js

- Auto-activated virtual environment

- Copy/paste support (Ctrl+Shift+C/V)

- Persistent session across renders

- Color-coded output for better readability



### 🎯 **Smart Workflow Features**

- **Auto-save backups**: Never lose your work

- **File recovery**: Restore from auto-saved versions

- **Auto-open output folder**: Jump directly to saved renders

- **Live preview**: See your animation immediately after render

- **Settings persistence**: Your preferences are remembered



### 🌓 **Modern UI/UX**

- Dark/Light theme toggle

- Responsive design with DPI awareness

- Glassmorphic design elements

- Smooth animations and transitions

- Collapsible render controls sidebar

- Toast notifications for all actions



---



## 📸 Screenshots



### Main Workspace

The main interface features a split view with Monaco code editor on the left and live preview on the right, with an integrated terminal at the bottom.



### Asset Manager

Browse, upload, and preview all your media files in one organized location with drag-and-drop support.



### Package Manager

Install and manage Python packages through an intuitive visual interface without touching the command line.



---



## 🚀 Getting Started



### Prerequisites



- **Windows 10/11** (64-bit)

- **Python 3.8+** installed and in PATH

- **4GB RAM minimum** (8GB recommended)

- **1GB free disk space**



### Installation



1. **Download the latest release**

   ```

   Download from GitHub Releases

   ```



2. **Extract the archive**

   ```

   Extract to your preferred location

   ```



3. **Run the application**

   ```

   Double-click app.exe (or python app.py from source)

   ```



4. **First-time setup** (automatic)

   - Virtual environment creation

   - Manim installation

   - LaTeX detection and setup

   - Assets folder initialization



### Building from Source



```bash

# Clone the repository

git clone https://github.com/yourusername/manim-studio.git

cd manim-studio



# Install dependencies

pip install -r requirements.txt



# Run the application

python app.py

```



### Building Executable with Nuitka



```bash

# Activate build environment

python -m venv venv_nuitka

venv_nuitka\Scripts\activate



# Install Nuitka

pip install nuitka



# Build executable

python build_nuitka.py



# Output will be in dist_nuitka/

```



---



## 📖 Quick Start Guide



### Creating Your First Animation



1. **Launch Manim Studio**

   - The app opens with a default scene template



2. **Write Your Code**

   ```python

   from manim import *



   class MyScene(Scene):

       def construct(self):

           circle = Circle()

           self.play(Create(circle))

           self.wait()

   ```



3. **Preview (F6)**

   - Click "Preview" or press F6

   - Get a fast low-quality preview in seconds



4. **Final Render (F5)**

   - Click "Render" or press F5

   - Choose quality settings in the sidebar

   - Save your high-quality video when complete

   - **Output folder opens automatically** after saving



### Keyboard Shortcuts



| Action | Shortcut |

|--------|----------|

| Render Animation | `F5` |

| Quick Preview | `F6` |

| Stop Render | `Esc` |

| Save File | `Ctrl + S` |

| New File | `Ctrl + N` |

| Open File | `Ctrl + O` |



---



## 🎨 Using Assets



### Adding Custom Fonts



1. **Upload Font**

   - Go to Assets tab

   - Drag & drop your .ttf or .otf file



2. **Use in Code**

   ```python

   from manim import *



   class CustomFontExample(Scene):

       def construct(self):

           register_font("YourFont.ttf")

           text = Text("Hello!", font="YourFont")

           self.play(Write(text))

   ```



### Adding Images/Videos



1. **Upload Media**

   - Drag files to Assets tab dropzone

   - Supported: MP4, PNG, JPG, SVG, GIF



2. **Use in Animation**

   ```python

   from manim import *



   class ImageExample(Scene):

       def construct(self):

           img = ImageMobject("myimage.png")

           self.play(FadeIn(img))

   ```



### Adding Audio



```python

from manim import *



class AudioExample(Scene):

    def construct(self):

        self.add_sound("music.mp3")

        circle = Circle()

        self.play(Create(circle))

```



---



## ⚙️ Configuration



### Render Settings



**Quality Presets:**

- **480p**: 854×480, 15fps (Fast preview)

- **720p**: 1280×720, 30fps (Standard HD)

- **1080p**: 1920×1080, 60fps (Full HD)

- **1440p**: 2560×1440, 60fps (2K)

- **4K**: 3840×2160, 60fps (Ultra HD)

- **8K**: 7680×4320, 60fps (Cinema quality)



**Output Formats:**

- MP4 (H.264 video)

- MOV (QuickTime)

- GIF (Animated)

- PNG (Image sequence)



### GPU Acceleration



Toggle GPU rendering in the header toolbar:

- **GPU: OFF** = Cairo renderer (CPU, compatible)

- **GPU: ON** = OpenGL renderer (GPU, faster but may have quirks)



### Editor Settings



Access via Settings (⚙️ icon):

- Font size (12-20px)

- Default save location

- Auto-save after render

- Auto-open output folder

- Manim cache settings



---



## 📂 File Structure



```

C:\Users\\.manim_studio\

├── assets\              # Your uploaded files (fonts, images, audio)

├── media\               # Manim cache and temp files

├── render\              # High-quality render output (temporary)

├── preview\             # Quick preview output (temporary)

├── autosave\            # Auto-saved code backups

├── venvs\

│   └── manim_studio_default\  # Python virtual environment

└── settings.json        # Your app preferences

```



**Note:** Render outputs are temporary. Use the "Save" button after rendering to save them permanently to your chosen location. The output folder will open automatically in Windows Explorer after saving.



---



## 🐛 Troubleshooting



### Rendering Fails



**Problem:** Render shows errors in terminal



**Solutions:**

1. Check syntax errors (red underlines in editor)

2. Ensure all imported files exist in assets folder

3. Try Preview (F6) first to catch errors quickly

4. Check LaTeX status in System tab

5. Review terminal output for specific error messages



### Custom Fonts Not Working



**Problem:** Font doesn't appear in animation



**Solutions:**

1. Ensure font file is uploaded to Assets folder

2. Use `register_font("YourFont.ttf")` before using it

3. Reference font by name without extension: `font="YourFont"`

4. Check that font file is valid TrueType (.ttf) or OpenType (.otf)



### LaTeX Not Working



**Problem:** LaTeX formulas fail to render



**Solutions:**

1. Check LaTeX status indicator (header, right side)

2. Install MiKTeX or TeX Live if not present

3. Restart application after LaTeX installation

4. Use raw strings for LaTeX: `r"$\frac{1}{2}$"`



### Package Installation Fails



**Problem:** Cannot install Python packages



**Solutions:**

1. Check terminal output for specific error

2. Ensure package name is spelled correctly

3. Try installing via terminal manually

4. Check internet connection

5. Some packages may require system dependencies



### Video Won't Play in Preview



**Problem:** Preview panel shows no video after render



**Solutions:**

1. Check that render completed successfully (terminal logs)

2. Try refreshing Assets tab

3. Check file path is correct

4. Ensure video file exists and is not corrupted

5. Try a different browser (if using web version)



---



## 🔧 Advanced Usage



### Command Line Arguments



```bash

# Run with custom window size

python app.py --width 1920 --height 1080



# Run in debug mode

python app.py --debug



# Specify custom user data directory

python app.py --user-dir "D:\MyManimData"

```



### Environment Variables



```bash

# Use custom Python executable

set MANIM_PYTHON_EXE=C:\Python39\python.exe



# Custom media directory

set MANIM_MEDIA_DIR=D:\ManimOutput

```



### Virtual Environment Management



The app creates an isolated virtual environment at:

```

C:\Users\\.manim_studio\venvs\manim_studio_default\

```



You can manage it via the integrated terminal or Packages tab.



---



## 🤝 Contributing



Contributions are welcome! Here's how you can help:



1. **Report Bugs**: Open an issue with detailed reproduction steps

2. **Suggest Features**: Describe your use case and proposed solution

3. **Submit Pull Requests**: Fork, branch, code, test, and PR

4. **Improve Documentation**: Fix typos, add examples, clarify instructions



### Development Setup



```bash

# Clone and setup development environment

git clone https://github.com/yourusername/manim-studio.git

cd manim-studio



# Install development dependencies

pip install -r requirements-dev.txt



# Run in development mode

python app.py --debug

```



---



## 📜 License



This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.



---



## 🙏 Acknowledgments



- **[Manim Community](https://www.manim.community/)** - The amazing animation engine

- **[Monaco Editor](https://microsoft.github.io/monaco-editor/)** - VS Code's powerful editor

- **[PyWebView](https://pywebview.flowrl.com/)** - Native Python desktop apps

- **[xterm.js](https://xtermjs.org/)** - Terminal emulator for the web

- **Font Awesome** - Beautiful icons



---



## 📞 Support



- **Documentation**: Check the built-in Help modal (? icon)

- **Issues**: [GitHub Issues](https://github.com/yourusername/manim-studio/issues)

- **Discussions**: [GitHub Discussions](https://github.com/yourusername/manim-studio/discussions)

- **Manim Help**: [Manim Community Discord](https://discord.gg/manim)



---



## 🗺️ Roadmap



### Upcoming Features



- [ ] **Live Preview Mode**: See animations update in real-time as you type

- [ ] **Scene Browser**: Visual navigation between multiple scenes

- [ ] **Animation Templates**: Pre-built scenes for common use cases

- [ ] **Export Presets**: Save and reuse render configurations

- [ ] **Collaborative Editing**: Share projects with team members

- [ ] **Plugin System**: Extend functionality with custom plugins

- [ ] **macOS/Linux Support**: Cross-platform compatibility

- [ ] **Cloud Sync**: Sync settings and projects across devices

- [ ] **Mobile Companion**: Preview on mobile devices

- [ ] **Timeline Editor**: Visual animation timeline



---



## 📊 System Requirements



### Minimum



- **OS**: Windows 10 (64-bit)

- **CPU**: Dual-core 2.0 GHz

- **RAM**: 4GB

- **Storage**: 1GB free space

- **Display**: 1280×720



### Recommended



- **OS**: Windows 11 (64-bit)

- **CPU**: Quad-core 3.0 GHz

- **RAM**: 8GB+

- **GPU**: Dedicated graphics (for GPU rendering)

- **Storage**: 5GB free space (for cache)

- **Display**: 1920×1080 or higher



---



## 🎓 Learning Resources



### Manim Tutorials



- [Manim Community Docs](https://docs.manim.community/)

- [3Blue1Brown](https://www.youtube.com/c/3blue1brown) - Creator of Manim

- [Theorem of Beethoven](https://www.youtube.com/c/TheoremofBeethoven) - Manim tutorials

- [Manim Examples](https://docs.manim.community/en/stable/examples.html)



### Python Resources



- [Python Official Docs](https://docs.python.org/3/)

- [Real Python](https://realpython.com/)

- [Python for Data Science](https://www.python.org/about/gettingstarted/)



---



## ⭐ Star History



If you find this project useful, please consider giving it a star on GitHub!



[![Star History Chart](https://api.star-history.com/svg?repos=yourusername/manim-studio&type=Date)](https://star-history.com/#yourusername/manim-studio&Date)



---



## 📝 Changelog



### v1.0.9.0 (Latest)

- ✨ **Auto-open output folder** after saving rendered files

- ✨ Improved render controls sidebar with chevron collapse icon

- 🎨 Enhanced toast notifications with comprehensive logging

- 🐛 Fixed async button handler for folder opening

- 🐛 Improved DPI awareness and responsive scaling

- 📖 Added comprehensive README documentation



### v1.0.8.0

- ✨ Added Package Manager with visual interface

- ✨ Drag & drop asset uploads

- 🐛 Fixed GPU toggle persistence

- 🐛 Fixed autosave recovery dialog

- 🎨 Improved responsive scaling and DPI awareness



### v1.0.7.0

- ✨ Added auto-save with backup recovery

- ✨ Integrated xterm.js terminal

- 🐛 Fixed LaTeX detection

- 🎨 Improved dark theme



### v1.0.6.0

- ✨ Initial public release

- 🎨 Professional UI with Monaco Editor

- ⚡ Dual render modes (Preview/Final)

- 📁 Asset management system



[View Full Changelog](CHANGELOG.md)



---






**Made with ❤️ for the Manim Community**



[⬆ Back to Top](#-manim-animation-studio)