You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Plex-Meta-Manager/docs/defaults/award/golden.md

15 KiB

Golden Globes Awards Collections

The golden Default Collection File is used to create collections based on the Golden Globe Awards.

Requirements & Recommendations

Supported Library Types: Movie, Show

Recommendations: The Golden Globe Best Motion Pictures Collection only works with Movie Libraries

Collections Section 130

Collection Key Description
Golden Globes Best Picture Winners best_picture Collection of Golden Globe Best Picture Award Winners.
Golden Globes Best Director Winners best_director Collection of Golden Globe Best Director Award Winners.
Golden Globe <<year>>
Example: Golden Globe 2022
<<year>>
Example: 2022
Collection of Golden Globe Award Winners for the given year.

Config

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

libraries:
  Movies:
    collection_files:
      - pmm: golden
  TV Shows:
    collection_files:
      - pmm: golden

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:
syncAdd and Remove Items based on Builders
appendOnly Add Items based on Builders
sync_mode_<<key>>1 Description: Changes the Sync Mode of the specified key's collection.
Default: sync_mode
Values:
syncAdd and Remove Items based on Builders
appendOnly Add Items based on Builders
collection_order Description: Changes the Collection Order for all collections in a Defaults file.
Default: custom
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>>1 Description: Changes the Collection Order of the specified key's collection.
Default: 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: Replaces the data dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
Values: Number greater than 0
endingControls the ending year for collections
Default: current_year
Values: Number greater than 1
incrementControls 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: Golden Globe <<key_name>>
Values: Any string with <<key_name>> in it.
summary_format Description: Changes the summary format of the Dynamic Collections.
Default: <<key_name>> Golden Globe Winners.
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.

{% 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: golden
        template_variables:
          collection_mode: show_items #(1)!
          collection_order: alpha #(2)!
          radarr_add_missing: true #(3)!
          name_format: Emmys <<key_name>> Winners #(4)!
          data:
            starting: current_year-10 #(5)!
            increment: 2 #(6)!
            ending: current_year #(7)!
  1. Shows the collection and all of its items within the Library tab in Plex
  2. Sorts the collection items alphabetically
  3. Adds items from the source list which are not in Plex to Radarr
  4. Change the name of the collections to "Golden Globes yearhere Winners"
  5. If today is 2024, then create collections for Golden Globes 2014 onwards
  6. If starting year is 2014, then create collections for 2014, 2016, 2018, 2020, etc.
  7. If today is 2024, then the final collection is Golden Globes 2024