collinheist/titlecardmaker repository overview

⁠ TitleCardMaker

An automated title card maker for Plex.

⁠Table of Contents

• Description⁠
• Getting Started⁠
• Usage and Troubleshooting⁠
• Examples⁠
• Contributing⁠
• Support⁠

⁠Description

TitleCardMaker is a program and Docker container⁠ written in Python that automates the creation of customized title cards (which are image previews of an episode of TV) for use in personal media services like Plex⁠, Emby⁠, or Jellyfin⁠.

TitleCardMaker can be automated such that everything can be pulled without manual intervention. All your series can be read from Sonarr⁠ or Plex; episode data can be pulled from Sonarr, Plex or TheMovieDatabase⁠; images from TheMovieDatabase or Plex; and TitleCardMaker can even utilize an episode's watch status within Plex to create "spoiler free" versions of title cards automatically, as shown below:

All configuration/automation of the TitleCardMaker is done via YAML files, and the actual image creation is done using the open-source and free image library called ImageMagick⁠.

⁠Getting Started

Read the Getting Started⁠ page on the Wiki for the traditional install, or the Getting Started on Docker⁠ page to install using Docker.

If you're using Unraid, there is a template available for easy setup - just search titlecardmaker on the Unraid Community Apps store.

⁠Usage and Troubleshooting

Assuming you're using the default preference filename, invoking the Maker is as simple as:

pipenv run python main.py --run

For invocation and configuration details, read here⁠.

⁠Examples

Below are some examples of each style of title card that can be created automatically by the TitleCardMaker:

⁠Built-in Card Types

⁠User-Created Card Types

The TitleCardMaker can also use user-created and maintained card types hosted on the companion GitHub⁠, an example of each type is shown below:

⁠Contributing

If you'd like to contribute - whether that's a suggested feature, a bug fix, or anything else - please do so on GitHub by creating an issue, or join the Discord⁠. The best way for me to manage technical aspects of the project is on GitHub.

⁠Support

This has taken a pretty substantial amount of effort, so if you find this project useful you can support me on BuyMeACoffee⁠, or become a GitHub sponsor⁠ - I would really appreciate it!