Skip to content

Franchise Collections

The franchise Default Collection File is used to dynamically create collections based on popular TV Show franchises.

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.

This file has a Movie Library Counterpart.

Requirements & Recommendations

Supported Library Types: Movie

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.

Example Template Variable Amendments (Click to Expand)

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)!

  1. Add TMDb Show 31917 to the data dictionary
  2. Add TMDb Shows 46958, 79863 and 110531 as addons of TMDb Show 31917 so that they appear in the same collection
  3. Add items missing from your library in Plex to Sonarr
  • File-Specific Template Variables are variables available specifically for this Kometa Defaults File.
Warning

Shared Collection Variables are NOT available to this Defaults File.

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_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
minimum_items Description: Controls the minimum items that the collection must have to be created.
Default: 2
Values: Any number
name_mapping_<<key>>1 Description: Sets the name mapping value for using assets of the key's collection.
Values: Any String
order_<<key>>1 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
sort_title_<<key>>1 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>>1 Description: Changes the summary of the key's collection.
Values: New Collection Summary
sonarr_add_missing_<<key>>1 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>>1 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>>1 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
item_sonarr_tag_<<key>>1 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
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 Description: Changes the Collection Order for all collections in a Defaults File.
Default: release
Values:
release Order Collection by Release Dates
alpha Order Collection Alphabetically
customOrder Collection Via the Builder Order
Any plex_search Sort Option Order Collection by any plex_search Sort Option
collection_order_<<key>>1 Description: Changes the Collection Order of the key's collection.
Default: collection_order
Values:
release Order Collection by Release Dates
alpha Order Collection Alphabetically
customOrder Collection Via the Builder Order
Any plex_search Sort Option Order Collection by any plex_search Sort Option
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
sync_mode_<<key>>1 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
  1. 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.

Default Value Source

This is a reference showing the source of the data used in this Defaults File.

Nothing in this section is required for using the Defaults File, but it can be useful for understanding where the data comes from.

Nothing in this section is directly useful for customizing this Defaults File.

Nothing here is a code example for end user use. It all looks like code, since it is taken directly from the Kometa source code to ensure it is up-to-date and accurate, but it is not intended for end user use, and is expressed in a different format to the way you would customize the defaults via Template Variables.

I want to customize this default

To learn how to customize any Defaults File using Template Variables see the Defaults Usage Guide.

Each Defaults File has its own set of Template Variables, which are used to control the behavior of that default. The Template Variables for this file can be found here.

I want to know what's behind the defaults

The lists provided here are for reference to show what values will be in use if no customization is done.

These do not show how to customize the defaults.

Nothing here is a code example for end user use. It all looks like code, since it is taken directly from the Kometa source code to ensure it is up-to-date and accurate, but it is not intended for end user use.

These lists are provided for reference only.

If you want to customize these collections, refer to the Defaults Usage Guide to learn how to use Template Variables.

The Continents collections use the dynamic collections system with a default list of target franchises and some default addons to group shows and movies into those franchises.

These lists are provided for reference only. If you want to customize this default, refer to "I want to customize this default".

###############################################################################
################################## IMPORTANT ##################################
#####################  THIS DATA IS PROVIDED FOR REFERENCE ####################
##  DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
#############  SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################

data: 
  "121": Doctor Who
  "253": Star Trek
  "549": Law & Order
  "951": Archie Comics
  "1399": Game of Thrones
  "1402": The Walking Dead
  "1412": Arrowverse
  "1431": CSI
  "4614": NCIS
  "4629": Stargate
  "8514": "RuPaul's Drag Race"
  "6357": The Twilight Zone
  "10222": The Real Housewives
  "31917": Pretty Little Liars
  "44006": One Chicago
  "54650": Power
  "73586": Yellowstone
  "75219": 9-1-1
  "79744": The Rookie
  "80748": FBI
  "85536": Star Wars

These lists are provided for reference only. If you want to customize this default, refer to "I want to customize this default".

###############################################################################
################################## IMPORTANT ##################################
#####################  THIS DATA IS PROVIDED FOR REFERENCE ####################
##  DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
#############  SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################

addons: 
  121: [57243, 1057, 424, 203, 64073]  # Doctor Who: K-9 & Company, Torchwood, The Sarah Jane Adventures, Class
  253: [655, 580, 1855, 1992, 314, 103516, 67198, 82491, 85948, 85949, 106393] # TOS, TAS, TNG, DS9, VOY, ENT, DIS, SHO, PIC, LOW, PRO, SNW
  549: [2734, 4601, 3357, 32632, 72496, 106158]  # Law & Order: Special Victims Unit, Criminal Intent, Trial by Jury, LA, True Crime, Organized Crime
  951: [25641, 4489, 24211, 9829, 605, 69050, 79242, 87539] # The Archie Show, Sabrina, The Teenage Witch, Josie and the Pussycats, Josie and the Pussycats in Outer Space, The New Archies, Riverdale, Chilling Adventures of Sabrina, Katy Keene
  1399: [94997] # Game of Thrones, House of the Dragon
  1402: [62286, 94305, 194583, 211684, 206586] # The Walking Dead: Fear the Walking Dead, World Beyond, Dead City, Daryl Dixon, The Ones Who Live
  1412: [60735, 62688, 62643, 71663, 89247]  # Arrow: The Flash, Supergirl, Legends of Tomorrow, Black Lightning, Batwoman
  1431: [1620, 2458, 122194, 61811] # CSI: Miami, NY, Vegas, Cyber
  4614: [17610, 124271, 61387, 4376, 157950]  # NCIS: Los Angeles, Hawaii, New Orleans, JAG, Sydney
  4629: [2290, 5148, 72925] # Stargate SG-1: Atlantis, Universe, Origins
  8514: [200870, 212798, 38409, 200865, 67482, 124045, 216276, 77233, 92611, 98888, 94038, 127841, 67564, 122692, 139203, 203734, 108934, 204701, 210689, 155431, 106475, 152261, 66769] #Drag Race: Sweden, Sweden Untucked, Untucked, Belgium, All-Stars, Spain, Brazil, Thailand, UK, Secret Celebrity, Canada, Italy, All Stars Untucked, Australia, Philippines, Canada VS the World, Holland, Philippines Untucked, Spain Untucked, UK VS the World, Vegas Revue, France, Ruvealed
  6357: [1918, 83135, 16399]  # The Twilight Zone (multiple)
  10222: [34268, 32390, 17380, 18204, 65300, 31493, 217065, 14808, 136105, 61868, 39283, 62087, 76474, 70612, 110381, 70463, 67480, 196592, 139703, 126149, 59556, 113333, 214463, 131449, 216849] # Real Housewives of Orange County: Miami, BH, ATL, NJ, Potomac, DC, Capetown, NYC, Ult. Girls Trip, Cheshire, Dallas, Melbourne, Hungary, Toronto, SLC, Sydney, Auckland, Dubai, ATL Porsha’s Family Matters, Johannesburg, Vancouver, Jersey, Amsterdam, Durban, Cheshire Christmas Cruising
  31917: [46958, 79863, 110531] # Pretty Little Liars: Ravenswood, The Perfectionists, Original Sin
  44006: [58841, 62650, 67993] # Chicago Fire: Med, PD, Justice
  54650: [97890, 124394, 119845] # Power, Ghost, Raising Kanan, Force
  73586: [157744, 118357, 157732] #Yellowstone: 1883, 1923, 1883: The Bass Reeves Story
  75219: 89393 # 9-1-1: 9-1-1 Lone Star
  79744: 201992 # The Rookie: Feds
  80748: [94372, 121658] # FBI: Most Wanted, International
  85536: [71412, 3478, 105971, 92830, 83867, 60554, 82856, 115036, 114461, 202879, 114478, 79093] # Star Wars Galaxy of Adventures: Forces of Destiny, The Clone Wars, The Bad Batch, Obi-Wan Kenobi, Andor, Rebels, The Mandalorian, The Book of Boba Fett, Ahsoka, Skeleton Crew, Visions, Resistance