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

Initial push of individual yaml files for defaults

Browse source
This commit is contained in:
YozoraXCII 2022-09-27 20:28:57 +01:00 committed by meisnate12
parent ec5248963c
commit af9aef324b
19 changed files with 1282 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

636
defaults/README.md
View file

@ -1,10 +1,12 @@
# <img src="https://metamanager.wiki/en/latest/_static/logo-full.png" alt="PMM">
# Default Collections & Overlays # Default Collections & Overlays
This directory is the default set of Plex Meta Manager Sponsored Configs. Plex Meta Manager includes a pre-created set of Metadata Files and Overlay Files which can be found in the "defaults" folder in the root of your Plex Meta Manager installation directory.
For more information on how to use them visit the [Defaults Metadata Guide](https://metamanager.wiki/en/latest/home/guides/defaults.html). These files offer an easy-to-use and customizable set of Collections and Overlays that the user can achieve without having to worry about creating the files that makes the collections and overlays possible.
All Collections come with a matching poster to make a clean, consistent set of collections in your library. These files are stored in the [Plex Meta Manager Images](https://github.com/meisnate12/Plex-Meta-Manager-Images) Repository and each poster is downloaded straight to your Plex Collection when you run Plex Meta Manager.
It should be noted that users running the on [nightly branch](https://metamanager.wiki/en/nightly/home/kb.html#how-do-i-switch-to-the-nightly-branch) of Plex Meta Manager will receive all updates to the PMM Defaults as soon as they are published via [GitHub](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/PMM), which may at times involve bugs or implementations that need to be further addressed. Users of the [develop](https://metamanager.wiki/en/nightly/home/kb.html#how-do-i-switch-to-the-develop-branch) and [master](https://metamanager.wiki/en/nightly/home/kb.html#how-do-i-switch-back-to-the-master-branch) branches will only receive updated Defaults files when an update to Plex Meta Manager is released - this helps to protect to keep these branches stable and prevent bugs from reaching the wider user-base.
Credits to Bullmoose20 and Yozora for helping drive this entire Default Set of Configs through the concept, design and implementation. Credits to Bullmoose20 and Yozora for helping drive this entire Default Set of Configs through the concept, design and implementation.
@ -12,6 +14,632 @@ Special thanks to Magic815 for the overlay image inspiration and base template.
Please consider [donating](https://github.com/sponsors/meisnate12) towards the project. Please consider [donating](https://github.com/sponsors/meisnate12) towards the project.
## Example Collection Configuration
To run a defaults metadata file, you can simply add it to your `metadata_path` using `pmm:` like so:
```yaml
libraries:
Movies:
metadata_path:
- pmm: chart/tmdb
- pmm: awards/bafta
```
A full list of the available metadata files can be found [HERE](LINK NEEDED)
## Example Overlay Configurations
To run a defaults OVERLAY file, you can simply add it to your `overlay_path` using `pmm:` like so:
```yaml
libraries:
Movies:
overlay_path:
- remove_overlays: false
- pmm: overlays/imdb_top_250
- pmm: overlays/ratings
```
A full list of the available overlay files can be found [HERE](LINK NEEDED)
### Example Poster Overlays
![](movie-overlays1-annotated.png)
![](movie-overlays2-annotated.png)
<details>
<summary>Click to expand sample config.yml Movies overlays section:</summary>
```yaml
libraries:
Movies:
overlay_path:
- remove_overlays: false
- reapply_overlay: true
- pmm: overlays/resolution # 1
- pmm: overlays/audio_codec # 2
- pmm: overlays/mediastinger # 3
- pmm: overlays/special_release # 4
- pmm: overlays/ratings # 5,6,7
template_variables:
rating1: user # 5 as this is user and mass_user_rating_update: mdb_tomatoes
rating1_image: rt_tomato # 5 as this is user and mass_user_rating_update: mdb_tomatoes
rating1_font: config/metadata/overlays/fonts/Adlib.ttf # 5 local font accessible to PMM
rating1_font_size: 63 # 5 adjusted font size to fit rating
rating2: critic # 6 as this is critic and mass_critic_rating_update: imdb
rating2_image: imdb # 6 as this is critic and mass_critic_rating_update: imdb
rating2_font: config/metadata/overlays/fonts/Impact.ttf # 6 local font accessible to PMM
rating2_font_size: 70 # 6 adjusted font size to fit rating
rating3: audience # 7 as this is audience and mass_audience_rating_update: tmdb
rating3_image: tmdb # 7 as this is audience and mass_audience_rating_update: tmdb
rating3_font: config/metadata/overlays/fonts/Avenir_95_Black.ttf # 7 local font accessible to PMM
rating3_font_size: 70 # 7 adjusted font size to fit rating
horizontal_position: right # the set of ratings is on the right of the poster
- pmm: overlays/streaming # 8
- pmm: overlays/video_format # 9
- pmm: overlays/audio_language # 10
- pmm: overlays/oscars # 11
template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied
weight: 40 # Weight of 40 applies if more than 1 sash is applied in bottom right
- pmm: overlays/imdb_top_250 # 12
template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied
weight: 30 # Weight of 30 applies if more than 1 sash is applied in bottom right
- pmm: overlays/rt_cert_fresh # 13
template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied
weight: 20 # Weight of 20 applies if more than 1 sash is applied in bottom right
- pmm: overlays/mc_must_see # NOT SHOWN, however would apply the "MetaCritic Must See" sash in the bottom right
template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied
weight: 10 # Weight of 10 applies if more than 1 sash is applied in bottom right
- pmm: overlays/commonsense_selection # NOT SHOWN, however would apply the "Commonsense Selected Families" sash in the bottom right
template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied
weight: 5 # Weight of 5 applies if more than 1 sash is applied in bottom right
operations:
mass_user_rating_update: mdb_tomatoes # 5 This operation will update the user rating in plex with Rotten Tomatoes ratings information
mass_critic_rating_update: imdb # 6 This operation will update the critic rating in plex with IMDb ratings information
mass_audience_rating_update: tmdb # 7 This operation will update the audience rating in plex with TMDb ratings information
```
</details>
### Example TV Shows - Show Overlays
![](tvshow-poster-annotated.png)
<details>
<summary>Click to expand sample config.yml TV Shows overlays section for the Show Poster:</summary>
```yaml
libraries:
TV Shows:
overlay_path:
- remove_overlays: false
- reapply_overlay: true
- pmm: overlays/resolution # 1
- pmm: overlays/audio_codec # 2
- pmm: overlays/mediastinger # 3
- pmm: overlays/ratings # 4,5,6
template_variables:
rating1: user # 4 as this is user and mass_user_rating_update: mdb_tomatoes
rating1_image: rt_tomato # 4 as this is user and mass_user_rating_update: mdb_tomatoes
rating1_font: config/metadata/overlays/fonts/Adlib.ttf # 4 local font accessible to PMM
rating1_font_size: 63 # 4 adjusted font size to fit rating
rating2: critic # 5 as this is critic and mass_critic_rating_update: imdb
rating2_image: imdb # 5 as this is critic and mass_critic_rating_update: imdb
rating2_font: config/metadata/overlays/fonts/Impact.ttf # 5 local font accessible to PMM
rating2_font_size: 70 # 5 adjusted font size to fit rating
rating3: audience # 6 as this is audience and mass_audience_rating_update: tmdb
rating3_image: tmdb # 6 as this is audience and mass_audience_rating_update: tmdb
rating3_font: config/metadata/overlays/fonts/Avenir_95_Black.ttf # 6 local font accessible to PMM
rating3_font_size: 70 # 6 adjusted font size to fit rating
horizontal_position: right # the set of ratings is on the right of the poster
- pmm: overlays/streaming # 7
- pmm: overlays/video_format # 8
- pmm: overlays/imdb_top_250 # 9
template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied
weight: 30 # Weight of 30 applies if more than 1 sash is applied in bottom right
- pmm: overlays/rt_cert_fresh # 10
template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied
weight: 20 # Weight of 20 applies if more than 1 sash is applied in bottom right
- pmm: overlays/mc_must_see # NOT SHOWN, however would apply the "MetaCritic Must See" sash in the bottom right
template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied
weight: 10 # Weight of 10 applies if more than 1 sash is applied in bottom right
- pmm: overlays/commonsense_selection # NOT SHOWN, however would apply the "Commonsense Selected Families" sash in the bottom right
template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied
weight: 5 # Weight of 5 applies if more than 1 sash is applied in bottom right
operations:
mass_user_rating_update: mdb_tomatoes # 4 This operation will update the user rating in plex with Rotten Tomatoes ratings information
mass_critic_rating_update: imdb # 5 This operation will update the critic rating in plex with IMDb ratings information
mass_audience_rating_update: tmdb # 6 This operation will update the audience rating in plex with TMDb ratings information
```
</details>
### Example TV Shows - Season Overlays
![](tvshow-poster-season-annotated.png)
<details>
<summary>Click to expand sample config.yml TV Shows overlays section for the Season Poster:</summary>
```yaml
libraries:
TV Shows:
overlay_path:
- remove_overlays: false
- reapply_overlay: true
- pmm: overlays/resolution # 1
template_variables:
overlay_level: season
- pmm: overlays/audio_codec # 2
template_variables:
overlay_level: season
- pmm: overlays/video_format # 3
template_variables:
overlay_level: season
```
</details>
### Example TV Shows - Episode Overlays
![](tvshow-poster-episode-annotated.png)
<details>
<summary>Click to expand sample config.yml TV Shows overlays section for the Episode Poster:</summary>
```yaml
libraries:
TV Shows:
overlay_path:
- remove_overlays: false
- reapply_overlay: true
- pmm: overlays/resolution # 1
template_variables:
overlay_level: episode
- pmm: overlays/audio_codec # 2
template_variables:
overlay_level: episode
- pmm: overlays/ratings # 3,4
template_variables:
rating1: critic # 3 as this is critic and mass_critic_rating_update: imdb
rating1_image: imdb # 3 as this is critic and mass_critic_rating_update: imdb
rating1_font: config/metadata/overlays/fonts/Impact.ttf # 3 local font accessible to PMM
rating1_font_size: 70 # 3 adjusted font size to fit rating
rating2: audience # 4 as this is audience and mass_audience_rating_update: tmdb
rating2_image: tmdb # 4 as this is audience and mass_audience_rating_update: tmdb
rating2_font: config/metadata/overlays/fonts/Avenir_95_Black.ttf # 4 local font accessible to PMM
rating2_font_size: 70 # 4 adjusted font size to fit rating
horizontal_position: right # the set of ratings is on the right of the poster
overlay_level: episode
- pmm: overlays/video_format # 5
template_variables:
overlay_level: episode
- pmm: overlays/episode_info # 6
template_variables:
overlay_level: episode
- pmm: overlays/runtimes # 7
template_variables:
overlay_level: episode
operations:
mass_episode_critic_rating_update: imdb # 3 This operation will update the episodes critic rating in plex with IMDb ratings information
mass_episode_audience_rating_update: tmdb # 4 This operation will update the episodes audience rating in plex with TMDb ratings information
```
</details>
## Separators
By default, most metadata files use separators to denote different sections of collection like actor collections vs studio collections.
<details>
<summary>Click to expand to see an example of Separators.</summary>
![](separators.jpg)
</details>
* Can be turned off by [customizing your config](#customizing-configs)
## Collection Section Order
Almost every default metadata file has a `collection_section` attribute. These attributes determine the order of the various sections and can be set by [customizing your config](#customizing-configs).
For example: `collection_section:01` translates to `sort_title: "!<<collection_section>><<pre>><<order_<<key>>>><<sort>>"` and so for `genre.yml` if you have a `Fantasy` collection, plex is going to show `!06_Fantasy`
This is the default PMM collection ordering:
| Collection | Order |
|:-------------------------------------|------------------------|
| `PMM/movie/seasonal.yml` | collection_section: 00 |
| `PMM/chart/anilist.yml` | collection_section: 01 |
| `PMM/chart/basic.yml` | collection_section: 01 |
| `PMM/chart/imdb.yml` | collection_section: 01 |
| `PMM/chart/myanimelist.yml` | collection_section: 01 |
| `PMM/chart/other.yml` | collection_section: 01 |
| `PMM/chart/tautulli.yml` | collection_section: 01 |
| `PMM/chart/tmdb.yml` | collection_section: 01 |
| `PMM/chart/trakt.yml` | collection_section: 01 |
| `PMM/movie/universe.yml` | collection_section: 02 |
| `PMM/streaming.yml` | collection_section: 03 |
| `PMM/show/network.yml` | collection_section: 04 |
| `PMM/genre.yml` | collection_section: 06 |
| `PMM/studio.yml` | collection_section: 07 |
| `PMM/movie/country.yml` | collection_section: 09 |
| `PMM/show/country.yml` | collection_section: 09 |
| `PMM/audio_language.yml` | collection_section: 10 |
| `PMM/subtitle_language.yml` | collection_section: 11 |
| `PMM/movie/decade.yml` | collection_section: 12 |
| `PMM/show/decade.yml` | collection_section: 12 |
| `PMM/year.yml` | collection_section: 13 |
| `PMM/content_rating_uk.yml` | collection_section: 14 |
| `PMM/movie/content_rating_us.yml` | collection_section: 14 |
| `PMM/show/content_rating_us.yml` | collection_section: 14 |
| `PMM/resolution.yml` | collection_section: 15 |
| `PMM/resolution_standards.yml` | collection_section: 15 |
| `PMM/award/bafta.yml` | collection_section: 16 |
| `PMM/award/cannes.yml` | collection_section: 16 |
| `PMM/award/choice.yml` | collection_section: 16 |
| `PMM/award/emmy.yml` | collection_section: 16 |
| `PMM/award/golden.yml` | collection_section: 16 |
| `PMM/award/oscars.yml` | collection_section: 16 |
| `PMM/award/other.yml` | collection_section: 16 |
| `PMM/award/separator.yml` | collection_section: 16 |
| `PMM/award/spirit.yml` | collection_section: 16 |
| `PMM/award/sundance.yml` | collection_section: 16 |
| `PMM/actor.yml` | collection_section: 17 |
| `PMM/movie/director.yml` | collection_section: 18 |
| `PMM/movie/producer.yml` | collection_section: 19 |
| `PMM/movie/writer.yml` | collection_section: 20 |
## Ratings Overlays
By default for Movies in Plex, the `Ratings Source` dropdown (`#3`) below, can come from Rotten Tomatoes (and includes Critic Ratings and Audience Ratings) or IMDb (Audience Ratings). This only changes the tiny icons displayed and where Plex will retrieve the ratings from upon initial scan and import of the media metadata.
**Plex Meta Manager can insert up to three ratings of your choice into the three spots regardless of what you choose in the `Advanced` tab of that Plex library**
![](ratings_source.png)
Plex has three available spots in the Plex DB to store ratings and thus Plex Meta Manager can be used to insert ratings sources of your choice into those spots. They are known as the User Rating (`#1`), Critic Rating (`#2`), and Audience Rating (`#3`).
**Note that the little icons cannot be changed and that the numbers next to the little icons are reflected in the poster ratings overlay**
![](ratings_spot.png)
To be able to insert the ratings you want, Plex Meta Manager operations need to be defined. In this example below, User ratings (`#1`) are being filled with Rotten Tomatoes Critics Ratings. Critic ratings (`#2`) are filled with IMDb, and Audience ratings (`#3`) are filled with TMDb.
**mass_*_rating_update** sources can be found here: [operations](../../config/operations)
![](ratings_operations.png)
Finally, to show the ratings on the poster, the following was added to the `overlay_path` section in the `config.yml` file to post Rotten Tomatoes Critics Ratings in (`#1`), IMDb ratings in (`#2`), and TMDb ratings in (`#3`)
![](ratings_overlay_path.png)
## Customizing Configs
Configs can be customized using the `template_variables` attribute when calling the file. These `template_variables` will be given to every template call in the file which allows them to affect how that file runs.
This example changes the ratings overlay to work on episodes.
```yaml
libraries:
TV Shows:
overlay_path:
- pmm: overlays/ratings
template_variables:
overlay_level: episode
```
Each file has a comment block at the top showing the available `template_variables` for each file. For example the [`PMM/genre`](https://github.com/meisnate12/Plex-Meta-Manager-Configs/blob/master/PMM/genre.yml) has this:
```yaml
#############################################################
# Dynamic Genre Collections #
# Created by Yozora, Bullmoose20, & Sohjiro #
#############################################################
# Call this from your config.yml (Movie or Show) #
# If nothing is specified these are the defaults #
# #
# metadata_path: #
# - pmm: genre #
# template_variables: #
# # Turn the separator collection on/off #
# use_separator: true #
# # Sets how the collection is sorted #
# sort_by: release.desc #
# # Sets the collection mode of the collection #
# collection_mode: #
# # Sets the value at the start of the sort title #
# collection_section: "06" #
#############################################################
```
Each of these when passed will change how the collection runs slightly.
* `use_separator` Turn the separator collection on/off
* `sort_by` Sets how the collection is sorted
* `collection_mode` Sets the collection mode of the collection
* `collection_section` Sets the value at the start of the sort title
**In addition to the defined `template_variables` each file in the PMM Folder has access to the `radarr_add_missing` and `sonarr_add_missing` template variables and for dynamic collections most attributes can be passed as template variables**
For example if you want yearly oscar collections that go back 10 years instead of 5 all of which gets sent to radarr use the `data` and `radarr_add_missing` template variables.
```yaml
libraries:
Movies:
metadata_path:
- pmm: award/oscars
template_variables:
radarr_add_missing: true
data:
starting: current_year-10
ending: current_year
```
Or maybe you want to change the number of actor collections made using PMM/actor.
```yaml
libraries:
Movies:
overlay_path:
- pmm: actor
template_variables:
collection_mode: hide
data:
depth: 5
limit: 50
```
Or maybe you want to change the collection sort order of the genre collections using PMM/genre.
```yaml
libraries:
Movies:
metadata_path:
- pmm: genre
template_variables:
collection_section: 11
```
Or maybe you want to disable separators globally per library.
```yaml
libraries:
LIBRARYNAME:
template_variables:
use_separator: false
metadata_path:
```
Alternatively it can be turned off individually per git file:
```yaml
libraries:
LIBRARYNAME:
metadata_path:
- pmm: <file1> # separator is disabled
template_variables:
use_separator: false
- pmm: <file2> # separator is enabled by default
- pmm: <file3> # separator is disabled
template_variables:
use_separator: false
```
## Errors ## Errors
If there are collections being made that have configuration errors or missing posters please either bring it up in our Discord or raise an Issue on the [Configs Repo](https://github.com/meisnate12/Plex-Meta-Manager-Configs/issues/new/choose). If there are collections being made that have configuration errors or missing posters please either bring it up in our Discord or raise an Issue on the [Configs Repo](https://github.com/meisnate12/Plex-Meta-Manager-Configs/issues/new/choose).
## Example Configuration File
<details>
<summary>Click to expand sample config.yml file:</summary>
```yaml
libraries:
Movies:
metadata_path:
- pmm: award/bafta
- pmm: award/cannes
- pmm: award/choice
- pmm: award/golden
- pmm: award/oscars
- pmm: award/other
- pmm: award/spirit
- pmm: award/sundance
- pmm: chart/anilist
- pmm: chart/basic
- pmm: chart/imdb
- pmm: chart/myanimelist
- pmm: chart/other
- pmm: chart/tautulli
- pmm: chart/tmdb
- pmm: chart/trakt
- pmm: actor
- pmm: audio_language
- pmm: movie/content_rating_us # Choose content_rating_uk or content_rating_us
- pmm: genre
- pmm: resolution_standards # Choose resolution_standards or resolution
- pmm: streaming
- pmm: studio
- pmm: subtitle_language
- pmm: year
- pmm: movie/country
- pmm: movie/decade
- pmm: movie/director
- pmm: movie/franchise
- pmm: movie/universe
- pmm: movie/producer
- pmm: movie/seasonal
- pmm: movie/writer
overlay_path:
- remove_overlays: false
- pmm: overlays/audio_codec
- pmm: overlays/audio_language
- pmm: overlays/commonsense
- pmm: overlays/direct_play
- pmm: overlays/mediastinger
- pmm: overlays/imdb_top_250
- pmm: overlays/mc_must_see
- pmm: overlays/rt_cert_fresh
- pmm: overlays/commonsense_selection
- pmm: overlays/ratings
template_variables:
rating1: critic
rating1_image: rt_tomato
- pmm: overlays/resolution
- pmm: overlays/special_release
- pmm: overlays/streaming
- pmm: overlays/versions
- pmm: overlays/video_format
TV Shows:
metadata_path:
- pmm: award/choice
- pmm: award/golden
- pmm: award/emmy
- pmm: chart/anilist
- pmm: chart/basic
- pmm: chart/imdb
- pmm: chart/myanimelist
- pmm: chart/other
- pmm: chart/tautulli
- pmm: chart/tmdb
- pmm: chart/trakt
- pmm: actor
- pmm: audio_language
- pmm: show/content_rating_us # Choose content_rating_uk or content_rating_us
- pmm: genre
- pmm: resolution_standards # Choose resolution_standards or resolution
- pmm: streaming
- pmm: studio
- pmm: subtitle_language
- pmm: year
- pmm: show/country
- pmm: show/decade
- pmm: show/network
overlay_path:
- remove_overlays: false
- pmm: overlays/audio_codec
- pmm: overlays/audio_codec
template_variables:
overlay_level: episode
- pmm: overlays/audio_codec
template_variables:
overlay_level: season
- pmm: overlays/audio_language
- pmm: overlays/audio_language
template_variables:
overlay_level: episode
- pmm: overlays/audio_language
template_variables:
overlay_level: season
- pmm: overlays/commonsense
- pmm: overlays/commonsense
template_variables:
overlay_level: episode
- pmm: overlays/commonsense
template_variables:
overlay_level: season
- pmm: overlays/direct_play
- pmm: overlays/direct_play
template_variables:
overlay_level: episode
- pmm: overlays/direct_play
template_variables:
overlay_level: season
- pmm: overlays/episode_info
template_variables:
overlay_level: episode
- pmm: overlays/mediastinger
- pmm: overlays/mediastinger
template_variables:
overlay_level: episode
- pmm: overlays/mediastinger
template_variables:
overlay_level: season
- pmm: overlays/imdb_top_250
- pmm: overlays/imdb_top_250
template_variables:
overlay_level: episode
- pmm: overlays/imdb_top_250
template_variables:
overlay_level: season
- pmm: overlays/mc_must_see
- pmm: overlays/mc_must_see
template_variables:
overlay_level: episode
- pmm: overlays/mc_must_see
template_variables:
overlay_level: season
- pmm: overlays/rt_cert_fresh
- pmm: overlays/rt_cert_fresh
template_variables:
overlay_level: episode
- pmm: overlays/rt_cert_fresh
template_variables:
overlay_level: season
- pmm: overlays/commonsense_selection
- pmm: overlays/commonsense_selection
template_variables:
overlay_level: episode
- pmm: overlays/commonsense_selection
template_variables:
overlay_level: season
- pmm: overlays/ratings
template_variables:
rating2: audience
rating2_image: imdb
- pmm: overlays/ratings
template_variables:
rating2: audience
rating2_image: imdb
overlay_level: episode
- pmm: overlays/resolution
- pmm: overlays/resolution
template_variables:
overlay_level: episode
- pmm: overlays/resolution
template_variables:
overlay_level: season
- pmm: overlays/runtimes
template_variables:
overlay_level: episode
- pmm: overlays/special_release
- pmm: overlays/special_release
template_variables:
overlay_level: episode
- pmm: overlays/special_release
template_variables:
overlay_level: season
- pmm: overlays/streaming
- pmm: overlays/versions
- pmm: overlays/versions
template_variables:
overlay_level: episode
- pmm: overlays/versions
template_variables:
overlay_level: season
- pmm: overlays/versions
template_variables:
overlay_level: show
- pmm: overlays/video_format
- pmm: overlays/video_format
template_variables:
overlay_level: episode
- pmm: overlays/video_format
template_variables:
overlay_level: season
playlist_files:
- pmm: playlist
```
</details>

BIN
docs/defaults.zip Normal file
View file

Binary file not shown.

2
docs/defaults/actor.md
View file

@ -15,7 +15,7 @@ libraries:
``` ```
## Rainier Style ## Rainier Style
Below is a screnshot of the alternative `Rainier` style which can be set via template variables Below is a screenshot of the alternative `Rainier` style which can be set via template variables
![](images/actor2.png) ![](images/actor2.png)

BIN
docs/defaults/images/country1.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 99 KiB

BIN
docs/defaults/images/country2.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 107 KiB

53
docs/defaults/movie/content_rating_us.md Normal file
View file

@ -0,0 +1,53 @@
# 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.
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")
Example Collections Created:
![](../images/content_rating_us.png)
The below YAML in your config.yml will create the actor collections:
```yaml
libraries:
Movies:
metadata_path:
- pmm: content_rating_us
```
ohhh
## Template Variables
Template Variables can be used to manipulate the file from the default settings which are provided.
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
Below are the available variables which can be used to customize the file.
| Variable | Usage | Default Value | Values |
|:-------------------|:-----------------------------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| sort_by | Controls the sort method for the collections | `release.desc` | Any sort method in the [Sorts Options Table](#sort-options) |
| collection_section | Controls the sort order of these collections against other default collections | `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:
```yaml
libraries:
Movies:
metadata_path:
- pmm: content_rating_us
template_variables:
sort_by: title.asc
collection_section: 25
collection_mode: show_items
use_other: false
use_separator: false
sep_style: blue
```

55
docs/defaults/movie/country.md Normal file
View file

@ -0,0 +1,55 @@
# country Language Default Metadata File
The `- pmm: country` Metadata File is used to dynamically create collections based on the counties available in your library.
Example Collections Created:
![](../images/country1.png)
The below YAML in your config.yml will create the actor collections:
```yaml
libraries:
Movies:
metadata_path:
- pmm: country
```
## Color Style
Below is a screenshot of the alternative `color` style which can be set via template variables
![](../images/country2.png)
## Template Variables
Template Variables can be used to manipulate the file from the default settings which are provided.
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
Below are the available variables which can be used to customize the file.
| Variable | Usage | Default Value | Values |
|:-------------------|:-----------------------------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| 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:
```yaml
libraries:
Movies:
metadata_path:
- pmm: country
template_variables:
sort_by: title.asc
collection_section: 8
collection_mode: show_items
use_other: false
use_separator: false
sep_style: purple
```

51
docs/defaults/movie/decade.md Normal file
View file

@ -0,0 +1,51 @@
# Decade Language 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>"
Example Collections Created:
![](../images/decade.png)
The below YAML in your config.yml will create the actor collections:
```yaml
libraries:
Movies:
metadata_path:
- pmm: decade
```
## Template Variables
Template Variables can be used to manipulate the file from the default settings which are provided.
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
Below are the available variables which can be used to customize the file.
| Variable | Usage | Default Value | Values |
|:-------------------|:-----------------------------------------------------------------------------------------------------|------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| sort_by | Controls the sort method for the collections | `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 shows an example config.yml with all the template_variables set away from their defaults:
```yaml
libraries:
Movies:
metadata_path:
- pmm: decade
template_variables:
sort_by: title.asc
collection_section: 18
collection_mode: show_items
use_other: false
use_separator: false
sep_style: purple
```

56
docs/defaults/movie/director.md Normal file
View file

@ -0,0 +1,56 @@
# Director Default Metadata File
The `- pmm: director` Metadata File is used to dynamically create collections based on the most popular directors in your library.
Example Collections Created:
![](images/director1.png)
The below YAML in your config.yml will create the director collections:
```yaml
libraries:
Movies:
metadata_path:
- pmm: director
```
## Rainier Style
Below is a screenshot of the alternative `Rainier` style which can be set via template variables
![](images/director2.png)
## Template Variables
Template Variables can be used to manipulate the director file from the default settings which are provided.
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
Below are the available variables which can be used to customize the file.
| Variable | Usage | Default Value | Values |
|:-------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| 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 |
The below shows an example config.yml with all of the template_variables set away from their defaults:
```yaml
libraries:
Movies:
metadata_path:
- pmm: director
template_variables:
style: rainier
sort_by: title.asc
collection_section: 12
collection_mode: show_items
use_separator: false
sep_style: purple
```

55
docs/defaults/movie/franchise.md Normal file
View file

@ -0,0 +1,55 @@
# Franchise Language Default Metadata File
The `- pmm: franchise` Metadata File is used to create collections based on popular Movie 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 "Iron Man" franchise collection will appear next to the "Iron Man" movies within your library.
Example Collections Created:
![](../images/moviefranchise.png)
The below YAML in your config.yml will create the actor collections:
```yaml
libraries:
Movies:
metadata_path:
- pmm: franchise
```
## Template Variables
Template Variables can be used to manipulate the file from the default settings which are provided.
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
Below are the available variables which can be used to customize the file.
| Variable | Usage | Default Value | Values |
|:-------------------|:----------------------------------------------|---------------|:----------------------------------------------:|
| 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:
```yaml
libraries:
Movies:
metadata_path:
- pmm: franchise
template_variables:
collection_order: alpha
sort_title: "!10_<<collection_name>>"
build_collection: false
radarr_add_missing: true
radarr_folder: /mnt/local/Media/TV
radarr_tag: <<collection_name>>
item_radarr_tag: <<collection_name>>
```

51
docs/defaults/movie/network.md Normal file
View file

@ -0,0 +1,51 @@
# Network Language Default Metadata File
The `- pmm: network` Metadata File is used to dynamically create collections based on the counties available in your library.
Example Collections Created:
![](../images/network.png)
The below YAML in your config.yml will create the actor collections:
```yaml
libraries:
Movies:
metadata_path:
- pmm: network
```
## Template Variables
Template Variables can be used to manipulate the file from the default settings which are provided.
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
Below are the available variables which can be used to customize the file.
| Variable | Usage | Default Value | Values |
|:-------------------|:-----------------------------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| sort_by | Controls the sort method for the collections | `release.desc` | Any sort method in the [Sorts Options Table](#sort-options) |
| collection_section | Controls the sort order of these collections against other default collections | `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:
```yaml
libraries:
Movies:
metadata_path:
- pmm: network
template_variables:
sort_by: title.asc
collection_section: 07
collection_mode: show_items
use_other: false
use_separator: false
sep_style: stb
```

56
docs/defaults/movie/producer.md Normal file
View file

@ -0,0 +1,56 @@
# Producer Default Metadata File
The `- pmm: producer` Metadata File is used to dynamically create collections based on the most popular producers in your library.
Example Collections Created:
![](images/producer1.png)
The below YAML in your config.yml will create the producer collections:
```yaml
libraries:
Movies:
metadata_path:
- pmm: producer
```
## Rainier Style
Below is a screenshot of the alternative `Rainier` style which can be set via template variables
![](images/producer2.png)
## Template Variables
Template Variables can be used to manipulate the producer file from the default settings which are provided.
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
Below are the available variables which can be used to customize the file.
| Variable | Usage | Default Value | Values |
|:-------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| 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 |
The below shows an example config.yml with all of the template_variables set away from their defaults:
```yaml
libraries:
Movies:
metadata_path:
- pmm: producer
template_variables:
style: rainier
sort_by: title.asc
collection_section: 12
collection_mode: show_items
use_separator: false
sep_style: purple
```

54
docs/defaults/movie/universe.md Normal file
View file

@ -0,0 +1,54 @@
# Universe Language 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)
This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html)
Example Collections Created:
![](../images/universe.png)
The below YAML in your config.yml will create the actor collections:
```yaml
libraries:
Movies:
metadata_path:
- pmm: universe
```
## Template Variables
Template Variables can be used to manipulate the file from the default settings which are provided.
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
Below are the available variables which can be used to customize the file.
| Variable | Usage | Default Value | Values |
|:-------------------|:---------------------------------------------|---------------|:-------------------------------------------------------:|
| 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 existing 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:
Movies:
metadata_path:
- pmm: universe
template_variables:
collection_order: release
radarr_add_missing: true
radarr_folder: /mnt/local/Media/TV
radarr_tag: <<collection_name>>
item_radarr_tag: <<collection_name>>
use_separator: false
sep_style: gray
```

56
docs/defaults/movie/writer.md Normal file
View file

@ -0,0 +1,56 @@
# Writer Default Metadata File
The `- pmm: writer` Metadata File is used to dynamically create collections based on the most popular writers in your library.
Example Collections Created:
![](images/writer1.png)
The below YAML in your config.yml will create the writer collections:
```yaml
libraries:
Movies:
metadata_path:
- pmm: writer
```
## Rainier Style
Below is a screenshot of the alternative `Rainier` style which can be set via template variables
![](images/writer2.png)
## Template Variables
Template Variables can be used to manipulate the writer file from the default settings which are provided.
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
Below are the available variables which can be used to customize the file.
| Variable | Usage | Default Value | Values |
|:-------------------|:-------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| 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 |
The below shows an example config.yml with all of the template_variables set away from their defaults:
```yaml
libraries:
Movies:
metadata_path:
- pmm: writer
template_variables:
style: rainier
sort_by: title.asc
collection_section: 12
collection_mode: show_items
use_separator: false
sep_style: purple
```

6
docs/defaults/show/country.md
View file

@ -4,7 +4,7 @@ The `- pmm: country` Metadata File is used to dynamically create collections bas
Example Collections Created: Example Collections Created:
![](../images/country.png) ![](../images/country1.png)
The below YAML in your config.yml will create the actor collections: The below YAML in your config.yml will create the actor collections:
```yaml ```yaml
@ -13,7 +13,10 @@ libraries:
metadata_path: metadata_path:
- pmm: country - pmm: country
``` ```
## Color Style
Below is a screenshot of the alternative `color` style which can be set via template variables
![](../images/country2.png)
## Template Variables ## Template Variables
Template Variables can be used to manipulate the file from the default settings which are provided. Template Variables can be used to manipulate the file from the default settings which are provided.
@ -25,6 +28,7 @@ Below are the available variables which can be used to customize the file.
| Variable | Usage | Default Value | Values | | 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) | | 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_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 | | 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 |

51
docs/defaults/show/decade.md Normal file
View file

@ -0,0 +1,51 @@
# Decade Language 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>"
Example Collections Created:
![](../images/decade.png)
The below YAML in your config.yml will create the actor collections:
```yaml
libraries:
Movies:
metadata_path:
- pmm: decade
```
## Template Variables
Template Variables can be used to manipulate the file from the default settings which are provided.
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
Below are the available variables which can be used to customize the file.
| Variable | Usage | Default Value | Values |
|:-------------------|:-----------------------------------------------------------------------------------------------------|------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| sort_by | Controls the sort method for the collections | `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:
```yaml
libraries:
Movies:
metadata_path:
- pmm: decade
template_variables:
sort_by: title.asc
collection_section: 18
collection_mode: show_items
use_other: false
use_separator: false
sep_style: purple
```

55
docs/defaults/show/franchise.md Normal file
View file

@ -0,0 +1,55 @@
# Franchise Language Default Metadata File
The `- pmm: 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.
Example Collections Created:
![](../images/showfranchise.png)
The below YAML in your config.yml will create the actor collections:
```yaml
libraries:
Movies:
metadata_path:
- pmm: franchise
```
## Template Variables
Template Variables can be used to manipulate the file from the default settings which are provided.
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
Below are the available variables which can be used to customize the file.
| Variable | Usage | Default Value | Values |
|:-------------------|:-------------------------------------------------------------------------------|---------------|:----------------------------------------------:|
| 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:
```yaml
libraries:
Movies:
metadata_path:
- pmm: franchise
template_variables:
collection_order: alpha
sort_title: "!10_<<collection_name>>"
build_collection: false
sonarr_add_missing: true
sonarr_folder: /mnt/local/Media/TV
sonarr_tag: <<collection_name>>
item_sonarr_tag: <<collection_name>>
```

51
docs/defaults/show/network.md Normal file
View file

@ -0,0 +1,51 @@
# Network Language Default Metadata File
The `- pmm: network` Metadata File is used to dynamically create collections based on the counties available in your library.
Example Collections Created:
![](../images/network.png)
The below YAML in your config.yml will create the actor collections:
```yaml
libraries:
Movies:
metadata_path:
- pmm: network
```
## Template Variables
Template Variables can be used to manipulate the file from the default settings which are provided.
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
Below are the available variables which can be used to customize the file.
| Variable | Usage | Default Value | Values |
|:-------------------|:-----------------------------------------------------------------------------------------------------|----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| sort_by | Controls the sort method for the collections | `release.desc` | Any sort method in the [Sorts Options Table](#sort-options) |
| collection_section | Controls the sort order of these collections against other default collections | `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:
```yaml
libraries:
Movies:
metadata_path:
- pmm: network
template_variables:
sort_by: title.asc
collection_section: 07
collection_mode: show_items
use_other: false
use_separator: false
sep_style: stb
```

5
docs/home/guides/defaults.md
View file

@ -6,11 +6,6 @@ The intention of this directory is to offer easy to use and slightly customizabl
All posters defined in the Metadata Files are stored in the [Plex Meta Manager Images](https://github.com/meisnate12/Plex-Meta-Manager-Images) Repository and all Overlay images are in the [Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs) Repository at [PMM/overlays/images](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/PMM/overlays/images), which allows for changes to be made in one central location that will deploy to all users of this setup when they next run PMM. All posters defined in the Metadata Files are stored in the [Plex Meta Manager Images](https://github.com/meisnate12/Plex-Meta-Manager-Images) Repository and all Overlay images are in the [Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs) Repository at [PMM/overlays/images](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/PMM/overlays/images), which allows for changes to be made in one central location that will deploy to all users of this setup when they next run PMM.
It should be noted that users running the on [nightly branch](https://metamanager.wiki/en/nightly/home/kb.html#how-do-i-switch-to-the-nightly-branch) of Plex Meta Manager will receive all updates to the PMM Defaults as soon as they are published via [GitHub](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/PMM), which may at times involve bugs or implementations that need to be further addressed. Users of the [develop](https://metamanager.wiki/en/nightly/home/kb.html#how-do-i-switch-to-the-develop-branch) and [master](https://metamanager.wiki/en/nightly/home/kb.html#how-do-i-switch-back-to-the-master-branch) branches will only receive updated Defaults files when an update to Plex Meta Manager is released - this helps to protect to keep these branches stable and prevent bugs from reaching the wider user-base.
Credits to Bullmoose20 and Yozora for helping drive this entire Default Set of Configs through the concept, design and implementation.
Special thanks to Magic815 for the overlay image inspiration and base template.
## Configurations ## Configurations