2021-01-28 19:54:57 +00:00
<!doctype html>
< html class = "no-js" >
< head > < meta charset = "utf-8" / >
2021-11-28 10:52:56 +00:00
< meta name = "viewport" content = "width=device-width,initial-scale=1" / > < meta name = "generator" content = "Docutils 0.18.1: http://docutils.sourceforge.net/" / >
2021-04-11 11:26:13 +00:00
< link rel = "index" title = "Index" href = "../genindex.html" / > < link rel = "search" title = "Search" href = "../search.html" / > < link rel = "next" title = "Example Scenes" href = "example_scenes.html" / > < link rel = "prev" title = "Quick Start" href = "quickstart.html" / >
2021-01-28 19:54:57 +00:00
2021-01-31 14:35:44 +00:00
< link rel = "shortcut icon" href = "../_static/icon.png" / > < meta name = "generator" content = "sphinx-3.0.3, furo 2020.10.05.beta9" / >
2021-01-28 19:54:57 +00:00
< title > CLI flags and configuration - manim documentation< / title >
< link rel = "stylesheet" href = "../_static/copybutton.css" / >
2021-07-18 14:25:47 +00:00
< link rel = "stylesheet" href = "https://cdn.jsdelivr.net/gh/manim-kindergarten/CDN@master/manimgl_assets/custom.css" / >
< link rel = "stylesheet" href = "https://cdn.jsdelivr.net/gh/manim-kindergarten/CDN@master/manimgl_assets/colors.css" / >
2022-05-15 00:49:09 +00:00
< link rel = "stylesheet" href = "../_static/styles/default.css?989fc0aad45d86e6fe6a8e29" >
< link rel = "stylesheet" href = "../_static/pygments.css?989fc0aad45d86e6fe6a8e29" >
2021-01-28 19:54:57 +00:00
< style >
:root {
--color-code-background: #f8f8f8;
--color-code-foreground: #000000;
}
< / style >
< script id = "documentation_options" data-url_root = "../" src = "../_static/documentation_options.js" > < / script > < script src = "../_static/jquery.js" > < / script >
< script src = "../_static/underscore.js" > < / script >
< script src = "../_static/doctools.js" defer > < / script >
2021-01-31 14:35:44 +00:00
< script src = "../_static/language_data.js" defer > < / script >
2021-01-28 19:54:57 +00:00
< script src = "../_static/clipboard.min.js" > < / script >
2022-05-15 00:49:09 +00:00
< script src = "../_static/copybutton.js" > < / script > < script src = "../_static/scripts/main.js?989fc0aad45d86e6fe6a8e29" > < / script > < / head >
2021-01-28 19:54:57 +00:00
< body dir = "" >
< svg xmlns = "http://www.w3.org/2000/svg" style = "display: none;" >
< symbol id = "svg-toc" viewBox = "0 0 24 24" >
< title > Contents< / title >
< svg xmlns = "http://www.w3.org/2000/svg" width = "24" height = "24" viewBox = "0 0 24 24" fill = "none"
stroke-width="1.5" stroke="#101010" stroke-linecap="round" stroke-linejoin="round">
< path stroke = "none" d = "M0 0h24v24H0z" / >
< line x1 = "4" y1 = "6" x2 = "20" y2 = "6" / >
< line x1 = "10" y1 = "12" x2 = "20" y2 = "12" / >
< line x1 = "6" y1 = "18" x2 = "20" y2 = "18" / >
< / svg >
< / symbol >
< symbol id = "svg-menu" viewBox = "0 0 24 24" >
< title > Menu< / title >
< svg xmlns = "http://www.w3.org/2000/svg" width = "24" height = "24" viewBox = "0 0 24 24" fill = "none"
stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"
class="feather feather-menu">
< line x1 = "3" y1 = "12" x2 = "21" y2 = "12" > < / line >
< line x1 = "3" y1 = "6" x2 = "21" y2 = "6" > < / line >
< line x1 = "3" y1 = "18" x2 = "21" y2 = "18" > < / line >
< / svg >
< / symbol >
< symbol id = "svg-arrow-right" viewBox = "0 0 24 24" >
< title > Expand< / title >
< svg xmlns = "http://www.w3.org/2000/svg" width = "24" height = "24" viewBox = "0 0 24 24" fill = "none"
stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"
class="feather feather-chevron-right">
< polyline points = "9 18 15 12 9 6" > < / polyline >
< / svg >
< / symbol >
< / svg >
< input type = "checkbox" class = "sidebar-toggle" name = "__navigation" id = "__navigation" >
< input type = "checkbox" class = "sidebar-toggle" name = "__toc" id = "__toc" >
< label class = "overlay sidebar-overlay" for = "__navigation" > < / label >
< label class = "overlay toc-overlay" for = "__toc" > < / label >
< div class = "page" >
< header class = "mobile-header" >
< label class = "header-left nav-overlay-icon" for = "__navigation" >
< i class = "icon" > < svg > < use href = "#svg-menu" > < / use > < / svg > < / i >
< / label >
< div class = "header-center" > < div class = "brand" > manim documentation< / div > < / div >
< div class = "header-right" > < / div >
< / header >
< aside class = "sidebar-drawer" >
< div class = "sidebar-container" >
< div class = "sidebar-sticky" > < a class = "sidebar-brand centered" href = "../index.html" >
< div class = "sidebar-logo-container" >
< img class = "sidebar-logo" src = "../_static/transparent_graph.png" alt = "Logo" / >
< / div >
< / a > < form class = "sidebar-search-container" method = "get" action = "../search.html" >
< input class = "sidebar-search" placeholder = "Search" name = "q" >
< input type = "hidden" name = "check_keywords" value = "yes" >
< input type = "hidden" name = "area" value = "default" >
< / form > < div class = "sidebar-tree sidebar-scroll" >
2021-04-11 11:26:13 +00:00
< p > < span class = "caption-text" > Getting Started< / span > < / p >
2021-01-28 19:54:57 +00:00
< ul class = "current" >
< li class = "toctree-l1" > < a class = "reference internal" href = "installation.html" > Installation< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "quickstart.html" > Quick Start< / a > < / li >
< li class = "toctree-l1 current current-page" > < a class = "current reference internal" href = "#" > CLI flags and configuration< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "example_scenes.html" > Example Scenes< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "config.html" > CONFIG dictionary< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "structure.html" > Manim’ < / a > < / li >
2021-02-10 03:07:02 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "whatsnew.html" > What’ < / a > < / li >
2021-01-28 19:54:57 +00:00
< / ul >
2021-04-11 11:26:13 +00:00
< p > < span class = "caption-text" > Documentation< / span > < / p >
2021-01-28 19:54:57 +00:00
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "../documentation/constants.html" > constants< / a > < / li >
2021-02-11 18:56:34 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../documentation/custom_config.html" > custom_config< / a > < / li >
2021-01-28 19:54:57 +00:00
< / ul >
2021-04-11 11:26:13 +00:00
< p > < span class = "caption-text" > Development< / span > < / p >
2021-01-28 19:54:57 +00:00
< ul >
< li class = "toctree-l1" > < a class = "reference internal" href = "../development/changelog.html" > Changelog< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../development/contributing.html" > Contributing< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../development/about.html" > About< / a > < / li >
< / ul >
< / div >
< / div >
< / div >
< / aside >
< main class = "main" >
< div class = "content" >
< article role = "main" >
< label class = "toc-overlay-icon" for = "__toc" >
< i class = "icon" > < svg > < use href = "#svg-toc" > < / use > < / svg > < / i >
< / label >
2021-04-11 11:26:13 +00:00
< section id = "cli-flags-and-configuration" >
2021-01-28 19:54:57 +00:00
< h1 > CLI flags and configuration< a class = "headerlink" href = "#cli-flags-and-configuration" title = "Permalink to this headline" > ¶< / a > < / h1 >
2021-04-11 11:26:13 +00:00
< section id = "command-line-interface" >
2021-01-28 19:54:57 +00:00
< h2 > Command Line Interface< a class = "headerlink" href = "#command-line-interface" title = "Permalink to this headline" > ¶< / a > < / h2 >
2021-02-11 18:56:34 +00:00
< p > To run manim, you need to enter the directory at the same level as < code class = "docutils literal notranslate" > < span class = "pre" > manimlib/< / span > < / code >
2021-01-28 19:54:57 +00:00
and enter the command in the following format into terminal:< / p >
2021-02-11 18:56:34 +00:00
< div class = "highlight-sh notranslate" > < div class = "highlight" > < pre > < span > < / span > manimgl < code> .py < Scene> < flags>
< span class = "c1" > # or< / span >
manim-render < code> .py < Scene> < flags>
2021-01-28 19:54:57 +00:00
< / pre > < / div >
< / div >
< ul class = "simple" >
2021-02-11 18:56:34 +00:00
< li > < p > < code class = "docutils literal notranslate" > < span class = "pre" > < code> .py< / span > < / code > : The python file you wrote. Needs to be at the same level as < code class = "docutils literal notranslate" > < span class = "pre" > manimlib/< / span > < / code > , otherwise you need to use an absolute path or a relative path.< / p > < / li >
2021-01-28 19:54:57 +00:00
< li > < p > < code class = "docutils literal notranslate" > < span class = "pre" > < Scene> < / span > < / code > : The scene you want to render here. If it is not written or written incorrectly, it will list all for you to choose. And if there is only one < code class = "docutils literal notranslate" > < span class = "pre" > Scene< / span > < / code > in the file, this class will be rendered directly.< / p > < / li >
< li > < p > < code class = "docutils literal notranslate" > < span class = "pre" > < flags> < / span > < / code > : CLI flags.< / p > < / li >
< / ul >
2021-04-11 11:26:13 +00:00
< section id = "some-useful-flags" >
2021-01-28 19:54:57 +00:00
< h3 > Some useful flags< a class = "headerlink" href = "#some-useful-flags" title = "Permalink to this headline" > ¶< / a > < / h3 >
< ul class = "simple" >
< li > < p > < code class = "docutils literal notranslate" > < span class = "pre" > -w< / span > < / code > to write the scene to a file.< / p > < / li >
< li > < p > < code class = "docutils literal notranslate" > < span class = "pre" > -o< / span > < / code > to write the scene to a file and open the result.< / p > < / li >
2021-01-31 14:35:44 +00:00
< li > < p > < code class = "docutils literal notranslate" > < span class = "pre" > -s< / span > < / code > to skip to the end and just show the final frame.< / p >
< ul >
2021-01-28 19:54:57 +00:00
< li > < p > < code class = "docutils literal notranslate" > < span class = "pre" > -so< / span > < / code > will save the final frame to an image and show it.< / p > < / li >
< / ul >
< / li >
< li > < p > < code class = "docutils literal notranslate" > < span class = "pre" > -n< / span > < span class = "pre" > < number> < / span > < / code > to skip ahead to the < code class = "docutils literal notranslate" > < span class = "pre" > n< / span > < / code > ’ < / p > < / li >
< li > < p > < code class = "docutils literal notranslate" > < span class = "pre" > -f< / span > < / code > to make the playback window fullscreen.< / p > < / li >
< / ul >
2021-04-11 11:26:13 +00:00
< / section >
< section id = "all-supported-flags" >
2021-01-28 19:54:57 +00:00
< h3 > All supported flags< a class = "headerlink" href = "#all-supported-flags" title = "Permalink to this headline" > ¶< / a > < / h3 >
2021-04-11 11:26:13 +00:00
< / section >
< / section >
< section id = "custom-config" >
2021-02-11 18:56:34 +00:00
< h2 > custom_config< a class = "headerlink" href = "#custom-config" title = "Permalink to this headline" > ¶< / a > < / h2 >
2021-01-28 19:54:57 +00:00
< p > In order to perform more configuration (about directories, etc.) and permanently
change the default value (you don’
2021-02-11 18:56:34 +00:00
you can modify < code class = "docutils literal notranslate" > < span class = "pre" > custom_config.yml< / span > < / code > . The meaning of each option is in
page < a class = "reference internal" href = "../documentation/custom_config.html" > < span class = "doc" > custom_config< / span > < / a > .< / p >
< p > You can also use different < code class = "docutils literal notranslate" > < span class = "pre" > custom_config.yml< / span > < / code > for different directories, such as
2021-01-28 19:54:57 +00:00
following the directory structure:< / p >
< div class = "highlight-text notranslate" > < div class = "highlight" > < pre > < span > < / span > manim/
├── manimlib/
│ ├── animation/
│ ├── ...
2021-02-11 18:56:34 +00:00
│ ├── default_config.yml
2021-01-28 19:54:57 +00:00
│ └── window.py
├── project/
│ ├── code.py
2021-02-11 18:56:34 +00:00
│ └── custom_config.yml
└── custom_config.yml
2021-01-28 19:54:57 +00:00
< / pre > < / div >
< / div >
2021-02-11 18:56:34 +00:00
< p > When you enter the < code class = "docutils literal notranslate" > < span class = "pre" > project/< / span > < / code > folder and run < code class = "docutils literal notranslate" > < span class = "pre" > manimgl< / span > < span class = "pre" > code.py< / span > < span class = "pre" > < Scene> < / span > < / code > ,
2021-06-14 05:42:07 +00:00
it will overwrite < code class = "docutils literal notranslate" > < span class = "pre" > manim/default_config.yml< / span > < / code > with < code class = "docutils literal notranslate" > < span class = "pre" > custom_config.yml< / span > < / code >
2021-01-28 19:54:57 +00:00
in the < code class = "docutils literal notranslate" > < span class = "pre" > project< / span > < / code > folder.< / p >
2021-06-14 16:49:20 +00:00
< p > Alternatively, you can use < code class = "docutils literal notranslate" > < span class = "pre" > --config_file< / span > < / code > flag in CLI to specify configuration file manually.< / p >
< div class = "highlight-sh notranslate" > < div class = "highlight" > < pre > < span > < / span > manimgl project/code.py --config_file /path/to/custom_config.yml
< / pre > < / div >
< / div >
2021-04-11 11:26:13 +00:00
< / section >
< / section >
2021-01-28 19:54:57 +00:00
< / article >
< footer >
< div class = "related-pages" >
< a class = "next-page" href = "example_scenes.html" >
< div class = "page-info" >
< div class = "context" >
< span > Next< / span >
< / div >
< div class = "title" > Example Scenes< / div >
< / div >
< svg > < use href = "#svg-arrow-right" > < / use > < / svg >
< / a >
< a class = "prev-page" href = "quickstart.html" >
< svg > < use href = "#svg-arrow-right" > < / use > < / svg >
< div class = "page-info" >
< div class = "context" >
< span > Previous< / span >
< / div >
< div class = "title" > Quick Start< / div >
< / div >
< / a >
< / div >
< div class = "related-information" >
< span class = "copyright" > Copyright © - This document has been placed in the public domain.< / span > |
Built with < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > using
< a class = "muted-link" href = "https://pradyunsg.me" > @pradyunsg< / a > 's
< a href = "https://github.com/pradyunsg/furo" > Furo theme< / a > .
< / div >
< / footer >
< / div >
< aside class = "toc-drawer" >
< div class = "toc-sticky toc-scroll" >
< div class = "toc-title-container" >
< span class = "toc-title" >
Contents
< / span >
< / div >
< div class = "toc-tree" >
< ul >
< li > < a class = "reference internal" href = "#" > CLI flags and configuration< / a > < ul >
< li > < a class = "reference internal" href = "#command-line-interface" > Command Line Interface< / a > < ul >
< li > < a class = "reference internal" href = "#some-useful-flags" > Some useful flags< / a > < / li >
< li > < a class = "reference internal" href = "#all-supported-flags" > All supported flags< / a > < / li >
< / ul >
< / li >
2021-02-11 18:56:34 +00:00
< li > < a class = "reference internal" href = "#custom-config" > custom_config< / a > < / li >
2021-01-28 19:54:57 +00:00
< / ul >
< / li >
< / ul >
< / div >
< / div >
< / aside >
< / main >
< / div >
< / body >
< / html >
