Season Specification - CollinHeist/TitleCardMaker GitHub Wiki

Background

The Maker allows for arbitrary season titles (instead of Season 1, Season 2, etc.) two ways: either the seasons or episode_ranges attributes within a series YAML file.

In addition to customizing the season titles, non-standard source images can also be specified, such as forcing a specific backdrop for all images of Season 2, or just unwatched episodes of episodes 10-20. This functionality is described in greater detail here.

Seasons

This attribute allows the specification of arbitrary season titles (or source images) by season number, with 0 being utilized for all specials. These titles will be ignored if season hiding is enabled, and not all card types necessarily utilize custom season titles.

It is not necessary to specify "default titles" for a series, i.e. 1: Season 1, 2: Season 2, etc. If unspecified, the Maker utilizes these automatically.

Hiding Season Titles

Season titles can also be hidden/disabled by specifying hide as true - like so:

seasons:
  hide: true

Example

The following example sets the season title for season 1 to Part 1, and season 2 to Part 2; it also uses a file backdrop-season2.jpg within the series' source directory for all episodes of Season 2.

seasons:
  1: Part 1
  2:
    title: Part 2
    source: backdrop-season2.jpg

Episode Ranges

This attribute allows the specification of arbitrary season titles (or source images) by index or absolute episode number. If an episode has no absolute number, then the episode's episode number will be used. These titles will be ignored if season hiding is enabled, and not all card types necessarily utilize custom season titles.

Examples

Index

The following example sets the season titles for episodes 1-10 of Season 1 to Part 1, and episodes 1-5 of season 2 to Part 2.

episode_ranges:
  s1e1-s1e10: Part 1
  s2e1-s2e5:
    title: Part 2

Absolute Episode Numbers

The following example sets the season title for episodes 1-10 to Part 1, and episodes 11-20 to Part 2.

episode_ranges:
  1-10: Part 1
  11-20:
    title: Part 2