Plex-Meta-Manager/docs/defaults/award/other.md
2023-01-04 14:46:04 -05:00

5.4 KiB

Other Awards Collections

The other_award Default Metadata File is used to create collections based on numerous other awards.

This Default file requires Trakt Authentication

This file only works with Movie Libraries.

Collections Section 16

Collection Key Description
Berlinale Golden Bears berlinale Collection of Berlinale Golden Bears Award Winners.
César Best Film Winners cesar Collection of César Best Film Winners Award Winners.
Razzies Golden Raspberry Winners razzie Collection of Razzies Golden Raspberry Winners Award Winners.
Venice Golden Lions venice Collection of Venice Golden Lions Award Winners.

Config

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

libraries:
  Movies:
    metadata_path:
      - pmm: other_award

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
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
  1. Each default collection has a key that when calling to effect a specific collection you must replace <<key>> with when calling.

The below shows an example config.yml with template_variables set away from their defaults:

libraries:
  Movies:
    metadata_path:
      - pmm: other_award
        template_variables:
          collection_mode: show_items
          collection_order: alpha
          radarr_add_missing: true