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

Standardize Defaults Requirements & Recommendations

Browse source
This commit is contained in:
YozoraXCII 2023-01-21 00:20:33 +00:00
parent c929d5631e
commit 25f9badf71
64 changed files with 307 additions and 152 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -2,12 +2,14 @@
The `bafta` Default Metadata File is used to create collections based on the British Academy of Film and Television Arts Awards.
This Default file requires [Trakt Authentication](../../config/trakt)
**This file only works with Movie Libraries.**
![](../images/bafta.png)
## Requirements & Recommendations
Supported Library Types: Movie
Requirements: [Trakt Authentication](../../config/trakt)
## Collections Section 16
| Collection | Key | Description |

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

@ -2,12 +2,14 @@
The `cannes` Default Metadata File is used to create collections based on the Cannes Film Awards.
This Default file requires [Trakt Authentication](../../config/trakt)
**This file only works with Movie Libraries.**
![](../images/cannes.png)
## Requirements & Recommendations
Supported Library Types: Movie
Requirements: [Trakt Authentication](../../config/trakt)
## Collections Section 16
| Collection | Key | Description |

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

@ -2,12 +2,14 @@
The `choice` Default Metadata File is used to create collections based on the Critics Choice Awards.
This Default file requires [Trakt Authentication](../../config/trakt)
**This file works with Movie and Show Libraries.**
![](../images/choice.png)
## Requirements & Recommendations
Supported Library Types: Movie, Show
Requirements: [Trakt Authentication](../../config/trakt)
## Collections Section 16
| Collection | Key | Description |

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

@ -2,10 +2,12 @@
The `emmy` Default Metadata File is used to create collections based on the Emmy Awards.
**This file works with Movie and Show Libraries.**
![](../images/emmy.png)
## Requirements & Recommendations
Supported Library Types: Movie, Show
## Collections Section 16
| Collection | Key | Description |

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

@ -2,10 +2,14 @@
The `golden` Default Metadata File is used to create collections based on the Golden Globe Awards.
**The `Golden Globe Best Motion Pictures` Collection only works with Movie Libraries but the year collections work with both Movie and Show libraries.**
![](../images/golden.png)
## Requirements & Recommendations
Supported Library Types: Movie, Show
Recommendations: The `Golden Globe Best Motion Pictures` Collection only works with Movie Libraries
## Collections Section 16
| Collection | Key | Description |

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

@ -2,10 +2,12 @@
The `oscars` Default Metadata File is used to create collections based on the Academy Awards (Oscars).
**This file only works with Movie Libraries.**
![](../images/oscars.png)
## Requirements & Recommendations
Supported Library Types: Movie
## Collections Section 16
| Collection | Key | Description |

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

@ -2,12 +2,14 @@
The `other_award` Default Metadata File is used to create collections based on numerous other awards.
This Default file requires [Trakt Authentication](../../config/trakt)
**This file only works with Movie Libraries.**
![](../images/awardother.png)
## Requirements & Recommendations
Supported Library Types: Movie, Show
Requirements: [Trakt Authentication](../../config/trakt)
## Collections Section 16
| Collection | Key | Description |

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

@ -2,10 +2,12 @@
The `separator_award` Default Metadata File is used to create a seperator collection for Awards.
**This file works with Movie and Show Libraries.**
![](../images/awardseparator.png)
## Requirements & Recommendations
Supported Library Types: Movie, Show
## Collections Section 16
| Collection | Key | Description |

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

@ -2,12 +2,14 @@
The `spirit` Default Metadata File is used to create collections based on the Independent Spirit Awards.
This Default file requires [Trakt Authentication](../../config/trakt)
**This file only works with Movie Libraries.**
![](../images/spirit.png)
## Requirements & Recommendations
Supported Library Types: Movie
Requirements: [Trakt Authentication](../../config/trakt)
## Collections Section 16
| Collection | Key | Description |

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

@ -2,12 +2,14 @@
The `sundance` Default Metadata File is used to create collections based on the Sundance Film Festival Awards.
This Default file requires [Trakt Authentication](../../config/trakt)
**This file only works with Movie Libraries.**
![](../images/sundance.png)
## Requirements & Recommendations
Supported Library Types: Movie
Requirements: [Trakt Authentication](../../config/trakt)
## Collections Section 16
| Collection | Key | Description |

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

@ -2,10 +2,12 @@
The `actor` Default Metadata File is used to dynamically create collections based on the most popular actors/actresses in your library.
**This file works with Movie and Show Libraries.**
![](../images/actor1.png)
## Requirements & Recommendations
Supported Library Types: Movie, Show
## Collections Section 17
| Collection | Key | Description |

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

@ -2,10 +2,12 @@
The `audio_language` Default Metadata File is used to dynamically create collections based on the audio languages available in your library.
**This file works with Movie and Show Libraries.**
![](../images/audio_language.png)
## Requirements & Recommendations
Supported Library Types: Movie, Show
## Collections Section 10
| Collection | Key | Description |

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

@ -2,12 +2,14 @@
The `collectionless` Default Metadata File is used to create a [Collectionless collection](../../metadata/builders/plex.md#plex-collectionless) to help Show/Hide Movies/Shows properly in your library.
**For this file to work it needs to run last under `metadata_path` and all other normal collections must use `collection_mode: hide_items`.**
**This file works with Movie and Show Libraries.**
![](../images/collectionless.png)
## Requirements & Recommendations
Supported Library Types: Movie, Show
Requirements: For this file to work it needs to run last under `metadata_path` and all other normal collections must use `collection_mode: hide_items`
## Collection
| Collection | Description |

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

@ -4,12 +4,14 @@ The `content_rating_cs` Default Metadata File is used to dynamically create coll
If you do not use the Common Sense-based rating system within Plex, this file will attempt to match the ratings in your library to the respective rating system.
Use the [Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with either `mdb_commonsense` or `mdb_commonsense0` to update Plex to the Common Sense Rating.
**This file works with Movie and Show Libraries.**
![](../images/content_rating_cs.png)
## Requirements & Recommendations
Supported Library Types: Movie, Show
Recommendations: Use the [Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with either `mdb_commonsense` or `mdb_commonsense0` to update Plex to the Common Sense Rating.
## Collections Section 14
| Collection | Key | Description |

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

@ -2,12 +2,16 @@
The `content_rating_mal` Default Metadata File is used to dynamically create collections based on the content ratings available in your library.
This file assumes that you are using the `mass_content_rating_update: mal` operation on your library, and if you do not use the MAL-based rating system within Plex, this file will attempt to match the ratings in your library to the respective rating system.
**This file works with Movie and Show Libraries.**
If you do not use the MAL-based rating system within Plex, this file will attempt to match the ratings in your library to the respective rating system.
![](../images/content_rating_mal.png)
## Requirements & Recommendations
Supported Library Types: Movie, Show
Recommendations: Use the [Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with `mal` or `mdb_commonsense0` to update Plex to the MyAnimeList Content Rating.
## Collections Section 14
| Collection | Key | Description |

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

@ -4,10 +4,14 @@ The `content_rating_uk` Default Metadata File is used to dynamically create coll
If you do not use the UK-based rating system within Plex, this file will attempt to match the ratings in your library to the respective rating system.
**This file works with Movie and Show Libraries.**
![](../images/content_rating_uk.png)
## Requirements & Recommendations
Supported Library Types: Movie, Show
Recommendation: Set the Certification Country within your library's advanced settings to "United Kingdom"
## Collections Section 14
| Collection | Key | Description |

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

@ -4,10 +4,12 @@ The `genre` Default Metadata File is used to dynamically create collections base
This file also merges similarly named genres (such as "Sci-Fi", "SciFi" and "Sci-Fi & Fantasy") into one ("Science Fiction")
**This file works with Movie and Show Libraries.**
![](../images/genre.png)
## Requirements & Recommendations
Supported Library Types: Movie, Show
## Collections Section 06
| Collection | Key | Description |

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

@ -2,11 +2,12 @@
The `resolution` Default Metadata File is used to dynamically create collections based on the resolutions available in your library.
**This file works with Movie and Show Libraries.**
![](../images/resolution.png)
## Requirements & Recommendations
Supported Library Types: Movie, Show
## Collections Section 15
| Collection | Key | Description |

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

@ -2,10 +2,12 @@
The `streaming` Default Metadata File is used to dynamically create collections based on the streaming Services that your media is available on.
**This file works with Movie and Show Libraries.**
![](../images/streaming.png)
## Requirements & Recommendations
Supported Library Types: Movie, Show
## Collections Section 03
| Collection | Key | Description |

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

@ -4,10 +4,12 @@ The `studio` Default Metadata File is used to dynamically create collections bas
This file also merges similarly named studios (such as "20th Century Fox" and "20th Century Animation") into one ("20th Century Studios")
**This file works with Movie and Show Libraries.**
![](../images/studio.png)
## Requirements & Recommendations
Supported Library Types: Movie, Show
## Collections Section 07
| Collection | Key | Description |

6
docs/defaults/both/studio_anime.md
View file

@ -2,10 +2,12 @@
The `studio_anime` Default Metadata File is used to dynamically create collections based on the studios available in your library.
**This file works with Movie and Show Libraries.**
![](../images/studio_anime.png)
## Requirements & Recommendations
Supported Library Types: Movie, Show
## Collections Section 07
| Collection | Key | Description |

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

@ -2,10 +2,12 @@
The `subtitle_language` Default Metadata File is used to dynamically create collections based on the subtitle languages available in your library.
**This file works with Movie and Show Libraries.**
![](../images/subtitle_language.png)
## Requirements & Recommendations
Supported Library Types: Movie, Show
## Collections Section 11
| Collection | Key | Description |

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

@ -2,10 +2,12 @@
The `year` Default Metadata File is used to dynamically create collections based on the years available in your library, sorted by critic rating to create a "best of <year>"
**This file works with Movie and Show Libraries.**
![](../images/year.png)
## Requirements & Recommendations
Supported Library Types: Movie, Show
## Collections Section 13
| Collection | Key | Description |

6
docs/defaults/chart/anilist.md
View file

@ -2,10 +2,12 @@
The `anilist` Default Metadata File is used to create collections based on Anilist charts.
**This file works with Movie and Show Libraries.**
![](../images/anilist.png)
## Requirements & Recommendations
Supported Library Types: Movie, Show
## Collections Section 01
| Collection | Key | Description |

6
docs/defaults/chart/basic.md
View file

@ -2,10 +2,12 @@
The `basic` Default Metadata File is used to create collections based on recently released media in your library.
**This file works with Movie and Show Libraries.**
![](../images/basic.png)
## Requirements & Recommendations
Supported Library Types: Movie, Show
## Collections Section 01
| Collection | Key | Description |

6
docs/defaults/chart/flixpatrol.md
View file

@ -2,10 +2,12 @@
The `flixpatrol` Default Metadata File is used to create collections based on FlixPatrol Charts.
**This file works with Movie and Show Libraries.**
![](../images/flixpatrol.png)
## Requirements & Recommendations
Supported Library Types: Movie, Show
## Collections Section 01
| Collection | Key | Description |

8
docs/defaults/chart/imdb.md
View file

@ -2,10 +2,14 @@
The `imdb` Default Metadata File is used to create collections based on IMDb Charts.
**The `IMDb Lowest Rated` Collection only works with Movie Libraries but the rest of the collections work with both Movie and Show libraries.**
![](../images/imdb.png)
## Requirements & Recommendations
Supported Library Types: Movie, Show
Recommendations: The `IMDb Lowest Rated` Collection only works with Movie Libraries
## Collections Section 01
| Collection | Key | Description |

6
docs/defaults/chart/myanimelist.md
View file

@ -2,10 +2,12 @@
The `myanimelist` Default Metadata File is used to create collections based on MyAnimeList Charts.
**This file works with Movie and Show Libraries.**
![](../images/myanimelist.png)
## Requirements & Recommendations
Supported Library Types: Movie, Show
## Collections Section 01
| Collection | Key | Description |

8
docs/defaults/chart/other.md
View file

@ -2,10 +2,14 @@
The `other_chart` Default Metadata File is used to create collections based on other Charts.
**The `StevenLu's Popular Movies` and `Top 10 Pirated Movies of the Week` Collections only work with Movie Libraries but the rest of the collections work with both Movie and Show libraries.**
![](../images/chartother.png)
## Requirements & Recommendations
Supported Library Types: Movie, Show
Recommendations: The `StevenLu's Popular Movies` and `Top 10 Pirated Movies of the Week` Collections only work with Movie Libraries
## Collections Section 01
| Collection | Key | Description |

6
docs/defaults/chart/separator.md
View file

@ -2,10 +2,12 @@
The `separator_chart` Default Metadata File is used to create a seperator collection for Charts.
**This file works with Movie and Show Libraries.**
![](../images/chartseparator.png)
## Requirements & Recommendations
Supported Library Types: Movie, Show
## Collections Section 01
| Collection | Key | Description |

10
docs/defaults/chart/tautulli.md
View file

@ -2,12 +2,14 @@
The `tautulli` Default Metadata File is used to create collections based on Tautulli/Plex Charts.
This Default file requires [Tautulli Authentication](../../config/tautulli)
**This file works with Movie and Show Libraries.**
![](../images/tautulli.png)
## Requirements & Recommendations
Supported Library Types: Movie, Show
Requirements: [Tautulli Authentication](../../config/tautulli)
## Collections Section 01
| Collection | Key | Description |

8
docs/defaults/chart/tmdb.md
View file

@ -2,10 +2,14 @@
The `tmdb` Default Metadata File is used to create collections based on TMDb Charts.
**The `TMDb Airing Today` and `TMDb On The Air` Collections only work with Show Libraries but the rest of the collections work with both Movie and Show libraries.**
![](../images/tmdb.png)
## Requirements & Recommendations
Supported Library Types: Movie, Show
Recommendations: The `TMDb Airing Today` and `TMDb On The Air` Collections only work with Show Libraries
## Collections Section 01
| Collection | Key | Description |

8
docs/defaults/chart/trakt.md
View file

@ -2,10 +2,14 @@
The `trakt` Default Metadata File is used to create collections based on Trakt Charts.
**This file works with Movie and Show Libraries.**
![](../images/trakt.png)
## Requirements & Recommendations
Supported Library Types: Movie, Show
Requirements: [Trakt Authentication](../../config/trakt)
## Collections Section 01
| Collection | Key | Description |

8
docs/defaults/movie/content_rating_us.md
View file

@ -4,10 +4,16 @@ The `content_rating_us` Default Metadata File is used to dynamically create coll
If you do not use the US-based rating system within Plex, this file will attempt to match the ratings in your library to the respective rating system.
**This file works with Movie Libraries, but has a Show Library [Counterpart](../show/content_rating_us).**
**This file has a Show Library [Counterpart](../show/content_rating_us).**
![](../images/moviecontent_rating_us.png)
## Requirements & Recommendations
Supported Library Types: Movie
Recommendation: Set the Certification Country within your library's advanced settings to "United States".
## Collections Section 14
| Collection | Key | Description |

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

@ -2,10 +2,14 @@
The `country` Default Metadata File is used to dynamically create collections based on the countries available in your library.
**This file works with Movie Libraries, but has a Show Library [Counterpart](../show/country).**
**This file has a Show Library [Counterpart](../show/country).**
![](../images/country1.png)
## Requirements & Recommendations
Supported Library Types: Movie
## Collections Section 09
| Collection | Key | Description |

6
docs/defaults/movie/decade.md
View file

@ -2,10 +2,14 @@
The `decade` Default 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>"
**This file works with Movie Libraries, but has a Show Library [Counterpart](../show/decade).**
**This file works has a Show Library [Counterpart](../show/decade).**
![](../images/decade.png)
## Requirements & Recommendations
Supported Library Types: Movie
## Collections Section 12
| Collection | Key | Description |

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

@ -2,10 +2,12 @@
The `director` Default Metadata File is used to dynamically create collections based on the most popular directors in your library.
**This file only works with Movie Libraries.**
![](../images/director1.png)
## Requirements & Recommendations
Supported Library Types: Movie
## Collections Section 18
| Collection | Key | Description |

6
docs/defaults/movie/franchise.md
View file

@ -4,10 +4,14 @@ The `franchise` Default Metadata File is used to create collections based on pop
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.
**This file works with Movie Libraries, but has a Show Library [Counterpart](../show/franchise).**
**This file has a Show Library [Counterpart](../show/franchise).**
![](../images/moviefranchise.png)
## Requirements & Recommendations
Supported Library Types: Movie
## Collections
| Collection | Key | Description |

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

@ -2,10 +2,12 @@
The `producer` Default Metadata File is used to dynamically create collections based on the most popular producers in your library.
**This file only works with Movie Libraries.**
![](../images/producer1.png)
## Requirements & Recommendations
Supported Library Types: Movie
## Collections Section 19
| Collection | Key | Description |

6
docs/defaults/movie/seasonal.md
View file

@ -2,10 +2,12 @@
The `seasonal` Default Metadata File is used to dynamically create seasonal collections based on holidays .
**This file only works with Movie Libraries.**
![](../images/seasonal.png)
## Requirements & Recommendations
Supported Library Types: Movie
## Collections Section 00
| Collection | Key | Description |

6
docs/defaults/movie/universe.md
View file

@ -4,10 +4,12 @@ The `universe` Default Metadata File is used to create collections based on popu
This Default file requires [Trakt Authentication](../../config/trakt)
**This file only works with Movie Libraries.**
![](../images/universe.png)
## Requirements & Recommendations
Supported Library Types: Movie
## Collections Section 02
| Collection | Key | Description |

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

@ -2,10 +2,12 @@
The `writer` Default Metadata File is used to dynamically create collections based on the most popular writers in your library.
**This file only works with Movie Libraries.**
![](../images/writer1.png)
## Requirements & Recommendations
Supported Library Types: Movie
## Collections Section 20
| Collection | Key | Description |

2
docs/defaults/overlay_list.md
View file

@ -23,7 +23,7 @@ These overlays are applied by calling the below paths into the `overlay_path` [s
| [Ratings](overlays/ratings) | `ratings` | IMDb Audience Rating, Metacritic Critic Rating | &#9989; | &#9989; | &#10060; | &#9989; |
| [Resolution/Editions](overlays/resolution) | `resolution` | 4K Dolby Vision logo, 720P logo, "Director's Cut", "Criterion Collection" | &#9989; | &#9989; | &#10060; | &#9989; |
| [Ribbon](overlays/ribbon) | `ribbon` | IMDb Top 250 Ribbon, RT Fresh Ribbon | &#9989; | &#9989; | &#10060; | &#10060; |
| [Runtimes](overlays/runtimes) | `runtimes` | "Runtime: 1h 30m" | &#9989; | &#9989; | &#10060; | &#10060; |
| [Runtimes](overlays/runtimes) | `runtimes` | "Runtime: 1h 30m" | &#9989; | &#9989; | &#10060; | &#9989; |
| [Status](overlays/status) | `status` | Airing, Returning, Canceled, Ended | &#10060; | &#9989; | &#10060; | &#10060; |
| [Streaming](overlays/streaming) | `streaming` | Netflix logo, Hulu logo | &#9989; | &#9989; | &#10060; | &#10060; |
| [Versions](overlays/versions) | `versions` | Multiple Versions logo | &#9989; | &#9989; | &#9989; | &#9989; |

10
docs/defaults/overlays/audio_codec.md
View file

@ -2,12 +2,14 @@
The `audio_codec` Default Overlay File is used to create an overlay based on the audio codec available on each item within your library.
**This file works with Movie and Show Libraries.**
**Designed for [TRaSH Guides](https://trash-guides.info/) filename naming scheme.**
![](images/audio_codec.png)
## Requirements & Recommendations
Supported Overlay Level: Movie, Show, Season, Episode
Recommendations: Designed for [TRaSH Guides](https://trash-guides.info/) filename naming scheme
## Supported Audio Codecs
| Audio Codec | Key | Weight |

8
docs/defaults/overlays/commonsense.md
View file

@ -2,12 +2,16 @@
The `commonsense` Default Overlay File is used to create an overlay based on the CommonSense Age Rating on each item within your library.
Use the [Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with either `mdb_commonsense` or `mdb_commonsense0` to update Plex to the Common Sense Rating.
**This file works with Movie and Show Libraries.**
![](images/commonsense.png)
## Requirements & Recommendations
Supported library types: Movie & Show
Requirements: Use the [Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with either `mdb_commonsense` or `mdb_commonsense0` to update Plex to the Common Sense Rating.
## Supported CommonSense Age Rating
| Rating | Key |

6
docs/defaults/overlays/direct_play.md
View file

@ -2,10 +2,12 @@
The `direct_play` Default Overlay File is used to create an overlay to indicate items that cannot be transcoded and instead only support Direct Play (i.e. if you use Tautulli to kill 4K transcoding)
**This file works with Movie and Show Libraries.**
![](images/direct_play.png)
## Requirements & Recommendations
Supported library types: Movie & Show
## Config
The below YAML in your config.yml will create the overlays:

6
docs/defaults/overlays/episode_info.md
View file

@ -2,10 +2,12 @@
The `episode_info` Default Overlay File is used to create an overlay on the episode title card on the episode numbering within a given series in your library.
**This file only works with Show Libraries.**
![](images/episode_info.png)
## Requirements & Recommendations
Supported library types: Show
## Config
The below YAML in your config.yml will create the overlays:

6
docs/defaults/overlays/flixpatrol.md
View file

@ -2,10 +2,12 @@
The `flixpatrol` Default Overlay File is used to create an overlay based on the Top Lists from FlixPatrol on items within your library.
**This file works with Movie and Show Libraries.**
![](images/flixpatrol.png)
## Requirements & Recommendations
Supported Overlay Level: Movie, Show
## Supported Services
| Service | Key | Weight |

8
docs/defaults/overlays/language_count.md
View file

@ -2,12 +2,12 @@
The `language_count` Default Overlay File is used to create an overlay based on the number of audio/subtitle languages available on each item within your library.
**This file works with Movie and Show Libraries.**
**Designed for [TRaSH Guides](https://trash-guides.info/) filename naming scheme.**
![](images/language_count.png)
## Requirements & Recommendations
Supported Overlay Level: Movie, Show, Season, Episode
## Supported Audio/Subtitle Languages
| Audio/Subtitle Languages | Key | Weight |

8
docs/defaults/overlays/languages.md
View file

@ -2,12 +2,12 @@
The `languages` Default Overlay File is used to create an overlay of a flag and [ISO 639-1 Code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) based on the audio/subtitle languages available on each item within your library.
**This file works with Movie and Show Libraries.**
**Designed for [TRaSH Guides](https://trash-guides.info/) filename naming scheme.**
![](images/language.png)
## Requirements & Recommendations
Supported library types: Movie & Show
## Supported Audio/Subtitle Language Flags
| Audio/Subtitle Languages | Key | Weight | Default Flag | Default Use |

6
docs/defaults/overlays/mediastinger.md
View file

@ -2,10 +2,12 @@
The `mediastinger` Default Overlay File is used to create an overlay based on if there's an after/during credit scene on each movie within your library.
**This file only works with Movie Libraries.**
![](images/mediastinger.png)
## Requirements & Recommendations
Supported Overlay Level: Movie
## Config
The below YAML in your config.yml will create the overlays:

14
docs/defaults/overlays/ratings.md
View file

@ -2,14 +2,18 @@
The `ratings` Default Overlay File is used to create an overlay based on the Critic Rating, Audience Rating, and User Rating in Plex for each item within your library.
This file only updates the overlays based on the data in Plex. Use the [Mass * Rating Update Library Operation](../../config/operations.md#mass--rating-update) and the [Mass Episode * Rating Update Library Operation](../../config/operations.md#mass-episode--rating-update) to update Plex to the Ratings you want on the Overlay.
**This file works with Movie and Show Libraries.**
**If no template variables are set this file will do nothing.**
This file only updates the overlays based on the data in Plex, it will not pull the ratings directly from any third-party website, see recommendations below for more info.
![](images/ratings_overlay.png)
## Requirements & Recommendations
Supported Overlay Level: Movie, Show, Episode
Requirements: Template Variables must be configured, otherwise this file will not apply any overlays.
Recommendations: Use the [Mass * Rating Update Library Operation](../../config/operations.md#mass--rating-update) and the [Mass Episode * Rating Update Library Operation](../../config/operations.md#mass-episode--rating-update) to update Plex to the Ratings you want on the Overlay.
## Config
The below YAML in your config.yml will create the overlays:

8
docs/defaults/overlays/resolution.md
View file

@ -2,12 +2,12 @@
The `resolution` Default Overlay File is used to create an overlay based on the resolutions and editions available on each item within your library.
**This file works with Movie and Show Libraries.**
**Designed for [TRaSH Guides](https://trash-guides.info/) filename naming scheme.**
![](images/resolution.png)
## Requirements & Recommendations
Supported Overlay Level: Movie, Show, Episode
## Supported Resolutions
| Resolution | Key |

6
docs/defaults/overlays/ribbon.md
View file

@ -2,10 +2,12 @@
The `ribbon` Default Overlay File is used to create a ribbon overlay based on the Top Lists of various sites on each item within your library.
**This file works with Movie and Show Libraries.**
![](images/ribbon.png)
## Requirements & Recommendations
Supported Overlay Level: Movie, Show
## Supported Ribbon
| Ribbon | Key | Weight |

6
docs/defaults/overlays/runtimes.md
View file

@ -2,10 +2,12 @@
The `runtimes` Default Overlay File is used to create an overlay on of the movie or episodes runtime for all items in your library.
**This file works with Movie and Show Libraries.**
![](images/runtimes.png)
## Requirements & Recommendations
Supported Overlay Level: Movie, Show, Episode
## Config
The below YAML in your config.yml will create the overlays:

6
docs/defaults/overlays/status.md
View file

@ -2,10 +2,12 @@
The `status` Default Overlay File is used to create an overlay on a show detailing its Current Airing Status for all shows in your library.
**This file only works with Show Libraries.**
![](images/status.png)
## Requirements & Recommendations
Supported Overlay Level: Show
## Supported Status
| Status | Key | Weight |

6
docs/defaults/overlays/streaming.md
View file

@ -2,10 +2,12 @@
The `streaming` Default Overlay File is used to create an overlay based on the streaming service the file is found on for each item within your library.
**This file works with Movie and Show Libraries.**
![](images/streaming.png)
## Requirements & Recommendations
Supported Overlay Level: Movie, Show
## Supported Streaming Services
| Streaming Service | Key | Weight |

6
docs/defaults/overlays/versions.md
View file

@ -2,10 +2,12 @@
The `versions` Default Overlay File is used to create an overlay based on if there's multiple versions on each item within your library.
**This file works with Movie and Show Libraries.**
![](images/version.png)
## Requirements & Recommendations
Supported Overlay Level: Movie, Show, Season, Episode
## Config
The below YAML in your config.yml will create the overlays:

10
docs/defaults/overlays/video_format.md
View file

@ -2,12 +2,14 @@
The `video_format` Default Overlay File is used to create an overlay based on the video format available on each item within your library.
**This file works with Movie and Show Libraries.**
**Designed for [TRaSH Guides](https://trash-guides.info/) filename naming scheme.**
![](images/video_format.png)
## Requirements & Recommendations
Supported Overlay Level: Movie, Show, Season, Episode
Recommendations: Designed for [TRaSH Guides](https://trash-guides.info/) filename naming scheme
## Supported Video Formats
| Video Format | Key | Weight |

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

@ -4,10 +4,14 @@ The `content_rating_us` Default Metadata File is used to dynamically create coll
If you do not use the US-based rating system within Plex, this file will attempt to match the ratings in your library to the respective rating system.
**This file works with Show Libraries, but has a Movie Library [Counterpart](../movie/content_rating_us).**
**This file has a Movie Library [Counterpart](../movie/content_rating_us).**
![](../images/moviecontent_rating_us.png)
## Requirements & Recommendations
Supported Library Types: Show
## Collections Section 14
| Collection | Key | Description |

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

@ -2,10 +2,14 @@
The `country` Default Metadata File is used to dynamically create collections based on the countries available in your library.
**This file works with Show Libraries, but has a Movie Library [Counterpart](../movie/country).**
**This file has a Movie Library [Counterpart](../movie/country).**
![](../images/country1.png)
## Requirements & Recommendations
Supported Library Types: Show
## Collections Section 09
| Collection | Key | Description |

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

@ -2,10 +2,14 @@
The `decade` Metadata File is used to dynamically create collections based on the decades available in your library, sorted by critic rating to create a "best of <decade>"
**This file works with Show Libraries, but has a Movie Library [Counterpart](../movie/decade).**
**This file has a Movie Library [Counterpart](../movie/decade).**
![](../images/decade.png)
## Requirements & Recommendations
Supported Library Types: Show
## Collections Section 12
| Collection | Key | Description |

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

@ -4,10 +4,14 @@ The `franchise` Default Metadata File is used to create collections based on pop
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.
**This file works with Show Libraries, but has a Movie Library [Counterpart](../movie/franchise).**
**This file has a Movie Library [Counterpart](../movie/franchise).**
![](../images/showfranchise.png)
## Requirements & Recommendations
Supported Library Types: Show
## Collections
| Collection | Key | Description |

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

@ -2,10 +2,12 @@
The `network` Default Metadata File is used to dynamically create collections based on the networks available in your library.
**This file only works with Show Libraries.**
![](../images/network.png)
## Requirements & Recommendations
Supported Library Types: Show
## Collections Section 04
| Collection | Key | Description |