vidtoolz-colored-textclip

Create a color clip with overlaid text

Installation

First install vidtoolz.

pip install vidtoolz

Then install this plugin in the same environment as your vidtoolz application.

vidtoolz install vidtoolz-colored-textclip

Usage

type vid textclip --help to get help

usage: vid textclip [-h] [-f FONT] [-fs FONTSIZE] [-d DURATION]
                    [-fd FADE_DURATION] [-tc TEXT_COLOR] [-bg BG_COLOR]
                    [-gc GRADIENT_COLORS] [-rg] [-s SIZE] [-o OUTPUT] [--fps FPS]
                    [-p PADDING] [-e] [-ef] [-g]
                    [--content CONTENT] text

Create a color clip with overlaid text

positional arguments:
  text                  Text to display.

optional arguments:
  --content CONTENT     Optional smaller text centered below the main text.
  -h, --help            show this help message and exit
  -f FONT, --font FONT  Font name to use. Ex Noteworthy, Melno, Papyrus,
                        Zapfino (default: Arial)
  -fs FONTSIZE, --fontsize FONTSIZE
                        Font size. (default: 80)
  -d DURATION, --duration DURATION
                        Duration of video in seconds. (default: 5.0)
  -fd FADE_DURATION, --fade-duration FADE_DURATION
                        Fade-in/out duration. (default: 1.0)
  -tc TEXT_COLOR, --text-color TEXT_COLOR
                        Text color. (default: white)
  -bg BG_COLOR, --bg-color BG_COLOR
                        Background color as R,G,B. (default: (0, 0, 0))
  -gc GRADIENT_COLORS, --gradient-colors GRADIENT_COLORS
                        Semicolon-separated list of R,G,B colors for the
                        gradient background. e.g. 255,0,0;0,0,255
  -rg, --random-gradient
                        Use a randomly generated gradient background.
  -s SIZE, --size SIZE  Video size as width,height. (default: 1920,1080)
  -o OUTPUT, --output OUTPUT
                        Output video file name. (default: None)
  --fps FPS             Frames per second. (default: 60)
  -p PADDING, --padding PADDING
                        Padding on text (default: 30)
  -e, --expand          If set, the text will slowly enlarge during the video.
  -ef, --effect         If set, adds Sharpwipereverb sound effect at the start.
  -g, --glitch          If set, adds a glitch effect to the text.

Add a smaller supporting text block beneath the title with --content:

vid textclip "What is an LLM?" --content "The foundation of modern AI"

Development

To set up this plugin locally, first checkout the code. Then create a new virtual environment:

cd vidtoolz-colored-textclip
python -m venv venv
source venv/bin/activate

Now install the dependencies and test dependencies:

pip install -e '.[test]'

To run the tests:

python -m pytest