Plex-Meta-Manager/docs/defaults/award/cannes.md

Cannes Awards Collections

The cannes Default Metadata File is used to create collections based on the Cannes Film Awards.

Requirements & Recommendations

Supported Library Types: Movie

Requirements: Trakt Authentication

Collections Section 130

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

Config

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

libraries:
  Movies:
    metadata_path:
      - pmm: cannes

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 template_variables: section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.

All Shared Collection 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
year_collection_section	Description: Change the collection section for year collections only. (Use quotes to not lose leading zeros "05") Values: Any number
sync_mode	Description: Changes the Sync Mode for all collections in a Defaults file. Default: sync Values: sync Add and Remove Items based on Builders append Only Add Items based on Builders
sync_mode_<<key>>1	Description: Changes the Sync Mode of the specified key's collection. Default: sync_mode Values: sync Add and Remove Items based on Builders append Only Add Items based on Builders
collection_order	Description: Changes the Collection Order for all collections in a Defaults file. Default: custom Values: release Order Collection by Release Dates alpha Order Collection Alphabetically custom Order Collection Via the Builder Order Any plex_search Sort Option Order Collection by any plex_search Sort Option
collection_order_<<key>>1	Description: Changes the Collection Order of the specified key's collection. Default: collection_order Values: release Order Collection by Release Dates alpha Order Collection Alphabetically custom Order Collection Via the Builder Order Any plex_search Sort Option Order Collection by any plex_search Sort Option
data	Description: Replaces the data dynamic collection value. Attribute Description & Values starting Controls the starting year for collections Default: current_year-5 Values: Number greater than 0 ending Controls the ending year for collections Default: current_year Values: Number greater than 1 increment Controls the increment (i.e. every 5th year) Default: 1 Values: Number greater than 0 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
exclude	Description: Exclude these Years from creating a Dynamic Collection. Values: List of Years
name_format	Description: Changes the title format of the Dynamic Collections. Default: Cannes <<key_name>> Values: Any string with <<key_name>> in it.
summary_format	Description: Changes the summary format of the Dynamic Collections. Default: <<key_name>> Cannes Awards. Values: Any string with <<key_name>> in it.

1. Each default collection has a key that when calling to effect a specific collection you must replace <<key>> with when calling.

The below is an example config.yml extract with some Template Variables added in to change how the file works.

libraries:
  Movies:
    metadata_path:
      - pmm: cannes
        template_variables:
          collection_mode: show_items
          collection_order: alpha
          radarr_add_missing: true
          data:
            starting: current_year-10
            ending: current_year