Plex-Meta-Manager/docs/defaults/both/year.md
2022-10-07 18:18:32 +01:00

5.1 KiB

Year Language Default Metadata File

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

All Shared Variables are available as well as the additional Variables below which can be used to customize the file.

Variable Description & Values
collection_order Description: Changes the Collection Order
Values:
releaseOrder Collection by Release Dates
alphaOrder Collection Alphabetically
customOrder Collection Via the Builder Order
Any plex_search Sort OptionOrder Collection by any plex_search Sort Option
data Description: Changes the following values of the collection builder
Values:
AttributeDescription & Values
startingControls the starting year for collections
Values: Number greater than 0
Default: current_year-10
endingControls the ending year for collections
Values: Number greater than 1
Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0
Default: 1
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5

The below is an example config.yml extract with some template_variables changed 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