Mirrors/Plex-Meta-Manager
2
0
Fork 0
mirror of https://github.com/meisnate12/Plex-Meta-Manager synced 2024-11-22 12:33:10 +00:00
Code Issues Projects Releases Packages Wiki Activity

WIP adding tooltips to template variable examples highlighting what each template variable does.

Browse source
This commit is contained in:
YozoraXCII 2023-11-18 11:01:16 +00:00
parent c0c1c03406
commit b4b8af3e7b
29 changed files with 571 additions and 152 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
docs/defaults/award/bafta.md
View file

@ -51,18 +51,38 @@ All [Shared Collection Variables](../collection_variables.md) are available as w
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: bafta - pmm: bafta
template_variables: template_variables:
collection_mode: show_items collection_mode: show_items #(1)!
collection_order: alpha collection_order: alpha #(2)!
radarr_add_missing: true radarr_add_missing: true #(3)!
name_format: BAFTA <<key_name>> Winners #(4)!
data: data:
starting: current_year-10 starting: current_year-10 #(5)!
ending: current_year increment: 2 #(6)!
ending: current_year #(7)!
``` ```
1. Shows the collection and all of its items within the Library tab in Plex
2. Sorts the collection items alphabetically
3. Adds items from the source list which are not in Plex to Radarr
4. Change the name of the collections to "BAFTA yearhere Winners"
5. If today is 2024, then create collections for BAFTA 2014 onwards
6. If starting year is 2014, then create collections for 2014, 2016, 2018, 2020, etc.
7. If today is 2024, then the final collection is BAFTA 2024

30
docs/defaults/award/cannes.md
View file

@ -51,18 +51,38 @@ All [Shared Collection Variables](../collection_variables.md) are available as w
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: cannes - pmm: cannes
template_variables: template_variables:
collection_mode: show_items collection_mode: show_items #(1)!
collection_order: alpha collection_order: alpha #(2)!
radarr_add_missing: true radarr_add_missing: true #(3)!
name_format: Cannes <<key_name>> Winners #(4)!
data: data:
starting: current_year-10 starting: current_year-10 #(5)!
ending: current_year increment: 2 #(6)!
ending: current_year #(7)!
``` ```
1. Shows the collection and all of its items within the Library tab in Plex
2. Sorts the collection items alphabetically
3. Adds items from the source list which are not in Plex to Radarr
4. Change the name of the collections to "Cannes yearhere Winners"
5. If today is 2024, then create collections for Cannes 2014 onwards
6. If starting year is 2014, then create collections for 2014, 2016, 2018, 2020, etc.
7. If today is 2024, then the final collection is Cannes 2024

29
docs/defaults/award/choice.md
View file

@ -53,20 +53,39 @@ All [Shared Collection Variables](../collection_variables.md) are available as w
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: choice - pmm: choice
template_variables: template_variables:
collection_mode: show_items collection_mode: show_items #(1)!
collection_order: alpha collection_order: alpha #(2)!
radarr_add_missing: true radarr_add_missing: true #(3)!
name_format: Critics Choice Awards <<key_name>> Winners #(4)!
data: data:
starting: current_year-10 starting: current_year-10 #(5)!
ending: current_year increment: 2 #(6)!
ending: current_year #(7)!
``` ```
1. Shows the collection and all of its items within the Library tab in Plex
2. Sorts the collection items alphabetically
3. Adds items from the source list which are not in Plex to Radarr
4. Change the name of the collections to "Critics Choice Awards yearhere Winners"
5. If today is 2024, then create collections for Critics Choice Awards 2014 onwards
6. If starting year is 2014, then create collections for 2014, 2016, 2018, 2020, etc.
7. If today is 2024, then the final collection is Critics Choice Awards 2024

30
docs/defaults/award/emmy.md
View file

@ -51,20 +51,38 @@ All [Shared Collection Variables](../collection_variables.md) are available as w
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: emmy - pmm: emmy
template_variables: template_variables:
collection_mode: show_items collection_mode: show_items #(1)!
collection_order: alpha collection_order: alpha #(2)!
radarr_add_missing: true radarr_add_missing: true #(3)!
name_format: Emmys <<key_name>> Winners #(4)!
data: data:
starting: current_year-10 starting: current_year-10 #(5)!
ending: current_year increment: 2 #(6)!
ending: current_year #(7)!
``` ```
1. Shows the collection and all of its items within the Library tab in Plex
2. Sorts the collection items alphabetically
3. Adds items from the source list which are not in Plex to Radarr
4. Change the name of the collections to "Emmys yearhere Winners"
5. If today is 2024, then create collections for Emmys 2014 onwards
6. If starting year is 2014, then create collections for 2014, 2016, 2018, 2020, etc.
7. If today is 2024, then the final collection is Emmys 2024

30
docs/defaults/award/golden.md
View file

@ -55,20 +55,38 @@ All [Shared Collection Variables](../collection_variables.md) are available as w
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: golden - pmm: golden
template_variables: template_variables:
collection_mode: show_items collection_mode: show_items #(1)!
collection_order: alpha collection_order: alpha #(2)!
radarr_add_missing: true radarr_add_missing: true #(3)!
name_format: Emmys <<key_name>> Winners #(4)!
data: data:
starting: current_year-10 starting: current_year-10 #(5)!
ending: current_year increment: 2 #(6)!
ending: current_year #(7)!
``` ```
1. Shows the collection and all of its items within the Library tab in Plex
2. Sorts the collection items alphabetically
3. Adds items from the source list which are not in Plex to Radarr
4. Change the name of the collections to "Golden Globes yearhere Winners"
5. If today is 2024, then create collections for Golden Globes 2014 onwards
6. If starting year is 2014, then create collections for 2014, 2016, 2018, 2020, etc.
7. If today is 2024, then the final collection is Golden Globes 2024

30
docs/defaults/award/oscars.md
View file

@ -50,20 +50,38 @@ All [Shared Collection Variables](../collection_variables.md) are available as w
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: oscars - pmm: oscars
template_variables: template_variables:
collection_mode: show_items collection_mode: show_items #(1)!
collection_order: alpha collection_order: alpha #(2)!
radarr_add_missing: true radarr_add_missing: true #(3)!
name_format: Emmys <<key_name>> Winners #(4)!
data: data:
starting: current_year-10 starting: current_year-10 #(5)!
ending: current_year-1 increment: 2 #(6)!
ending: current_year #(7)!
``` ```
1. Shows the collection and all of its items within the Library tab in Plex
2. Sorts the collection items alphabetically
3. Adds items from the source list which are not in Plex to Radarr
4. Change the name of the collections to "Oscars yearhere Winners"
5. If today is 2024, then create collections for Oscars 2014 onwards
6. If starting year is 2014, then create collections for 2014, 2016, 2018, 2020, etc.
7. If today is 2024, then the final collection is Oscars 2024

22
docs/defaults/award/other.md
View file

@ -47,7 +47,17 @@ All [Shared Collection Variables](../collection_variables.md) are available as w
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.
The below shows an example config.yml with template_variables set away from their defaults: ### Example Template Variable Amendments
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:
@ -55,7 +65,11 @@ libraries:
metadata_path: metadata_path:
- pmm: other_award - pmm: other_award
template_variables: template_variables:
collection_mode: show_items use_berlinale: false #(1)!
collection_order: alpha collection_order: alpha #(2)!
radarr_add_missing: true radarr_add_missing: true #(3)!
``` ```
1. Do not create the "Berlinale Golden Bears" collection
2. Sorts the collection items alphabetically
3. Adds items from the source list which are not in Plex to Radarr

17
docs/defaults/award/separator.md
View file

@ -38,14 +38,27 @@ 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_award - pmm: separator_award
template_variables: template_variables:
use_separator: false sep_style: purple #(1)!
sep_style: purple
``` ```
1. Use the purple [Separator Style](../separators.md#separator-styles)

32
docs/defaults/award/spirit.md
View file

@ -52,18 +52,38 @@ All [Shared Collection Variables](../collection_variables.md) are available as w
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.
### Example Template Variable Amendments
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: spirit - pmm: spirit
template_variables: template_variables:
collection_mode: show_items collection_mode: show_items #(1)!
collection_order: alpha collection_order: alpha #(2)!
radarr_add_missing: true radarr_add_missing: true #(3)!
name_format: Independent Spirit Awards <<key_name>> Winners #(4)!
data: data:
starting: current_year-10 starting: current_year-10 #(5)!
ending: current_year increment: 2 #(6)!
ending: current_year #(7)!
``` ```
1. Shows the collection and all of its items within the Library tab in Plex
2. Sorts the collection items alphabetically
3. Adds items from the source list which are not in Plex to Radarr
4. Change the name of the collections to "Independent Spirit Awards yearhere Winners"
5. If today is 2024, then create collections for Independent Spirit Awards 2014 onwards
6. If starting year is 2014, then create collections for 2014, 2016, 2018, 2020, etc.
7. If today is 2024, then the final collection is Independent Spirit Awards 2024

30
docs/defaults/award/sundance.md
View file

@ -51,20 +51,38 @@ All [Shared Collection Variables](../collection_variables.md) are available as w
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: sundance - pmm: sundance
template_variables: template_variables:
collection_mode: show_items collection_mode: show_items #(1)!
collection_order: alpha collection_order: alpha #(2)!
radarr_add_missing: true radarr_add_missing: true #(3)!
name_format: Sundance Film Festival <<key_name>> Winners #(4)!
data: data:
starting: current_year-10 starting: current_year-10 #(5)!
ending: current_year increment: 2 #(6)!
ending: current_year #(7)!
``` ```
1. Shows the collection and all of its items within the Library tab in Plex
2. Sorts the collection items alphabetically
3. Adds items from the source list which are not in Plex to Radarr
4. Change the name of the collections to "Sundance Film Festival yearhere Winners"
5. If today is 2024, then create collections for Sundance Film Festival 2014 onwards
6. If starting year is 2014, then create collections for 2014, 2016, 2018, 2020, etc.
7. If today is 2024, then the final collection is Sundance Film Festival 2024

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

@ -58,8 +58,18 @@ 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:
@ -67,11 +77,16 @@ libraries:
- pmm: actor - pmm: actor
template_variables: template_variables:
data: data:
depth: 10 depth: 10 #(1)!
limit: 20 limit: 20 #(2)!
style: diiivoy style: diiivoycolor #(3)!
sort_by: title.asc sort_by: title.asc
use_separator: false use_separator: false #(4)!
sep_style: purple tmdb_person_offset_Richard Brooks: 1 #(5)!
tmdb_person_offset_Richard Brooks: 1
``` ```
1. Check the first 10 casting credits in each movie
2. Create 20 collections maximum
3. use the [diiivoy Color Style](#diiivoy-color-style)
4. Do not create a "Actors Collections" separator
5. There are two Richard Brooks, so use the 2nd [Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb

19
docs/defaults/both/aspect.md
View file

@ -60,14 +60,27 @@ 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: aspect - pmm: aspect
template_variables: template_variables:
use_separator: false use_1.65: false #(1)!
sep_style: purple sep_style: plum #(2)!
``` ```
1. Do not create a "1.65 - Early Widescreen" collection
2. Use the plum [Separator Style](../separators.md#separator-styles)

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

@ -55,22 +55,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:
Movies: Movies:
metadata_path: metadata_path:
- pmm: audio_language - pmm: audio_language
template_variables: template_variables:
use_other: false use_other: false #(1)!
use_separator: false use_separator: false #(2)!
sep_style: purple
exclude: exclude:
- fr # exclude French - fr #(3)!
sort_by: title.asc sort_by: title.asc
``` ```
1. Do not create an "Other Audio" collection
2. Do not create an "Audio Language Collections" separator
3. Exclude "French" from having an Audio Collection
## 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.

32
docs/defaults/both/based.md
View file

@ -56,19 +56,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:
Movies: Movies:
metadata_path: metadata_path:
- pmm: based - pmm: based
template_variables: template_variables:
use_separator: false sep_style: navy #(1)!
sep_style: purple use_comics: false #(2)!
use_comics: false order_true_story: 01 #(3)!
order_true_story: 01 visible_library_video_games: true #(4)!
visible_library_video_games: true visible_home_video_games: true #(5)!
visible_home_video_games: true visible_shared_video_games: true #(6)!
visible_shared_video_games: true ```
```
1. Use the navy [Separator Style](../separators.md#separator-styles)
2. Do not create a "Based on a Comic" collection
3. Make the "Based on a True Story" collection appear in the collection list before the other collections in this file
4. Pin the "Based on a Video Game" collection to the Recommended tab of the library
5. Pin the "Based on a Video Game" collection to the homescreen of the server owner
6. Pin the "Based on a Video Game" collection to the homescreen of other users of the server

1
docs/defaults/both/collectionless.md
View file

@ -52,6 +52,7 @@ Note that the `template_variables:` section only needs to be used if you do want
| `exclude` | **Description:** Exclude these Collections from being considered for collectionless.<br>**Values:** List of Collections | | `exclude` | **Description:** Exclude these Collections from being considered for collectionless.<br>**Values:** List of Collections |
| `exclude_prefix` | **Description:** Overrides the [default exclude_prefix list](#default-exclude_prefix). Exclude Collections with one of these prefixes from being considered for collectionless.<br>**Default:** [default exclude_prefix list](#default-exclude_prefix)<br>**Values:** List of Prefixes | | | `exclude_prefix` | **Description:** Overrides the [default exclude_prefix list](#default-exclude_prefix). Exclude Collections with one of these prefixes from being considered for collectionless.<br>**Default:** [default exclude_prefix list](#default-exclude_prefix)<br>**Values:** List of Prefixes | |
### 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.

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

@ -62,28 +62,42 @@ 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_cs - pmm: content_rating_cs
template_variables: template_variables:
use_separator: false sep_style: blue #(1)!
sep_style: blue use_other: false #(2)!
use_other: false
append_addons: append_addons:
German 18: # this doesn't have to exist already German 18: #(3)!
- de/18 # adds "de/18" to the existing "18" addon list - 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/Shows" collection
3. Defines a collection which will be called "German 18", this does not need to already exist in your library
4. Adds the "de/18" content rating to the "German 18" addon list, "de/18" must exist in your library if the "German 18" 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.
### Default `include` ### Default `include`
```yaml ```yaml

24
docs/defaults/both/content_rating_mal.md
View file

@ -62,23 +62,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_mal - pmm: content_rating_mal
template_variables: template_variables:
use_other: false sep_style: tan #(1)!
use_separator: false use_other: false #(2)!
sep_style: blue
append_addons: append_addons:
"R+ - Mild Nudity": "R+ - Mild Nudity": #(3)!
- "de/18" - de/18 #(4)!
sort_by: title.asc sort_by: title.asc
``` ```
1. Use the tan [Separator Style](../separators.md#separator-styles)
2. Do not create a "Not Rated Movies/Shows" collection
3. Defines a collection which will be called "R+ - Mild Nudity", this does not need to already exist in your library
4. Adds the "de/18" content rating to the "R+ - Mild Nudity" addon list, "de/18" must exist in your library if the "R+ - Mild Nudity" 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.

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

@ -62,23 +62,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_uk - pmm: content_rating_cs
template_variables: template_variables:
use_separator: false sep_style: stb #(1)!
sep_style: blue use_other: false #(2)!
use_other: false
append_addons: append_addons:
15: 15: #(3)!
- de/15 # adds "de/15" to the existing "15" addon list - de/15 #(4)!
sort_by: title.asc sort_by: title.asc
``` ```
1. Use the stb [Separator Style](../separators.md#separator-styles)
2. Do not create a "Not Rated Movies/Shows" collection
3. Defines a collection which will be called "15", this does not need to already exist in your library
4. Adds the "de/15" content rating to the "15" addon list, "de/18" must exist in your library if the "15" 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.

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

@ -56,25 +56,39 @@ 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: genre - pmm: genre
template_variables: template_variables:
use_separator: false sep_style: red #(1)!
sep_style: red
exclude: exclude:
- Politics - Politics #(2)!
- News - News #(3)!
append_addons: append_addons:
Horror: Horror: #(4)!
- Thriller # Adds all thriller items to the Horror collection - Thriller #(5)! # Adds all thriller items to the Horror collection
sort_by: title.asc
``` ```
1. Use the red [Separator Style](../separators.md#separator-styles)
2. Do not create a "Politics" collection, and do not include it in any other collections that it may be in as part of an "include"
3. Do not create a "News" collection, and do not include it in any other collections that it may be in as part of an "include"
4. Create a "Horror" collection, this genre does not need to exist in your library
5. Include the "Thriller" genre in the "Horror" collection, the "Thriller" genre must exist in your library if the "Horror" genre 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.

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

@ -66,21 +66,33 @@ 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: resolution - pmm: resolution
template_variables: template_variables:
use_separator: false sep_style: green #(1)!
sep_style: green
exclude: exclude:
- SD - sd #(2)!
sort_by: title.asc sort_by: title.asc
``` ```
1. Use the green [Separator Style](../separators.md#separator-styles)
2. Do not use the "sd" resolution as part of the "480p Movies/Shows" Collections
## 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.

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

@ -83,21 +83,39 @@ Some logic is applied to allow for regional streaming service lists to be availa
| `ca` | `max`, `showtime` | These collections will not be created if the region is `ca` as these streaming services are part of the Crave streaming service in Canada | | `ca` | `max`, `showtime` | These collections will not be created if the region is `ca` as these streaming services are part of the Crave streaming service in Canada |
### 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: streaming - pmm: streaming
template_variables: template_variables:
region: fr region: fr #(1)!
use_separator: false sep_style: amethyst #(2)!
sep_style: stb visible_library_disney: true #(3)!
visible_library_disney: true visible_home_disney: true #(4)!
visible_home_disney: true visible_shared_disney: true #(5)!
visible_shared_disney: true sonarr_add_missing_hulu: true #(6)!
sonarr_add_missing_hulu: true radarr_add_missing_amazon: true #(7)!
radarr_add_missing_amazon: true sort_by: random #(8)!
sort_by: random ```
```
1. Use french region lists where possible
2. Use the amethyst [Separator Style](../separators.md#separator-styles)
3. Pin the "Disney+ Movies/Shows" collection to the Recommended tab of the library
4. Pin the "Disney+ Movies/Shows" collection to the homescreen of the server owner
5. Pin the "Disney+ Movies/Shows" collection to the homescreen of other users of the server
6. Add missing shows in your library from the "Hulu Shows" list to your Sonarr
7. Add missing movies in your library from the "Prime Video Movies" list to your Radarr
8. Sort all of the collections created by this file randomly

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

@ -59,8 +59,18 @@ 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:
@ -68,14 +78,16 @@ libraries:
- pmm: studio - pmm: studio
template_variables: template_variables:
append_include: append_include:
- Big Bull Productions - Big Bull Productions #(1)!
sort_by: title.asc sort_by: title.asc
collection_section: 4 collection_mode: show_items #(2)!
collection_mode: show_items sep_style: gray #(3)!
use_separator: false
sep_style: gray
``` ```
1. add "Big Bull Productions" to 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.

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

@ -55,22 +55,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:
Movies: Movies:
metadata_path: metadata_path:
- pmm: subtitle_language - pmm: subtitle_language
template_variables: template_variables:
use_other: false use_other: false #(1)!
use_separator: false use_separator: false #(2)!
sep_style: purple
exclude: exclude:
- fr # Exclude French - fr #(3)!
sort_by: title.asc sort_by: title.asc
``` ```
1. Do not create an "Other Audio" collection
2. Do not create an "Audio Language Collections" separator
3. Exclude "French" from having an Audio Collection
## Default `include` ## Default `include`
```yaml ```yaml

28
docs/defaults/both/universe.md
View file

@ -70,24 +70,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:
Movies: Movies:
metadata_path: metadata_path:
- pmm: universe - pmm: universe
template_variables: template_variables:
use_separator: false sep_style: salmon #(1)!
sep_style: gray collection_order: release #(2)!
collection_order: release radarr_add_missing: true #(3)!
radarr_add_missing: true
# Add a custom universe
append_data: append_data:
monster: MonsterVerse monster: MonsterVerse #(4)!
trakt_list_monster: https://trakt.tv/users/rzepkowski/lists/monsterverse-movies trakt_list_monster: https://trakt.tv/users/rzepkowski/lists/monsterverse-movies #(5)!
``` ```
1. Use the salmon [Separator Style](../separators.md#separator-styles)
2. Sort the Universe collections by release date
3. Send missing items in your library from the source lists to Radarr
4. Create a new universe called "MonsterVerse", the key for this universe will be "monster"
5. Add a trakt list to the "monster" key
## 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.

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

@ -50,16 +50,29 @@ 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: year - pmm: year
template_variables: template_variables:
use_separator: false sep_style: purple #(1)!
sep_style: purple sort_by: title.asc
sort_by: title.asc sort_by_2022: release.desc #(2)!
sort_by_2022: release.desc ```
```
1. Use the purple [Separator Style](../separators.md#separator-styles)
2. Set the sort order for "Best of 2022" to release date descending

29
docs/defaults/movie/director.md
View file

@ -55,20 +55,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:
Movies: Movies:
metadata_path: metadata_path:
- pmm: director - pmm: director
template_variables: template_variables:
style: rainier
use_separator: false
sep_style: purple
data: data:
depth: 10 depth: 10 #(1)!
limit: 20 limit: 20 #(2)!
style: rainier #(3)!
sort_by: title.asc sort_by: title.asc
tmdb_person_offset_Richard Brooks: 1 use_separator: false #(4)!
``` tmdb_person_offset_Richard Brooks: 1 #(5)!
```
1. Check the first 10 casting credits in each movie
2. Create 20 collections maximum
3. use the [rainier Style](#rainier-style)
4. Do not create a "Directors Collections" separator
5. There are two Richard Brooks, so use the 2nd [Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb

29
docs/defaults/movie/producer.md
View file

@ -55,20 +55,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:
Movies: Movies:
metadata_path: metadata_path:
- pmm: producer - pmm: producer
template_variables: template_variables:
style: diiivoycolor
use_separator: false
sep_style: purple
data: data:
depth: 10 depth: 15 #(1)!
limit: 20 limit: 5 #(2)!
style: signature #(3)!
sort_by: title.asc sort_by: title.asc
tmdb_person_offset_Richard Brooks: 1 use_separator: false #(4)!
``` tmdb_person_offset_Richard Brooks: 1 #(5)!
```
1. Check the first 15 casting credits in each movie
2. Create 5 collections maximum
3. use the [rainier Style](#signature-style)
4. Do not create a "Producers Collections" separator
5. There are two Richard Brooks, so use the 2nd [Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb

29
docs/defaults/movie/writer.md
View file

@ -55,20 +55,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:
Movies: Movies:
metadata_path: metadata_path:
- pmm: writer - pmm: writer
template_variables: template_variables:
style: signature
use_separator: false
sep_style: purple
data: data:
depth: 10 depth: 10 #(1)!
limit: 20 limit: 20 #(2)!
style: diivivoy #(3)!
sort_by: title.asc sort_by: title.asc
tmdb_person_offset_Charles Bennett: 1 use_separator: false #(4)!
``` tmdb_person_offset_Richard Brooks: 1 #(5)!
```
1. Check the first 10 casting credits in each movie
2. Create 20 collections maximum
3. use the [diivivoy Style](#rainier-style)
4. Do not create a "Writers Collections" separator
5. There are two Richard Brooks, so use the 2nd [Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb

2
mkdocs.yml
View file

@ -206,7 +206,7 @@ nav:
- Continents (Movie): defaults/movie/continent.md - Continents (Movie): defaults/movie/continent.md
- Continents (Show): defaults/show/continent.md - Continents (Show): defaults/show/continent.md
- Media: - Media:
- Aspect Rations (Show): defaults/both/aspect.md - Aspect Ration (Show): defaults/both/aspect.md
- Resolutions: defaults/both/resolution.md - Resolutions: defaults/both/resolution.md
- Audio Languages: defaults/both/audio_language.md - Audio Languages: defaults/both/audio_language.md
- Subtitle Languages: defaults/both/subtitle_language.md - Subtitle Languages: defaults/both/subtitle_language.md