中文README文件

A GitHub Action that uses manim to render video

It runs on a docker image with python3.7 and texlive-full environments.

• source_file

  Required, the source file with the scenes you want to render (relative to the current repo). E.g.:

  -uses: manim-kindergarten/manim_action_renderer@master
    with:
      source_file: path/to/your/file.py

• scene_names

  The name of the scenes to be rendered in the source file, in the form of a string, multiple scenes need to be separated by spaces in "". The default is to render all (with a -a flag).

• args

  The arguments passed to the manim command line. Usually controls the resolution of the exported video. The default is -w which is 1440@60.

• manim_repo

  The manim repository that needs to be used when rendering the video, the default is https://github.com/manim-kindergarten/manim (recommended, because it can be used without changes)
  [WIP] this can be changed to https://github.com/3b1b/manim or https://github.com/ManimCommunity/manim. But at present, this will throw an error because there is no adaptation.

• extra_packages

  Additional python modules that need to be used, use pip to install them. Use a space to separate every two, e.g.: "packageA packageB".

• extra_system_packages

  The system packages that need to be used, use the apk to install them.

• pre_render

  The shell command to be executed before rendering.

• post_render

  The shell command to be executed after rendering.

• video_path

  The directory (./outputs/) where all videos are stored after rendering is used to upload the results to artifacts.

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      -uses: actions/checkout@v2
      -name: Rendering Scenes
        uses: manim-kindergarten/manim_action_renderer@master
        id: renderer
        with:
          source_file: example_scenes.py
          scene_names: "OpeningManimExample WriteStuff"
          args: "--high_quality"
      -name: Save output as artifacts
        uses: actions/upload-artifact@v2
        with:
          name: Videos
          path: ${{ steps.renderer.outputs.video_path }}

Due to installation dependencies and time-consuming rendering, it takes about 5 minutes before starting to render the scenes
The final generated video file will be delivered to the artifacts part of the action running page.

MIT