Plex-Meta-Manager/docs/defaults/award/sundance.md
2022-10-07 16:56:11 -04:00

7.5 KiB

Sundance Film Festival Awards Default Metadata File

The sundance Metadata File is used to create collections based on the Sundance Film Festival Awards.

This Default file requires Trakt Authentication

This file only works with Movie Libraries.

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

libraries:
  Movies:
    metadata_path:
      - pmm: sundance

Collections

Collection Key Description
Sundance Grand Jury Winners grand Collection of Sundance Film Festival Grand Jury Award Winners.
Sundance Film Festival <<year>> <<year>> Collection of Sundance Film Festival Award Winners for the given year.

Examples

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 templates_variables: section only needs to be used if you do want to actually change how the defaults work. Any value not specified is just ignored.

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

Variable Description & Values
use_year_collections Description: Turn the individual year collections off
Values: false to turn of the collections
collection_order Description: Changes the Collection Order for all collections in a Defaults file.
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
collection_order_<<key>> Description: Changes the Collection Order of the specified key's Collection.
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:
startingControls the starting year for collections
Values: Number greater than 0
Default: current_year-5
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: sundance
        template_variables:
          collection_section: 8
          collection_mode: show_items
          collection_order: alpha
          radarr_add_missing: true