Configuring the TitleCardMaker

Configuring the TitleCardMaker

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	❌
Sonarr	sonarr	❌
TMDb	tmdb	❌
ImageMagick	imagemagick	❌1

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

Complete Example

Below is a complete example of a valid (except for the URL/API keys) preference file. Feel free to copy this and modify if to match your own configuration.

options:
  source: ./source/
  series:
    - ./tv.yml
  card_type: standard
  card_extension: jpg
  filename_format: "{full_name} - S{season:02}E{episode:02}"
  image_source_priority: tmdb, plex
  episode_data_source: tmdb
  season_folder_format: "Season {season:02}"
  validate_fonts: true
  sync_specials: False

archive:
  path: ./archives/
  summary:
    create: true 
    created_by: CollinHeist
    background_color: '#1A1A1A'
    minimum_episodes: 5
  
plex:
  url: http://192.168.0.1:32400/         # Your local plex IP address here
  token: pzdygxzJJdszc-t_Pw_zfZ          # Your Plex token here
  watched_style: unique
  unwatched_style: blur
  integrate_with_pmm_overlays: false

sonarr:
  url: http://192.168.0.1:8989/api/v3/   # Your Sonarr IP address here
  api_key: d91238d71938581edfaccd        # Your Sonarr API key here
  sync_specials: true

tmdb:
  api_key: d91238d71938581edfaccd        # Your TMDb API key here
  retry_count: 5
  minimum_resolution: 600x300

imagemagick:
  container: ImageMagick                 # Could also use container ID, i.e. 9ab39821bdae