Franchise Collections¶

The franchise Default Collection File is used to 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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.