Plex
/
Plex-Meta-Manager
mirror of https://github.com/meisnate12/Plex-Meta-Manager.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

[95] update award default pages

Browse Source
pull/1097/head
meisnate12 2 years ago
parent 5c2b0b9aa8
commit d332c4ac55
21 changed files with 188 additions and 318 deletions
Show Stats Download Patch File Download Diff File

2
VERSION
Unescape View File

@ -1 +1 @@
1.17.3-develop94 1.17.3-develop95

4
defaults/award/bafta.yml
Unescape View File

@ -1,9 +1,9 @@
############################################################################## ##############################################################################
# BAFTA Collections # # British Academy Film Awards Collections #
# Created by Yozora, Bullmoose20, & Sohjiro # # Created by Yozora, Bullmoose20, & Sohjiro #
# Credit to pjcob & maxwelldeux for the Trakt Lists # # Credit to pjcob & maxwelldeux for the Trakt Lists #
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
# https://metamanager.wiki/en/latest/defaults/chart/bafta.html # # https://metamanager.wiki/en/latest/defaults/award/bafta.html #
############################################################################## ##############################################################################
external_templates: external_templates:

40
defaults/award/cannes.yml
Unescape View File

@ -1,43 +1,11 @@
############################################################################## ##############################################################################
# Cannes Collections # # Cannes Awards Collections #
# Created by Yozora, Bullmoose20, & Sohjiro # # Created by Yozora, Bullmoose20, & Sohjiro #
# Credit to pjcob & maxwelldeux for the Trakt Lists # # Credit to pjcob & maxwelldeux for the Trakt Lists #
# https://metamanager.wiki/en/latest/defaults/chart/cannes.html # # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
# https://metamanager.wiki/en/latest/defaults/award/cannes.html #
############################################################################## ##############################################################################
#############################################################
# Cannes Collections #
# Created by Yozora, Bullmoose20, & Sohjiro #
# Credit to pjcob & maxwelldeux for the Trakt Lists #
#############################################################
# REQUIRES TRAKT AUTHENTICATION #
# https://metamanager.wiki/en/latest/config/trakt.html #
# #
# Call this from your config.yml (Movie only) #
# If nothing is specified these are the defaults #
# #
# metadata_path: #
# - git: PMM/award/cannes #
# template_variables: #
# # Turn the individual year collections on/off #
# use_year_collections: true #
# # Sets the collection order of the collection #
# collection_order: custom #
# # Sets the collection mode of the collection #
# collection_mode: #
# # Sets the value at the start of the sort title #
# collection_section: 16 #
# # Adds missing from the collection to radarr #
# radarr_add_missing: #
# # Radarr Folder to add to #
# radarr_folder: #
# # Radarr Tag for added missing #
# radarr_tag: #
# # Radarr Tag for existing items #
# item_radarr_tag: #
#############################################################
external_templates: external_templates:
pmm: templates pmm: templates
template_variables: template_variables:
@ -49,7 +17,7 @@ translations:
collections: collections:
Cannes Golden Palm Winners: Cannes Golden Palm Winners:
variables: variables:
key: palme key: palm
template: template:
- name: shared - name: shared
sort: Cannes ! sort: Cannes !

40
defaults/award/choice.yml
Unescape View File

@ -1,42 +1,10 @@
############################################################# ##############################################################################
# Critics Choice Awards Collections # # Critics Choice Awards Collections #
# Created by Yozora, Bullmoose20, & Sohjiro # # Created by Yozora, Bullmoose20, & Sohjiro #
# Credit to pjcob for the Trakt Lists # # Credit to pjcob for the Trakt Lists #
############################################################# # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
# REQUIRES TRAKT AUTHENTICATION # # https://metamanager.wiki/en/latest/defaults/award/choice.html #
# https://metamanager.wiki/en/latest/config/trakt.html # ##############################################################################
# #
# Call this from your config.yml (Movie or Show) #
# If nothing is specified these are the defaults #
# #
# metadata_path: #
# - git: PMM/award/choice #
# template_variables: #
# # Turn the individual year collections on/off #
# use_year_collections: true #
# # Sets the collection order of the collection #
# collection_order: custom #
# # Sets the collection mode of the collection #
# collection_mode: #
# # Sets the value at the start of the sort title #
# collection_section: 16 #
# # Adds missing from the collection to radarr #
# radarr_add_missing: #
# # Adds missing from the collection to sonarr #
# sonarr_add_missing: #
# # Radarr Folder to add to #
# radarr_folder: #
# # Sonarr Folder to add to #
# sonarr_folder: #
# # Radarr Tag for added missing #
# radarr_tag: #
# # Sonarr Tag for added missing #
# sonarr_tag: #
# # Radarr Tag for existing items #
# item_radarr_tag: #
# # Sonarr Tag for existing items #
# item_sonarr_tag: #
#############################################################
external_templates: external_templates:
pmm: templates pmm: templates

40
defaults/award/emmy.yml
Unescape View File

@ -1,39 +1,9 @@
############################################################# ##############################################################################
# Emmy Collections # # Emmy Awards Collections #
# Created by Yozora, Bullmoose20, & Sohjiro # # Created by Yozora, Bullmoose20, & Sohjiro #
############################################################# # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
# Call this from your config.yml (Movie or Show) # # https://metamanager.wiki/en/latest/defaults/award/emmy.html #
# If nothing is specified these are the defaults # ##############################################################################
# #
# metadata_path: #
# - git: PMM/award/emmy #
# template_variables: #
# # Turn the individual year collections on/off #
# use_year_collections: true #
# # Sets the sort of the IMDb Search #
# imdb_sort: moviemeter,desc #
# collection_order: custom #
# # Sets the collection mode of the collection #
# collection_mode: #
# # Sets the value at the start of the sort title #
# collection_section: 16 #
# # Adds missing from the collection to radarr #
# radarr_add_missing: #
# # Adds missing from the collection to sonarr #
# sonarr_add_missing: #
# # Radarr Folder to add to #
# radarr_folder: #
# # Sonarr Folder to add to #
# sonarr_folder: #
# # Radarr Tag for added missing #
# radarr_tag: #
# # Sonarr Tag for added missing #
# sonarr_tag: #
# # Radarr Tag for existing items #
# item_radarr_tag: #
# # Sonarr Tag for existing items #
# item_sonarr_tag: #
#############################################################
external_templates: external_templates:
pmm: templates pmm: templates

41
defaults/award/golden.yml
Unescape View File

@ -1,40 +1,10 @@
############################################################# ##############################################################################
# Golden Globes Collections # # Golden Globes Awards Collections #
# Created by Yozora, Bullmoose20, & Sohjiro # # Created by Yozora, Bullmoose20, & Sohjiro #
# Credit to maxwelldeux for the Trakt Lists # # Credit to maxwelldeux for the Trakt Lists #
############################################################# # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
# Call this from your config.yml (Movie or Show) # # https://metamanager.wiki/en/latest/defaults/award/golden.html #
# If nothing is specified these are the defaults # ##############################################################################
# #
# metadata_path: #
# - git: PMM/award/golden #
# template_variables: #
# # Turn the individual year collections on/off #
# use_year_collections: true #
# # Sets the sort of the IMDb Search #
# imdb_sort: moviemeter,desc #
# collection_order: custom #
# # Sets the collection mode of the collection #
# collection_mode: #
# # Sets the value at the start of the sort title #
# collection_section: 16 #
# # Adds missing from the collection to radarr #
# radarr_add_missing: #
# # Adds missing from the collection to sonarr #
# sonarr_add_missing: #
# # Radarr Folder to add to #
# radarr_folder: #
# # Sonarr Folder to add to #
# sonarr_folder: #
# # Radarr Tag for added missing #
# radarr_tag: #
# # Sonarr Tag for added missing #
# sonarr_tag: #
# # Radarr Tag for existing items #
# item_radarr_tag: #
# # Sonarr Tag for existing items #
# item_sonarr_tag: #
#############################################################
external_templates: external_templates:
pmm: templates pmm: templates
@ -51,6 +21,7 @@ collections:
template: template:
- name: shared - name: shared
sort: Golden Globes !1 sort: Golden Globes !1
allowed_libraries: movie
image: award/golden/best_picture_winner image: award/golden/best_picture_winner
- name: arr - name: arr
- name: custom - name: custom

31
defaults/award/oscars.yml
Unescape View File

@ -1,31 +1,8 @@
############################################################# ##############################################################################
# Oscars Collections # # Academy Awards (Oscars) Collections #
# Created by Yozora, Bullmoose20, & Sohjiro # # Created by Yozora, Bullmoose20, & Sohjiro #
############################################################# # https://metamanager.wiki/en/latest/defaults/award/oscars.html #
# Call this from your config.yml (Movie only) # ##############################################################################
# If nothing is specified these are the defaults #
# #
# metadata_path: #
# - git: PMM/award/oscars #
# template_variables: #
# # Turn the individual year collections on/off #
# use_year_collections: true #
# # Sets the sort of the IMDb Search #
# imdb_sort: user_rating,desc #
# collection_order: custom #
# # Sets the collection mode of the collection #
# collection_mode: #
# # Sets the value at the start of the sort title #
# collection_section: 16 #
# # Adds missing from the collection to radarr #
# radarr_add_missing: #
# # Radarr Folder to add to #
# radarr_folder: #
# # Radarr Tag for added missing #
# radarr_tag: #
# # Radarr Tag for existing items #
# item_radarr_tag: #
#############################################################
external_templates: external_templates:
pmm: templates pmm: templates

32
defaults/award/other_award.yml
Unescape View File

@ -1,32 +1,10 @@
############################################################# ##############################################################################
# Awards Collections # # Other Awards Collections #
# Created by Yozora, Bullmoose20, & Sohjiro # # Created by Yozora, Bullmoose20, & Sohjiro #
# Credit to maxwelldeux for the Trakt Lists # # Credit to maxwelldeux for the Trakt Lists #
############################################################# # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
# REQUIRES TRAKT AUTHENTICATION # # https://metamanager.wiki/en/latest/defaults/award/other.html #
# https://metamanager.wiki/en/latest/config/trakt.html # ##############################################################################
# #
# Call this from your config.yml (Movie only) #
# If nothing is specified these are the defaults #
# #
# metadata_path: #
# - git: PMM/award/other #
# template_variables: #
# # Sets the collection order of the collection #
# collection_order: custom #
# # Sets the collection mode of the collection #
# collection_mode: #
# # Sets the value at the start of the sort title #
# collection_section: 16 #
# # Adds missing from the collection to radarr #
# radarr_add_missing: #
# # Radarr Folder to add to #
# radarr_folder: #
# # Radarr Tag for added missing #
# radarr_tag: #
# # Radarr Tag for existing items #
# item_radarr_tag: #
#############################################################
external_templates: external_templates:
pmm: templates pmm: templates

31
defaults/award/spirit.yml
Unescape View File

@ -1,33 +1,10 @@
############################################################# ##############################################################################
# Independent Spirit Awards Collections # # Independent Spirit Awards Collections #
# Created by Yozora, Bullmoose20, & Sohjiro # # Created by Yozora, Bullmoose20, & Sohjiro #
# Credit to pjcob for the Trakt Lists # # Credit to pjcob for the Trakt Lists #
############################################################# # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
# REQUIRES TRAKT AUTHENTICATION # # https://metamanager.wiki/en/latest/defaults/award/cannes.html #
# https://metamanager.wiki/en/latest/config/trakt.html # ##############################################################################
# #
# Call this from your config.yml (Movie only) #
# If nothing is specified these are the defaults #
# #
# metadata_path: #
# - git: PMM/award/spirit #
# template_variables: #
# # Turn the individual year collections on/off #
# use_year_collections: true #
# collection_order: custom #
# # Sets the collection mode of the collection #
# collection_mode: #
# # Sets the value at the start of the sort title #
# collection_section: 16 #
# # Adds missing from the collection to radarr #
# radarr_add_missing: #
# # Radarr Folder to add to #
# radarr_folder: #
# # Radarr Tag for added missing #
# radarr_tag: #
# # Radarr Tag for existing items #
# item_radarr_tag: #
#############################################################
external_templates: external_templates:
pmm: templates pmm: templates

33
defaults/award/sundance.yml
Unescape View File

@ -1,33 +1,10 @@
############################################################# ##############################################################################
# Sundance Collections # # Sundance Awards Collections #
# Created by Yozora, Bullmoose20, & Sohjiro # # Created by Yozora, Bullmoose20, & Sohjiro #
# Credit to pjcob & maxwelldeux for the Trakt Lists # # Credit to pjcob & maxwelldeux for the Trakt Lists #
############################################################# # EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
# REQUIRES TRAKT AUTHENTICATION # # https://metamanager.wiki/en/latest/defaults/award/cannes.html #
# https://metamanager.wiki/en/latest/config/trakt.html # ##############################################################################
# #
# Call this from your config.yml (Movie only) #
# If nothing is specified these are the defaults #
# #
# metadata_path: #
# - git: PMM/award/sundance #
# template_variables: #
# # Turn the individual year collections on/off #
# use_year_collections: true #
# collection_order: custom #
# # Sets the collection mode of the collection #
# collection_mode: #
# # Sets the value at the start of the sort title #
# collection_section: 16 #
# # Adds missing from the collection to radarr #
# radarr_add_missing: #
# # Radarr Folder to add to #
# radarr_folder: #
# # Radarr Tag for added missing #
# radarr_tag: #
# # Radarr Tag for existing items #
# item_radarr_tag: #
#############################################################
external_templates: external_templates:
pmm: templates pmm: templates

2
defaults/show/country.yml
Unescape View File

@ -57,7 +57,7 @@ dynamic_collections:
- translation - translation
- shared - shared
template_variables: template_variables:
search_term: filter_term:
default: origin_country default: origin_country
image: image:
default: country/<<style>>/<<key_name_encoded>> default: country/<<style>>/<<key_name_encoded>>

8
docs/defaults/award/bafta.md
Unescape View File

@ -1,9 +1,11 @@
# BAFTA Default Metadata File # British Academy Film Default Metadata File
The `bafta` Metadata File is used to create collections based on the British Academy Film Awards. The `bafta` Metadata File is used to create collections based on the British Academy Film Awards.
This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html) This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html)
This file only works with Movie Libraries.
The below YAML in your config.yml will create the collections: The below YAML in your config.yml will create the collections:
```yaml ```yaml
@ -17,7 +19,7 @@ libraries:
| Collection | Key | Description | | Collection | Key | Description |
|:-------------------|:----------:|:------------------------------------------------------------------------| |:-------------------|:----------:|:------------------------------------------------------------------------|
| `BAFTA Best Films` | `best` | Collection of British Academy of Film Best Film Award Winners | | `BAFTA Best Films` | `best` | Collection of British Academy of Film Best Film Award Winners. |
| `BAFTA <<year>>` | `<<year>>` | Collection of British Academy of Film Award Winners for the given year. | | `BAFTA <<year>>` | `<<year>>` | Collection of British Academy of Film Award Winners for the given year. |
### Examples ### Examples
@ -36,7 +38,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
|:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_year_collections` | **Description:** Turn the individual year collections off<br>**Values:** `false` to turn of the collections | | `use_year_collections` | **Description:** Turn the individual year collections off<br>**Values:** `false` to turn of the collections |
| `collection_order` | **Description:** Changes the Collection Order<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | | `collection_order` | **Description:** Changes the Collection Order<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
| `data` | **Description:** Changes the following values of the collection builder<br>**Values:**<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>current_year</code></strong></li><li><strong>You can also use a value relative to the <code>current_year</code> by doing <code>current_year-5</code></strong></li></ul> | | `data` | **Description:** Changes the following values of the collection builder<br><table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>current_year</code></strong></li><li><strong>You can also use a value relative to the <code>current_year</code> by doing <code>current_year-5</code></strong></li></ul> |
The below shows an example config.yml with all the template_variables set away from their defaults: The below shows an example config.yml with all the template_variables set away from their defaults:

18
docs/defaults/award/cannes.md
Unescape View File

@ -1,14 +1,13 @@
# Cannes Default Metadata File # Cannes Default Metadata File
The `- pmm: cannes` Metadata File is used to create collections based on the Cannes Film Awards. The `cannes` Metadata File is used to create collections based on the Cannes Film Awards.
This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html) This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html)
Example Collections Created: This file only works with Movie Libraries.
![](../images/cannes.png)
The below YAML in your config.yml will create the collections: The below YAML in your config.yml will create the collections:
```yaml ```yaml
libraries: libraries:
Movies: Movies:
@ -16,7 +15,16 @@ libraries:
- pmm: cannes - 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
![](../images/cannes.png)
## Template Variables ## Template Variables
@ -30,7 +38,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
|:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_year_collections` | **Description:** Turn the individual year collections off<br>**Values:** `false` to turn of the collections | | `use_year_collections` | **Description:** Turn the individual year collections off<br>**Values:** `false` to turn of the collections |
| `collection_order` | **Description:** Changes the Collection Order<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | | `collection_order` | **Description:** Changes the Collection Order<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
| `data` | **Description:** Changes the following values of the collection builder<br>**Values:**<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>current_year</code></strong></li><li><strong>You can also use a value relative to the <code>current_year</code> by doing <code>current_year-5</code></strong></li></ul> | | `data` | **Description:** Changes the following values of the collection builder<br><table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>current_year</code></strong></li><li><strong>You can also use a value relative to the <code>current_year</code> by doing <code>current_year-5</code></strong></li></ul> |
The below shows an example config.yml with all the template_variables set away from their defaults: The below shows an example config.yml with all the template_variables set away from their defaults:

23
docs/defaults/award/choice.md
Unescape View File

@ -1,21 +1,32 @@
# choice Default Metadata File # Critics Choice Default Metadata File
The `- pmm: choice` Metadata File is used to create collections based on the Critics Choice Awards. The `choice` Metadata File is used to create collections based on the Critics Choice Awards.
This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html) This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html)
Example Collections Created: This file works with Movie and TV Libraries.
![](../images/choice.png)
The below YAML in your config.yml will create the collections: The below YAML in your config.yml will create the collections:
```yaml ```yaml
libraries: libraries:
Movies: Movies:
metadata_path: metadata_path:
- pmm: choice - pmm: choice
TV Shows:
metadata_path:
- pmm: choice
``` ```
## Collections
| Collection | Key | Description |
|:---------------------------------|:----------:|:---------------------------------------------------------------|
| `Critics Choice Awards <<year>>` | `<<year>>` | Collection of Critics Choice Award Winners for the given year. |
### Examples
![](../images/choice.png)
## Template Variables ## Template Variables
@ -29,7 +40,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
|:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_year_collections` | **Description:** Turn the individual year collections off<br>**Values:** `false` to turn of the collections | | `use_year_collections` | **Description:** Turn the individual year collections off<br>**Values:** `false` to turn of the collections |
| `collection_order` | **Description:** Changes the Collection Order<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | | `collection_order` | **Description:** Changes the Collection Order<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
| `data` | **Description:** Changes the following values of the collection builder<br>**Values:**<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>current_year</code></strong></li><li><strong>You can also use a value relative to the <code>current_year</code> by doing <code>current_year-5</code></strong></li></ul> | | `data` | **Description:** Changes the following values of the collection builder<br><table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>current_year</code></strong></li><li><strong>You can also use a value relative to the <code>current_year</code> by doing <code>current_year-5</code></strong></li></ul> |
The below shows an example config.yml with all the template_variables set away from their defaults: The below shows an example config.yml with all the template_variables set away from their defaults:

21
docs/defaults/award/emmy.md
Unescape View File

@ -1,19 +1,30 @@
# Emmys Default Metadata File # Emmys Default Metadata File
The `- pmm: emmy` Metadata File is used to create collections based on the Emmy Awards. The `emmy` Metadata File is used to create collections based on the Emmy Awards.
Example Collections Created: This file works with Movie and TV Libraries.
![](../images/emmy.png)
The below YAML in your config.yml will create the collections: The below YAML in your config.yml will create the collections:
```yaml ```yaml
libraries: libraries:
Movies: Movies:
metadata_path: metadata_path:
- pmm: emmy - pmm: emmy
TV Shows:
metadata_path:
- pmm: emmy
``` ```
## Collections
| Collection | Key | Description |
|:-------------------|:----------:|:------------------------------------------------------|
| `Emmys <<year>>` | `<<year>>` | Collection of Emmys Award Winners for the given year. |
### Examples
![](../images/emmy.png)
## Template Variables ## Template Variables
@ -27,7 +38,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
|:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_year_collections` | **Description:** Turn the individual year collections off<br>**Values:** `false` to turn of the collections | | `use_year_collections` | **Description:** Turn the individual year collections off<br>**Values:** `false` to turn of the collections |
| `collection_order` | **Description:** Changes the Collection Order<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | | `collection_order` | **Description:** Changes the Collection Order<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
| `data` | **Description:** Changes the following values of the collection builder<br>**Values:**<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>current_year</code></strong></li><li><strong>You can also use a value relative to the <code>current_year</code> by doing <code>current_year-5</code></strong></li></ul> | | `data` | **Description:** Changes the following values of the collection builder<br><table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>current_year</code></strong></li><li><strong>You can also use a value relative to the <code>current_year</code> by doing <code>current_year-5</code></strong></li></ul> |
The below shows an example config.yml with all the template_variables set away from their defaults: The below shows an example config.yml with all the template_variables set away from their defaults:

26
docs/defaults/award/golden.md
Unescape View File

@ -1,19 +1,31 @@
# Golden Globes Default Metadata File # Golden Globes Default Metadata File
The `- pmm: golden` Metadata File is used to create collections based on the Golden Globe Awards. The `golden` Metadata File is used to create collections based on the Golden Globe Awards.
Example Collections Created: The `Golden Globe Best Motion Pictures` only works with Movie Libraries but the year collections work with both Movie and TV libraries.
![](../images/golden.png)
The below YAML in your config.yml will create the collections: The below YAML in your config.yml will create the collections:
```yaml ```yaml
libraries: libraries:
Movies: Movies:
metadata_path: metadata_path:
- pmm: golden - pmm: golden
TV Shows:
metadata_path:
- pmm: golden
``` ```
## Collections
| Collection | Key | Description |
|:------------------------------------|:----------:|:--------------------------------------------------------------|
| `Golden Globe Best Motion Pictures` | `best` | Collection of Golden Globe Best Motion Picture Award Winners. |
| `Golden Globe <<year>>` | `<<year>>` | Collection of Golden Globe Award Winners for the given year. |
### Examples
![](../images/golden.png)
## Template Variables ## Template Variables
@ -27,7 +39,11 @@ All [Shared Variables](../variables) are available as well as the additional Var
|:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_year_collections` | **Description:** Turn the individual year collections off<br>**Values:** `false` to turn of the collections | | `use_year_collections` | **Description:** Turn the individual year collections off<br>**Values:** `false` to turn of the collections |
| `collection_order` | **Description:** Changes the Collection Order<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | | `collection_order` | **Description:** Changes the Collection Order<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
| `data` | **Description:** Changes the following values of the collection builder<br>**Values:**<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>current_year</code></strong></li><li><strong>You can also use a value relative to the <code>current_year</code> by doing <code>current_year-5</code></strong></li></ul> | | `data` | **Description:** Changes the following values of the collection builder<br><table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>current_year</code></strong></li><li><strong>You can also use a value relative to the <code>current_year</code> by doing <code>current_year-5</code></strong></li></ul> |
<table class="clearTable">
<tr><th>Values:</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>current_year</code></strong></li><li><strong>You can also use a value relative to the <code>current_year</code> by doing <code>current_year-5</code></strong></li></ul>
The below shows an example config.yml with all the template_variables set away from their defaults: The below shows an example config.yml with all the template_variables set away from their defaults:

21
docs/defaults/award/oscars.md
Unescape View File

@ -1,10 +1,8 @@
# Oscars Default Metadata File # Academy Awards (Oscars) Default Metadata File
The `- pmm: oscars` Metadata File is used to create collections based on the Oscars Awards. The `oscars` Metadata File is used to create collections based on the Academy Awards (Oscars).
Example Collections Created: This file only works with Movie Libraries.
![](../images/oscars.png)
The below YAML in your config.yml will create the collections: The below YAML in your config.yml will create the collections:
```yaml ```yaml
@ -14,6 +12,17 @@ libraries:
- pmm: oscars - pmm: oscars
``` ```
## Collections
| Collection | Key | Description |
|:-------------------------------|:---------------:|:-------------------------------------------------------|
| `Oscars Best Picture Winners` | `best_picture` | Collection of Oscars Best Picture Award Winners. |
| `Oscars Best Director Winners` | `best_director` | Collection of Oscars Best Director Award Winners. |
| `Oscars Winners <<year>>` | `<<year>>` | Collection of Oscars Award Winners for the given year. |
### Examples
![](../images/oscars.png)
## Template Variables ## Template Variables
@ -27,7 +36,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
|:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_year_collections` | **Description:** Turn the individual year collections off<br>**Values:** `false` to turn of the collections | | `use_year_collections` | **Description:** Turn the individual year collections off<br>**Values:** `false` to turn of the collections |
| `collection_order` | **Description:** Changes the Collection Order<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | | `collection_order` | **Description:** Changes the Collection Order<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
| `data` | **Description:** Changes the following values of the collection builder<br>**Values:**<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>current_year</code></strong></li><li><strong>You can also use a value relative to the <code>current_year</code> by doing <code>current_year-5</code></strong></li></ul> | | `data` | **Description:** Changes the following values of the collection builder<br><table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>current_year</code></strong></li><li><strong>You can also use a value relative to the <code>current_year</code> by doing <code>current_year-5</code></strong></li></ul> |
The below shows an example config.yml with all the template_variables set away from their defaults: The below shows an example config.yml with all the template_variables set away from their defaults:

19
docs/defaults/award/other.md
Unescape View File

@ -1,14 +1,13 @@
# Other Awards Default Metadata File # Other Awards Default Metadata File
The `- pmm: other_award` Metadata File is used to create collections based on numerous other awards. The `other_award` Metadata File is used to create collections based on numerous other awards.
This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html) This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html)
Example Collections Created: This file only works with Movie Libraries.
![](../images/awardother.png)
The below YAML in your config.yml will create the collections: The below YAML in your config.yml will create the collections:
```yaml ```yaml
libraries: libraries:
Movies: Movies:
@ -16,6 +15,18 @@ libraries:
- pmm: other_award - pmm: other_award
``` ```
## Collections
| 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. |
### Examples
![](../images/awardother.png)
## Template Variables ## Template Variables

18
docs/defaults/award/spirit.md
Unescape View File

@ -1,14 +1,13 @@
# Independent Spirit Awards Default Metadata File # Independent Spirit Awards Default Metadata File
The `- pmm: spirit` Metadata File is used to create collections based on the Independent Spirit Awards. The `spirit` Metadata File is used to create collections based on the Independent Spirit Awards.
This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html) This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html)
Example Collections Created: This file only works with Movie Libraries.
![](../images/spirit.png)
The below YAML in your config.yml will create the collections: The below YAML in your config.yml will create the collections:
```yaml ```yaml
libraries: libraries:
Movies: Movies:
@ -16,6 +15,15 @@ libraries:
- pmm: spirit - pmm: spirit
``` ```
## Collections
| Collection | Key | Description |
|:-------------------------------------|:----------:|:-------------------------------------------------------------------|
| `Independent Spirit Awards <<year>>` | `<<year>>` | Collection of Independent Spirit Award Winners for the given year. |
### Examples
![](../images/spirit.png)
## Template Variables ## Template Variables
@ -29,7 +37,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
|:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_year_collections` | **Description:** Turn the individual year collections off<br>**Values:** `false` to turn of the collections | | `use_year_collections` | **Description:** Turn the individual year collections off<br>**Values:** `false` to turn of the collections |
| `collection_order` | **Description:** Changes the Collection Order<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | | `collection_order` | **Description:** Changes the Collection Order<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
| `data` | **Description:** Changes the following values of the collection builder<br>**Values:**<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>current_year</code></strong></li><li><strong>You can also use a value relative to the <code>current_year</code> by doing <code>current_year-5</code></strong></li></ul> | | `data` | **Description:** Changes the following values of the collection builder<br><table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>current_year</code></strong></li><li><strong>You can also use a value relative to the <code>current_year</code> by doing <code>current_year-5</code></strong></li></ul> |
The below shows an example config.yml with all the template_variables set away from their defaults: The below shows an example config.yml with all the template_variables set away from their defaults:

20
docs/defaults/award/sundance.md
Unescape View File

@ -1,14 +1,13 @@
# Sundance Film Festival Awards Default Metadata File # Sundance Film Festival Awards Default Metadata File
The `- pmm: sundance` Metadata File is used to create collections based on the Sundance Film Festival Awards. The `sundance` Metadata File is used to create collections based on the Sundance Film Festival Awards.
This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html) This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html)
Example Collections Created: This file only works with Movie Libraries.
![](../images/sundance.png)
The below YAML in your config.yml will create the collections: The below YAML in your config.yml will create the collections:
```yaml ```yaml
libraries: libraries:
Movies: Movies:
@ -16,6 +15,16 @@ libraries:
- pmm: sundance - pmm: sundance
``` ```
## Collections
| Collection | Key | Description |
|:------------------------------------|:----------:|:-----------------------------------------------------------------------|
| `Sundance Grand Jury Winners` | `grand` | Collection of Sundance Film Festival Grand Jury Award Winners. |
| `Sundance Film Festival <<year>>` | `<<year>>` | Collection of Sundance Film Festival Award Winners for the given year. |
### Examples
![](../images/sundance.png)
## Template Variables ## Template Variables
@ -29,8 +38,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
|:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_year_collections` | **Description:** Turn the individual year collections off<br>**Values:** `false` to turn of the collections | | `use_year_collections` | **Description:** Turn the individual year collections off<br>**Values:** `false` to turn of the collections |
| `collection_order` | **Description:** Changes the Collection Order<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> | | `collection_order` | **Description:** Changes the Collection Order<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
| `data` | **Description:** Changes the following values of the collection builder<br>**Values:**<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>current_year</code></strong></li><li><strong>You can also use a value relative to the <code>current_year</code> by doing <code>current_year-5</code></strong></li></ul> | | `data` | **Description:** Changes the following values of the collection builder<br><table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-5</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>current_year</code></strong></li><li><strong>You can also use a value relative to the <code>current_year</code> by doing <code>current_year-5</code></strong></li></ul> |
The below shows an example config.yml with all the template_variables set away from their defaults: The below shows an example config.yml with all the template_variables set away from their defaults:

4
modules/overlays.py
Unescape View File

@ -74,8 +74,8 @@ class Overlays:
logger.separator(f"{'Re-' if self.library.reapply_overlays else ''}Applying Overlays for the {self.library.name} Library") logger.separator(f"{'Re-' if self.library.reapply_overlays else ''}Applying Overlays for the {self.library.name} Library")
logger.info("") logger.info("")
for i, (over_key, (item, over_names)) in enumerate(sorted(key_to_overlays.items(), key=lambda io: self.library.get_item_sort_title(io[1][0])), 1): for i, (over_key, (item, over_names)) in enumerate(sorted(key_to_overlays.items(), key=lambda io: self.library.get_item_sort_title(io[1][0])), 1):
try:
item_title = self.library.get_item_sort_title(item, atr="title") item_title = self.library.get_item_sort_title(item, atr="title")
try:
logger.ghost(f"Overlaying: {i}/{len(key_to_overlays)} {item_title}") logger.ghost(f"Overlaying: {i}/{len(key_to_overlays)} {item_title}")
image_compare = None image_compare = None
overlay_compare = None overlay_compare = None
@ -359,7 +359,7 @@ class Overlays:
if self.config.Cache and poster_compare: if self.config.Cache and poster_compare:
self.config.Cache.update_image_map(item.ratingKey, f"{self.library.image_table_name}_overlays", item.thumb, poster_compare, overlay='|'.join(compare_names)) self.config.Cache.update_image_map(item.ratingKey, f"{self.library.image_table_name}_overlays", item.thumb, poster_compare, overlay='|'.join(compare_names))
except Failed as e: except Failed as e:
logger.error(e) logger.error(f"{e}\nOverlays Attempted on {item_title}: {', '.join(over_names)}")
logger.exorcise() logger.exorcise()
overlay_run_time = str(datetime.now() - overlay_start).split('.')[0] overlay_run_time = str(datetime.now() - overlay_start).split('.')[0]
logger.info("") logger.info("")

Write Preview
Loading…
Cancel
Save