Plex-Meta-Manager/docs/defaults/award/bafta.md
2022-10-05 11:30:53 -04:00

54 lines
4.3 KiB
Markdown

# BAFTA Default Metadata File
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)
The below YAML in your config.yml will create the collections:
```yaml
libraries:
Movies:
metadata_path:
- pmm: bafta
```
## Collections
| Collection | Key | Description |
|:-------------------|:----------:|:------------------------------------------------------------------------|
| `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. |
## Example Collections
![](../images/bafta.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.
| 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<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 Collection Order<br>**Values:**<pre>data:<br>&nbsp;&nbsp;starting: current_year-5<br>&nbsp;&nbsp;ending: current_year</pre> |
The below shows an example config.yml with all the template_variables set away from their defaults:
```yaml
libraries:
Movies:
metadata_path:
- pmm: bafta
template_variables:
collection_section: 8
collection_mode: show_items
collection_order: alpha
radarr_add_missing: true
```