Archive Attributes

Background

This is an optional YAML section for creating and maintaining an archive of title cards, separate from the title cards directly linked to your Plex/media library. This was designed with the intention of making it easier to share completed sets of title cards to places like /r/PlexTitleCards.

When an archive is in use (which is not the default behavior), all sub-variations (or profiles as they're referred to in the Maker) of a set are created in the archive directory. For example, if I am using the standard card type and specify a custom font to use for a series (Show (Year)) and have archiving enabled (globally and for this series), the following directories will be created:

archive
└── Show (Year)
    ├── Generic Season Titles, Custom Font
    │   ├── Summary.jpg
    │   ├── Season 1
    │   └── ...
    └── Generic Season Titles, Generic Font
    │   ├── Summary.jpg
        ├── Season 1
        └── ...

If a non-standard card type/class is being used, then the associated archive directories will have modified names (such as Generic Season Titles, Custom Font - Star Wars Style).

Table of Sub-Directories

Given a show's attributes (such as custom/generic font, or custom/generic season titles, etc.) the following directories will be produced in that show's archive in addition to the Generic Season Titles, Generic Font archive:

Custom Font	Custom Season Titles	Hidden Season Titles	Archive Directories
❌	❌	❌	-
❌	❌	✔️	No Season Titles, Generic Font
❌	✔️	❌	Custom Season Titles, Generic Font
❌	✔️	✔️	No Season Titles, Generic Font, Custom Season Titles, Generic Font
✔️	❌	❌	Generic Season Titles, Custom Font
✔️	❌	✔️	Generic Season Titles, Custom Font, No Season Titles, Custom Font, No Season Titles, Generic Font
✔️	✔️	❌	Generic Season Titles, Custom Font, Custom Season Titles, Custom Font, Custom Season Titles, Generic Font
✔️	✔️	✔️	Generic Season Titles, Custom Font, Custom Season Titles, Custom Font, Custom Season Titles, Generic Font, No Season Titles, Custom Font, No Season Titles, Generic Font

Attributes

Name	YAML Attribute	Allowed Values	Default Value	Required
Archive Path	path	Any valid directory	-	✔️
Summary Enable	summary, create	Boolean (true or false)	false	❌
Summary Background Color	summary, background_color	A valid ImageMagick color	#1A1A1A	❌
Summary Logo Filename	summary, logo_filename	Any valid filename	logo.png	❌
Summary Minimum Episodes	summary, minimum_episodes	Any number	1	❌

Archive Path

The location all archives of all series will be created and maintained under. If this option is omitted, no archive will be created.

archive:
  path: /example/archive/directory

Summary Options

Summary Enable

Whether to create show summary images for each archived series. This is disabled by default.

A show summary is a montage of title cards for a given profile, and its purpose is to give a quick visual indication of the look of cards. For example, below are two different summary images created for the same series:

archive:
  summary:
    enable: true

Summary Background Color

The background color to use for summary image creation. Default value is shown above.

archive:
  summary:
    background_color: "#51A5DB" # A nice blue background

Summary Logo Filename

The logo filename to search for (and write to) for all logos used in summary creation. This is the name of the file within the show's source directory, so for the simplified preferences.yml show below..

options:
  source: /source/

archive:
  path: /archives/
  summary:
    logo_filename: summary-logo.png

A summary for series the Show (Year) would be looked for at /source/Show (Year)/summary-logo.png,

Summary Minimum Episodes

The minimum number of episodes that must exist before creating a show summary. This is intended to prevent odd looking summaries containing one/two title cards, as the summary was created when the show was first airing. This value is inclusive, so if set to 5, and the associated archive directory has 5 title cards, a summary will be created.

archive:
  summary:
    minimum_episodes: 6