Plex-Meta-Manager/docs/defaults/award/cannes.md
2022-10-06 14:58:57 -04:00

6.5 KiB

Cannes Default Metadata File

The cannes Metadata File is used to create collections based on the Cannes Film 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: cannes

Collections

Collection Key Description
Cannes Golden Palm Winners palm Collection of Cannes Golden Palm Award Winners.
Cannes <<year>> <<year>> Collection of Cannes Film Award Winners for the given year.

Examples

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 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
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 shows an example config.yml with all the template_variables set away from their defaults:

libraries:
  Movies:
    metadata_path:
      - pmm: cannes
        template_variables:
          collection_section: 8
          collection_mode: show_items
          collection_order: alpha
          radarr_add_missing: true