Manim Sideview installs statistics

Manim Sideview

<img src="https://repository-images.githubusercontent.com/429329947/d3f3cf71-a491-47e0-a629-34e0a4b9051f" height="100%" width="300px">

A Visual Studio Code extension that enhances your experience with manim, providing powerful features including gallery-based code snippet catalogs and live preview of videos and images with flexible configuration options.

Prerequisites

• Manim Installation: Ensure you have manim installed on your PATH. Check out the official installation guide.
• Python Environment: The extension works with your active Python environment.
• Custom Executable Path: If manim isn't on your PATH, you can set a custom executable path.

Table Of Contents

• Getting Started
• Rendering Scenes
• Configuring
• Mobject Gallery
• Frequently Asked Questions
• Keyboard Shortcuts
• Credits
• Changelog

Getting Started

After the extension is installed, open the source file with the scene classes and press the <image src="https://raw.githubusercontent.com/Rickaym/Manim-Sideview/master/assets/images/rotation.png" height="100%" width= "15px"> icon from the menu bar or use Ctrl+' r to immediately start rendering with a live preview!

<image src="https://raw.githubusercontent.com/Rickaym/manim-sideview/master/images/quickstart.gif">

That's it, folks!

If you have any questions or find any issues, create a GitHub issue here, seek support through the extension development discord server or you can ping @rick.aym with a question on the official manim community discord server.

Rendering Scenes

<image src="https://raw.githubusercontent.com/Rickaym/Manim-Sideview/master/assets/images/dark_logo.png" height="100%" width= "20px"></image> Working with multiple scenes

After rendering a scene for the first time, the extension creates a persistent job tied to the source file to maintain your scene names and configurations.

Changing the Scene Name

Manim Sideview renders one scene at a time. To switch between scenes, you can:

1. Use the Manim: Set A New SceneName command through the command palette (Shift + Command + P on Mac / Ctrl + Shift + P on Windows/Linux)
2. Use the default hotkey Ctrl + ' followed by c
3. Click the render-change icon in the sideview:<br> <image src="https://raw.githubusercontent.com/Rickaym/Manim-Sideview/master/images/render-change.png"></image>

Scene Auto-Detection

When you first render a file, the extension will scan for any class that inherits from a Scene class and present them as options for easy selection.

Configuring

<image src="https://raw.githubusercontent.com/Rickaym/Manim-Sideview/master/assets/images/dark_logo.png" height="100%" width= "20px"></image> You can configure your renders in two primary ways:

1. VS Code Settings

Set manim-sideview.commandLineArgs in your VS Code settings (File -> Preferences -> Settings) to pass CLI arguments to manim.

[!WARNING] Avoid using quality args like 'ql' that change the output file path. For output path configuration, use the manim.cfg file instead.

2. Configuration File

Create a manim.cfg file in your working directory following the Manim configuration guidelines.

Note: When a manim.cfg file is detected, all command line arguments from manim-sideview.commandLineArgs are ignored.

Mobject Gallery

The Mobject gallery is a web view that allows users to insert code snippets for commonly used manim objects, like squares, text, and also complex graphs.

How do I open the gallery?

1. Open the command palette using Shift + Command + P (Mac) / Ctrl + Shift + P
2. Use the command Manim: Open Mobject Gallery

You can place the cursor at the desired location and click the image of the manim object to insert the code into a Python file or Jupyter Notebook!

Frequently Asked Questions…