Multi Episode Cards - CollinHeist/TitleCardMaker GitHub Wiki
Background
The Maker will attempt to automatically detect and create multi-episode cards. These are cards which represent multiple sequential episodes, typically 2+ part episodes. In an attempt to work with libraries that have these episodes split as well as combined, the Maker tries to detect which episodes need to be combined and creates cards for both (multi and singular).
The generated multi-episode cards will use the interpreted partless title for title text, and the first episode's information - notably the source file.
Example
An example of this is Brooklyn Nine-Nine's season 4 premiere. Although the first three episodes aired separately - called Coral Palms (1)
, Coral Pamls (2)
, and Coral Palms (3)
- some releases combine these episodes into one episode Coral Palms
.
The 'standard' cards for these episodes are:
However, the Maker will identify these episodes and create a MultiEpisode card as:
Identification Process
The Maker identifies multi episode candidates by going through every episode within a show's datafile and matching sequential episodes' partless titles within each season. If at least two sequential episodes have the same partless title, then a MultiEpisode card is created.
Identifiable Titles
The Maker matches a few 'styles' of partless titles, they are:
Style | Example(s) |
---|---|
Title (digit) |
Finale (1) , Finale (IV) |
Title Part word |
Finale Part 1 , Finale Part One , Finale Part IV |
Title (Part word) |
Finale (Part 1) , Finale (Part One) , Finale (Part IV) |
Title - Part word |
Finale - Part 1 , Finale - Part One , Finale - Part IV |
Title: Part word |
Finale: Part 1 , Finale: Part One , Finale: Part IV |
Title, Part word |
Finale, Part 1 , Finale, Part One , Finale, Part IV |
NOTE: All matching is case-insensitive
I've implemented the most common multipart episode naming schemes, but if there is a style that's missing, submit an issue.
File Naming
Because the Maker allows for customizable file naming for all title cards, it will attempt to interpret how to name MultiEpisode card files.
This is done by finding the {episode}
format key and given formatting options to create a ranged image extension, i.e. E{start}-E{end}
as recommended by Plex. Below is an example of how the Maker would modify the given episode format strings:
filename_format Option |
Modified Format | Example |
---|---|---|
{full_name} - S{season:02}E{episode:02} |
{full_name} - S{season:02}E{episode_start:02}-E{episode_end:02} |
Title (Year) - S01E01-E04 |
{full_name} - S{season}e{episode} - {title} |
{full_name} - S{season}e{episode_start}-e{episode_end} - {title} |
Title (Year) - S1e1-e4 - Episode Title |
NOTE: This feature is not thoroughly tested, so if you encounter any odd behavior, submit an issue.
Episode Text Format String Modification
Like above, because the Maker permits per-show customizable episode text formatting, it will also attempt to interpret how to modify a given format string to suit a MutliEpisode card. This logic is fairly simple, and assumes the general structure of the format string being modified.
The Maker looks for an episode index (either {abs_number}
or {episode_number}
) within the format string; makes the preceding text plural (if there is a leading space), and then ranges the episode index. For example:
episode_text_format Option |
Modified Format | Example |
---|---|---|
EPISODE {episode_number} |
EPISODES {episode_start}-{episode_end} |
EPISODES 1-3 |
CHAPTER {abs_number} |
CHAPTERS {abs_start}-{abs_end} |
CHAPTERS 7-8 |
E{episode_number} |
E{episode_start}-{episode_end} |
E14-15 |
NOTE: Because the Maker assumes the format string is standard-ish. a bad format string can lead to bad results. For example, if
E {abs_number}
is given, the result will beES {abs_start}-{abs_end}
which might be undesirable.
Limitations
The Maker will not automatically identify and create MultiEpisode cards for the following situations:
- Multi-part episodes are not sequential by episode number (sequential absolute numbering is NOT checked)
- Multi-part episodes are sequential, but not within the same season (i.e.
S01E10 - Cliffhanger (1)
andS02E01 - Cliffhanger (2)
) - Multi-part episodes have a titling scheme that's not identified by the Maker
- For example, the Avatar season 1 finale titles are
Chapter Nineteen: The Siege of the North, Part 1
andChapter Twenty: The Siege of the North, Part 2
- For example, the Avatar season 1 finale titles are
In all of these situations, the mini maker can be used to manually create the desired cards.