Plex-Meta-Manager/docs/defaults/resolution_standards.md
2022-09-27 18:01:34 -04:00

53 lines
3.8 KiB
Markdown

# Resolution Standards Default Metadata File
The `- pmm: resolution_standards` Metadata File is used to dynamically create collections based on the resolutions available in your library.
This file takes the base resolutions ("4K" and "720p") and turns them into the commonly-known standards name ("Ultra HD" and "HD Ready")
To avoid duplication, this file should not be used in combination with `- pmm: resolution`
Example Collections Created:
![](images/resolution_standards.png)
The below YAML in your config.yml will create the collections:
```yaml
libraries:
Movies:
metadata_path:
- pmm: resolution_standards
```
## 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 |
|:-------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| sort_by | Controls the sort method for the collections | `release.desc` | Any sort method in the [Sorts Options Table](#sort-options) |
| 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 |
| use_separator | Controls whether a separator is created | `true` | `true` or `false` |
| sep_style | Sets the theme of the separator | `orig` | `orig`, `blue`, `gray`, `green`, `purple`, `red`, `stb` |
| item_radarr_tag | Radarr Tag for existing items | | list of tag(s) to be applied to existing items |
| item_sonarr_tag | Sonarr Tag for existing items | | list of tag(s) to be applied to existing items |
The below shows an example config.yml with all of the template_variables set away from their defaults:
```yaml
libraries:
Movies:
metadata_path:
- pmm: resolution_standards
template_variables:
sort_by: title.asc
collection_section: 16
collection_mode: show_items
use_separator: false
sep_style: stb
```