Skip to content

Season Specification

Jump to bottom
Collin Heist edited this page May 22, 2022 · 12 revisions

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 below.

Seasons

This attributes allows the specification of arbitrary season titles 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.

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 unwatched episodes of Season 2. Watched episodes use the series' watched_style setting.

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

NOTE: Just like titles can be changed without specifying a custom source; sources can be specified without specifying a custom season title, and the source_applies_to field is optional. If omitted, the given source applies to all images in the season.

Episode Ranges

This attributes allows the specification of arbitrary season titles by absolute episode number. If an episode has no absolute number, then the generic season title is used instead. These titles will be ignored if season hiding is enabled, and not all card types necessarily utilize custom season titles.

Example

The following example sets the season title for episodes 1-10 to Part 1, and episodes 11-20 to Part 2; it also uses a file backdrop-part2.jpg within the series' source directory for all unwatched episodes between 11-20. Watched episodes use the series' watched_style setting.

episode_ranges:
  1-10: Part 1
  11-20:
    title: Part 2
    source: backdrop-part2.jpg
    source_applies_to: unwatched

NOTE: Just like titles can be changed without specifying a custom source; sources can be specified without specifying a custom season title, and the source_applies_to field is optional. If omitted, the given source applies to all images in the episode range.

How Manual Sources Interact with Series Card Styles

It might not be obvious how a series' card style interacts with manually specified sources.

If an image is specified manually (via either seasons or episode_ranges), then that image is assumed to match the style of the episodes. In other words, if the style for a series is art, and a specified source applies to all episodes, then the image is assumed to be art. If it's blur, then the image is assumed to be some image that needs to be blurred. And if it's unique, then it's assumed to be a spoiler image.

Clone this wiki locally