Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/CollinHeist/TitleCardMaker

Automated title card maker for Plex, Jellyfin, and Emby
https://github.com/CollinHeist/TitleCardMaker

docker emby emby-server jellyfin plex plex-media-server python

Last synced: 6 days ago
JSON representation

Automated title card maker for Plex, Jellyfin, and Emby

Host: GitHub
URL: https://github.com/CollinHeist/TitleCardMaker
Owner: CollinHeist
License: gpl-3.0
Created: 2021-10-23T23:56:58.000Z (about 3 years ago)
Default Branch: master
Last Pushed: 2024-10-24T03:01:42.000Z (15 days ago)
Last Synced: 2024-10-24T19:56:46.493Z (14 days ago)
Topics: docker, emby, emby-server, jellyfin, plex, plex-media-server, python
Language: Python
Homepage: https://titlecardmaker.com/
Size: 141 MB
Stars: 467
Watchers: 13
Forks: 22
Open Issues: 97
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

awesome-jellyfin - TitleCardMaker - Automated title card maker for Plex, Jellyfin, and Emby. (👾 Other)

README

        #  TitleCardMaker

[![](https://img.shields.io/github/release/CollinHeist/TitleCardMaker.svg)](https://github.com/CollinHeist/TitleCardMaker/releases)

[![Docker Pulls](https://img.shields.io/docker/pulls/collinheist/titlecardmaker)](https://hub.docker.com/r/collinheist/titlecardmaker)

[![GitHub Develop Commits](https://img.shields.io/github/commits-since/CollinHeist/TitleCardMaker/latest/develop?label=Commits%20in%20Develop)](https://github.com/CollinHeist/TitleCardMaker/tree/develop)

[![Discord](https://img.shields.io/discord/955533113734357125?logo=discord&logoColor=white)](https://discord.gg/bJ3bHtw8wH)

[![Support](https://img.shields.io/badge/-Support_Development-9cf?color=informational)](https://github.com/sponsors/CollinHeist)

An automated title card maker for the Plex, Jellyfin, and Emby media servers. All user documentation is available on the [Wiki](https://github.com/CollinHeist/TitleCardMaker/wiki).

> [!IMPORTANT] 

> Version 2.0 - the Web UI - has officially entered pre-release, and is currently available for project [Sponsors](https://github.com/sponsors/CollinHeist).



More details are located at [titlecardmaker.com](https://titlecardmaker.com/) - this README (and the Wiki documentation) are primarily geared towards the non-UI (v1).

## Table of Contents

- [Description](#description)

- [Getting Started](#getting-started)

- [Usage and Troubleshooting](#usage-and-troubleshooting)

- [Examples](#examples)

- [Contributing](#contributing)

- [Support](#support)

## Description

`TitleCardMaker` is a program and [Docker container](https://hub.docker.com/r/collinheist/titlecardmaker) 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 server services like [Plex](https://www.plex.tv/), [Jellyfin](https://jellyfin.org/), or [Emby](https://emby.media/).

TitleCardMaker can be automated such that everything can be done without manual intervention. All your series can be read from your media server or Sonarr; episode data can be pulled from Sonarr, your media server, or [TheMovieDatabase](https://www.themoviedb.org/); images from TheMovieDatabase, or your media server; and TitleCardMaker can even utilize an episode's watch status 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](https://imagemagick.org/).

## Getting Started

> [!NOTE]

> The [Wiki](https://github.com/CollinHeist/TitleCardMaker/wiki) has very extensive documentation on every feature and customization available in TitleCardMaker. I __highly__ recommend looking here as the first step when troubleshooting or customizing your setup. [The Discord](https://discord.gg/bJ3bHtw8wH) is also a great place to get detailed help.

Read the [Getting Started](https://github.com/CollinHeist/TitleCardMaker/wiki) page on the Wiki for the traditional install, or the [Getting Started on Docker](https://github.com/CollinHeist/TitleCardMaker/wiki/Docker-Tutorial) 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:

```console

pipenv run python main.py --run

```

For invocation and configuration details, read [here](https://github.com/CollinHeist/TitleCardMaker/wiki/Running-the-TitleCardMaker).

> [!TIP]

> If you have trouble getting the Maker working, or have a problem, [create an issue on GitHub](https://github.com/CollinHeist/TitleCardMaker/issues/new), or [join the Discord](https://discord.gg/bJ3bHtw8wH) for help.

## Examples

Below are examples of almost all the types of title card that can be created automatically by TitleCardMaker:

### Built-in Card Types

                          

> The above cards are, in order, the [anime](https://github.com/CollinHeist/TitleCardMaker/wiki/AnimeTitleCard), [banner](https://github.com/CollinHeist/TitleCardMaker/wiki/BannerTitleCard), [calligraphy](https://github.com/CollinHeist/TitleCardMaker/wiki/CalligraphyTitleCard), [comic book](https://github.com/CollinHeist/TitleCardMaker/wiki/ComicBookTitleCard), [cutout](https://github.com/CollinHeist/TitleCardMaker/wiki/CutoutTitleCard), [divider](https://github.com/CollinHeist/TitleCardMaker/wiki/DividerTitleCard), [fade](https://github.com/CollinHeist/TitleCardMaker/wiki/FadeTitleCard), [formula 1](https://titlecardmaker.com/card_types/formula/), [frame](https://github.com/CollinHeist/TitleCardMaker/wiki/FrameTitleCard), [graph](https://titlecardmaker.com/card_types/graph/), [inset](https://github.com/CollinHeist/TitleCardMaker/wiki/InsetTitleCard), [landscape](https://github.com/CollinHeist/TitleCardMaker/wiki/LandscapeTitleCard), [logo](https://github.com/CollinHeist/TitleCardMaker/wiki/LogoTitleCard), [marvel](https://github.com/CollinHeist/TitleCardMaker/wiki/MarvelTitleCard), [music](https://titlecardmaker.com/card_types/music/), [notification](https://titlecardmaker.com/card_types/notification/), [olivier](https://github.com/CollinHeist/TitleCardMaker/wiki/OlivierTitleCard), [overline](https://github.com/CollinHeist/TitleCardMaker/wiki/OverlineTitleCard),  [poster](https://github.com/CollinHeist/TitleCardMaker/wiki/PosterTitleCard), [roman](https://github.com/CollinHeist/TitleCardMaker/wiki/RomanNumeralTitleCard), [standard](https://github.com/CollinHeist/TitleCardMaker/wiki/StandardTitleCard), [striped](https://titlecardmaker.com/card_types/striped/), [shape](https://github.com/CollinHeist/TitleCardMaker/wiki/ShapeTitleCard), [star wars](https://github.com/CollinHeist/TitleCardMaker/wiki/StarWarsTitleCard), [tinted frame](https://github.com/CollinHeist/TitleCardMaker/wiki/TintedFrameTitleCard), [tinted glass](https://github.com/CollinHeist/TitleCardMaker/wiki/TintedGlassTitleCard), and the [white border](https://github.com/CollinHeist/TitleCardMaker/wiki/WhiteBorderTitleCard) title cards.

User-Created Card Types


The TitleCardMaker can also use user-created and maintained card types hosted on the [companion GitHub](https://github.com/CollinHeist/TitleCardMaker-CardTypes), an example of each type is shown below:

           

 

> The above cards are, in order, `Yozora/BarebonesTitleCard`, `Beedman/GradientLogoTitleCard`, `Yozora/RetroTitleCard`, `Yozora/SlimTitleCard`, `Wdvh/StarWarsTitleOnly`, `Wdvh/WhiteTextAbsolute`, `lyonza/WhiteTextBroadcast`, `Wdvh/WhiteTextStandard`, `Wdvh/WhiteTextTitleOnly`, `azuravian/TitleColorMatch`, and `KHthe8th/TintedFramePlusTitleCard`

## Other Features

In addition to title card creation and management, the TitleCardMaker can also be used for other image-creation functionality. For example, the [mini maker](https://github.com/CollinHeist/TitleCardMaker/wiki/Using-the-Mini-Maker) - a.k.a. `mini_maker.py` - can be used to "manually" create collection posters, genre cards, movie posters, show summaries, and season posters. An example of each is shown below:

    

This is largely done via the command-line, and is described on the wiki [here](https://github.com/CollinHeist/TitleCardMaker/wiki/Using-the-Mini-Maker).

## 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](https://discord.gg/bJ3bHtw8wH). 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](https://www.buymeacoffee.com/CollinHeist), or become a [GitHub sponsor](https://github.com/sponsors/CollinHeist) - I would really appreciate it!

A _huge_ thank you to my current and past sponsors.