Franchise Collections¶

The franchise Default Collection File is used to create collections based on popular TV Show franchises, and can be used as a replacement to the TMDb Collections that Plex creates out-of-the-box.

Unlike most Default Collection Files, Franchise works by placing collections inline with the main library items if your library allows it. For example, the "Pretty Little Liars" franchise collection will appear next to the "Pretty Little Liars" show in your library so that you have easy access to the other shows in the franchise.

This file has a Movie Library Counterpart.

Requirements & Recommendations¶

Supported Library Types: Show

Collections¶

Collection	Key	Description
`<<Collection Name>>` Example: `Pretty Little Liars`	`<<Starting TMDb Show ID>>` Example: `31917`	Collection of Shows specified for this Collection.

Config¶

The below YAML in your config.yml will create the collections:

libraries:
  TV Shows:
    collection_files:
      - default: franchise

Template Variables¶

Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.

Note that the template_variables: section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.

Variable Lists (click to expand)

File-Specific Template Variables are variables available specifically for this Kometa Defaults File.

Warning

Shared Collection Variables are NOT available to this Defaults File.

File-Specific Template Variables

Variable Description & Values

addons Description: Overrides the default addons dictionary. Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
Values: Dictionary List of TMDb Show IDs

append_addons Description: Appends to the default addons dictionary.
Values: Dictionary List of TMDb Show IDs

append_data Description: Appends to the default data dictionary.
Values: Dictionary List of TMDb Main Show ID

build_collection Description: Controls if you want the collection to actually be built. i.e. you may just want these shows sent to Sonarr.
Values: false to not build the collection

collection_mode

Description: Controls the collection mode of all collections in this file.
Values:

`default`	Library default
`hide`	Hide Collection
`hide_items`	Hide Items in this Collection
`show_items`	Show this Collection and its Items

collection_order_<<key>>¹

Description: Changes the Collection Order of the key's collection.
Default: collection_order
Values:

`release`	Order Collection by Release Dates
`alpha`	Order Collection Alphabetically
`custom`	Order Collection Via the Builder Order
Any `plex_search` Sort Option	Order Collection by any `plex_search` Sort Option

collection_order

Description: Changes the Collection Order for all collections in this file.
Values:

`release`	Order Collection by Release Dates
`alpha`	Order Collection Alphabetically
`custom`	Order Collection Via the Builder Order
Any `plex_search` Sort Option	Order Collection by any `plex_search` Sort Option

collection_section Description: Adds a sort title with this collection sections.
Values: Any number

data Description: Overrides the default data dictionary. Defines the data that the custom dynamic collection processes.
Values: Dictionary List of TMDb Main Show ID

exclude Description: Exclude these Collections from creating a Dynamic Collection.
Values: List of Collection IDs

item_sonarr_tag_<<key>>¹ Description: Used to append a tag in Sonarr for every show found by the builders that's in Sonarr of the key's collection.
Default: item_sonarr_tag
Values: List or comma-separated string of tags

item_sonarr_tag Description: Used to append a tag in Sonarr for every show found by the builders that's in Sonarr for all collections in a Defaults File.
Values: List or comma-separated string of tags

minimum_items Description: Controls the minimum items that the collection must have to be created.
Default: 2
Values: Any number

name_mapping_<<key>>¹ Description: Sets the name mapping value for using assets of the key's collection.
Values: Any String

order_<<key>>¹ Description: Controls the sort order of the collections in their collection section.
Values: Any number

remove_addons Description: Removes from the default addons dictionary.
Values: Dictionary List of TMDb Show IDs

remove_data Description: Removes from the default data dictionary.
Values: List of TMDb Main Show IDs to remove

sonarr_add_missing_<<key>>¹ Description: Override Sonarr add_missing attribute of the key's collection.
Default: sonarr_add_missing
Values: true or false

sonarr_add_missing Description: Override Sonarr add_missing attribute for all collections in a Defaults File.
Values: true or false

sonarr_folder_<<key>>¹ Description: Override Sonarr root_folder_path attribute of the key's collection.
Default: sonarr_folder
Values: Folder Path

sonarr_folder Description: Override Sonarr root_folder_path attribute for all collections in a Defaults File.
Values: Folder Path

sonarr_tag_<<key>>¹ Description: Override Sonarr tag attribute of the key's collection.
Default: sonarr_tag
Values: List or comma-separated string of tags

sonarr_tag Description: Override Sonarr tag attribute for all collections in a Defaults File.
Values: List or comma-separated string of tags

sort_title_<<key>>¹ Description: Sets the sort title of the key's collection.
Default: sort_title
Values: Any String

sort_title Description: Sets the sort title for all collections. Use <<collection_name>> to use the collection name. Example: "!02_<<collection_name>>"
Values: Any String with <<collection_name>>

summary_<<key>>¹ Description: Changes the summary of the key's collection.
Values: New Collection Summary

sync_mode_<<key>>¹

Description: Changes the Sync Mode of the key's collection.
Default: sync_mode
Values:

`sync`	Add and Remove Items based on Builders
`append`	Only Add Items based on Builders

sync_mode

Description: Changes the Sync Mode for all collections in a Defaults File.
Default: sync
Values:

`sync`	Add and Remove Items based on Builders
`append`	Only Add Items based on Builders

Each default collection has a key that you must replace <<key>> with when using this Template Variable. These keys are found in the table at the top of this page.

Example Template Variable Amendments

The below is an example config.yml extract with some Template Variables added in to change how the file works.

Click the icon to learn more

libraries:
  TV Shows:
    collection_files:
      - default: franchise
        template_variables:
          append_data:
            "31917": Pretty Little Liars  #(1)!
          append_addons:
            31917: [46958, 79863, 110531]  #(2)!
          sonarr_add_missing: true  #(3)!

Add TMDb Show 31917 to the data dictionary
Add TMDb Shows 46958, 79863 and 110531 as addons of TMDb Show 31917 so that they appear in the same collection
Add items missing from your library in Plex to Sonarr

Default Values¶

Unless you customize them as described above, these collections use default lists and searches to create the collections.

If you are interested in customizing the default values, you can find that information here.

If you are interested in seeing what those default builders are, you can find that information here.