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

59 lines
7.5 KiB
Markdown
Raw Normal View History

# Sundance Film Festival Awards Default Metadata File
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)
2022-10-06 18:58:57 +00:00
This file only works with Movie Libraries.
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: sundance
```
2022-10-06 18:58:57 +00:00
## 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
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.
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
2022-10-07 20:56:11 +00:00
| Variable | Description & Values |
|:---------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `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 for all collections in a Defaults file.<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_<<key>>` | **Description:** Changes the Collection Order of the specified key's Collection.<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><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> |
2022-10-07 20:56:11 +00:00
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:
Movies:
metadata_path:
2022-10-03 20:34:30 +00:00
- pmm: sundance
template_variables:
collection_section: 8
collection_mode: show_items
collection_order: alpha
radarr_add_missing: true
```