@ -38,14 +38,25 @@ Note that the `template_variables:` section only needs to be used if you do want
This file contains only a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available.
This file contains only a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available.
### Example Template Variable Amendments
The below is an example config.yml extract with some Template Variables added in to change how the file works.
The below is an example config.yml extract with some Template Variables added in to change how the file works.
???+ tip
Anywhere you see this icon:
> :fontawesome-solid-circle-plus:
That's a tooltip, you can press them to get more information.
```yaml
```yaml
libraries:
libraries:
Movies:
Movies:
metadata_path:
metadata_path:
- pmm: separator_chart
- pmm: separator_chart
template_variables:
template_variables:
use_separator: false
sep_style: purple #(1)!
sep_style: purple
```
```
1. Use the purple [Separator Style](../separators.md#separator-styles)
@ -61,23 +61,37 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
### Example Template Variable Amendments
The below is an example config.yml extract with some Template Variables added in to change how the file works.
The below is an example config.yml extract with some Template Variables added in to change how the file works.
???+ tip
Anywhere you see this icon:
> :fontawesome-solid-circle-plus:
That's a tooltip, you can press them to get more information.
```yaml
```yaml
libraries:
libraries:
Movies:
Movies:
metadata_path:
metadata_path:
- pmm: content_rating_us
- pmm: content_rating_us
template_variables:
template_variables:
use_other: false
sep_style: blue #(1)!
use_separator: false
use_other: false #(2)!
sep_style: blue
append_addons:
append_addons:
R:
R: #(3)!
- "de/18"
- "de/18" #(4)!
sort_by: title.asc
sort_by: title.asc
```
```
1. Use the blue [Separator Style](../separators.md#separator-styles)
2. Do not create a "Not Rated Movies" collection
3. Defines a collection which will be called "R", this does not need to already exist in your library
4. Adds the "de/18" content rating to the "R" addon list, "de/18" must exist in your library if the "R" content rating does not
## Default values
## Default values
These are lists provided for reference to show what values will be in use if you do no customization. If you want to customize these values, use the methods described above. These do not show how to change a name or a list.
These are lists provided for reference to show what values will be in use if you do no customization. If you want to customize these values, use the methods described above. These do not show how to change a name or a list.
@ -64,23 +64,37 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
### Example Template Variable Amendments
The below is an example config.yml extract with some Template Variables added in to change how the file works.
The below is an example config.yml extract with some Template Variables added in to change how the file works.
???+ tip
Anywhere you see this icon:
> :fontawesome-solid-circle-plus:
That's a tooltip, you can press them to get more information.
```yaml
```yaml
libraries:
libraries:
Movies:
Movies:
metadata_path:
metadata_path:
- pmm: continent
- pmm: continent
template_variables:
template_variables:
use_other: false
use_other: false #(1)!
use_separator: false
use_separator: false #(2)!
style: color
style: color #(3)!
sep_style: purple
exclude:
exclude:
- Europe
- Europe #(4)!
sort_by: title.asc
sort_by: title.asc
```
```
1. Do not create the "Other Continents" collection
2. Do not create a "Continent Collections" separator
3. Set the [Color Style](#color-style)
4. Exclude "Europe" from the list of collections that are created
## Default values
## Default values
The following yml is provided for reference to show what values will be in use if you do no customization. If you want to customize these values, use the methods described above. These do not show how to change a name or a list.
The following yml is provided for reference to show what values will be in use if you do no customization. If you want to customize these values, use the methods described above. These do not show how to change a name or a list.
@ -64,23 +64,37 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
### Example Template Variable Amendments
The below is an example config.yml extract with some Template Variables added in to change how the file works.
The below is an example config.yml extract with some Template Variables added in to change how the file works.
???+ tip
Anywhere you see this icon:
> :fontawesome-solid-circle-plus:
That's a tooltip, you can press them to get more information.
```yaml
```yaml
libraries:
libraries:
Movies:
Movies:
metadata_path:
metadata_path:
- pmm: country
- pmm: country
template_variables:
template_variables:
use_other: false
use_other: false #(1)!
use_separator: false
use_separator: false #(2)!
style: color
style: color #(3)!
sep_style: purple
exclude:
exclude:
- France
- France #(4)!
sort_by: title.asc
sort_by: title.asc
```
```
1. Do not create the "Other Countries" collection
2. Do not create a "Country Collections" separator
3. Set the [Color Style](#color-style)
4. Exclude "France" from the list of collections that are created
## Default values
## Default values
These are lists provided for reference to show what values will be in use if you do no customization. If you want to customize these values, use the methods described above. These do not show how to change a name or a list.
These are lists provided for reference to show what values will be in use if you do no customization. If you want to customize these values, use the methods described above. These do not show how to change a name or a list.
@ -69,20 +69,33 @@ Note that the `template_variables:` section only needs to be used if you do want
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
### Example Template Variable Amendments
The below is an example config.yml extract with some Template Variables added in to change how the file works.
The below is an example config.yml extract with some Template Variables added in to change how the file works.
???+ tip
Anywhere you see this icon:
> :fontawesome-solid-circle-plus:
That's a tooltip, you can press them to get more information.
```yaml
```yaml
libraries:
libraries:
Movies:
Movies:
metadata_path:
metadata_path:
- pmm: franchise
- pmm: franchise
template_variables:
template_variables:
collection_order: alpha
build_collection: false #(1)!
collection_section: "02"
movie_105995: 336560 #(2)!
build_collection: false
radarr_add_missing: true #(3)!
movie_105995: 336560
radarr_add_missing: true
```
```
1. Do not create any physical collections in Plex (normally used when you want to perform an "operation" instead, see the third tooltip for the example)
2. Add [TMDb Movie 336560](https://www.themoviedb.org/movie/336560-lake-placid-vs-anaconda) to [TMDb Collection 105995](https://www.themoviedb.org/collection/105995-anaconda-collection)
3. Add items missing from your library in Plex to Radarr. When used in this particular file, hundreds if not thousands of items may be sent to Radarr - proceed with caution!
## Default values
## Default values
These are lists provided for reference to show what values will be in use if you do no customization. If you want to customize these values, use the methods described above. These do not show how to change a name or a list.
These are lists provided for reference to show what values will be in use if you do no customization. If you want to customize these values, use the methods described above. These do not show how to change a name or a list.
@ -64,23 +64,37 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
### Example Template Variable Amendments
The below is an example config.yml extract with some Template Variables added in to change how the file works.
The below is an example config.yml extract with some Template Variables added in to change how the file works.
???+ tip
Anywhere you see this icon:
> :fontawesome-solid-circle-plus:
That's a tooltip, you can press them to get more information.
```yaml
```yaml
libraries:
libraries:
Movies:
Movies:
metadata_path:
metadata_path:
- pmm: region
- pmm: region
template_variables:
template_variables:
use_other: false
use_other: false #(1)!
use_separator: false
use_separator: false #(2)!
style: color
style: color #(3)!
sep_style: purple
exclude:
exclude:
- French
- French #(4)!
sort_by: title.asc
sort_by: title.asc
```
```
1. Do not create the "Other Regions" collection
2. Do not create a "Region Collections" separator
3. Set the [Color Style](#color-style)
4. Exclude "French" from the list of collections that are created
## Default values
## Default values
The following yaml is provided for reference to show what values will be in use if you do no customization. If you want to customize these values, use the methods described above. These do not show how to change a name or a list.
The following yaml is provided for reference to show what values will be in use if you do no customization. If you want to customize these values, use the methods described above. These do not show how to change a name or a list.
1. Do not create the "Independence Day" collection
2. Set a custom schedule for the Thanksgiving Day collection
3. Sort the collections created by this file to random
4. Create a new Seasonal collection called "Veteran's Day", they key for this collection is `veteran`
5. Set a scheduled range for the "Veteran's Day" collection
6. Add an IMDb List to be used for the "Veteran's Day" collection
7. Add the 🪖 emoji to the "Veteran's Day" collection so that the title in Plex is "🪖 Veteran's Day Movies"
## Default values
## Default values
These are lists provided for reference to show what values will be in use if you do no customization. If you want to customize these values, use the methods described above. These do not show how to change a name or a list.
These are lists provided for reference to show what values will be in use if you do no customization. If you want to customize these values, use the methods described above. These do not show how to change a name or a list.
@ -59,23 +59,38 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
### Example Template Variable Amendments
The below is an example config.yml extract with some Template Variables added in to change how the file works.
The below is an example config.yml extract with some Template Variables added in to change how the file works.
???+ tip
Anywhere you see this icon:
> :fontawesome-solid-circle-plus:
That's a tooltip, you can press them to get more information.
```yaml
```yaml
libraries:
libraries:
TV Shows:
Movies:
metadata_path:
metadata_path:
- pmm: content_rating_us
- pmm: content_rating_us
template_variables:
template_variables:
use_other: false
sep_style: blue #(1)!
use_separator: false
use_other: false #(2)!
sep_style: blue
append_addons:
append_addons:
R:
R: #(3)!
- "de/18"
- "de/18" #(4)!
sort_by: title.asc
sort_by: title.asc
```
```
1. Use the blue [Separator Style](../separators.md#separator-styles)
2. Do not create a "Not Rated Movies" collection
3. Defines a collection which will be called "R", this does not need to already exist in your library
4. Adds the "de/18" content rating to the "R" addon list, "de/18" must exist in your library if the "R" content rating does not
## Default values
## Default values
These are lists provided for reference to show what values will be in use if you do no customization. If you want to customize these values, use the methods described above. These do not show how to change a name or a list.
These are lists provided for reference to show what values will be in use if you do no customization. If you want to customize these values, use the methods described above. These do not show how to change a name or a list.
@ -67,23 +67,37 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
### Example Template Variable Amendments
The below is an example config.yml extract with some Template Variables added in to change how the file works.
The below is an example config.yml extract with some Template Variables added in to change how the file works.
???+ tip
Anywhere you see this icon:
> :fontawesome-solid-circle-plus:
That's a tooltip, you can press them to get more information.
```yaml
```yaml
libraries:
libraries:
TV Shows:
Movies:
metadata_path:
metadata_path:
- pmm: continent
- pmm: continent
template_variables:
template_variables:
use_other: false
use_other: false #(1)!
use_separator: false
use_separator: false #(2)!
style: color
style: color #(3)!
sep_style: purple
exclude:
exclude:
- nz
- Europe #(4)!
sort_by: title.asc
sort_by: title.asc
```
```
1. Do not create the "Other Continents" collection
2. Do not create a "Continent Collections" separator
3. Set the [Color Style](#color-style)
4. Exclude "Europe" from the list of collections that are created
## Default values
## Default values
These are lists provided for reference to show what values will be in use if you do no customization. If you want to customize these values, use the methods described above. These do not show how to change a name or a list.
These are lists provided for reference to show what values will be in use if you do no customization. If you want to customize these values, use the methods described above. These do not show how to change a name or a list.
@ -67,23 +67,37 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
### Example Template Variable Amendments
The below is an example config.yml extract with some Template Variables added in to change how the file works.
The below is an example config.yml extract with some Template Variables added in to change how the file works.
???+ tip
Anywhere you see this icon:
> :fontawesome-solid-circle-plus:
That's a tooltip, you can press them to get more information.
```yaml
```yaml
libraries:
libraries:
TV Shows:
Movies:
metadata_path:
metadata_path:
- pmm: country
- pmm: country
template_variables:
template_variables:
use_other: false
use_other: false #(1)!
use_separator: false
use_separator: false #(2)!
style: color
style: color #(3)!
sep_style: purple
exclude:
exclude:
- fr
- France #(4)!
sort_by: title.asc
sort_by: title.asc
```
```
1. Do not create the "Other Countries" collection
2. Do not create a "Country Collections" separator
3. Set the [Color Style](#color-style)
4. Exclude "France" from the list of collections that are created
## Default values
## Default values
These are lists provided for reference to show what values will be in use if you do no customization. If you want to customize these values, use the methods described above. These do not show how to change a name or a list.
These are lists provided for reference to show what values will be in use if you do no customization. If you want to customize these values, use the methods described above. These do not show how to change a name or a list.
@ -69,8 +69,18 @@ Note that the `template_variables:` section only needs to be used if you do want
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
### Example Template Variable Amendments
The below is an example config.yml extract with some Template Variables added in to change how the file works.
The below is an example config.yml extract with some Template Variables added in to change how the file works.
???+ tip
Anywhere you see this icon:
> :fontawesome-solid-circle-plus:
That's a tooltip, you can press them to get more information.
```yaml
```yaml
libraries:
libraries:
TV Shows:
TV Shows:
@ -78,12 +88,16 @@ libraries:
- pmm: franchise
- pmm: franchise
template_variables:
template_variables:
append_data:
append_data:
"31917": Pretty Little Liars
"31917": Pretty Little Liars #(1)!
append_addons:
append_addons:
31917: [46958, 79863, 110531] # Pretty Little Liars: Ravenswood, The Perfectionists, Original Sin
31917: [46958, 79863, 110531] #(2)!
sonarr_add_missing: true
sonarr_add_missing: true #(3)!
```
```
1. Add [TMDB Show 31917](https://www.themoviedb.org/tv/31917-pretty-little-liars) to the data dictionary
2. Add [TMDb Shows 46958](https://www.themoviedb.org/tv/46958), [79863](https://www.themoviedb.org/tv/79863) and [110531](https://www.themoviedb.org/tv/110531) as addons of [TMDB Show 31917](https://www.themoviedb.org/tv/31917-pretty-little-liars) so that they appear in the same collection
3. Add items missing from your library in Plex to Sonarr
## Default values
## Default values
These are lists provided for reference to show what values will be in use if you do no customization. If you want to customize these values, use the methods described above. These do not show how to change a name or a list.
These are lists provided for reference to show what values will be in use if you do no customization. If you want to customize these values, use the methods described above. These do not show how to change a name or a list.
@ -54,21 +54,35 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
### Example Template Variable Amendments
The below is an example config.yml extract with some Template Variables added in to change how the file works.
The below is an example config.yml extract with some Template Variables added in to change how the file works.
???+ tip
Anywhere you see this icon:
> :fontawesome-solid-circle-plus:
That's a tooltip, you can press them to get more information.
```yaml
```yaml
libraries:
libraries:
TV Shows:
Movies:
metadata_path:
metadata_path:
- pmm: network
- pmm: network
template_variables:
template_variables:
use_separator: false
sep_style: stb
append_exclude:
append_exclude:
- BBC
- BBC #(1)!
sort_by: title.asc
sort_by: title.asc
collection_mode: show_items #(2)!
sep_style: gray #(3)!
```
```
1. exclude "BBC" from the list of items that should be included in the Collection list
2. Show these collections and their items within the "Library" tab
3. Use the gray [Separator Style](../separators.md#separator-styles)
## Default values
## Default values
These are lists provided for reference to show what values will be in use if you do no customization. If you want to customize these values, use the methods described above. These do not show how to change a name or a list.
These are lists provided for reference to show what values will be in use if you do no customization. If you want to customize these values, use the methods described above. These do not show how to change a name or a list.
| `Region Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. |
| `Region Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. |
| `<<Region>>`<br>**Example:** `de` | `<<2 digit ISO 3166-1 code>>`<br>**Example:** `de` | Collection of TV Shows that have this Region. |
| `<<Region>>`<br>**Example:** `German` | `<<2 digit ISO 3166-1 code>>`<br>**Example:** `German ` | Collection of TV Shows that have this Region. |
| `Other Regions` | `other` | Collection of TV Shows that are in other uncommon Regions. |
| `Other Regions` | `other` | Collection of TV Shows that are in other uncommon Regions. |
## Config
## Config
@ -67,23 +67,37 @@ This file contains a [Separator](../separators.md) so all [Shared Separator Vari
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
### Example Template Variable Amendments
The below is an example config.yml extract with some Template Variables added in to change how the file works.
The below is an example config.yml extract with some Template Variables added in to change how the file works.
???+ tip
Anywhere you see this icon:
> :fontawesome-solid-circle-plus:
That's a tooltip, you can press them to get more information.
```yaml
```yaml
libraries:
libraries:
TV Shows:
Movies:
metadata_path:
metadata_path:
- pmm: region
- pmm: region
template_variables:
template_variables:
use_other: false
use_other: false #(1)!
use_separator: false
use_separator: false #(2)!
style: color
style: color #(3)!
sep_style: purple
exclude:
exclude:
- fr
- fr #(4)!
sort_by: title.asc
sort_by: title.asc
```
```
1. Do not create the "Other Regions" collection
2. Do not create a "Region Collections" separator
3. Set the [Color Style](#color-style)
4. Exclude "French" from the list of collections that are created
## Default values
## Default values
These are lists provided for reference to show what values will be in use if you do no customization. If you want to customize these values, use the methods described above. These do not show how to change a name or a list.
These are lists provided for reference to show what values will be in use if you do no customization. If you want to customize these values, use the methods described above. These do not show how to change a name or a list.
YozoraXCII
1 year ago