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

56 lines
4 KiB
Markdown
Raw Normal View History

2022-09-27 15:08:18 +00:00
# BAFTA Default Metadata File
The `- pmm: award/bafta` Metadata File is used to create collections based on the British Academy Film Awards.
2022-09-27 15:08:18 +00:00
This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html)
2022-09-27 15:08:18 +00:00
Example Collections Created:
2022-09-28 13:00:40 +00:00
![](../images/bafta.png)
2022-09-27 15:08:18 +00:00
2022-09-27 22:01:34 +00:00
The below YAML in your config.yml will create the collections:
2022-09-27 15:08:18 +00:00
```yaml
libraries:
Movies:
metadata_path:
- pmm: award/bafta
2022-09-27 15:08:18 +00:00
```
## 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 NOT want to use the default settings.
Below are the available variables which can be used to customize the file.
| Variable | Usage | Default Value | Values |
|:---------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| use_year_collections | Turn the individual year collections on/off | `true` | `true` or `false` |
| collection_section | Controls the sort order of these collections against other default collections | `10` | Any number |
| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default<br/>`hide` - Hide Collection<br/>`hide_items`- Hide Items in this Collection<br/>`show_items` - Show this Collection and its Items |
| collection_order | Sets the collection order of the collection | `custom` | `alpha`, `release` or `custom` |
| radarr_add_missing | Adds missing from the collection to Radarr | `false` | `true` or `false` |
| radarr_folder | Radarr Folder to add to | | Folder to add missing items to |
| radarr_tag | Radarr Tag for added missing | | list of tag(s) to be applied to missing items |
| item_radarr_tag | Radarr Tag for existing items | | list of tag(s) to be applied to existing items |
2022-09-27 15:08:18 +00:00
The below shows an example config.yml with all the template_variables set away from their defaults:
2022-09-27 15:08:18 +00:00
```yaml
libraries:
Movies:
metadata_path:
- pmm: award/bafta
2022-09-27 15:08:18 +00:00
template_variables:
collection_section: 8
2022-09-27 15:08:18 +00:00
collection_mode: show_items
collection_order: alpha
radarr_add_missing: true
radarr_folder: /mnt/local/Media/Movies
radarr_tag: <<collection_name>>
item_radarr_tag: <<collection_name>>
2022-09-27 15:08:18 +00:00
```