Configuring the TitleCardMaker - CollinHeist/TitleCardMaker GitHub Wiki

Configuring the TitleCardMaker (preferences.yml)

Controlling how the TitleCardMaker interfaces with your system is done via a single preferences YAML file, whose options are detailed below. By default, the Maker looks for a file called preferences.yml alongside main.py.

Name YAML Attribute Required
Options options ✅
Archive archive ❌
Plex plex ❌
Jellyfin jellyfin ❌
Emby emby ❌
Sonarr sonarr ❌
TMDb tmdb ❌
Tautulli tautulli ❌
ImageMagick imagemagick ❌1

1 Not required only if your host OS supports ImageMagick; some OS's do not (i.e. Unraid)

Simple Example

Below is a simple example of the most common options needed by most (Plex) users. This can be copied and used as a good starting place for your preferences.yml file. See the links above for more information about each section.

options:
  source: ./source/
  series:
  - ./yaml/sonarr_sync.yml
  filename_format: "{full_name} - S{season:02}E{episode:02}"
  season_folder_format: "Season {season:02}"
  sync_specials: false
  
plex:
  url: http://192.168.0.1:32400/         # Your local Plex IP address
  token: pzdygxzJJdszc-t_Pw_zfZ          # Your Plex token

sonarr:
  url: http://192.168.0.1:8989/api/v3/   # Your Sonarr IP address
  api_key: d91238d71938581edfaccd        # Your Sonarr API key
  sync:
  - file: ./yaml/sonarr_sync.yml
    card_directory: ./cards/
    monitored_only: true
    plex_libraries:                      # Your library paths and names
      /media/tv/: TV
      /media/anime/: Anime

tmdb:
  api_key: d91238d71938581edfaccd        # Your TMDb API key here

Simple Docker Example

Below is a simple example of the most common options needed by most Docker users. This can be copied and used as a good starting place for your preferences.yml file. See the links above for more information about each section.

options:
  source: /config/source/
  series:
  - /config/yaml/sonarr_sync.yml
  filename_format: "{full_name} - S{season:02}E{episode:02}"
  season_folder_format: "Season {season:02}"
  sync_specials: false
  
plex:
  url: http://192.168.0.1:32400/         # Your local plex IP address
  token: pzdygxzJJdszc-t_Pw_zfZ          # Your Plex token

sonarr:
  url: http://192.168.0.1:8989/api/v3/   # Your Sonarr IP address
  api_key: d91238d71938581edfaccd        # Your Sonarr API key
  sync:
  - file: /config/yaml/sonarr_sync.yml
    card_directory: /config/cards/
    monitored_only: true
    plex_libraries:                      # Your library paths and names
      /media/tv: TV
      /media/anime: Anime

tmdb:
  api_key: d91238d71938581edfaccd        # Your TMDb API key here
⚠️ **GitHub.com Fallback** ⚠️