14 KiB

Raw Blame History

Cannes Awards Collections

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

Requirements & Recommendations

Supported Library Types: Movie

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:
    collection_files:
      - pmm: cannes

Template Variable Default Values

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.

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>>¹

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>>¹

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.

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

{% include-markdown "../collection_variables.md" %}

Example Template Variable Amendments

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

???+ tip

Anywhere you see this icon:

> :fontawesome-solid-circle-plus:

That's a tooltip, you can press them to get more information.

libraries:
  Movies:
    collection_files:
      - pmm: cannes
        template_variables:
          collection_mode: show_items #(1)!
          collection_order: alpha #(2)!
          radarr_add_missing: true #(3)!
          name_format: Cannes <<key_name>> Winners #(4)!
          data:
            starting: current_year-10 #(5)!
            increment: 2 #(6)!
            ending: current_year #(7)!

Shows the collection and all of its items within the Library tab in Plex
Sorts the collection items alphabetically
Adds items from the source list which are not in Plex to Radarr
Change the name of the collections to "Cannes yearhere Winners"
If today is 2024, then create collections for Cannes 2014 onwards
If starting year is 2014, then create collections for 2014, 2016, 2018, 2020, etc.
If today is 2024, then the final collection is Cannes 2024

14 KiB Raw Blame History