Plex-Meta-Manager/docs/defaults/award/choice.md
2022-10-03 21:34:30 +01:00

5.3 KiB

choice Default Metadata File

The - pmm: choice Metadata File is used to create collections based on the Critics Choice Awards.

This Default file requires Trakt Authentication

Example Collections Created:

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

libraries:
  Movies:
    metadata_path:
      - pmm: choice

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
use_year_collections Turn the individual year collections on/off true true or false
collection_section Controls the sort order of these collections against other default collections 16 Any number
collection_mode Controls the collection mode of these collections default default - Library default
hide - Hide Collection
hide_items- Hide Items in this Collection
show_items - Show this Collection and its Items
collection_order Sets the collection order of the collection custom alpha, release or custom
radarr_add_missing Adds missing from the collection to Radarr false true or false
radarr_folder Radarr Folder to add to Folder to add missing items to
radarr_tag Radarr Tag for added missing list of tag(s) to be applied to missing items
item_radarr_tag Radarr Tag for existing items list of tag(s) to be applied to existing items
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
sonrr_tag Sonarr Tag for added missing list of tag(s) to be applied to missing 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: choice
        template_variables:
          collection_section: 9
          collection_mode: show_items
          collection_order: alpha
          radarr_add_missing: true
          radarr_folder: /mnt/local/Media/Movies
          radarr_tag: <<collection_name>>
          item_radarr_tag: <<collection_name>>
          sonarr_add_missing: true
          sonarr_folder: /mnt/local/Media/TV
          sonarr_tag: <<collection_name>>
          item_sonarr_tag: <<collection_name>>