Plex-Meta-Manager/docs/defaults/show/franchise.md

Franchise Collections

The franchise Default Metadata 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 Metadata 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 works with Show Libraries, but has a Movie Library Counterpart.

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:
    metadata_path:
      - pmm: 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 is its default value if it has one if not it's just ignored.

Shared Collection Variables are NOT available to this default file.

Variable	Description & Values
summary_<<key>>1	Description: Changes the summary of the specified key's collection. Values: New Collection Summary
collection_section	Description: Adds a sort title with this collection sections. Values: Any number
order_<<key>>1	Description: Controls the sort order of the collections in their collection section. Values: Any number
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
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 specified key's collection. 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>>
sort_title_<<key>>1	Description: Sets the sort title of the specified key's collection. Default: sort_title Values: Any String
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
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 specified key's collection. Default: sync_mode Values: sync Add and Remove Items based on Builders append Only Add Items based on Builders
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_order_<<key>>1	Description: Changes the Collection Order of the specified 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
exclude	Description: Exclude these Collections from creating a Dynamic Collection. Values: List of Collection IDs
data	Description: Overrides the default data dictionary. Defines the data that the custom dynamic collection processes. Values: Dictionary List of TMDb Main Show ID
append_data	Description: Appends to the default data dictionary. Values: Dictionary List of TMDb Main Show ID
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
sonarr_add_missing	Description: Override Sonarr add_missing attribute for all collections in a Defaults file. Values: true or false
sonarr_add_missing_<<key>>1	Description: Override Sonarr add_missing attribute of the specified key's collection. Default: sonarr_add_missing Values: true or false
sonarr_folder	Description: Override Sonarr root_folder_path attribute for all collections in a Defaults file. Values: Folder Path
sonarr_folder_<<key>>1	Description: Override Sonarr root_folder_path attribute of the specified key's collection. Default: sonarr_folder Values: Folder Path
sonarr_tag	Description: Override Sonarr tag attribute for all collections in a Defaults file. Values: List or comma-separated string of tags
sonarr_tag_<<key>>1	Description: Override Sonarr tag attribute of the specified key's collection. Default: 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
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 specified key's collection. Default: item_sonarr_tag Values: List or comma-separated string of tags

1. Each default collection has a key that when calling to effect a specific collection you must replace <<key>> with when calling.

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

libraries:
  TV Shows:
    metadata_path:
      - pmm: franchise
        template_variables:
          append_data:
            "31917": Pretty Little Liars
          append_addons:
            31917: [46958, 79863, 110531] # Pretty Little Liars: Ravenswood, The Perfectionists, Original Sin
          sonarr_add_missing: true

Default values

These are lists provided for reference to show what values will be in use if you do no customization. If you want to customize these values, use the methods described above. These do not show how to change a name or a list.

Default data

data:
  "44006": One Chicago
  "75219": 9-1-1
  "253": Star Trek
  "1412": Arrowverse
  "85536": Star Wars
  "121": Doctor Who
  "1402": The Walking Dead
  "4629": Stargate
  "519": Law & Order
  "5614": NCIS
  "1431": CSI
  "951": Archie Comics
  "31917": Pretty Little Liars
  "6357": The Twilight Zone

Default addons

addons:
  44006: [58841, 62650, 67993] # Chicago Fire: Med, PD, Justice
  75219: 89393 # 9-1-1: 9-1-1 Lone Star
  253: [655, 1855, 314, 67198, 85949] # Star Trek, The Next Generation, Voyager, Enterprise, Discovery, Picard
  1412: [60735, 62688, 62643, 71663, 89247]  # Arrow: The Flash, Supergirl, Legends of Tomorrow, Black Lightning, Batwoman
  85536: [71412, 3478, 105971, 92830, 83867, 60554, 82856, 115036, 114461, 202879, 114462, 114476, 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, Rangers of the New Republic, Lando, Visions, Resistance
  121: [57243, 1057, 424, 203, 64073]  # Doctor Who: K-9 & Company, Torchwood, The Sarah Jane Adventures, Class
  1402: [62286, 94305] # The Walking Dead: Fear the Walking Dead, World Beyond
  4629: [2290, 5148, 72925] # Stargate SG-1: Atlantis, Universe, Origins
  549: [2734, 4601, 3357, 32632, 72496, 157088, 106158]  #Law & Order, Special Victims Unit, Criminal Intent, Trial by Jury, LA, True Crime, Hate Crimes, Organized Crime
  5614: [17610, 124271, 61387, 4376]  # NCIS, Los Angeles, New Orleans, Hawaii, JAG
  1431: [1620, 2458, 122194, 61811] # CSI: Miami, NY, Cyber, Vegas
  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
  31917: [46958, 79863, 110531] # Pretty Little Liars: Ravenswood, The Perfectionists, Original Sin
  6357: [1918, 83135, 16399]  # The Twilight Zone (multiple)