3b1b-manim/docs/source/getting_started/configuration.rst

CLI flags and configuration
===========================

Command Line Interface
----------------------

To run manim, you need to enter the directory at the same level as ``manim.py`` 
and enter the command in the following format into terminal:

.. code-block:: sh

    python manim.py <code>.py <Scene> <flags>

- ``<code>.py`` : The python file you wrote. Needs to be at the same level as ``manim.py``, otherwise you need to use an absolute path or a relative path.
- ``<Scene>`` : 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 ``Scene`` in the file, this class will be rendered directly.
- ``<flags>`` : CLI flags.

Some useful flags
^^^^^^^^^^^^^^^^^

- ``-w`` to write the scene to a file.
- ``-o`` to write the scene to a file and open the result.
- ``-s`` to skip to the end and just show the final frame. 

    - ``-so`` will save the final frame to an image and show it.
    
- ``-n <number>`` to skip ahead to the ``n``\ ’th animation of a scene. 
- ``-f`` to make the playback window fullscreen.

All supported flags
^^^^^^^^^^^^^^^^^^^

========================================================== ====== =================================================================================================================================================================================================
flag                                                       abbr   function
========================================================== ====== =================================================================================================================================================================================================
``--help``                                                 ``-h`` Show the help message and exit
``--write_file``                                           ``-w`` Render the scene as a movie file
``--skip_animations``                                      ``-s`` Skip to the last frame
``--low_quality``                                          ``-l`` Render at a low quality (for faster rendering)
``--medium_quality``                                       ``-m`` Render at a medium quality
``--hd``                                                          Render at a 1080p quality
``--uhd``                                                         Render at a 4k quality
``--full_screen``                                          ``-f`` Show window in full screen
``--save_pngs``                                            ``-g`` Save each frame as a png
``--save_as_gif``                                          ``-i`` Save the video as gif
``--transparent``                                          ``-t`` Render to a movie file with an alpha channel
``--quiet``                                                ``-q``
``--write_all``                                            ``-a`` Write all the scenes from a file
``--open``                                                 ``-o`` Automatically open the saved file once its done
``--finder``                                                      Show the output file in finder
``--file_name FILE_NAME``                                         Name for the movie or image file
``--start_at_animation_number START_AT_ANIMATION_NUMBER``  ``-n`` Start rendering not from the first animation, but from another, specified by its index. If you passin two comma separated values, e.g. "3,6", it will end the rendering at the second value.
``--resolution RESOLUTION``                                ``-r`` Resolution, passed as "WxH", e.g. "1920x1080"
``--frame_rate FRAME_RATE``                                       Frame rate, as an integer
``--color COLOR``                                          ``-c`` Background color
``--leave_progress_bars``                                         Leave progress bars displayed in terminal
``--video_dir VIDEO_DIR``                                         directory to write video
========================================================== ====== =================================================================================================================================================================================================

custom_default
--------------

In order to perform more configuration (about directories, etc.) and permanently 
change the default value (you don't have to add flags to the command every time), 
you can modify ``custom_default.yml``. The meaning of each option is in 
page :doc:`../documentation/custom_default`.

You can also use different ``custom_default.yml`` for different directories, such as 
following the directory structure:

.. code-block:: text

    manim/
    ├── manimlib/
    │   ├── animation/
    │   ├── ...
    │   └── window.py
    ├── project/
    │   ├── code.py
    │   └── custom_default.yml
    ├── custom_default.yml
    └── manim.py

When you enter the ``project/`` folder and run ``python ../manim.py code.py <Scene>``, 
it will overwrite ``manim/custom_default.yml`` with ``custom_default.yml`` 
in the ``project`` folder.
-												finish config, structure, constants and custom_default

											
										
										
											2021-01-26 14:57:05 +08:00
+								CLI flags and configuration
 								===========================
 								Command Line Interface
 								----------------------
 								To run manim, you need to enter the directory at the same level as ``manim.py``
 								and enter the command in the following format into terminal:
 								.. code-block:: sh
 								    python manim.py <code>.py <Scene> <flags>
 								- ``<code>.py`` : The python file you wrote. Needs to be at the same level as ``manim.py``, otherwise you need to use an absolute path or a relative path.
 								- ``<Scene>`` : 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 ``Scene`` in the file, this class will be rendered directly.
 								- ``<flags>`` : CLI flags.
 								Some useful flags
 								^^^^^^^^^^^^^^^^^
 								- ``-w`` to write the scene to a file.
 								- ``-o`` to write the scene to a file and open the result.
 								- ``-s`` to skip to the end and just show the final frame.
-												fix

add a link to Chinese version in home page

fix a list wrong display

fix color list

											
										
										
											2021-01-31 21:37:53 +08:00
-												fix bugs and update README

											
										
										
											2021-01-26 22:56:54 +08:00
+								    - ``-so`` will save the final frame to an image and show it.
-												fix

add a link to Chinese version in home page

fix a list wrong display

fix color list

											
										
										
											2021-01-31 21:37:53 +08:00
-												finish config, structure, constants and custom_default

											
										
										
											2021-01-26 14:57:05 +08:00
+								- ``-n <number>`` to skip ahead to the ``n``\ ’th animation of a scene.
 								- ``-f`` to make the playback window fullscreen.
 								All supported flags
 								^^^^^^^^^^^^^^^^^^^
 								========================================================== ====== =================================================================================================================================================================================================
 								flag                                                       abbr   function
 								========================================================== ====== =================================================================================================================================================================================================
 								``--help``                                                 ``-h`` Show the help message and exit
 								``--write_file``                                           ``-w`` Render the scene as a movie file
 								``--skip_animations``                                      ``-s`` Skip to the last frame
 								``--low_quality``                                          ``-l`` Render at a low quality (for faster rendering)
 								``--medium_quality``                                       ``-m`` Render at a medium quality
 								``--hd``                                                          Render at a 1080p quality
 								``--uhd``                                                         Render at a 4k quality
 								``--full_screen``                                          ``-f`` Show window in full screen
 								``--save_pngs``                                            ``-g`` Save each frame as a png
 								``--save_as_gif``                                          ``-i`` Save the video as gif
 								``--transparent``                                          ``-t`` Render to a movie file with an alpha channel
 								``--quiet``                                                ``-q``
 								``--write_all``                                            ``-a`` Write all the scenes from a file
 								``--open``                                                 ``-o`` Automatically open the saved file once its done
 								``--finder``                                                      Show the output file in finder
 								``--file_name FILE_NAME``                                         Name for the movie or image file
 								``--start_at_animation_number START_AT_ANIMATION_NUMBER``  ``-n`` Start rendering not from the first animation, but from another, specified by its index. If you passin two comma separated values, e.g. "3,6", it will end the rendering at the second value.
 								``--resolution RESOLUTION``                                ``-r`` Resolution, passed as "WxH", e.g. "1920x1080"
 								``--frame_rate FRAME_RATE``                                       Frame rate, as an integer
 								``--color COLOR``                                          ``-c`` Background color
 								``--leave_progress_bars``                                         Leave progress bars displayed in terminal
 								``--video_dir VIDEO_DIR``                                         directory to write video
 								========================================================== ====== =================================================================================================================================================================================================
 								custom_default
 								--------------
 								In order to perform more configuration (about directories, etc.) and permanently
 								change the default value (you don't have to add flags to the command every time),
 								you can modify ``custom_default.yml``. The meaning of each option is in
 								page :doc:`../documentation/custom_default`.
 								You can also use different ``custom_default.yml`` for different directories, such as
 								following the directory structure:
 								.. code-block:: text
 								    manim/
 								    ├── manimlib/
 								    │   ├── animation/
 								    │   ├── ...
 								    │   └── window.py
 								    ├── project/
 								    │   ├── code.py
 								    │   └── custom_default.yml
 								    ├── custom_default.yml
 								    └── manim.py
 								When you enter the ``project/`` folder and run ``python ../manim.py code.py <Scene>``,
 								it will overwrite ``manim/custom_default.yml`` with ``custom_default.yml``
 								in the ``project`` folder.