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

56 lines
4.3 KiB
Markdown
Raw Normal View History

# Other Awards Default Metadata File
2022-10-06 18:58:57 +00:00
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)
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:
- pmm: other_award
```
2022-10-06 18:58:57 +00:00
## Collections
2022-10-07 12:45:31 +00:00
| Collection | Key | Description |
2022-10-06 18:58:57 +00:00
|:-----------------------------------|:-----------:|:--------------------------------------------------------------|
| `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. |
2022-10-07 12:45:31 +00:00
| `Razzies Golden Raspberry Winners` | `razzie` | Collection of Razzies Golden Raspberry Winners Award Winners. |
| `Venice Golden Lions` | `venice` | Collection of Venice Golden Lions Award Winners. |
2022-10-06 18:58:57 +00:00
### Examples
![](../images/awardother.png)
## Template Variables
Template Variables can be used to manipulate the file from the default settings which are provided.
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 12:45:31 +00:00
| Variable | Description & Values |
|:-----------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `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> |
The below shows an example config.yml with template_variables set away from their defaults:
```yaml
libraries:
Movies:
metadata_path:
- pmm: other_award
template_variables:
collection_section: 8
collection_mode: show_items
collection_order: alpha
radarr_add_missing: true
```