安装指南
============

.. admonition:: 注意

   Manim 运行在 Python 3.7 或者更高版本上（推荐使用 Python 3.8）

   另外，不是特别推荐在 WSL 上安装 manimgl，因为 manimgl 在 **预览时** 不可避免地会调用 Pyglet Window 这个库，而这个库需要 GUI。不少用户为此花费大量的心血寻找解决方案，但真正解决的少之又少 qwq

所需的系统依赖有：

- `FFmpeg <https://ffmpeg.org/>`__ (Windows 下安装需要自行配置 **环境变量** )
- `OpenGL <https://www.opengl.org//>`__ (包含在 python 包 ``PyOpenGL`` 中，无需手动安装)
- `LaTeX <https://www.latex-project.org>`__ (可选，如果需要 LaTeX 则必需)
- `Pango <https://pango.org>`__ (只有 Linux 系统需要，可选，如果需要使用 manim 的 ``Text`` 则必需)


安装上述依赖
------------

Windows
^^^^^^^^

1. 安装 `FFmpeg <https://www.wikihow.com/Install-FFmpeg-on-Windows>`_, 并且保证它在 ``PATH`` 环境变量中

   当你在控制台中输入 ``ffmpeg -version`` ，能打印出 FFmpeg 的版本号，那么就安装成功了

2. 安装一个 LaTeX 发行版，推荐 `TeXLive-full <http://tug.org/texlive/>`__

macOS
^^^^^^

1. 使用 homebrew 安装 ffmpeg 和 pango

   .. code-block:: sh

      brew install ffmpeg
      brew install pango

2. 安装 `MacTex <https://www.tug.org/mactex/>`__

   你可以选择进入上面链接手动安装，也可使用 brew cask 安装

   .. code-block:: sh

      brew install --cask mactex-no-gui

Linux (以 Ubuntu 为例)
^^^^^^^^^^^^^^^^^^^^^^^^

1. 使用 apt 包管理器安装 ffmpeg 和 pango

   .. code-block:: sh

      sudo apt install ffmpeg 
      sudo apt install libpango1.0-dev

2. 安装 `Texlive <https://www.tug.org/texlive/>`__

   .. code-block:: sh

      sudo apt install texlive-full


使用 python 环境安装 manimgl
------------------------------

.. code-block:: sh

   # 通过 pip 安装 manimgl
   pip install manimgl

   # 配置运行参数，可选
   manimgl --config  # 如果想要在 LaTeX 中使用中文，请选择 xelatex 选项

   # 测试一下
   manimgl

如果你想要更改 manimlib 的源码并使用，或者使用最新版本，可以 clone 下这个存储库，然后进入文件夹中执行：

.. code-block:: sh

   # 安装
   pip install -e .

   # 配置运行参数，可选
   manimgl --config  # 如果想要在 LaTeX 中使用中文，请选择 xelatex 选项

   # 测试
   manimgl example_scenes.py OpeningManimExample
   # 或
   manim-render example_scenes.py OpeningManimExample

如果你运行了上面这条命令，并且没有任何报错信息出现，那么你就已经安装好了 manim 所需的全部环境。


使用 Anaconda
---------------

- 同上安装 FFmpeg 和 LaTeX
- 创建一个新的 conda 环境：

.. code-block:: sh
   
   git clone https://github.com/3b1b/manim.git
   cd manim 
   conda create -n manim python=3.8
   conda activate manim
   pip install -e .