meisnate12
2 years ago
commit
d14e9f461a
@ -0,0 +1,63 @@
|
|||||||
|
## Collections
|
||||||
|
|
||||||
|
These files can generally be used on both Movie and Show library-types, or are part of a category of collection (such as Award Shows.)
|
||||||
|
|
||||||
|
These collections are applied by calling the below paths into the `metadata_path` section of your config.yml
|
||||||
|
|
||||||
|
### Chart Collections
|
||||||
|
|
||||||
|
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|
||||||
|
|:-----------------------------------|:-----------------:|:-------------------------------------------|:-----------------:|:----------------:|
|
||||||
|
| [Chart Separator](chart/separator) | `separator_chart` | Chart Collections | ✅ | ✅ |
|
||||||
|
| [AniList](chart/anilist) | `anilist` | AniList Popular, AniList Season | ✅ | ✅ |
|
||||||
|
| [Basic](chart/basic) | `basic` | Newly Released, New Episodes | ✅ | ✅ |
|
||||||
|
| [FlixPatrol](chart/flixpatrol) | `flixpatrol` | Top Disney, Top Hbo, Top Hulu, Top Netflix | ✅ | ✅ |
|
||||||
|
| [IMDb](chart/imdb) | `imdb` | IMDb Popular, IMDb Top 250 | ✅ | ✅ |
|
||||||
|
| [MyAnimeList](chart/myanimelist) | `myanimelist` | MyAnimeList Popular, MyAnimeList Top Rated | ✅ | ✅ |
|
||||||
|
| [Other](chart/other) | `other_chart` | AniDB Popular, Common Sense Selection | ✅ | ✅ |
|
||||||
|
| [Tautulli](chart/tautulli) | `tautulli` | Plex Popular, Plex Watched | ✅ | ✅ |
|
||||||
|
| [TMDb](chart/tmdb) | `tmdb` | TMDb Popular, TMDb Airing Today | ✅ | ✅ |
|
||||||
|
| [Trakt](chart/trakt) | `trakt` | Trakt Popular, Trakt Trending | ✅ | ✅ |
|
||||||
|
|
||||||
|
### Award Collections
|
||||||
|
|
||||||
|
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|
||||||
|
|:-----------------------------------------------------------|:-----------------:|:--------------------------------------------|:-----------------:|:----------------:|
|
||||||
|
| [Award Separator](award/separator) | `separator_award` | Award Collections | ✅ | ✅ |
|
||||||
|
| [British Academy of Film and Television Arts](award/bafta) | `bafta` | BAFTA Best Films, BAFTA 2021 | ✅ | ❌ |
|
||||||
|
| [Cannes](award/cannes) | `cannes` | Cannes - Palme d'or, Cannes 2018 | ✅ | ❌ |
|
||||||
|
| [Critics Choice](award/choice) | `choice` | Critics Choice Awards 2020 | ✅ | ✅ |
|
||||||
|
| [Emmys](award/emmy) | `emmy` | Emmys 2021 | ✅ | ✅ |
|
||||||
|
| [Golden Globes](award/golden) | `golden` | Best Motion Pictures | ✅ | ✅ |
|
||||||
|
| [Academy Awards (Oscars)](award/oscars) | `oscars` | Best Picture Winners | ✅ | ✅ |
|
||||||
|
| [Independent Spirit](award/spirit) | `spirit` | Independent Spirit Awards 2021 | ✅ | ❌ |
|
||||||
|
| [Sundance](award/sundance) | `sundance` | Sundance Grand Jury Winners | ✅ | ✅ |
|
||||||
|
| [Other](award/other) | `other_award` | Berlinale Golden Bears, Venice Golden Lions | ✅ | ❌ |
|
||||||
|
|
||||||
|
### General Collections
|
||||||
|
|
||||||
|
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|
||||||
|
|:------------------------------------------------------------------------------------|:--------------------:|:-------------------------------------------------------|:-----------------:|:----------------:|
|
||||||
|
| [Actor](both/actor) | `actor` | Chris Hemsworth, Margot Robbie | ✅ | ✅ |
|
||||||
|
| [Audio Language](both/audio_language) | `audio_language` | French Audio, Korean Audio | ✅ | ✅ |
|
||||||
|
| [Collectionless](both/collectionless) | `collectionless` | Collectionless | ✅ | ✅ |
|
||||||
|
| [Common Sense Content Rating](both/content_rating_cs) | `content_rating_cs` | 1, 2, 3, 4, 5, 6, 15, 16, 17, 18 | ✅ | ✅ |
|
||||||
|
| [MyAnimeList Content Rating](both/content_rating_mal) | `content_rating_mal` | G, PG, PG-13, R, R+, Rx | ✅ | ✅ |
|
||||||
|
| [Content Rating (UK)](both/content_rating_uk) | `content_rating_uk` | U, PG, 12A | ✅ | ✅ |
|
||||||
|
| Content Rating (US) [Movie](movie/content_rating_us)/[Show](show/content_rating_us) | `content_rating_us` | G, PG, NC-17 | ✅ | ✅ |
|
||||||
|
| Country [Movie](movie/country)/[Show](show/country) | `country` | Belgium, India | ✅ | ✅ |
|
||||||
|
| Decade [Movie](movie/decade)/[Show](show/decade) | `decade` | Best of 2012, Best of 2022 | ✅ | ✅ |
|
||||||
|
| [Director](movie/director) | `director` | Steven Spielberg (Director), Olivia Wilde (Director) | ✅ | ❌ |
|
||||||
|
| Franchise [Movie](movie/franchise)/[Show](show/franchise) | `franchise` | Star Wars: Skywalker Saga, Godzilla (Anime) | ✅ | ✅ |
|
||||||
|
| [Genre](both/genre) | `genre` | Action, Drama, Science Fiction | ✅ | ✅ |
|
||||||
|
| [Network](show/network) | `network` | Disney Channel, Lifetime | ❌ | ✅ |
|
||||||
|
| [Producer](movie/producer) | `producer` | James Cameron (Producer), Reese Witherspoon (Producer) | ✅ | ❌ |
|
||||||
|
| [Resolution](both/resolution) | `resolution` | 4K Movies, 1080p Movies, 720p Movies | ✅ | ✅ |
|
||||||
|
| [Seasonal](movie/seasonal) | `seasonal` | Easter, Christmas | ✅ | ❌ |
|
||||||
|
| [Streaming](both/streaming) | `streaming` | Disney+ Movies, HBO Max Shows | ✅ | ✅ |
|
||||||
|
| [Studio](both/studio) | `studio` | DreamWorks Studios, Walt Disney Pictures | ✅ | ✅ |
|
||||||
|
| [Anime Studio](both/studio_anime) | `studio_anime` | Bones, Studio Ghibli, Toei Animation | ✅ | ✅ |
|
||||||
|
| [Subtitle Language](both/subtitle_language) | `subtitle_language` | German Subtitles, Swedish Subtitles | ✅ | ✅ |
|
||||||
|
| [Universe](movie/universe) | `universe` | Marvel Cinematic Universal, Wizarding World | ✅ | ❌ |
|
||||||
|
| [Year](both/year) | `year` | Best of 2010, Best of 2019 | ✅ | ✅ |
|
||||||
|
| [Writer](movie/writer) | `writer` | James Cameron (Writer), Lilly Wachowski (Writer) | ✅ | ❌ |
|
||||||
@ -1,63 +1,191 @@
|
|||||||
## Collections
|
# Collection Defaults
|
||||||
|
|
||||||
These files can generally be used on both Movie and Show library-types, or are part of a category of collection (such as Award Shows.)
|
There are many Default Metadata Files built into PMM itself which offer an easy-to-use and customizable set of Collections that the user can achieve without having to worry about creating the files that makes the collections possible.
|
||||||
|
|
||||||
These collections are applied by calling the below paths into the `metadata_path` section of your config.yml
|
This is the simplest way to create Collections using Plex Meta Manager.
|
||||||
|
|
||||||
### Chart Collections
|
## Metadata Files
|
||||||
|
|
||||||
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|
```{include} collection_list.md
|
||||||
|:-----------------------------------|:-----------------:|:-------------------------------------------|:-----------------:|:----------------:|
|
```
|
||||||
| [Chart Separator](chart/separator) | `separator_chart` | Chart Collections | ✅ | ✅ |
|
|
||||||
| [AniList](chart/anilist) | `anilist` | AniList Popular, AniList Season | ✅ | ✅ |
|
## Configurations
|
||||||
| [Basic](chart/basic) | `basic` | Newly Released, New Episodes | ✅ | ✅ |
|
|
||||||
| [FlixPatrol](chart/flixpatrol) | `flixpatrol` | Top Disney, Top Hbo, Top Hulu, Top Netflix | ✅ | ✅ |
|
To run a default pmm Metadata file you can simply add it to your `metadata_path` using `pmm` like so:
|
||||||
| [IMDb](chart/imdb) | `imdb` | IMDb Popular, IMDb Top 250 | ✅ | ✅ |
|
|
||||||
| [MyAnimeList](chart/myanimelist) | `myanimelist` | MyAnimeList Popular, MyAnimeList Top Rated | ✅ | ✅ |
|
```yaml
|
||||||
| [Other](chart/other) | `other_chart` | AniDB Popular, Common Sense Selection | ✅ | ✅ |
|
libraries:
|
||||||
| [Tautulli](chart/tautulli) | `tautulli` | Plex Popular, Plex Watched | ✅ | ✅ |
|
Movies:
|
||||||
| [TMDb](chart/tmdb) | `tmdb` | TMDb Popular, TMDb Airing Today | ✅ | ✅ |
|
metadata_path:
|
||||||
| [Trakt](chart/trakt) | `trakt` | Trakt Popular, Trakt Trending | ✅ | ✅ |
|
- pmm: actor
|
||||||
|
- pmm: genre
|
||||||
### Award Collections
|
```
|
||||||
|
|
||||||
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|
## Separators
|
||||||
|:-----------------------------------------------------------|:-----------------:|:--------------------------------------------|:-----------------:|:----------------:|
|
|
||||||
| [Award Separator](award/separator) | `separator_award` | Award Collections | ✅ | ✅ |
|
Most Metadata files use separators to denote different sections of collection like actor collections vs studio collections.
|
||||||
| [British Academy of Film and Television Arts](award/bafta) | `bafta` | BAFTA Best Films, BAFTA 2021 | ✅ | ❌ |
|
|
||||||
| [Cannes](award/cannes) | `cannes` | Cannes - Palme d'or, Cannes 2018 | ✅ | ❌ |
|
**Chart Separator and Award Separator each have their own file, while the other Separators are part of their respective files.**
|
||||||
| [Critics Choice](award/choice) | `choice` | Critics Choice Awards 2020 | ✅ | ✅ |
|
|
||||||
| [Emmys](award/emmy) | `emmy` | Emmys 2021 | ✅ | ✅ |
|
<details>
|
||||||
| [Golden Globes](award/golden) | `golden` | Best Motion Pictures | ✅ | ✅ |
|
<summary>Click to expand to see an example of Separators.</summary>
|
||||||
| [Academy Awards (Oscars)](award/oscars) | `oscars` | Best Picture Winners | ✅ | ✅ |
|
|
||||||
| [Independent Spirit](award/spirit) | `spirit` | Independent Spirit Awards 2021 | ✅ | ❌ |
|
|
||||||
| [Sundance](award/sundance) | `sundance` | Sundance Grand Jury Winners | ✅ | ✅ |
|
|
||||||
| [Other](award/other) | `other_award` | Berlinale Golden Bears, Venice Golden Lions | ✅ | ❌ |
|
</details>
|
||||||
|
|
||||||
### General Collections
|
### Library On/Off
|
||||||
|
|
||||||
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|
Chart Separators are turned On by default (except `seasonal`), to turn the Separators On/Off on a per Library basis.
|
||||||
|:------------------------------------------------------------------------------------|:--------------------:|:-------------------------------------------------------|:-----------------:|:----------------:|
|
|
||||||
| [Actor](both/actor) | `actor` | Chris Hemsworth, Margot Robbie | ✅ | ✅ |
|
```yaml
|
||||||
| [Audio Language](both/audio_language) | `audio_language` | French Audio, Korean Audio | ✅ | ✅ |
|
libraries:
|
||||||
| [Collectionless](both/collectionless) | `collectionless` | Collectionless | ✅ | ✅ |
|
LIBRARYNAME:
|
||||||
| [Common Sense Content Rating](both/content_rating_cs) | `content_rating_cs` | 1, 2, 3, 4, 5, 6, 15, 16, 17, 18 | ✅ | ✅ |
|
template_variables:
|
||||||
| [MyAnimeList Content Rating](both/content_rating_mal) | `content_rating_mal` | G, PG, PG-13, R, R+, Rx | ✅ | ✅ |
|
use_separator: false
|
||||||
| [Content Rating (UK)](both/content_rating_uk) | `content_rating_uk` | U, PG, 12A | ✅ | ✅ |
|
metadata_path:
|
||||||
| Content Rating (US) [Movie](movie/content_rating_us)/[Show](show/content_rating_us) | `content_rating_us` | G, PG, NC-17 | ✅ | ✅ |
|
- pmm: actor
|
||||||
| Country [Movie](movie/country)/[Show](show/country) | `country` | Belgium, India | ✅ | ✅ |
|
- pmm: genre
|
||||||
| Decade [Movie](movie/decade)/[Show](show/decade) | `decade` | Best of 2012, Best of 2022 | ✅ | ✅ |
|
```
|
||||||
| [Director](movie/director) | `director` | Steven Spielberg (Director), Olivia Wilde (Director) | ✅ | ❌ |
|
|
||||||
| Franchise [Movie](movie/franchise)/[Show](show/franchise) | `franchise` | Star Wars: Skywalker Saga, Godzilla (Anime) | ✅ | ✅ |
|
## Collection Section Order
|
||||||
| [Genre](both/genre) | `genre` | Action, Drama, Science Fiction | ✅ | ✅ |
|
|
||||||
| [Network](show/network) | `network` | Disney Channel, Lifetime | ❌ | ✅ |
|
All Default Metadata Files have a `collection_section` attribute. These attributes determine the order of the various sections and can be set by [customizing your config](#customizing-configs).
|
||||||
| [Producer](movie/producer) | `producer` | James Cameron (Producer), Reese Witherspoon (Producer) | ✅ | ❌ |
|
|
||||||
| [Resolution](both/resolution) | `resolution` | 4K Movies, 1080p Movies, 720p Movies | ✅ | ✅ |
|
For example: `collection_section: 01` translates to `sort_title: "!<<collection_section>><<pre>><<order_<<key>>>><<sort>>"` and so for `genre` if you have a `Fantasy` collection, plex is going to show `!06_Fantasy`
|
||||||
| [Seasonal](movie/seasonal) | `seasonal` | Easter, Christmas | ✅ | ❌ |
|
|
||||||
| [Streaming](both/streaming) | `streaming` | Disney+ Movies, HBO Max Shows | ✅ | ✅ |
|
This is the default PMM collection ordering:
|
||||||
| [Studio](both/studio) | `studio` | DreamWorks Studios, Walt Disney Pictures | ✅ | ✅ |
|
|
||||||
| [Anime Studio](both/studio_anime) | `studio_anime` | Bones, Studio Ghibli, Toei Animation | ✅ | ✅ |
|
| Collection | Collection Section |
|
||||||
| [Subtitle Language](both/subtitle_language) | `subtitle_language` | German Subtitles, Swedish Subtitles | ✅ | ✅ |
|
|:-----------------------|:------------------:|
|
||||||
| [Universe](movie/universe) | `universe` | Marvel Cinematic Universal, Wizarding World | ✅ | ❌ |
|
| `seasonal` | `00` |
|
||||||
| [Year](both/year) | `year` | Best of 2010, Best of 2019 | ✅ | ✅ |
|
| `anilist` | `01` |
|
||||||
| [Writer](movie/writer) | `writer` | James Cameron (Writer), Lilly Wachowski (Writer) | ✅ | ❌ |
|
| `basic` | `01` |
|
||||||
|
| `imdb` | `01` |
|
||||||
|
| `flixpatrol` | `01` |
|
||||||
|
| `myanimelist` | `01` |
|
||||||
|
| `other_chart` | `01` |
|
||||||
|
| `tautulli` | `01` |
|
||||||
|
| `tmdb` | `01` |
|
||||||
|
| `trakt` | `01` |
|
||||||
|
| `universe` | `02` |
|
||||||
|
| `streaming` | `03` |
|
||||||
|
| `network` | `04` |
|
||||||
|
| `genre` | `06` |
|
||||||
|
| `studio` | `07` |
|
||||||
|
| `country` | `09` |
|
||||||
|
| `audio_language` | `10` |
|
||||||
|
| `subtitle_language` | `11` |
|
||||||
|
| `decade` | `12` |
|
||||||
|
| `year` | `13` |
|
||||||
|
| `content_rating_us` | `14` |
|
||||||
|
| `content_rating_uk` | `14` |
|
||||||
|
| `content_rating_cs` | `14` |
|
||||||
|
| `resolution` | `15` |
|
||||||
|
| `resolution_standards` | `15` |
|
||||||
|
| `bafta` | `16` |
|
||||||
|
| `cannes` | `16` |
|
||||||
|
| `choice` | `16` |
|
||||||
|
| `emmy` | `16` |
|
||||||
|
| `golden` | `16` |
|
||||||
|
| `oscars` | `16` |
|
||||||
|
| `other_award` | `16` |
|
||||||
|
| `spirit` | `16` |
|
||||||
|
| `sundance` | `16` |
|
||||||
|
| `actor` | `17` |
|
||||||
|
| `director` | `18` |
|
||||||
|
| `producer` | `19` |
|
||||||
|
| `writer` | `20` |
|
||||||
|
|
||||||
|
## 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:
|
||||||
|
metadata_path:
|
||||||
|
- pmm: imdb
|
||||||
|
template_variables:
|
||||||
|
use_popular: false
|
||||||
|
use_lowest: false
|
||||||
|
visible_library_top: true
|
||||||
|
visible_home_top: true
|
||||||
|
visible_shared_top: true
|
||||||
|
```
|
||||||
|
|
||||||
|
Each file has a page on the wiki showing the available `template_variables` for each file. For example the default `pmm: genre` has a page [here](both/genre).
|
||||||
|
|
||||||
|
**In addition to the defined `template_variables` almost all default Metadata files have access to the [Shared Variables](collection_variables).**
|
||||||
|
|
||||||
|
### Examples
|
||||||
|
|
||||||
|
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: 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
|
||||||
|
```
|
||||||
|
|
||||||
|
```{include} example.md
|
||||||
|
```
|
||||||
@ -1,191 +0,0 @@
|
|||||||
# Collection Defaults
|
|
||||||
|
|
||||||
There are many Default Metadata Files built into PMM itself which offer an easy-to-use and customizable set of Collections that the user can achieve without having to worry about creating the files that makes the collections possible.
|
|
||||||
|
|
||||||
This is the simplest way to create Collections using Plex Meta Manager.
|
|
||||||
|
|
||||||
## Metadata Files
|
|
||||||
|
|
||||||
```{include} collections.md
|
|
||||||
```
|
|
||||||
|
|
||||||
## Configurations
|
|
||||||
|
|
||||||
To run a default pmm Metadata file you can simply add it to your `metadata_path` using `pmm` like so:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
libraries:
|
|
||||||
Movies:
|
|
||||||
metadata_path:
|
|
||||||
- pmm: actor
|
|
||||||
- pmm: genre
|
|
||||||
```
|
|
||||||
|
|
||||||
## Separators
|
|
||||||
|
|
||||||
Most Metadata files use separators to denote different sections of collection like actor collections vs studio collections.
|
|
||||||
|
|
||||||
**Chart Separator and Award Separator each have their own file, while the other Separators are part of their respective files.**
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Click to expand to see an example of Separators.</summary>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
### Library On/Off
|
|
||||||
|
|
||||||
Chart Separators are turned On by default (except `seasonal`), to turn the Separators On/Off on a per Library basis.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
libraries:
|
|
||||||
LIBRARYNAME:
|
|
||||||
template_variables:
|
|
||||||
use_separator: false
|
|
||||||
metadata_path:
|
|
||||||
- pmm: actor
|
|
||||||
- pmm: genre
|
|
||||||
```
|
|
||||||
|
|
||||||
## Collection Section Order
|
|
||||||
|
|
||||||
All Default Metadata Files have 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` if you have a `Fantasy` collection, plex is going to show `!06_Fantasy`
|
|
||||||
|
|
||||||
This is the default PMM collection ordering:
|
|
||||||
|
|
||||||
| Collection | Collection Section |
|
|
||||||
|:-----------------------|:------------------:|
|
|
||||||
| `seasonal` | `00` |
|
|
||||||
| `anilist` | `01` |
|
|
||||||
| `basic` | `01` |
|
|
||||||
| `imdb` | `01` |
|
|
||||||
| `flixpatrol` | `01` |
|
|
||||||
| `myanimelist` | `01` |
|
|
||||||
| `other_chart` | `01` |
|
|
||||||
| `tautulli` | `01` |
|
|
||||||
| `tmdb` | `01` |
|
|
||||||
| `trakt` | `01` |
|
|
||||||
| `universe` | `02` |
|
|
||||||
| `streaming` | `03` |
|
|
||||||
| `network` | `04` |
|
|
||||||
| `genre` | `06` |
|
|
||||||
| `studio` | `07` |
|
|
||||||
| `country` | `09` |
|
|
||||||
| `audio_language` | `10` |
|
|
||||||
| `subtitle_language` | `11` |
|
|
||||||
| `decade` | `12` |
|
|
||||||
| `year` | `13` |
|
|
||||||
| `content_rating_us` | `14` |
|
|
||||||
| `content_rating_uk` | `14` |
|
|
||||||
| `content_rating_cs` | `14` |
|
|
||||||
| `resolution` | `15` |
|
|
||||||
| `resolution_standards` | `15` |
|
|
||||||
| `bafta` | `16` |
|
|
||||||
| `cannes` | `16` |
|
|
||||||
| `choice` | `16` |
|
|
||||||
| `emmy` | `16` |
|
|
||||||
| `golden` | `16` |
|
|
||||||
| `oscars` | `16` |
|
|
||||||
| `other_award` | `16` |
|
|
||||||
| `spirit` | `16` |
|
|
||||||
| `sundance` | `16` |
|
|
||||||
| `actor` | `17` |
|
|
||||||
| `director` | `18` |
|
|
||||||
| `producer` | `19` |
|
|
||||||
| `writer` | `20` |
|
|
||||||
|
|
||||||
## 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:
|
|
||||||
metadata_path:
|
|
||||||
- pmm: imdb
|
|
||||||
template_variables:
|
|
||||||
use_popular: false
|
|
||||||
use_lowest: false
|
|
||||||
visible_library_top: true
|
|
||||||
visible_home_top: true
|
|
||||||
visible_shared_top: true
|
|
||||||
```
|
|
||||||
|
|
||||||
Each file has a page on the wiki showing the available `template_variables` for each file. For example the default `pmm: genre` has a page [here](both/genre).
|
|
||||||
|
|
||||||
**In addition to the defined `template_variables` almost all default Metadata files have access to the [Shared Variables](variables).**
|
|
||||||
|
|
||||||
### Examples
|
|
||||||
|
|
||||||
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: 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
|
|
||||||
```
|
|
||||||
|
|
||||||
```{include} example.md
|
|
||||||
```
|
|
||||||
@ -0,0 +1,30 @@
|
|||||||
|
## Overlays
|
||||||
|
|
||||||
|
These files apply overlays and can generally be used on both Movie and Show library-types, and often works at the season and episode-level too.
|
||||||
|
|
||||||
|
It should be noted that when an overlay has ❗ for a season or episode, it normally means that whilst the overlay can technically be applied at the level, it wasn't designed for this purpose. For example, a show's season cannot have a resolution since it is not a video file, and an episode cannot have a commonsense age-rating since only Movies and Shows are rated by CommonSense.
|
||||||
|
|
||||||
|
In the scenario where there is missing data such as age ratings for episodes, then generally the highest-level data available will be applied at the lower level (i.e. a Show's CommonSense age rating would apply to all episodes).
|
||||||
|
|
||||||
|
These overlays are applied by calling the below paths into the `overlay_path` [section](../config/libraries.md#overlay-path) of your config.yml
|
||||||
|
|
||||||
|
### Overlay Files
|
||||||
|
|
||||||
|
| Default | path | Example Overlays | Movies | Shows | Seasons | Episodes |
|
||||||
|
|:-----------------------------------------------|:----------------:|:--------------------------------------------------------------------------|:--------:|:---------:|:---------:|:--------:|
|
||||||
|
| [Audio Codec](overlays/audio_codec) | `audio_codec` | Dolby Atmos logo, DTS logo | ✅ | ✅ | ✅ | ✅ |
|
||||||
|
| [CommonSense Age Rating](overlays/commonsense) | `commonsense` | "3+", "16+" | ✅ | ✅ | ❗ | ❗ |
|
||||||
|
| [Direct Play](overlays/direct_play) | `direct_play` | "Direct Play Only" | ✅ | ❗ | ❗ | ✅ |
|
||||||
|
| [Episode Info](overlays/episode_info) | `episode_info` | "S01E01", "S02E09" | ❌ | ❌ | ❌ | ✅ |
|
||||||
|
| [FlixPatrol](overlays/flixpatrol) | `flixpatrol` | "Streaming service logo with words "TOP" | ✅ | ✅ | ❌ | ❌ |
|
||||||
|
| [Language Count](overlays/language_count) | `language_count` | Dual-Audio, Multi-Audio, Dual-Subtitle, Multi-Subtitle | ✅ | ✅ | ✅ | ✅ |
|
||||||
|
| [Languages](overlays/languages) | `languages` | Flags Based on the Audio/Subtitles a file has | ✅ | ✅ | ✅ | ✅ |
|
||||||
|
| [Mediastinger](overlays/mediastinger) | `mediastinger` | Mediastinger Logo for After/During Credit Scenes | ✅ | ✅ | ❌ | ❌ |
|
||||||
|
| [Ratings](overlays/ratings) | `ratings` | IMDb Audience Rating, Metacritic Critic Rating | ✅ | ✅ | ❌ | ✅ |
|
||||||
|
| [Resolution/Editions](overlays/resolution) | `resolution` | 4K Dolby Vision logo, 720P logo, "Director's Cut", "Criterion Collection" | ✅ | ✅ | ❌ | ✅ |
|
||||||
|
| [Ribbon](overlays/ribbon) | `ribbon` | IMDb Top 250 Ribbon, RT Fresh Ribbon | ✅ | ✅ | ❌ | ❌ |
|
||||||
|
| [Runtimes](overlays/runtimes) | `runtimes` | "Runtime: 1h 30m" | ✅ | ✅ | ❌ | ❌ |
|
||||||
|
| [Status](overlays/status) | `status` | Airing, Returning, Canceled, Ended | ❌ | ✅ | ❌ | ❌ |
|
||||||
|
| [Streaming](overlays/streaming) | `streaming` | Netflix logo, Hulu logo | ✅ | ✅ | ❌ | ❌ |
|
||||||
|
| [Versions](overlays/versions) | `versions` | Multiple Versions logo | ✅ | ✅ | ✅ | ✅ |
|
||||||
|
| [Video Format](overlays/video_format) | `video_format` | "REMUX", "HDTV" | ✅ | ❗ | ❗ | ✅ |
|
||||||
@ -1,30 +1,243 @@
|
|||||||
|
# Overlay Defaults
|
||||||
|
|
||||||
|
There are many Default Overlay Files built into PMM itself which offer an easy-to-use and customizable set of Overlays that the user can achieve without having to worry about creating the files that makes the overlays possible.
|
||||||
|
|
||||||
|
This is the simplest way to create Overlays using Plex Meta Manager.
|
||||||
|
|
||||||
|
## Overlay Files
|
||||||
|
|
||||||
|
```{include} overlay_list.md
|
||||||
|
```
|
||||||
|
|
||||||
|
## Configurations
|
||||||
|
|
||||||
|
To run a default pmm Overlay file you can simply add it to your `overlay_path` using `pmm` like so:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
libraries:
|
||||||
|
Movies:
|
||||||
|
overlay_path:
|
||||||
|
- pmm: ribbon
|
||||||
|
- pmm: ratings
|
||||||
|
```
|
||||||
|
|
||||||
## Overlays
|
## Overlays
|
||||||
|
|
||||||
These files apply overlays and can generally be used on both Movie and Show library-types, and often works at the season and episode-level too.
|
The default set of overlays are a combination of Positional Overlays and Text Overlays.
|
||||||
|
|
||||||
It should be noted that when an overlay has ❗ for a season or episode, it normally means that whilst the overlay can technically be applied at the level, it wasn't designed for this purpose. For example, a show's season cannot have a resolution since it is not a video file, and an episode cannot have a commonsense age-rating since only Movies and Shows are rated by CommonSense.
|
### Example Poster Overlays
|
||||||
|
|
||||||
In the scenario where there is missing data such as age ratings for episodes, then generally the highest-level data available will be applied at the lower level (i.e. a Show's CommonSense age rating would apply to all episodes).
|
|
||||||
|
|
||||||
These overlays are applied by calling the below paths into the `overlay_path` [section](../config/libraries.md#overlay-path) of your config.yml
|
|
||||||
|
<details>
|
||||||
### Overlay Files
|
<summary>Click to expand sample config.yml Movies overlays section:</summary>
|
||||||
|
|
||||||
| Default | path | Example Overlays | Movies | Shows | Seasons | Episodes |
|
**Note: This uses fonts not packaged with PMM. See [bullmoose20's Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/bullmoose20)**
|
||||||
|:-----------------------------------------------|:----------------:|:--------------------------------------------------------------------------|:--------:|:---------:|:---------:|:--------:|
|
|
||||||
| [Audio Codec](overlays/audio_codec) | `audio_codec` | Dolby Atmos logo, DTS logo | ✅ | ✅ | ✅ | ✅ |
|
```yaml
|
||||||
| [CommonSense Age Rating](overlays/commonsense) | `commonsense` | "3+", "16+" | ✅ | ✅ | ❗ | ❗ |
|
libraries:
|
||||||
| [Direct Play](overlays/direct_play) | `direct_play` | "Direct Play Only" | ✅ | ❗ | ❗ | ✅ |
|
Movies:
|
||||||
| [Episode Info](overlays/episode_info) | `episode_info` | "S01E01", "S02E09" | ❌ | ❌ | ❌ | ✅ |
|
overlay_path:
|
||||||
| [FlixPatrol](overlays/flixpatrol) | `flixpatrol` | "Streaming service logo with words "TOP" | ✅ | ✅ | ❌ | ❌ |
|
- remove_overlays: false
|
||||||
| [Language Count](overlays/language_count) | `language_count` | Dual-Audio, Multi-Audio, Dual-Subtitle, Multi-Subtitle | ✅ | ✅ | ✅ | ✅ |
|
- reapply_overlay: true
|
||||||
| [Languages](overlays/languages) | `languages` | Flags Based on the Audio/Subtitles a file has | ✅ | ✅ | ✅ | ✅ |
|
- pmm: resolution # 1
|
||||||
| [Mediastinger](overlays/mediastinger) | `mediastinger` | Mediastinger Logo for After/During Credit Scenes | ✅ | ✅ | ❌ | ❌ |
|
- pmm: audio_codec # 2
|
||||||
| [Ratings](overlays/ratings) | `ratings` | IMDb Audience Rating, Metacritic Critic Rating | ✅ | ✅ | ❌ | ✅ |
|
- pmm: mediastinger # 3
|
||||||
| [Resolution/Editions](overlays/resolution) | `resolution` | 4K Dolby Vision logo, 720P logo, "Director's Cut", "Criterion Collection" | ✅ | ✅ | ❌ | ✅ |
|
- pmm: special_release # 4
|
||||||
| [Ribbon](overlays/ribbon) | `ribbon` | IMDb Top 250 Ribbon, RT Fresh Ribbon | ✅ | ✅ | ❌ | ❌ |
|
- pmm: ratings # 5, 6, 7
|
||||||
| [Runtimes](overlays/runtimes) | `runtimes` | "Runtime: 1h 30m" | ✅ | ✅ | ❌ | ❌ |
|
template_variables:
|
||||||
| [Status](overlays/status) | `status` | Airing, Returning, Canceled, Ended | ❌ | ✅ | ❌ | ❌ |
|
rating1: user # 5 as this is user and mass_user_rating_update: mdb_tomatoes
|
||||||
| [Streaming](overlays/streaming) | `streaming` | Netflix logo, Hulu logo | ✅ | ✅ | ❌ | ❌ |
|
rating1_image: rt_tomato # 5 as this is user and mass_user_rating_update: mdb_tomatoes
|
||||||
| [Versions](overlays/versions) | `versions` | Multiple Versions logo | ✅ | ✅ | ✅ | ✅ |
|
rating1_font: config/custom_fonts/Adlib.ttf # 5 local font accessible to PMM
|
||||||
| [Video Format](overlays/video_format) | `video_format` | "REMUX", "HDTV" | ✅ | ❗ | ❗ | ✅ |
|
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/custom_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/custom_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: streaming # 8
|
||||||
|
- pmm: video_format # 9
|
||||||
|
- pmm: audio_language # 10
|
||||||
|
- pmm: ribbon # 11, 12 Bottom right sash is used by more than one overlay so a weight for priority can be applied
|
||||||
|
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
|
||||||
|
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Click to expand sample config.yml TV Shows overlays section for the Show Poster:</summary>
|
||||||
|
|
||||||
|
**Note: This uses fonts not packaged with PMM. See [bullmoose20's Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/bullmoose20)**
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
libraries:
|
||||||
|
TV Shows:
|
||||||
|
overlay_path:
|
||||||
|
- remove_overlays: false
|
||||||
|
- reapply_overlay: true
|
||||||
|
- pmm: resolution # 1
|
||||||
|
- pmm: audio_codec # 2
|
||||||
|
- pmm: mediastinger # 3
|
||||||
|
- pmm: 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/custom_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/custom_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/custom_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: streaming # 7
|
||||||
|
- pmm: video_format # 8
|
||||||
|
- pmm: ribbon # 10, 11 Bottom right sash is used by more than one overlay so a weight for priority can be applied
|
||||||
|
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
|
||||||
|
|
||||||
|
|
||||||
|
<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: resolution # 1
|
||||||
|
template_variables:
|
||||||
|
overlay_level: season
|
||||||
|
- pmm: audio_codec # 2
|
||||||
|
template_variables:
|
||||||
|
overlay_level: season
|
||||||
|
- pmm: video_format # 3
|
||||||
|
template_variables:
|
||||||
|
overlay_level: season
|
||||||
|
```
|
||||||
|
</details>
|
||||||
|
|
||||||
|
### Example TV Shows - Episode Overlays
|
||||||
|
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Click to expand sample config.yml TV Shows overlays section for the Episode Poster:</summary>
|
||||||
|
|
||||||
|
**Note: This uses fonts not packaged with PMM. See [bullmoose20's Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/bullmoose20)**
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
libraries:
|
||||||
|
TV Shows:
|
||||||
|
overlay_path:
|
||||||
|
- remove_overlays: false
|
||||||
|
- reapply_overlay: true
|
||||||
|
- pmm: resolution # 1
|
||||||
|
template_variables:
|
||||||
|
overlay_level: episode
|
||||||
|
- pmm: audio_codec # 2
|
||||||
|
template_variables:
|
||||||
|
overlay_level: episode
|
||||||
|
- pmm: 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/custom_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/custom_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: video_format # 5
|
||||||
|
template_variables:
|
||||||
|
overlay_level: episode
|
||||||
|
- pmm: episode_info # 6
|
||||||
|
template_variables:
|
||||||
|
overlay_level: episode
|
||||||
|
- pmm: 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>
|
||||||
|
|
||||||
|
## Rating 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**
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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**
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
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`)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## 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: ratings
|
||||||
|
template_variables:
|
||||||
|
overlay_level: episode
|
||||||
|
```
|
||||||
|
|
||||||
|
Each file has a page on the wiki showing the available `template_variables` for each file. For example the default `pmm: ratings` has a page [here](ratings).
|
||||||
|
|
||||||
|
**In addition to the defined `template_variables` almost all default Overlay files have access to the [Shared Variables](collection_variables).**
|
||||||
|
|
||||||
|
### Examples
|
||||||
|
|
||||||
|
```{include} example.md
|
||||||
|
```
|
||||||
@ -1,243 +0,0 @@
|
|||||||
# Overlay Defaults
|
|
||||||
|
|
||||||
There are many Default Overlay Files built into PMM itself which offer an easy-to-use and customizable set of Overlays that the user can achieve without having to worry about creating the files that makes the overlays possible.
|
|
||||||
|
|
||||||
This is the simplest way to create Overlays using Plex Meta Manager.
|
|
||||||
|
|
||||||
## Overlay Files
|
|
||||||
|
|
||||||
```{include} ../overlays.md
|
|
||||||
```
|
|
||||||
|
|
||||||
## Configurations
|
|
||||||
|
|
||||||
To run a default pmm Overlay file you can simply add it to your `overlay_path` using `pmm` like so:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
libraries:
|
|
||||||
Movies:
|
|
||||||
overlay_path:
|
|
||||||
- pmm: ribbon
|
|
||||||
- pmm: ratings
|
|
||||||
```
|
|
||||||
|
|
||||||
## Overlays
|
|
||||||
|
|
||||||
The default set of overlays are a combination of Positional Overlays and Text Overlays.
|
|
||||||
|
|
||||||
### Example Poster Overlays
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Click to expand sample config.yml Movies overlays section:</summary>
|
|
||||||
|
|
||||||
**Note: This uses fonts not packaged with PMM. See [bullmoose20's Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/bullmoose20)**
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
libraries:
|
|
||||||
Movies:
|
|
||||||
overlay_path:
|
|
||||||
- remove_overlays: false
|
|
||||||
- reapply_overlay: true
|
|
||||||
- pmm: resolution # 1
|
|
||||||
- pmm: audio_codec # 2
|
|
||||||
- pmm: mediastinger # 3
|
|
||||||
- pmm: special_release # 4
|
|
||||||
- pmm: 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/custom_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/custom_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/custom_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: streaming # 8
|
|
||||||
- pmm: video_format # 9
|
|
||||||
- pmm: audio_language # 10
|
|
||||||
- pmm: ribbon # 11, 12 Bottom right sash is used by more than one overlay so a weight for priority can be applied
|
|
||||||
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
|
|
||||||
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Click to expand sample config.yml TV Shows overlays section for the Show Poster:</summary>
|
|
||||||
|
|
||||||
**Note: This uses fonts not packaged with PMM. See [bullmoose20's Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/bullmoose20)**
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
libraries:
|
|
||||||
TV Shows:
|
|
||||||
overlay_path:
|
|
||||||
- remove_overlays: false
|
|
||||||
- reapply_overlay: true
|
|
||||||
- pmm: resolution # 1
|
|
||||||
- pmm: audio_codec # 2
|
|
||||||
- pmm: mediastinger # 3
|
|
||||||
- pmm: 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/custom_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/custom_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/custom_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: streaming # 7
|
|
||||||
- pmm: video_format # 8
|
|
||||||
- pmm: ribbon # 10, 11 Bottom right sash is used by more than one overlay so a weight for priority can be applied
|
|
||||||
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
|
|
||||||
|
|
||||||
|
|
||||||
<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: resolution # 1
|
|
||||||
template_variables:
|
|
||||||
overlay_level: season
|
|
||||||
- pmm: audio_codec # 2
|
|
||||||
template_variables:
|
|
||||||
overlay_level: season
|
|
||||||
- pmm: video_format # 3
|
|
||||||
template_variables:
|
|
||||||
overlay_level: season
|
|
||||||
```
|
|
||||||
</details>
|
|
||||||
|
|
||||||
### Example TV Shows - Episode Overlays
|
|
||||||
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Click to expand sample config.yml TV Shows overlays section for the Episode Poster:</summary>
|
|
||||||
|
|
||||||
**Note: This uses fonts not packaged with PMM. See [bullmoose20's Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/bullmoose20)**
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
libraries:
|
|
||||||
TV Shows:
|
|
||||||
overlay_path:
|
|
||||||
- remove_overlays: false
|
|
||||||
- reapply_overlay: true
|
|
||||||
- pmm: resolution # 1
|
|
||||||
template_variables:
|
|
||||||
overlay_level: episode
|
|
||||||
- pmm: audio_codec # 2
|
|
||||||
template_variables:
|
|
||||||
overlay_level: episode
|
|
||||||
- pmm: 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/custom_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/custom_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: video_format # 5
|
|
||||||
template_variables:
|
|
||||||
overlay_level: episode
|
|
||||||
- pmm: episode_info # 6
|
|
||||||
template_variables:
|
|
||||||
overlay_level: episode
|
|
||||||
- pmm: 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>
|
|
||||||
|
|
||||||
## Rating 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**
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
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**
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
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)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
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`)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 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: ratings
|
|
||||||
template_variables:
|
|
||||||
overlay_level: episode
|
|
||||||
```
|
|
||||||
|
|
||||||
Each file has a page on the wiki showing the available `template_variables` for each file. For example the default `pmm: ratings` has a page [here](ratings).
|
|
||||||
|
|
||||||
**In addition to the defined `template_variables` almost all default Overlay files have access to the [Shared Variables](variables).**
|
|
||||||
|
|
||||||
### Examples
|
|
||||||
|
|
||||||
```{include} ../example.md
|
|
||||||
```
|
|
||||||
Loading…
Reference in new issue