Skip to content

Local Installation

Linux Compatability

Some Linux distros either do not support ImageMagick - which is a requirement for TitleCardMaker. In this case the Docker installation is required.

Installing TitleCardMaker locally, instead of in a Docker container, requires a few additional pieces of software, these are:

  • Python
  • git
  • Pip
  • Pipenv
  • ImageMagick

The installation of these, as well as TitleCardMaker itself, will be covered below.

Installing Python

Python Already Installed?

If you believe Python is already installed, you can quickly check this (and that you have a suitable version), by running the following command:

python3 --version

This should output at least Python 3.9, ideally 3.11 or higher.

Given the wide diversity of Linux Distros, it is not feasible to cover the installation of Python in all circumstances. This guide covers some common installation methods.

Python comes pre-installed on MacOS, but it can be updated with Homebrew by running the following command:

brew update && brew upgrade python
  1. Go to the Python website, and download the installer for the latest version of Python 3.10.
  2. Run the installer, and make sure to select the Add to PATH checkbox during installation.
  3. Enable PowerShell scripts by following these instructions.

Installing git

Git Already Installed?

If you believe git is already installed, you can quickly check this by running the following command:

git --version

Follow these distro-specific instructions.

brew install git
  1. Download the 64-bit standalone installer from here.

  2. Run the installer, and click through until you get to the "Choosing the default editor used by Git" step.

    Recommendation

    I recommend changing the default editor to something other than Vim (such as Sublime Text, Notepad++, etc.).

  3. Continue clicking through until you get to the "Adjusting your PATH environment" step and make sure that the (Recommended) option of "Git from the command line and also from 3rd-party software" option is selected.

Upgrading Pip

Execute the following command:

python3 -m pip install --upgrade pip

Installing Pipenv

TitleCardMaker uses pipenv to install the external Python libraries that are required. Install pipenv by executing the following command:

pip3 install pipenv

Then install the required libraries (dependencies) by executing:

$ pipenv install

Command Failure

If this command fails, it is possible pipenv has not been added to your PATH. Retry this by prefacing the command with python3 -m, like so:

python3 -m pipenv install

Installing ImageMagick

ImageMagick is the image manipulation and creation library that TCM uses to create the Title Cards.

Depending on your Linux distro, you might be able to use whatever package manager comes installed. Some of the common installations are detailed here. It is also worth checking the ImageMagick website here.

If there is no pre-installed package, and you don't want to use the Docker container, then you can build ImageMagick yourself. This process is much more complicated and error-prone, but is described here.

Execute the following command:

brew install imagemagick
  1. Download the Windows Binary Release from here.
  2. Follow the installer, be sure to check the Add application directory to your system path and the Install legacy utilities (e.g. convert) checkboxes during installation.

Verify it is installed by executing the following:

magick logo: logo.gif

This should create a logo.gif file of the ImageMagick wizard in that directory.

Launching TitleCardMaker

With all the required packages and software installed, you are ready to launch TitleCardMaker. This can be done by executing the following command:

$ pipenv run uvicorn app-main:app --host "0.0.0.0" --port 4242
[DEBUG] Dumped Preferences to "[...]/TitleCardMaker/config/config.pickle"..
INFO:     Started server process [4072]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://0.0.0.0:4242 (Press CTRL+C to quit)

This launches the TitleCardMaker web interface, and you will be able to access it by going to http://0.0.0.0:4242 or http://localhost:4242 in a browser.

Success

Installation is complete, and TitleCardMaker is ready to be configured.