manimgl-best-practices

Files (107)

• LICENSE.txt
• SKILL.md
• attention_arcs_animation.py · examples/
• attention_pattern_dots.py · examples/
• attention_scenes.py · examples/
• attention_softmax_masking.py · examples/
• autoregressive_flow.py · examples/
• basic_multihead.py · examples/
• bloch_sphere_3d.py · examples/
• block_collision_basic.py · examples/
• blocks_3d.py · examples/
• collision_phase_space.py · examples/
• complex_s_plane.py · examples/
• cost_function.py · examples/
• cube_projection_3d.py · examples/
• damped_solutions_splane.py · examples/
• dot_product_visualization.py · examples/
• double_slit_interference.py · examples/
• eigenvalue_equations.py · examples/
• eigenvector_flow_field.py · examples/
• eigenvector_matrix_transformation.py · examples/
• elastic_collision_vectors.py · examples/
• embedding_matrix.py · examples/
• equation_transforms.py · examples/
• exponential_derivative.py · examples/
• fibonacci_eigenvalues.py · examples/
• gradient_descent_basic.py · examples/
• hexagon_cube_correspondence.py · examples/
• integration_visualization.py · examples/
• laplace_integral.py · examples/
• light_polarization.py · examples/
• linear_regression.py · examples/
• llm_prediction_pipeline.py · examples/
• lorenz_attractor.py · examples/
• lozenge_tiling.py · examples/
• max_random_process.py · examples/
• mlp_forward_pass.py · examples/
• mlp_network_icon.py · examples/
• mlp_neuron_activation.py · examples/
• mlp_neurons_flow.py · examples/
• mlp_relu_visualization.py · examples/
• mlp_vector_space.py · examples/
• mlp_weight_matrix.py · examples/
• multi_head_attention.py · examples/
• network_block_flow.py · examples/
• neural_network_basic.py · examples/
• parallax_starfield.py · examples/
• probability_distribution.py · examples/
• probability_output.py · examples/
• quantum_gates.py · examples/
• qubit_state_vector.py · examples/
• query_key_dot_products.py · examples/
• query_key_space_mapping.py · examples/
• radial_wave_visualization.py · examples/
• rotating_exponentials.py · examples/
• semantic_similarity.py · examples/
• simple_test.py · examples/
• softmax_visualization.py · examples/
• solve_damped_ode.py · examples/
• spring_mass_system.py · examples/
• …and 47 more

SKILL.md (first lines)

## How to use

Read individual rule files for detailed explanations and code examples:

### Core Concepts
- [rules/scenes.md](rules/scenes.md) - InteractiveScene, Scene types, and construct method
- [rules/mobjects.md](rules/mobjects.md) - Mobject types, VMobject, Groups, and positioning
- [rules/animations.md](rules/animations.md) - Animation classes, playing animations, and timing

### Creation & Transformation
- [rules/creation-animations.md](rules/creation-animations.md) - ShowCreation, Write, FadeIn, DrawBorderThenFill
- [rules/transform-animations.md](rules/transform-animations.md) - Transform, ReplacementTransform, TransformMatchingTex
- [rules/animation-groups.md](rules/animation-groups.md) - LaggedStart, Succession, AnimationGroup

### Text & Math
- [rules/tex.md](rules/tex.md) - Tex class, raw strings R"...", and LaTeX rendering
- [rules/text.md](rules/text.md) - Text mobjects, fonts, and styling
- [rules/t2c.md](rules/t2c.md) - tex_to_color_map (t2c) for coloring math expressions

### Styling & Appearance
- [rules/colors.md](rules/colors.md) - Color constants, gradients, RGB, hex, GLSL coloring
- [rules/styling.md](rules/styling.md) - Fill, stroke, opacity, backstroke, gloss, shadow

### 3D & Camera
- [rules/3d.md](rules/3d.md) - 3D objects, surfaces, Sphere, Torus, parametric surfaces, lighting
- [rules/camera.md](rules/camera.md) - frame.reorient(), Euler angles, fix_in_frame(), camera animations

### Interactive Development
- [rules/interactive.md](rules/interactive.md) - Interactive mode with `-se` flag, checkpoint_paste()
- [rules/frame.md](rules/frame.md) - self.frame, camera control, reorient, and zooming
- [rules/embedding.md](rules/embedding.md) - self.embed() for IPython debugging, touch() mode

### Configuration & CLI
- [rules/cli.md](rules/cli.md) - manimgl command, flags (-w, -o, -se, -l, -h), rendering options
- [rules/config.md](rules/config.md) - custom_config.yml, directories, camera settings, quality presets

## Working Examples

Complete, tested example files demonstrating common patterns:

- [examples/simple_test.py](examples/simple_test.py) - Minimal scene: basic shapes, text, and animations
- [examples/equation_transforms.py](examples/equation_transforms.py) - LaTeX equations and mathematical content
- [examples/linear_regression.py](examples/linear_regression.py) - Axes, functions, and graphing
- [examples/three_d_surfaces.py](examples/three_d_surfaces.py) - 3D scenes with camera control and surfaces
- [examples/vector_fields.py](examples/vector_fields.py) - Dynamic animations with updaters and flow fields

## Scene Templates

Copy and modify these templates to start new projects:

- [templates/basic_scene.py](templates/basic_scene.py) - Standard 2D scene template
- [templates/interactive_scene.py](templates/interactive_scene.py) - InteractiveScene with self.embed()
- [templates/3d_scene.py](templates/3d_scene.py) - 3D scene with frame.reorient()
- [templates/math_scene.py](templates/math_scene.py) - Mathematical derivations and equations

## Quick Reference

### Basic Scene Structure
```python
from manimlib import *

class MyScene(InteractiveScene):
    def construct(self):
        # Create mobjects
        circle = Circle()

        # Add to scene (static)
        self.add(circle)

        # Or animate
        self.play(ShowCreation(circle))  # Note: ShowCreation, not Create

        # Wait
        self.wait(1)
```

### Render Command
```bash
# Render and preview
manimgl scene.py MyScene

# Interactive mode - drop into shell at line 15
manimgl scene.py MyScene -se 15

# Write to file
manimgl scene.py MyScene -w

# Low quality for testing
manimgl scene.py MyScene -l
```

### Key Differences from ManimCE

| Feature | ManimGL (3b1b) | Manim Community |
|---------|----------------|-----------------|
| Import | `from manimlib import *` | `from manim import *` |
| CLI | `manimgl` | `manim` |
| Math text | `Tex(R"\pi")` | `MathTex(r"\pi")` |
| Scene | `InteractiveScene` | `Scene` |
| Create anim | `ShowCreation` | `Create` |
| Camera | `self.frame` | `self.camera.frame` |
| Fix in frame | `mob.fix_in_frame()` | `self.add_fixed_in_frame_mobjects(mob)` |
| Package | `manimgl` (PyPI) | `manim` (PyPI) |

### Interactive Development Workflow

ManimGL's killer feature is interactive development:

```bash
# Start at line 20 with state preserved
manimgl scene.py MyScene -se 20
```

In interactive mode:
```python
# Copy code to clipboard, then run:
checkpoint_paste()           # Run with animations
checkpoint_paste(skip=True)  # Run instantly (no animations)
checkpoint_paste(record=True) # Record while running

From MoizIbnYousaf/marketing-cli, MIT.

More from MoizIbnYousaf/marketing-cli