Mirrors/Plex-Meta-Manager
2
0
Fork 0
mirror of https://github.com/meisnate12/Plex-Meta-Manager synced 2024-09-20 14:31:59 +00:00
Code Issues Projects Releases Packages Wiki Activity

[95] Merge remote-tracking branch 'yozora/nightly' into nightly

Browse source
This commit is contained in:
meisnate12 2022-10-06 15:49:41 -04:00
commit b2b329d471
11 changed files with 106 additions and 332 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/defaults/both/actor.md
View file

@ -24,7 +24,7 @@ Template Variables can be used to manipulate the actor file from the default set
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 actor file.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |

3
docs/defaults/both/audio_language.md
View file

@ -20,8 +20,7 @@ Template Variables can be used to manipulate the file from the default settings
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.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|

46
docs/defaults/both/content_rating_cs.md
View file

@ -22,19 +22,17 @@ Template Variables can be used to manipulate the file from the default settings
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.
All [Shared Variables](../variables) are available as well as the additional Variables below 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_other | Controls whether an "Other" collection is created for any items not included in the initial criteria | `true` | `true` or `false` |
| 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 |
| Variable | Description & Values |
|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
| `include` | **Description:** Overrides the default include list<br>**Values:** Any Content Rating found in your library |
| `exclude` | **Description:** Overrides the default exclude list<br>**Values:** Any Content Rating found in your library |
| `addons` | **Description:** 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 Content Rating found in your library |
| `append_include` | **Description:** Appends to the existing include list<br>**Values:** Any Content Rating found in your library |
| `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any Content Rating found in your library |
| `append_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Content Rating found in your library |
The below shows an example config.yml with all the template_variables set away from their defaults:
@ -43,28 +41,14 @@ libraries:
Movies:
metadata_path:
- pmm: content_rating_cs
template_variables:
template_variables:
append_addons:
German 18: # this doesn't have to exist already
- de/18 # adds "de/18" to the existing "18" addon list
sort_by: title.asc
collection_section: 21
collection_mode: show_items
use_other: false
use_separator: false
sep_style: blue
```
Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `content_rating_cs` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/both/content_rating_cs.yml)
An example of this is; to map the "de/18" content rating to "18", the following template variable can be used:
```yaml
libraries:
Movies:
metadata_path:
- pmm: content_rating_cs
template_variables:
addons:
"18":
- "de/18"
```
Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs)
```

44
docs/defaults/both/content_rating_uk.md
View file

@ -22,19 +22,17 @@ Template Variables can be used to manipulate the file from the default settings
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.
All [Shared Variables](../variables) are available as well as the additional Variables below 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_other | Controls whether an "Other" collection is created for any items not included in the initial criteria | `true` | `true` or `false` |
| 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 |
| Variable | Description & Values |
|:-----------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
| `include` | **Description:** Overrides the default include list<br>**Values:** Any Content Rating found in your library |
| `exclude` | **Description:** Overrides the default exclude list<br>**Values:** Any Content Rating found in your library |
| `addons` | **Description:** 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 Content Rating found in your library |
| `append_include` | **Description:** Appends to the existing include list<br>**Values:** Any Content Rating found in your library |
| `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any Content Rating found in your library |
| `append_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Content Rating found in your library |
The below shows an example config.yml with all the template_variables set away from their defaults:
@ -44,27 +42,13 @@ libraries:
metadata_path:
- pmm: content_rating_uk
template_variables:
addons:
15:
- de/15 # adds "de/15" to the existing "15" addon list
sort_by: title.asc
collection_section: 21
collection_mode: show_items
use_other: false
use_separator: false
sep_style: blue
```
Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `content_rating_uk` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/both/content_rating_uk.yml)
An example of this is; to map the "de/18" content rating to "18", the following template variable can be used:
```yaml
libraries:
Movies:
metadata_path:
- pmm: content_rating_uk
template_variables:
addons:
"18":
- "de/18"
```
Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs)
```

100
docs/defaults/both/genre.md
View file

@ -22,18 +22,17 @@ Template Variables can be used to manipulate the file from the default settings
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.
All [Shared Variables](../variables) are available as well as the additional Variables below 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 |
| Variable | Description & Values |
|:-----------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
| `include` | **Description:** Overrides the default include list<br>**Values:** Any Genre found in your library |
| `exclude` | **Description:** Overrides the default exclude list<br>**Values:** Any Genre found in your library |
| `addons` | **Description:** 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 Genre found in your library |
| `append_include` | **Description:** Appends to the existing include list<br>**Values:** Any Genre found in your library |
| `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any Genre found in your library |
| `append_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Genre found in your library |
The below shows an example config.yml with all the template_variables set away from their defaults:
@ -43,80 +42,15 @@ libraries:
metadata_path:
- pmm: genre
template_variables:
exclude:
- Politics
- News
addons:
Horror:
- Thriller # Adds all thriller items to the Horror collection
sort_by: title.asc
collection_section: 5
collection_mode: show_items
use_separator: false
sep_style: red
```
# UK Content Rating Default Metadata File
The `- pmm: content_rating_uk` Metadata File is used to dynamically create collections based on the content ratings available in your library.
If you do not use the UK-based rating system within Plex, this file will attempt to match the standard ratings (such as PG-13) to the respective UK rating system (such as 12)
Example Collections Created:
![](../images/content_rating_uk.png)
The below YAML in your config.yml will create the collections:
```yaml
libraries:
Movies:
metadata_path:
- pmm: content_rating_uk
```
## 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_other | Controls whether an "Other" collection is created for any items not included in the initial criteria | `true` | `true` or `false` |
| 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 the template_variables set away from their defaults:
```yaml
libraries:
Movies:
metadata_path:
- pmm: content_rating_uk
template_variables:
sort_by: title.asc
collection_section: 21
collection_mode: show_items
use_other: false
use_separator: false
sep_style: blue
```
Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `genre` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/both/genre.yml)
An example of this is; to map the "Children" genre to "Family", the following template variable can be used:
```yaml
libraries:
Movies:
metadata_path:
- pmm: genre
template_variables:
addons:
Family:
- Children
```
Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs)
```

41
docs/defaults/both/resolution.md
View file

@ -22,18 +22,17 @@ Template Variables can be used to manipulate the file from the default settings
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.
All [Shared Variables](../variables) are available as well as the additional Variables below 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 |
| Variable | Description & Values |
|:-----------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
| `include` | **Description:** Overrides the default include list<br>**Values:** Any Resolution found in your library |
| `exclude` | **Description:** Overrides the default exclude list<br>**Values:** Any Resolution found in your library |
| `addons` | **Description:** 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_include` | **Description:** Appends to the existing include list<br>**Values:** Any Resolution found in your library |
| `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any Resolution found in your library |
| `append_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Resolution found in your library |
The below shows an example config.yml with all the template_variables set away from their defaults:
@ -43,25 +42,11 @@ libraries:
metadata_path:
- pmm: resolution
template_variables:
exclude:
- SD
sort_by: title.asc
collection_section: 15
collection_mode: show_items
use_separator: false
sep_style: green
```
Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `resolution` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/both/resolution.yml)
An example of this is; to map the "SD" resolution to "480", the following template variable can be used:
```yaml
libraries:
Movies:
metadata_path:
- pmm: resolution
template_variables:
addons:
"480":
- SD
```
Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs)
```

40
docs/defaults/both/resolution_standards.md
View file

@ -24,18 +24,17 @@ Template Variables can be used to manipulate the file from the default settings
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.
All [Shared Variables](../variables) are available as well as the additional Variables below 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 |
| Variable | Description & Values |
|:-----------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
| `include` | **Description:** Overrides the default include list<br>**Values:** Any Resolution found in your library |
| `exclude` | **Description:** Overrides the default exclude list<br>**Values:** Any Resolution found in your library |
| `addons` | **Description:** 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_include` | **Description:** Appends to the existing include list<br>**Values:** Any Resolution found in your library |
| `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any Resolution found in your library |
| `append_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Resolution found in your library |
The below shows an example config.yml with all the template_variables set away from their defaults:
@ -45,24 +44,11 @@ libraries:
metadata_path:
- pmm: resolution_standards
template_variables:
exclude:
- HD Ready
sort_by: title.asc
collection_section: 16
collection_mode: show_items
use_separator: false
sep_style: stb
```
Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `resolution_standards` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/both/resolution_standards.yml)
An example of this is; to map the collection title of the "4k" resolution to "4K Ultra HD", the following template variable can be used:
```yaml
libraries:
Movies:
metadata_path:
- pmm: resolution_standards
template_variables:
title_override:
4k: 4K Ultra HD
```
Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs)
```

46
docs/defaults/both/streaming.md
View file

@ -22,7 +22,7 @@ Note that the `templates_variables:` section only needs to be used if you do NOT
As this file is more complex than others, a key system is used to control each collection that is created by the file. Each key refers to one streaming service and is used to control multiple template variables.
Below are the keys and what they refer to:
All [Shared Variables](../variables) are available using the below keys.
| Key | streaming Service |
|:----------|:------------------|
@ -40,33 +40,6 @@ Below are the keys and what they refer to:
| paramount | Paramount+ |
| peacock | Peacock |
Below are the available variables which can be used to customize the file. Note that any use of `key` within the variable should be replaced with the `key` from the above table (i.e. `use_all4` instead of `use_key`, `order_disney` instead of `order_key`)
| Variable | Usage | Default Value | Values |
|:---------------------------|:-------------------------------------------------------------------------------|--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| use_key | Turn the collection on/off | `true` | `true` or `false` |
| order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_disney` to put Disney+ first in the list of streaming services) |
| collection_order_key | Determines collection order of the collection | | |
| visible_library_key | Set visible_library for the collection | `false` | `true` or `false` |
| visible_home_key | Set visible_home for the collection | `false` | `true` or `false` |
| visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` |
| sonarr_add_missing_key | Adds missing from the collection to sonarr | `false` | `true` or `false` |
| sonarr_folder_key | Sonarr Folder to add to | | Folder to add missing items to |
| sonarr_tag_key | Sonarr Tag for added missing | | Tag(s) to add to missing items |
| item_sonarr_tag_key | Sonarr Tag for existing items | `false` | Tag(s) to add to existing items |
| radarr_add_missing_key | Adds missing from the collection to radarr | | `true` or `false` |
| radarr_folder_key | Radarr Folder to add to | | Folder to add missing items to |
| radarr_tag_key | Radarr Tag for added missing | | Tag(s) to add to missing items |
| item_radarr_tag_key | Radarr Tag for existing items | | Tag(s) to add to existing items |
| 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` |
The below shows an example config.yml with all the template_variables set away from their defaults:
```yaml
@ -93,19 +66,4 @@ libraries:
collection_mode: show_items
use_separator: false
sep_style: stb
```
Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `streaming` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/both/streaming.yml)
An example of this is; to only run the Disney+ collection against the movie library, the following template variable can be used:
```yaml
libraries:
Movies:
metadata_path:
- pmm: streaming
template_variables:
use:
disney: movie
```
Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs)
```

42
docs/defaults/both/studio.md
View file

@ -22,18 +22,17 @@ Template Variables can be used to manipulate the file from the default settings
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.
All [Shared Variables](../variables) are available as well as the additional Variables below 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 | `07` | 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 |
| Variable | Description & Values |
|:-----------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
| `include` | **Description:** Overrides the default include list<br>**Values:** Any Studio found in your library |
| `exclude` | **Description:** Overrides the default exclude list<br>**Values:** Any Studio found in your library |
| `addons` | **Description:** 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 Studio found in your library |
| `append_include` | **Description:** Appends to the existing include list<br>**Values:** Any Studio found in your library |
| `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any Studio found in your library |
| `append_addons` | **Description:** Appends to the existing addons list<br>**Values:** Any Studio found in your library |
The below shows an example config.yml with all the template_variables set away from their defaults:
@ -43,26 +42,11 @@ libraries:
metadata_path:
- pmm: studio
template_variables:
append_include:
- Big Bull Productions
sort_by: title.asc
collection_section: 4
collection_mode: show_items
use_separator: false
sep_style: gray
```
Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `studio` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/both/studio.yml)
An example of this is; to map the "ABC News" studio to it, the following template variables can be used:
```yaml
libraries:
Movies:
metadata_path:
- pmm: studio
template_variables:
addons:
ABC Picture:
- ABC News
```
Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs)
```

40
docs/defaults/both/subtitle_language.md
View file

@ -20,19 +20,15 @@ Template Variables can be used to manipulate the file from the default settings
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.
All [Shared Variables](../variables) are available as well as the additional Variables below 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 | `11` | 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_other | Controls whether an "Other" collection is created for any items not included in the initial criteria | `true` | `true` or `false` |
| 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 |
| Variable | Description & Values |
|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
| `include` | **Description:** Overrides the default include list<br>**Values:** Any list of [two-digit ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
| `exclude` | **Description:** Overrides the default exclude list<br>**Values:** Any list of [two-digit ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
| `append_include` | **Description:** Appends to the existing include list<br>**Values:** Any list of [two-digit ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
| `append_exclude` | **Description:** Appends to the existing exclude list<br>**Values:** Any list of [two-digit ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) |
The below shows an example config.yml with all the template_variables set away from their defaults:
@ -42,26 +38,12 @@ libraries:
metadata_path:
- pmm: subtitle_language
template_variables:
exclude:
- fr # Exclude French
sort_by: title.asc
collection_section: 20
collection_mode: show_items
use_other: false
use_separator: false
sep_style: purple
```
Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `subtitle_language` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/both/subtitle_language.yml)
An example of this is; to exclude the English Subtitles collection, the following template variable can be used:
```yaml
libraries:
Movies:
metadata_path:
- pmm: subtitle_language
template_variables:
exclude:
-en
```
Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs)
```

34
docs/defaults/both/year.md
View file

@ -20,19 +20,13 @@ Template Variables can be used to manipulate the file from the default settings
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.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| 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> |
| `data` | **Description:** Changes the following values of the collection builder<br>**Values:**<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> current_year-10</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections</br><strong>Values:</strong> Number greater than 1</td><td><strong>Default:</strong> current_year</td></tr><tr><td><code>increment</code></td><td>Controls the incriment (i.e. every 5th year)</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 1</td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>current_year</code></strong></li><li><strong>You can also use a value relative to the <code>current_year</code> by doing <code>current_year-5</code></strong></li></ul> |
| 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 | `13` | 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_other | Controls whether an "Other" collection is created for any items not included in the initial criteria | `true` | `true` or `false` |
| 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 the template_variables set away from their defaults:
@ -48,20 +42,4 @@ libraries:
use_other: false
use_separator: false
sep_style: purple
```
Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the `year` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/both/year.yml)
An example of this is; to include the previous 20 years (default is 10), the following template variable can be used:
```yaml
libraries:
Movies:
metadata_path:
- pmm: year
template_variables:
data:
starting: current_year-20
```
Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs)
```