Plex-Meta-Manager/docs/defaults/both/resolution.md

79 lines
5 KiB
Markdown
Raw Normal View History

2022-10-10 07:10:05 +00:00
# Resolution Collections
2022-09-27 15:08:18 +00:00
2022-10-10 07:10:05 +00:00
The `resolution` Default Metadata File is used to dynamically create collections based on the resolutions available in your library.
2022-09-27 15:08:18 +00:00
2022-10-10 07:10:05 +00:00
To avoid duplication, this file should not be used in combination with [`resolution_standards`](resolution_standards).
2022-09-27 15:08:18 +00:00
2022-10-10 07:10:05 +00:00
**This file works with Movie and TV Libraries.**
2022-09-27 15:08:18 +00:00
![](../images/resolution.png)
2022-09-27 15:08:18 +00:00
2022-10-10 07:10:05 +00:00
## Collections Section 15
| Collection | Key | Description |
|:-------------------------------------------------------------|:-----------------------------------:|:-----------------------------------------------------------|
| `Resolution Collections` | `separator` | Separator Collection to denote the Section of Collections. |
| `<<Resolution>> Movies/Shows`<br>**Example:** `1080p Movies` | `<<Number>>`<br>**Example:** `1080` | Collection of Movies/Shows that have this Resolution. |
## Config
2022-09-27 22:01:34 +00:00
The below YAML in your config.yml will create the collections:
2022-10-10 07:10:05 +00:00
2022-09-27 15:08:18 +00:00
```yaml
libraries:
Movies:
metadata_path:
- pmm: resolution
2022-10-10 07:10:05 +00:00
TV Shows:
metadata_path:
- pmm: resolution
2022-09-27 15:08:18 +00:00
```
## Template Variables
2022-10-10 07:10:05 +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 its default value if it has one if not it's just ignored.
2022-09-27 15:08:18 +00:00
2022-10-06 19:01:28 +00:00
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
2022-10-10 07:10:05 +00:00
| Variable | Description & Values |
|:---------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_separator` | **Description:** Turn the separator collection off.<br>**Values:** `false` to turn of the collection |
| `sep_style` | **Description:** Separator Style.<br>**Default:** `orig`<br>**Values:** `orig`, red`, `blue`, `green`, `gray`, `purple`, or `stb` |
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
| `sort_by_<<key>>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
| `exclude` | **Description:** Exclude these Resolutions from creating a Dynamic Collection.<br>**Values:** List of Resolutions found in your library |
| `addons` | **Description:** Overrides the [default addons list](#default-addons). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex<br>**Values:** Any Resolution found in your library |
| `append_addons` | **Description:** Appends to the [default addons list](#default-addons).<br>**Values:** Any Resolution found in your library |
| `resolution_name` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it. |
| `resolution_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that have the resolution <<key_name>>.`<br>**Values:** Any string. |
2022-09-27 15:08:18 +00:00
2022-10-08 16:31:06 +00:00
The below is an example config.yml extract with some Template Variables added in to change how the file works.
2022-09-27 15:08:18 +00:00
```yaml
libraries:
Movies:
metadata_path:
- pmm: resolution
template_variables:
2022-10-10 07:10:05 +00:00
use_separator: false
sep_style: green
2022-10-06 19:01:28 +00:00
exclude:
- SD
2022-09-27 15:08:18 +00:00
sort_by: title.asc
2022-10-10 07:10:05 +00:00
```
## Default `addons`
```yaml
addons:
1080:
- 2k
480:
- 144
- 240
- 360
- sd
- 576
2022-10-06 19:01:28 +00:00
```