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

74 lines
13 KiB
Markdown
Raw Normal View History

2022-10-10 07:10:05 +00:00
# Golden Globes Awards Collections
2022-10-10 07:10:05 +00:00
The `golden` Default Metadata File is used to create collections based on the Golden Globe Awards.
2022-10-10 07:10:05 +00:00
![](../images/golden.png)
## Requirements & Recommendations
Supported Library Types: Movie, Show
Recommendations: The `Golden Globe Best Motion Pictures` Collection only works with Movie Libraries
2023-02-08 10:18:02 +00:00
## Collections Section 130
2022-10-10 07:10:05 +00:00
2022-11-16 14:30:04 +00:00
| Collection | Key | Description |
|:------------------------------------------------------------|:----------------------------------|:--------------------------------------------------------------|
2023-01-12 15:16:19 +00:00
| `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. |
2022-10-10 07:10:05 +00:00
| `Golden Globe <<year>>`<br>**Example:** `Golden Globe 2022` | `<<year>>`<br>**Example:** `2022` | Collection of Golden Globe Award Winners for the given year. |
## Config
The below YAML in your config.yml will create the collections:
2022-10-06 18:58:57 +00:00
```yaml
libraries:
Movies:
metadata_path:
2022-10-03 20:34:30 +00:00
- pmm: golden
2022-10-06 18:58:57 +00:00
TV Shows:
metadata_path:
- pmm: golden
```
## Template Variables
2022-10-07 20:56:11 +00:00
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.
2023-01-04 19:46:04 +00:00
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.
2022-11-08 03:02:07 +00:00
All [Shared Collection Variables](../collection_variables) are available as well as the additional Variables below which can be used to customize the file.
2022-10-17 12:13:48 +00:00
| Variable | Description & Values |
|:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
2022-10-18 20:54:28 +00:00
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
2022-12-09 16:30:18 +00:00
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
2022-10-17 12:13:48 +00:00
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../metadata/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `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](../../metadata/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
| `data` | **Description:** Replaces the `data` dynamic collection value.<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<hr><strong>Default:</strong> current_year-5<hr><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<hr><strong>Default:</strong> current_year<hr><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<hr><strong>Default:</strong> 1<hr><strong>Values:</strong> Number greater than 0</td><td></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> |
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Golden Globe <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Golden Globe Winners.`<br>**Values:** Any string with `<<key_name>>` in it. |
2022-10-17 12:13:48 +00:00
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
2022-10-06 18:58:57 +00:00
2022-10-08 16:31:06 +00:00
The below is an example config.yml extract with some Template Variables added in to change how the file works.
```yaml
libraries:
Movies:
metadata_path:
2022-10-03 20:34:30 +00:00
- pmm: golden
template_variables:
collection_mode: show_items
collection_order: alpha
radarr_add_missing: true
data:
starting: current_year-10
ending: current_year
```