Plex-Meta-Manager/docs/defaults/both/year.md

4.7 KiB

Year Language Default Metadata File

The - pmm: year Metadata File is used to dynamically create collections based on the years available in your library, sorted by critic rating to create a "best of "

Example Collections Created:

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

libraries:
  Movies:
    metadata_path:
      - pmm: year

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
sort_by Controls the sort method for the collections release.desc Any sort method in the Sorts Options Table
collection_section Controls the sort order of these collections against other default collections 13 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
use_other Controls whether an "Other" collection is created for any items not included in the initial criteria true true or false
use_separator Controls whether a separator is created true true or false
sep_style Sets the theme of the separator orig orig, blue, gray, green, purple, red, stb
item_radarr_tag Radarr Tag for existing items 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: year
        template_variables:
          sort_by: title.asc
          collection_section: 8
          collection_mode: show_items
          use_other: false
          use_separator: false
          sep_style: purple

Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the year collections can be found here

An example of this is; to include the previous 20 years (default is 10), the following template variable can be used:

libraries:
  Movies:
    metadata_path:
      - pmm: year
        template_variables:
          data:
            starting: current_year-20

Further information on editing Dynamic Collections using template variables can be found here