Plex
/
Plex-Meta-Manager
mirror of https://github.com/meisnate12/Plex-Meta-Manager.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '2afc82a441'
${ noResults }
Plex-Meta-Manager/docs/defaults/show/franchise.md

3.1 KiB
Raw Blame History

Franchise Language Default Metadata File

The - pmm: show/franchise Metadata File is used to create collections based on popular TV franchises

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.

Example Collections Created:

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

libraries:
  Movies:
    metadata_path:
      - pmm: show/franchise

Template Variables

Template Variables can be used to manipulate the file from the default settings which are provided.

Note that the templates_variables: section only needs to be used if you do NOT want to use the default settings.

Below are the available variables which can be used to customize the file.

Variable Usage Default Value Values
collection_order Sets the collection order of the collection release release, alpha or custom
sort_title Sets the sort title Desired sort title
minimum_items Sets the minimum items of the collection 2 Any number
build_collection Sets weather to actually build the collection true true or false
sonarr_add_missing Adds missing from the collection to sonarr false true or false
sonarr_folder Sonarr Folder to add to Folder to add missing items to
sonarr_tag Sonarr Tag for added missing list of tag(s) to be applied to existing items
item_sonarr_tag Sonarr Tag for existing items list of tag(s) to be applied to existing items

The below shows an example config.yml with all the template_variables set away from their defaults:

libraries:
  Movies:
    metadata_path:
      - pmm: show/franchise
        template_variables:
          collection_order: alpha
          sort_title: "!10_<<collection_name>>"
          build_collection: false
          sonarr_add_missing: true
          sonarr_folder: /mnt/local/Media/TV
          sonarr_tag: <<collection_name>>
          item_sonarr_tag: <<collection_name>>