Franchise Collections¶

The franchise Default Collection File is used to dynamically create collections based on popular Movie 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 "Iron Man" franchise collection will appear next to the "Iron Man" movies within your library.

This file has a Show Library Counterpart.

Requirements & Recommendations¶

Supported Library Types: Movie

It is important to disable Plex's in-built Automatic Collections if you are using this Default file. Please see the below video showing how to do this.

You'll also need to delete any Collections created automatically by Plex prior to Kometa running this file. You can use the delete_collections operation to do this, or any other method.

Collections¶

Collection	Key	Description
`<<Collection Name>>` Example: `Iron Man`	`<<TMDb Collection ID>>` Example: `131292`	Collection of Movies found in this Collection on TMDb.

Config¶

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

libraries:
  Movies:
    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:
  Movies:
    collection_files:
      - default: franchise
        template_variables:
          build_collection: false #(1)!
          movie_105995: 336560 #(2)!
          radarr_add_missing: true #(3)!

Do not create any physical collections in Plex (normally used when you want to perform an "operation" instead, see the third tooltip for the example)
Add TMDb Movie 336560 to TMDb Collection 105995
Add items missing from your library in Plex to Radarr. When used in this particular file, hundreds if not thousands of items may be sent to Radarr - proceed with caution!

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

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

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

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

movie_<<key>>¹ Description: Adds the TMDb Movie IDs given to the key's collection. Overrides the default movie for that collection if used.
Values: List of TMDb Movie IDs

name_mapping_<<key>>¹ Description: Sets the name mapping value for using assets of the key's collection.Overrides the default name_mapping for that collection if used.
Values: Any String

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

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

title_override Description: Overrides the default title_override dictionary.
Values: Dictionary with key: new_title entries

radarr_add_missing_<<key>>¹ Description: Override Radarr add_missing attribute of the key's collection.
Default: radarr_add_missing
Values: true or false

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

radarr_folder_<<key>>¹ Description: Override Radarr root_folder_path attribute of the key's collection.
Default: radarr_folder
Values: Folder Path

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

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

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

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

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

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 Collection IDs

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

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

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

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
`custom`	Order Collection Via the Builder Order
Any `plex_search` Sort Option	Order Collection by any `plex_search` Sort Option

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

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>>¹

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

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.

Franchise CollectionsDefault addonsDefault title_overrideDefault movieDefault name_mapping

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 ############
###############################################################################

addons: 
  8091:       # Alien
    - 135416    # Prometheus
  2806:       # American Pie
    - 298820    # American Pie (Spin-off)
  87800:      # Appleseed
    - 371526    # Appleseed XIII
  477208:     # DC Super Hero Girls
    - 557495    # LEGO DC Super Hero Girls
  86066:      # Despicable Me
    - 544669    # Minions
  86115:      # Garfield
    - 373918    # Garfield CGI
  91361:      # Halloween
    - 126209    # Halloween (Rob Zombie Series)
  9818:       # Mortal Kombat
    - 931431    # Mortal Kombat
  495:        # Shaft
    - 608103    # Shaft (Reboot)
  1582:       # Teenage Mutant Ninja Turtles
    - 401562    # Teenage Mutant Ninja Turtles (Remake)
  111751:     # Texas Chainsaw Massacre
    - 425175    # Texas Chainsaw (Reboot)
  748:        # X-Men
    - 453993    # The Wolverine

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 ############
###############################################################################

title_override: 
  10: "Star Wars: Skywalker Saga"
  535313: Godzilla (MonsterVerse)
  535790: Godzilla (Anime)

Tip

Pass movie_<<key>> to the file as Template Variables to change this value per collection.

  - default: franchise
    template_variables:
      movie_131292:
        - 1234
        - 5678

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 ############
###############################################################################

movie: 
  521226:     # A Quiet Place
    - 762441    # A Quiet Place: Day One
  105995:     # Anaconda
    - 336560    # Lake Placid vs. Anaconda
  176097:     # Barbershop
    - 14177     # Beauty Shop
  448150:     # Deadpool
    - 567604    # Once Upon a Deadpool
  9485:       # The Fast and the Furious
    - 384018    # Hobbs & Shaw
  9735:       # Friday the 13th
    - 6466      # Freddy vs. Jason
    - 222724    # Crystal Lake Memories: The Complete History of Friday the 13th
  386382:     # Frozen
    - 326359    # Frozen Fever
    - 460793    # Olaf's Frozen Adventure
  2980:       # Ghostbusters
    - 43074     # Ghostbusters (2016)
  374509:     # Godzilla (Showa)
    - 18983     # Godzilla, King of the Monsters!
  374511:     # Godzilla (Heisei)
    - 39256     # Godzilla 1985
  535313:     # Godzilla
    - 293167    # Kong: Skull Island
  9743:       # The Hannibal Lecter
    - 11454     # Manhunter
  8354:       # Ice Age
    - 79218     # Ice Age: A Mammoth Christmas
    - 717095    # Ice Age Continental Drift: Scrat Got Your Tongue
    - 387893    # Ice Age: The Great Egg-Scapade
  70068:      # Ip Man
    - 658009    # Ip Man: Kung Fu Master
    - 643413    # Ip Man and Four Kings
    - 450001    # Master Z: Ip Man Legacy
    - 751391    # Young Ip Man: Crisis Time
    - 44249     # The Legend Is Born: Ip Man
    - 182127    # Ip Man: The Final Fight
    - 44865     # The Grandmaster
  328:        # Jurassic Park
    - 630322    # Battle at Big Rock
  8580:       # The Karate Kid
    - 38575     # The Karate Kid (2010)
  14740:      # Madagascar
    - 161143    # Madagascar: Madly Madagascar
    - 25472     # Merry Madagascar
    - 270946    # Penguins of Madagascar
  9818:       # Mortal Kombat
    - 664767    # Mortal Kombat Legends: Scorpion's Revenge
  171732:     # Rebirth of Mothra
    - 39410     # Mothra
  8581:       # A Nightmare on Elm Street
    - 6466      # Freddy vs. Jason
    - 23437     # A Nightmare on Elm Street (2010)
  627517:     # Oz
    - 13155     # Oz: Return to Oz
    - 68728     # Oz the Great and Powerful
  10789:      # Pet Sematary
    - 157433    # Pet Sematary (2019)
  708816:     # Power Rangers
    - 305470    # Power Rangers (2017)
    - 306264    # Power Rangers Super Megaforce: The Legendary Battle
  190435:     # Street Fighter (Animated)
    - 687354    # Street Fighter Assassin's Fist
    - 11667     # Street Fighter
  1582:       # Teenage Mutant Ninja Turtles
    - 1273      # TMNT
  2467:       # Tomb Raider
    - 338970    # Tomb Raider (2018)
  10194:      # Toy Story
    - 130925    # Partysaurus Rex
  63043:      # TRON
    - 73362     # TRON: The Next Day
  748:        # X-Men
    - 567604    # Once Upon a Deadpool

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 ############
###############################################################################

name_mapping: 
  1565: 28 Days-Weeks Later
  508334: Angels in the
  115838: Escape From
  386534: Has Fallen
  87359: Mission Impossible
  133352: Resident Evil Biohazard
  115575: Star Trek Alternate Reality
  115570: Star Trek The Next Generation
  151: Star Trek The Original Series
  10: Star Wars Skywalker Saga