Plex
/
Plex-Meta-Manager
mirror of https://github.com/meisnate12/Plex-Meta-Manager.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

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

Browse Source
pull/1104/head
meisnate12 2 years ago
parent 6b6020cd0e 842b5b2f5c
commit 73475402c9
45 changed files with 201 additions and 413 deletions
Show Stats Download Patch File Download Diff File

2
docs/defaults/award/bafta.md
Unescape View File

@ -40,7 +40,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `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><table class="clearTable"><tr><th>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-5</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> |
The below shows an example config.yml with all the template_variables set away from their defaults:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:

2
docs/defaults/award/cannes.md
Unescape View File

@ -40,7 +40,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `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><table class="clearTable"><tr><th>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-5</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> |
The below shows an example config.yml with all the template_variables set away from their defaults:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:

2
docs/defaults/award/choice.md
Unescape View File

@ -42,7 +42,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `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><table class="clearTable"><tr><th>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-5</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> |
The below shows an example config.yml with all the template_variables set away from their defaults:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:

2
docs/defaults/award/emmy.md
Unescape View File

@ -40,7 +40,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `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><table class="clearTable"><tr><th>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-5</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> |
The below shows an example config.yml with all the template_variables set away from their defaults:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:

2
docs/defaults/award/golden.md
Unescape View File

@ -41,7 +41,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `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><table class="clearTable"><tr><th>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-5</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> |
The below shows an example config.yml with all the template_variables set away from their defaults:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:

2
docs/defaults/award/oscars.md
Unescape View File

@ -38,7 +38,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `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><table class="clearTable"><tr><th>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-5</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> |
The below shows an example config.yml with all the template_variables set away from their defaults:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:

2
docs/defaults/award/spirit.md
Unescape View File

@ -39,7 +39,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `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><table class="clearTable"><tr><th>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-5</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> |
The below shows an example config.yml with all the template_variables set away from their defaults:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:

2
docs/defaults/award/sundance.md
Unescape View File

@ -40,7 +40,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `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><table class="clearTable"><tr><th>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-5</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> |
The below shows an example config.yml with all the template_variables set away from their defaults:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:

4
docs/defaults/both/actor.md
Unescape View File

@ -1,6 +1,6 @@
# Actor Default Metadata File
The `- pmm: actor` Metadata File is used to dynamically create collections based on the most popular actors/actresses in your library.
The `actor` Metadata File is used to dynamically create collections based on the most popular actors/actresses in your library.
Example Collections Created:
@ -34,7 +34,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `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>depth</code></td><td>Controls the depth within the casting credits to search for common actors</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 5</td></tr><tr><td><code>limit</code></td><td>Controls the maximum number of collections to create</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 25</td></tr></table> |
The below shows an example config.yml with all the template_variables set away from their defaults:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:

4
docs/defaults/both/audio_language.md
Unescape View File

@ -1,6 +1,6 @@
# Audio Language Default Metadata File
The `- pmm: audio_language` Metadata File is used to dynamically create collections based on the audio languages available in your library.
The `audio_language` Metadata File is used to dynamically create collections based on the audio languages available in your library.
Example Collections Created:
@ -30,7 +30,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `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:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:

4
docs/defaults/both/content_rating_cs.md
Unescape View File

@ -1,6 +1,6 @@
# Common Sense Media Content Rating Default Metadata File
The `- pmm: content_rating_cs` Metadata File is used to dynamically create collections based on the content ratings available in your library.
The `content_rating_cs` 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)
@ -34,7 +34,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `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:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:

4
docs/defaults/both/content_rating_uk.md
Unescape View File

@ -1,6 +1,6 @@
# 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.
The `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)
@ -34,7 +34,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `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:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:

4
docs/defaults/both/genre.md
Unescape View File

@ -1,6 +1,6 @@
# Genre Default Metadata File
The `- pmm: genre` Metadata File is used to dynamically create collections based on the genres available in your library.
The `genre` Metadata File is used to dynamically create collections based on the genres available in your library.
This file also merges similarly named genres (such as "Sci-Fi", "SciFi" and "Sci-Fi & Fantasy") into one ("Science Fiction")
@ -34,7 +34,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `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:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:

4
docs/defaults/both/resolution.md
Unescape View File

@ -1,6 +1,6 @@
# Resolution Default Metadata File
The `- pmm: resolution` Metadata File is used to dynamically create collections based on the resolutions available in your library.
The `resolution` Metadata File is used to dynamically create collections based on the resolutions available in your library.
To avoid duplication, this file should not be used in combination with `- pmm: resolution_standards`
@ -34,7 +34,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `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:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:

4
docs/defaults/both/resolution_standards.md
Unescape View File

@ -1,6 +1,6 @@
# 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.
The `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")
@ -36,7 +36,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `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:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:

4
docs/defaults/both/streaming.md
Unescape View File

@ -1,6 +1,6 @@
# Streaming Default Metadata File
The `- pmm: streaming` Metadata File is used to dynamically create collections based on the streaming Services that your media is available on.
The `streaming` Metadata File is used to dynamically create collections based on the streaming Services that your media is available on.
Example Collections Created:
@ -40,7 +40,7 @@ All [Shared Variables](../variables) are available using the below keys.
| paramount | Paramount+ |
| peacock | Peacock |
The below shows an example config.yml with all the template_variables set away from their defaults:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:

4
docs/defaults/both/studio.md
Unescape View File

@ -1,6 +1,6 @@
# Studio Default Metadata File
The `- pmm: studio` Metadata File is used to dynamically create collections based on the studios available in your library.
The `studio` Metadata File is used to dynamically create collections based on the studios available in your library.
This file also merges similarly named studios (such as "20th Century Fox" and "20th Century Animation") into one ("20th Century Studios")
@ -34,7 +34,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `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:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:

4
docs/defaults/both/subtitle_language.md
Unescape View File

@ -1,6 +1,6 @@
# Subtitle Language Default Metadata File
The `- pmm: subtitle_language` Metadata File is used to dynamically create collections based on the subtitle languages available in your library.
The `subtitle_language` Metadata File is used to dynamically create collections based on the subtitle languages available in your library.
Example Collections Created:
@ -30,7 +30,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `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:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:

4
docs/defaults/both/year.md
Unescape View File

@ -1,6 +1,6 @@
# Year Language Default Metadata File
The `- pmm: year` Metadata File is used to dynamically create collections based on the years available in your library, sorted by critic rating to create a "best of <year>"
The `year` Metadata File is used to dynamically create collections based on the years available in your library, sorted by critic rating to create a "best of <year>"
Example Collections Created:
@ -28,7 +28,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
| `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> |
The below shows an example config.yml with all the template_variables set away from their defaults:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:

6
docs/defaults/chart/anilist.md
Unescape View File

@ -1,6 +1,6 @@
# Anilist Chart Default Metadata File
The `- pmm: anilist` Metadata File is used to create collections based on Anilist charts
The `anilist` Metadata File is used to create collections based on Anilist charts
Example Collections Created:
@ -42,7 +42,7 @@ Below are the available variables which can be used to customize the file. Note
| order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_popular` to put popular first in the list of anilist charts) |
| summary_key | Determines summary of collection | | Any summary text |
| limit_key | Determines limit of collection | `100` | Any number |
| collection_order_key | Determines collection order of the collection | | |
| collection_order | 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` |
@ -57,7 +57,7 @@ Below are the available variables which can be used to customize the file. Note
| collection_section | Controls the sort order of these collections against other default collections | `01` | 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 |
The below shows an example config.yml with all the template_variables set away from their defaults:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:

6
docs/defaults/chart/basic.md
Unescape View File

@ -1,6 +1,6 @@
# Basic Chart Default Metadata File
The `- pmm: basic` Metadata File is used to create collections based on recently released media in your library.
The `basic` Metadata File is used to create collections based on recently released media in your library.
Example Collections Created:
@ -40,7 +40,7 @@ Below are the available variables which can be used to customize the file. Note
| order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_released` to put released first in the list of charts) |
| summary_key | Determines summary of collection | | Any summary text |
| limit_key | Determines limit of collection | `100` | Any number |
| collection_order_key | Determines collection order of the collection | | |
| collection_order | 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` |
@ -49,7 +49,7 @@ Below are the available variables which can be used to customize the file. Note
| collection_section | Controls the sort order of these collections against other default collections | `01` | 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 |
The below shows an example config.yml with all the template_variables set away from their defaults:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:

6
docs/defaults/chart/imdb.md
Unescape View File

@ -1,6 +1,6 @@
# IMDb Chart Default Metadata File
The `- pmm: imdb` Metadata File is used to create collections based on IMDb Charts.
The `imdb` Metadata File is used to create collections based on IMDb Charts.
Example Collections Created:
@ -41,7 +41,7 @@ Below are the available variables which can be used to customize the file. Note
| order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_popular` to put popular first in the list of imdb charts) |
| summary_key | Determines summary of collection | | Any summary text |
| limit_key | Determines limit of collection | `100` | Any number |
| collection_order_key | Determines collection order of the collection | | |
| collection_order | 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` |
@ -56,7 +56,7 @@ Below are the available variables which can be used to customize the file. Note
| collection_section | Controls the sort order of these collections against other default collections | `01` | 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 |
The below shows an example config.yml with all the template_variables set away from their defaults:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:

6
docs/defaults/chart/myanimelist.md
Unescape View File

@ -1,6 +1,6 @@
# MyAnimeList Chart Default Metadata File
The `- pmm: myanimelist` Metadata File is used to create collections based on MyAnimeList Charts.
The `myanimelist` Metadata File is used to create collections based on MyAnimeList Charts.
Example Collections Created:
@ -43,7 +43,7 @@ Below are the available variables which can be used to customize the file. Note
| order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_popular` to put popular first in the list of myanimelist charts) |
| summary_key | Determines summary of collection | | Any summary text |
| limit_key | Determines limit of collection | `100` | Any number |
| collection_order_key | Determines collection order of the collection | | |
| collection_order | 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` |
@ -58,7 +58,7 @@ Below are the available variables which can be used to customize the file. Note
| collection_section | Controls the sort order of these collections against other default collections | `01` | 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 |
The below shows an example config.yml with all the template_variables set away from their defaults:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:

6
docs/defaults/chart/other.md
Unescape View File

@ -1,6 +1,6 @@
# Other Chart Default Metadata File
The `- pmm: other_chart` Metadata File is used to create collections based on other Charts.
The `other_chart` Metadata File is used to create collections based on other Charts.
Example Collections Created:
@ -38,7 +38,7 @@ Below are the available variables which can be used to customize the file. Note
| 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_commonsense` to put commonsense first in the list of other charts) |
| summary_key | Determines summary of collection | | Any summary text |
| collection_order_key | Determines collection order of the collection | | |
| collection_order | 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` |
@ -53,7 +53,7 @@ Below are the available variables which can be used to customize the file. Note
| collection_section | Controls the sort order of these collections against other default collections | `01` | 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 |
The below shows an example config.yml with all the template_variables set away from their defaults:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:

6
docs/defaults/chart/tautulli.md
Unescape View File

@ -1,6 +1,6 @@
# Tautulli Chart Default Metadata File
The `- pmm: tautulli` Metadata File is used to create collections based on Tautulli/Plex Charts.
The `tautulli` Metadata File is used to create collections based on Tautulli/Plex Charts.
Example Collections Created:
@ -40,7 +40,7 @@ Below are the available variables which can be used to customize the file. Note
| limit_key | Determines limit of collection | `100` | Any number |
| list_days_key | Set list_days for the collection | `30` | Any number |
| list_size_key | Set list_size for the collection | `20` | Any number |
| collection_order_key | Determines collection order of the collection | | |
| collection_order | 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` |
@ -49,7 +49,7 @@ Below are the available variables which can be used to customize the file. Note
| collection_section | Controls the sort order of these collections against tautulli default collections | `01` | 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 |
The below shows an example config.yml with all the template_variables set away from their defaults:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:

6
docs/defaults/chart/tmdb.md
Unescape View File

@ -1,6 +1,6 @@
# TMDb Chart Default Metadata File
The `- pmm: tmdb` Metadata File is used to create collections based on TMDb Charts.
The `tmdb` Metadata File is used to create collections based on TMDb Charts.
Example Collections Created:
@ -43,7 +43,7 @@ Below are the available variables which can be used to customize the file. Note
| order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_popular` to put popular first in the list of tmdb charts) |
| summary_key | Determines summary of collection | | Any summary text |
| limit_key | Determines limit of collection | `100` | Any number |
| collection_order_key | Determines collection order of the collection | | |
| collection_order | 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` |
@ -58,7 +58,7 @@ Below are the available variables which can be used to customize the file. Note
| collection_section | Controls the sort order of these collections against other default collections | `01` | 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 |
The below shows an example config.yml with all the template_variables set away from their defaults:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:

6
docs/defaults/chart/trakt.md
Unescape View File

@ -1,6 +1,6 @@
# Trakt Chart Default Metadata File
The `- pmm: trakt` Metadata File is used to create collections based on Trakt Charts.
The `trakt` Metadata File is used to create collections based on Trakt Charts.
Example Collections Created:
@ -43,7 +43,7 @@ Below are the available variables which can be used to customize the file. Note
| order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_popular` to put popular first in the list of trakt charts) |
| summary_key | Determines summary of collection | | Any summary text |
| limit_key | Determines limit of collection | `100` | Any number |
| collection_order_key | Determines collection order of the collection | | |
| collection_order | 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` |
@ -58,7 +58,7 @@ Below are the available variables which can be used to customize the file. Note
| collection_section | Controls the sort order of these collections against other default collections | `01` | 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 |
The below shows an example config.yml with all the template_variables set away from their defaults:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:

45
docs/defaults/movie/content_rating_us.md
Unescape View File

@ -1,6 +1,6 @@
# US Content Rating Default Metadata File
The `- pmm: content_rating_us` Metadata File is used to dynamically create collections based on the content ratings available in your library.
The `content_rating_us` Metadata File is used to dynamically create collections based on the content ratings available in your library.
If you do not use the US-based rating system within Plex, this file will attempt to match the international ratings (such as "gb/12A") to the respective US rating system (such as "PG-13")
@ -22,20 +22,19 @@ 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 |
|:-----------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `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 |
| 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 | `14` | 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 |
The below shows an example config.yml with all the template_variables set away from their defaults:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:
@ -43,6 +42,9 @@ libraries:
metadata_path:
- pmm: content_rating_us
template_variables:
addons:
R:
- "de/18"
sort_by: title.asc
collection_section: 25
collection_mode: show_items
@ -51,20 +53,3 @@ libraries:
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_us` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/content_rating_us.yml)
An example of this is; to map the "de/18" content rating to "R", the following template variable can be used:
```yaml
libraries:
Movies:
metadata_path:
- pmm: content_rating_us
template_variables:
addons:
R:
- "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)

47
docs/defaults/movie/country.md
Unescape View File

@ -1,6 +1,6 @@
# Country Default Metadata File
The `- pmm: country` Metadata File is used to dynamically create collections based on the countries available in your library.
The `country` Metadata File is used to dynamically create collections based on the countries available in your library.
Example Collections Created:
@ -23,21 +23,19 @@ 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 |
|:-----------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `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 |
| Variable | Usage | Default Value | Values |
|:-------------------|:-----------------------------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| style | Controls the visual theme of the collections created | `white` | `white` or `color` |
| 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 | 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:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:
@ -45,27 +43,12 @@ libraries:
metadata_path:
- pmm: country
template_variables:
exclude:
- fr
sort_by: title.asc
collection_section: 8
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 `country` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/country.yml)
An example of this is; to override the exclude list to only exclude Barbados from the collection list, the following template variable can be used:
```yaml
libraries:
Movies:
metadata_path:
- pmm: country
template_variables:
exclude:
- Barbados
```
Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs)
```

36
docs/defaults/movie/decade.md
Unescape View File

@ -1,6 +1,6 @@
# Decade Default Metadata File
The `- pmm: decade` Metadata File is used to dynamically create collections based on the decades available in your library, sorted by critic rating to create a "best of <decade>"
The `decade` Metadata File is used to dynamically create collections based on the decades available in your library, sorted by critic rating to create a "best of <decade>"
Example Collections Created:
@ -20,20 +20,14 @@ 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 |
|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
| Variable | Usage | Default Value | Values |
|:-------------------|:-----------------------------------------------------------------------------------------------------|------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| sort_by | Controls the sort method for the collections | `audience_rating.desc` | Any sort method in the [Sorts Options Table](#sort-options) |
| collection_section | Controls the sort order of these collections against other default collections | `12` | 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 | Sonarr Tag for existing items | | list of tag(s) to be applied to existing items |
The below is an example config.yml extract with some template_variables changed from their defaults.
The below shows an example config.yml with all the template_variables set away from their defaults:
```yaml
libraries:
@ -47,20 +41,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 `decade` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/decade.yml)
An example of this is; to change the collection titles to "Best Movies of <decade>, the following template variable can be used:
```yaml
libraries:
Movies:
metadata_path:
- pmm: decade
template_variables:
title_format: Best <<library_type>>s of <<key_name>>
```
Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs)
```

43
docs/defaults/movie/director.md
Unescape View File

@ -1,6 +1,6 @@
# Director Default Metadata File
The `- pmm: director` Metadata File is used to dynamically create collections based on the most popular directors in your library.
The `director` Metadata File is used to dynamically create collections based on the most popular directors in your library.
Example Collections Created:
@ -25,20 +25,17 @@ Template Variables can be used to manipulate the director file from the default
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 |
|:-------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| style | Controls the visual theme of the collections created | `bw` | `bw` - Black and white theme or<br/>`rainier` - Rainier theme |
| 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 | `17` | 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 |
| Variable | Description & Values |
|:--------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `style ` | **Description:** Controls the visual theme of the collections created<br>**Values:**`bw` - Black and white theme or</br>`rainier` - Rainier theme |
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
| `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>depth</code></td><td>Controls the depth within the casting credits to search for common actors</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 5</td></tr><tr><td><code>limit</code></td><td>Controls the maximum number of collections to create</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 25</td></tr></table> |
The below shows an example config.yml with all the template_variables set away from their defaults:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:
@ -46,27 +43,13 @@ libraries:
metadata_path:
- pmm: director
template_variables:
data:
depth: 10
limit: 20
style: rainier
sort_by: title.asc
collection_section: 12
collection_mode: show_items
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 `director` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/director.yml)
An example of this is; To amend the maximum amount of collections that are created (default is 25), the following template variable can be used:
```yaml
libraries:
Movies:
metadata_path:
- pmm: director
template_variables:
data:
limit: 25
```
Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs)
```

20
docs/defaults/movie/franchise.md
Unescape View File

@ -1,6 +1,6 @@
# Franchise Default Metadata File
The `- pmm: franchise` Metadata File is used to create collections based on popular Movie franchises, and can be used as a replacement to the TMDb Collections that Plex creates out-of-the-box.
The `franchise` Metadata File is used to create collections based on popular Movie franchises, and can be used as a replacement to the TMDb Collections that Plex creates out-of-the-box.
Unlike most Default Metadata Files, Franchise works by placing collections inline with the main library items if your library allows it. For example, the "Iron Man" franchise collection will appear next to the "Iron Man" movies within your library.
@ -22,21 +22,9 @@ 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
| Variable | Usage | Default Value | Values |
|:-------------------|:----------------------------------------------|---------------|:----------------------------------------------:|
| collection_order | Sets the collection order of the collection | `release` | `release`, `alpha` or `custom` |
| sort_title | Sets the sort title | | Desired sort title |
| minimum_items | Sets the minimum items of the collection | `2` | Any number |
| build_collection | Sets weather to actually build the collection | `true` | `true` or `false` |
| 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 existing items |
| item_radarr_tag | Radarr 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:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:
@ -48,7 +36,7 @@ libraries:
sort_title: "!10_<<collection_name>>"
build_collection: false
radarr_add_missing: true
radarr_folder: /mnt/local/Media/TV
radarr_folder: /mnt/local/Media/Movies
radarr_tag: <<collection_name>>
item_radarr_tag: <<collection_name>>
```

43
docs/defaults/movie/producer.md
Unescape View File

@ -1,6 +1,6 @@
# Producer Default Metadata File
The `- pmm: producer` Metadata File is used to dynamically create collections based on the most popular producers in your library.
The `producer` Metadata File is used to dynamically create collections based on the most popular producers in your library.
Example Collections Created:
@ -25,20 +25,17 @@ Template Variables can be used to manipulate the producer file from the default
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 |
|:-------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| style | Controls the visual theme of the collections created | `bw` | `bw` - Black and white theme or<br/>`rainier` - Rainier theme |
| 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 | `17` | 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 |
| Variable | Description & Values |
|:--------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `style ` | **Description:** Controls the visual theme of the collections created<br>**Values:**`bw` - Black and white theme or</br>`rainier` - Rainier theme |
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
| `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>depth</code></td><td>Controls the depth within the casting credits to search for common actors</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 5</td></tr><tr><td><code>limit</code></td><td>Controls the maximum number of collections to create</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 25</td></tr></table> |
The below shows an example config.yml with all the template_variables set away from their defaults:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:
@ -46,27 +43,13 @@ libraries:
metadata_path:
- pmm: producer
template_variables:
data:
depth: 10
limit: 20
style: rainier
sort_by: title.asc
collection_section: 12
collection_mode: show_items
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 `producer` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/producer.yml)
An example of this is; To amend the maximum amount of collections that are created (default is 25), the following template variable can be used:
```yaml
libraries:
Movies:
metadata_path:
- pmm: producer
template_variables:
data:
limit: 25
```
Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs)
```

18
docs/defaults/movie/universe.md
Unescape View File

@ -1,6 +1,6 @@
# Universe Default Metadata File
The `- pmm: universe` Metadata File is used to create collections based on popular Movie universes (such as the Marvel Cinematic Universe or Wizarding World)
The `universe` Metadata File is used to create collections based on popular Movie universes (such as the Marvel Cinematic Universe or Wizarding World)
This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html)
@ -22,20 +22,10 @@ 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
The below is an example config.yml extract with some template_variables changed from their defaults.
| Variable | Usage | Default Value | Values |
|:-------------------|:---------------------------------------------|---------------|:-------------------------------------------------------:|
| collection_order | Sets the collection order of the collection | `alpha` | `release`, `alpha` 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 |
| 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
libraries:
@ -45,7 +35,7 @@ libraries:
template_variables:
collection_order: release
radarr_add_missing: true
radarr_folder: /mnt/local/Media/TV
radarr_folder: /mnt/local/Media/Movies
radarr_tag: <<collection_name>>
item_radarr_tag: <<collection_name>>
use_separator: false

43
docs/defaults/movie/writer.md
Unescape View File

@ -1,6 +1,6 @@
# Writer Default Metadata File
The `- pmm: writer` Metadata File is used to dynamically create collections based on the most popular writers in your library.
The `writer` Metadata File is used to dynamically create collections based on the most popular writers in your library.
Example Collections Created:
@ -25,20 +25,17 @@ Template Variables can be used to manipulate the writer file from the default se
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 |
|:-------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| style | Controls the visual theme of the collections created | `bw` | `bw` - Black and white theme or<br/>`rainier` - Rainier theme |
| 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 | `17` | 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 |
| Variable | Description & Values |
|:--------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `style ` | **Description:** Controls the visual theme of the collections created<br>**Values:**`bw` - Black and white theme or</br>`rainier` - Rainier theme |
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
| `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>depth</code></td><td>Controls the depth within the casting credits to search for common actors</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 5</td></tr><tr><td><code>limit</code></td><td>Controls the maximum number of collections to create</br><strong>Values:</strong> Number greater than 0</td><td><strong>Default:</strong> 25</td></tr></table> |
The below shows an example config.yml with all the template_variables set away from their defaults:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:
@ -46,27 +43,13 @@ libraries:
metadata_path:
- pmm: writer
template_variables:
data:
depth: 10
limit: 20
style: rainier
sort_by: title.asc
collection_section: 12
collection_mode: show_items
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 `writer` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/writer.yml)
An example of this is; To amend the maximum amount of collections that are created (default is 25), the following template variable can be used:
```yaml
libraries:
Movies:
metadata_path:
- pmm: writer
template_variables:
data:
limit: 25
```
Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs)
```

2
docs/defaults/overlays/audio_codec.md
Unescape View File

@ -1,6 +1,6 @@
# Audio Codec Default Overlay File
The `- pmm: audio_codec` Overlay File is used to create an overlay based on the audio codec available on each item within your library.
The `audio_codec` Overlay File is used to create an overlay based on the audio codec available on each item within your library.
Example Overlays Created:

2
docs/defaults/overlays/audio_language.md
Unescape View File

@ -1,6 +1,6 @@
# Audio Language Default Overlay File
The `- pmm: audio_language` Overlay File is used to create an overlay based on the number of audio languages available on each item within your library.
The `audio_language` Overlay File is used to create an overlay based on the number of audio languages available on each item within your library.
Example Overlays Created:

2
docs/defaults/overlays/commonsense.md
Unescape View File

@ -1,6 +1,6 @@
# CommonSense Age Rating Default Overlay File
The `- pmm: commonsense` Overlay File is used to create an overlay based on the CommonSense Age Rating on each item within your library.
The `commonsense` Overlay File is used to create an overlay based on the CommonSense Age Rating on each item within your library.
Note that this file requires the `mass_content_rating: mdb_commonsense` operation to be set against your library so that the content ratings are taken from CommonSense.

2
docs/defaults/overlays/direct_play.md
Unescape View File

@ -1,6 +1,6 @@
# Direct Play Default Overlay File
The `- pmm: direct_play` Overlay File is used to create an overlay to indicate items that cannot be transcoded and instead only support Direct Play (i.e. if you use Tautulli to kill 4K transcoding)
The `direct_play` Overlay File is used to create an overlay to indicate items that cannot be transcoded and instead only support Direct Play (i.e. if you use Tautulli to kill 4K transcoding)
Example Overlays Created:

2
docs/defaults/overlays/episode_info.md
Unescape View File

@ -1,6 +1,6 @@
# Episode Info Default Overlay File
The `- pmm: episode_info` Overlay File is used to create an overlay based on the episode numbering within a given series in your library.
The `episode_info` Overlay File is used to create an overlay based on the episode numbering within a given series in your library.
Note that this file should only be used against show libraries and is not expected to work against movie libraries.

52
docs/defaults/show/content_rating_us.md
Unescape View File

@ -1,6 +1,6 @@
# US Content Rating Default Metadata File
The `- pmm: show/content_rating_us` Metadata File is used to dynamically create collections based on the content ratings available in your library.
The `show/content_rating_us` Metadata File is used to dynamically create collections based on the content ratings available in your library.
If you do not use the US-based rating system within Plex, this file will attempt to match the international ratings (such as "gb/12A") to the respective US rating system (such as "TV-14")
@ -22,51 +22,33 @@ 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 |
|:-----------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `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 |
| 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 | `14` | 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:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:
Movies:
metadata_path:
- pmm: show/content_rating_us
- pmm: content_rating_us
template_variables:
addons:
R:
- "de/18"
sort_by: title.asc
collection_section: 25
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_us` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/show/content_rating_us.yml)
An example of this is; to map the "de/18" content rating to "TV-MA", the following template variable can be used:
```yaml
libraries:
Movies:
metadata_path:
- pmm: show/content_rating_us
template_variables:
addons:
TV-MA:
- "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)
```

49
docs/defaults/show/country.md
Unescape View File

@ -1,6 +1,6 @@
# Country Default Metadata File
The `- pmm: show/country` Metadata File is used to dynamically create collections based on the countries available in your library.
The `show/country` Metadata File is used to dynamically create collections based on the countries available in your library.
Example Collections Created:
@ -23,49 +23,32 @@ 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 |
|:-----------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `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 |
| Variable | Usage | Default Value | Values |
|:-------------------|:-----------------------------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| style | Controls the visual theme of the collections created | `white` | `white` or `color` |
| 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_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:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:
Movies:
metadata_path:
- pmm: show/country
- pmm: country
template_variables:
exclude:
- fr
sort_by: title.asc
collection_section: 8
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 `country` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/show/country.yml)
An example of this is; to include Barbados in the collection list, the following template variable can be used:
```yaml
libraries:
Movies:
metadata_path:
- pmm: show/country
template_variables:
include:
- bb
```
Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs)
```

37
docs/defaults/show/decade.md
Unescape View File

@ -1,6 +1,6 @@
# Decade Default Metadata File
The `- pmm: show/decade` Metadata File is used to dynamically create collections based on the decades available in your library, sorted by critic rating to create a "best of <decade>"
The `show/decade` Metadata File is used to dynamically create collections based on the decades available in your library, sorted by critic rating to create a "best of <decade>"
Example Collections Created:
@ -20,20 +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 |
|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `sort_by` | **Description:** Controls the sort method for the collections<br>**Values:** Any sort method in the [Sorts Options Table](#sort-options) |
| Variable | Usage | Default Value | Values |
|:-------------------|:-----------------------------------------------------------------------------------------------------|------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| sort_by | Controls the sort method for the collections | `audience_rating.desc` | Any sort method in the [Sorts Options Table](#sort-options) |
| collection_section | Controls the sort order of these collections against other default collections | `12` | 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_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:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:
@ -47,20 +40,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 `decade` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/show/decade.yml)
An example of this is; to change the collection titles to "Best Movies of <decade>, the following template variable can be used:
```yaml
libraries:
Movies:
metadata_path:
- pmm: show/decade
template_variables:
title_format: Best <<library_type>>s of <<key_name>>
```
Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs)
```

18
docs/defaults/show/franchise.md
Unescape View File

@ -1,6 +1,6 @@
# Franchise Default Metadata File
The `- pmm: show/franchise` Metadata File is used to create collections based on popular TV franchises
The `show/franchise` Metadata File is used to create collections based on popular TV franchises
Unlike most Default Metadata Files, Franchise works by placing collections inline with the main library items if your library allows it. For example, the "Pretty Little Liars" franchise collection will appear next to the "Pretty Little Liars" show in your library so that you have easy access to the other shows in the franchise.
@ -22,21 +22,9 @@ 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
| Variable | Usage | Default Value | Values |
|:-------------------|:-------------------------------------------------------------------------------|---------------|:----------------------------------------------:|
| collection_order | Sets the collection order of the collection | `release` | `release`, `alpha` or `custom` |
| sort_title | Sets the sort title | | Desired sort title |
| minimum_items | Sets the minimum items of the collection | `2` | Any number |
| build_collection | Sets weather to actually build the collection | `true` | `true` or `false` |
| sonarr_add_missing | Adds missing from the collection to sonarr | `false` | `true` or `false` |
| sonarr_folder | Sonarr Folder to add to | | Folder to add missing items to |
| sonarr_tag | Sonarr Tag for added missing | | 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:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:

45
docs/defaults/show/network.md
Unescape View File

@ -1,6 +1,6 @@
# Network Default Metadata File
The `- pmm: show/network` Metadata File is used to dynamically create collections based on the networks available in your library.
The `show/network` Metadata File is used to dynamically create collections based on the networks available in your library.
Example Collections Created:
@ -20,20 +20,19 @@ 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 |
|:-----------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `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 |
| 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 | `04` | 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_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:
The below is an example config.yml extract with some template_variables changed from their defaults.
```yaml
libraries:
@ -41,26 +40,12 @@ libraries:
metadata_path:
- pmm: show/show/network
template_variables:
append_exclude:
- BBC
sort_by: title.asc
collection_section: 07
collection_mode: show_items
use_other: false
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 `network` collections can be found [here](https://github.com/meisnate12/Plex-Meta-Manager/blob/defaults/defaults/show/network.yml)
An example of this is; to rename the "BBC" netowrk to "BBC Worldwide", the following template variables can be used:
```yaml
libraries:
Movies:
metadata_path:
- pmm: show/show/network
template_variables:
name_mapping:
- BBC: BBC Worldwide
```
Further information on editing Dynamic Collections using template variables can be found [here](https://metamanager.wiki/en/latest/home/guides/defaults.html#customizing-configs)
```
Write Preview
Loading…
Cancel
Save