From 25f9badf71d25ad2838fef61a608583c894fad44 Mon Sep 17 00:00:00 2001 From: YozoraXCII <96386153+YozoraXCII@users.noreply.github.com> Date: Sat, 21 Jan 2023 00:20:33 +0000 Subject: [PATCH] Standardize Defaults Requirements & Recommendations --- docs/defaults/award/bafta.md | 8 +++++--- docs/defaults/award/cannes.md | 8 +++++--- docs/defaults/award/choice.md | 8 +++++--- docs/defaults/award/emmy.md | 6 ++++-- docs/defaults/award/golden.md | 8 ++++++-- docs/defaults/award/oscars.md | 6 ++++-- docs/defaults/award/other.md | 8 +++++--- docs/defaults/award/separator.md | 6 ++++-- docs/defaults/award/spirit.md | 8 +++++--- docs/defaults/award/sundance.md | 8 +++++--- docs/defaults/both/actor.md | 6 ++++-- docs/defaults/both/audio_language.md | 6 ++++-- docs/defaults/both/collectionless.md | 8 +++++--- docs/defaults/both/content_rating_cs.md | 8 +++++--- docs/defaults/both/content_rating_mal.md | 10 +++++++--- docs/defaults/both/content_rating_uk.md | 8 ++++++-- docs/defaults/both/genre.md | 6 ++++-- docs/defaults/both/resolution.md | 5 +++-- docs/defaults/both/streaming.md | 6 ++++-- docs/defaults/both/studio.md | 6 ++++-- docs/defaults/both/studio_anime.md | 6 ++++-- docs/defaults/both/subtitle_language.md | 6 ++++-- docs/defaults/both/year.md | 6 ++++-- docs/defaults/chart/anilist.md | 6 ++++-- docs/defaults/chart/basic.md | 6 ++++-- docs/defaults/chart/flixpatrol.md | 6 ++++-- docs/defaults/chart/imdb.md | 8 ++++++-- docs/defaults/chart/myanimelist.md | 6 ++++-- docs/defaults/chart/other.md | 8 ++++++-- docs/defaults/chart/separator.md | 6 ++++-- docs/defaults/chart/tautulli.md | 8 +++++--- docs/defaults/chart/tmdb.md | 8 ++++++-- docs/defaults/chart/trakt.md | 8 ++++++-- docs/defaults/movie/content_rating_us.md | 8 +++++++- docs/defaults/movie/country.md | 6 +++++- docs/defaults/movie/decade.md | 6 +++++- docs/defaults/movie/director.md | 6 ++++-- docs/defaults/movie/franchise.md | 6 +++++- docs/defaults/movie/producer.md | 6 ++++-- docs/defaults/movie/seasonal.md | 6 ++++-- docs/defaults/movie/universe.md | 6 ++++-- docs/defaults/movie/writer.md | 6 ++++-- docs/defaults/overlay_list.md | 2 +- docs/defaults/overlays/audio_codec.md | 8 +++++--- docs/defaults/overlays/commonsense.md | 8 ++++++-- docs/defaults/overlays/direct_play.md | 6 ++++-- docs/defaults/overlays/episode_info.md | 6 ++++-- docs/defaults/overlays/flixpatrol.md | 6 ++++-- docs/defaults/overlays/language_count.md | 6 +++--- docs/defaults/overlays/languages.md | 6 +++--- docs/defaults/overlays/mediastinger.md | 6 ++++-- docs/defaults/overlays/ratings.md | 12 ++++++++---- docs/defaults/overlays/resolution.md | 6 +++--- docs/defaults/overlays/ribbon.md | 6 ++++-- docs/defaults/overlays/runtimes.md | 6 ++++-- docs/defaults/overlays/status.md | 6 ++++-- docs/defaults/overlays/streaming.md | 6 ++++-- docs/defaults/overlays/versions.md | 6 ++++-- docs/defaults/overlays/video_format.md | 8 +++++--- docs/defaults/show/content_rating_us.md | 6 +++++- docs/defaults/show/country.md | 6 +++++- docs/defaults/show/decade.md | 6 +++++- docs/defaults/show/franchise.md | 6 +++++- docs/defaults/show/network.md | 6 ++++-- 64 files changed, 291 insertions(+), 136 deletions(-) diff --git a/docs/defaults/award/bafta.md b/docs/defaults/award/bafta.md index 5d1487eb..0a9889ba 100644 --- a/docs/defaults/award/bafta.md +++ b/docs/defaults/award/bafta.md @@ -2,11 +2,13 @@ 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) +![](../images/bafta.png) -**This file only works with Movie Libraries.** +## Requirements & Recommendations -![](../images/bafta.png) +Supported Library Types: Movie + +Requirements: [Trakt Authentication](../../config/trakt) ## Collections Section 16 diff --git a/docs/defaults/award/cannes.md b/docs/defaults/award/cannes.md index e13e49c8..ad3d9f24 100644 --- a/docs/defaults/award/cannes.md +++ b/docs/defaults/award/cannes.md @@ -2,11 +2,13 @@ The `cannes` Default Metadata File is used to create collections based on the Cannes Film Awards. -This Default file requires [Trakt Authentication](../../config/trakt) +![](../images/cannes.png) -**This file only works with Movie Libraries.** +## Requirements & Recommendations -![](../images/cannes.png) +Supported Library Types: Movie + +Requirements: [Trakt Authentication](../../config/trakt) ## Collections Section 16 diff --git a/docs/defaults/award/choice.md b/docs/defaults/award/choice.md index 37c206cd..eb5406d4 100644 --- a/docs/defaults/award/choice.md +++ b/docs/defaults/award/choice.md @@ -2,11 +2,13 @@ The `choice` Default Metadata File is used to create collections based on the Critics Choice Awards. -This Default file requires [Trakt Authentication](../../config/trakt) +![](../images/choice.png) -**This file works with Movie and Show Libraries.** +## Requirements & Recommendations -![](../images/choice.png) +Supported Library Types: Movie, Show + +Requirements: [Trakt Authentication](../../config/trakt) ## Collections Section 16 diff --git a/docs/defaults/award/emmy.md b/docs/defaults/award/emmy.md index 78410f57..6f0532f2 100644 --- a/docs/defaults/award/emmy.md +++ b/docs/defaults/award/emmy.md @@ -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 | diff --git a/docs/defaults/award/golden.md b/docs/defaults/award/golden.md index b3407a63..bafd7d44 100644 --- a/docs/defaults/award/golden.md +++ b/docs/defaults/award/golden.md @@ -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 | diff --git a/docs/defaults/award/oscars.md b/docs/defaults/award/oscars.md index 3cd3c323..bb2560fa 100644 --- a/docs/defaults/award/oscars.md +++ b/docs/defaults/award/oscars.md @@ -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 | diff --git a/docs/defaults/award/other.md b/docs/defaults/award/other.md index 24a7fc86..ac982e25 100644 --- a/docs/defaults/award/other.md +++ b/docs/defaults/award/other.md @@ -2,11 +2,13 @@ The `other_award` Default Metadata File is used to create collections based on numerous other awards. -This Default file requires [Trakt Authentication](../../config/trakt) +![](../images/awardother.png) -**This file only works with Movie Libraries.** +## Requirements & Recommendations -![](../images/awardother.png) +Supported Library Types: Movie, Show + +Requirements: [Trakt Authentication](../../config/trakt) ## Collections Section 16 diff --git a/docs/defaults/award/separator.md b/docs/defaults/award/separator.md index 48f64d78..70b39163 100644 --- a/docs/defaults/award/separator.md +++ b/docs/defaults/award/separator.md @@ -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 | diff --git a/docs/defaults/award/spirit.md b/docs/defaults/award/spirit.md index 5e1010da..ef394104 100644 --- a/docs/defaults/award/spirit.md +++ b/docs/defaults/award/spirit.md @@ -2,11 +2,13 @@ The `spirit` Default Metadata File is used to create collections based on the Independent Spirit Awards. -This Default file requires [Trakt Authentication](../../config/trakt) +![](../images/spirit.png) -**This file only works with Movie Libraries.** +## Requirements & Recommendations -![](../images/spirit.png) +Supported Library Types: Movie + +Requirements: [Trakt Authentication](../../config/trakt) ## Collections Section 16 diff --git a/docs/defaults/award/sundance.md b/docs/defaults/award/sundance.md index e9e0d26a..9e34b6cf 100644 --- a/docs/defaults/award/sundance.md +++ b/docs/defaults/award/sundance.md @@ -2,11 +2,13 @@ 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) +![](../images/sundance.png) -**This file only works with Movie Libraries.** +## Requirements & Recommendations -![](../images/sundance.png) +Supported Library Types: Movie + +Requirements: [Trakt Authentication](../../config/trakt) ## Collections Section 16 diff --git a/docs/defaults/both/actor.md b/docs/defaults/both/actor.md index 78951bee..40fbb2a8 100644 --- a/docs/defaults/both/actor.md +++ b/docs/defaults/both/actor.md @@ -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 | diff --git a/docs/defaults/both/audio_language.md b/docs/defaults/both/audio_language.md index 779779ca..a67f09c4 100644 --- a/docs/defaults/both/audio_language.md +++ b/docs/defaults/both/audio_language.md @@ -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 | diff --git a/docs/defaults/both/collectionless.md b/docs/defaults/both/collectionless.md index a3b140bd..ea424275 100644 --- a/docs/defaults/both/collectionless.md +++ b/docs/defaults/both/collectionless.md @@ -2,11 +2,13 @@ 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`.** +![](../images/collectionless.png) -**This file works with Movie and Show Libraries.** +## Requirements & Recommendations -![](../images/collectionless.png) +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 diff --git a/docs/defaults/both/content_rating_cs.md b/docs/defaults/both/content_rating_cs.md index a1f5152a..b2345433 100644 --- a/docs/defaults/both/content_rating_cs.md +++ b/docs/defaults/both/content_rating_cs.md @@ -4,11 +4,13 @@ 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. +![](../images/content_rating_cs.png) -**This file works with Movie and Show Libraries.** +## Requirements & Recommendations -![](../images/content_rating_cs.png) +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 diff --git a/docs/defaults/both/content_rating_mal.md b/docs/defaults/both/content_rating_mal.md index 80b2aa3f..80a69fd3 100644 --- a/docs/defaults/both/content_rating_mal.md +++ b/docs/defaults/both/content_rating_mal.md @@ -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 | diff --git a/docs/defaults/both/content_rating_uk.md b/docs/defaults/both/content_rating_uk.md index c54942c6..02c827a9 100644 --- a/docs/defaults/both/content_rating_uk.md +++ b/docs/defaults/both/content_rating_uk.md @@ -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 | diff --git a/docs/defaults/both/genre.md b/docs/defaults/both/genre.md index 0976b7e6..adb76a10 100644 --- a/docs/defaults/both/genre.md +++ b/docs/defaults/both/genre.md @@ -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 | diff --git a/docs/defaults/both/resolution.md b/docs/defaults/both/resolution.md index c74667e3..14bb1e9d 100644 --- a/docs/defaults/both/resolution.md +++ b/docs/defaults/both/resolution.md @@ -2,10 +2,11 @@ The `resolution` Default Metadata File is used to dynamically create collections based on the resolutions available in your library. +![](../images/resolution.png) -**This file works with Movie and Show Libraries.** +## Requirements & Recommendations -![](../images/resolution.png) +Supported Library Types: Movie, Show ## Collections Section 15 diff --git a/docs/defaults/both/streaming.md b/docs/defaults/both/streaming.md index e8a4e8e2..1aced682 100644 --- a/docs/defaults/both/streaming.md +++ b/docs/defaults/both/streaming.md @@ -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 | diff --git a/docs/defaults/both/studio.md b/docs/defaults/both/studio.md index 82c0ca60..dbbdf9e4 100644 --- a/docs/defaults/both/studio.md +++ b/docs/defaults/both/studio.md @@ -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 | diff --git a/docs/defaults/both/studio_anime.md b/docs/defaults/both/studio_anime.md index 41f8e746..f3c8b56b 100644 --- a/docs/defaults/both/studio_anime.md +++ b/docs/defaults/both/studio_anime.md @@ -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 | diff --git a/docs/defaults/both/subtitle_language.md b/docs/defaults/both/subtitle_language.md index 1e1a65e4..75b76274 100644 --- a/docs/defaults/both/subtitle_language.md +++ b/docs/defaults/both/subtitle_language.md @@ -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 | diff --git a/docs/defaults/both/year.md b/docs/defaults/both/year.md index ce4cd971..7fdd8cb4 100644 --- a/docs/defaults/both/year.md +++ b/docs/defaults/both/year.md @@ -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 " -**This file works with Movie and Show Libraries.** - ![](../images/year.png) +## Requirements & Recommendations + +Supported Library Types: Movie, Show + ## Collections Section 13 | Collection | Key | Description | diff --git a/docs/defaults/chart/anilist.md b/docs/defaults/chart/anilist.md index 3cfc2904..9460a950 100644 --- a/docs/defaults/chart/anilist.md +++ b/docs/defaults/chart/anilist.md @@ -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 | diff --git a/docs/defaults/chart/basic.md b/docs/defaults/chart/basic.md index db414c3b..57b83d6b 100644 --- a/docs/defaults/chart/basic.md +++ b/docs/defaults/chart/basic.md @@ -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 | diff --git a/docs/defaults/chart/flixpatrol.md b/docs/defaults/chart/flixpatrol.md index ba5563b1..ec5fa410 100644 --- a/docs/defaults/chart/flixpatrol.md +++ b/docs/defaults/chart/flixpatrol.md @@ -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 | diff --git a/docs/defaults/chart/imdb.md b/docs/defaults/chart/imdb.md index aa58e36c..6fae8128 100644 --- a/docs/defaults/chart/imdb.md +++ b/docs/defaults/chart/imdb.md @@ -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 | diff --git a/docs/defaults/chart/myanimelist.md b/docs/defaults/chart/myanimelist.md index 0f393e06..8090e457 100644 --- a/docs/defaults/chart/myanimelist.md +++ b/docs/defaults/chart/myanimelist.md @@ -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 | diff --git a/docs/defaults/chart/other.md b/docs/defaults/chart/other.md index ac89eb8e..0f46f871 100644 --- a/docs/defaults/chart/other.md +++ b/docs/defaults/chart/other.md @@ -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 | diff --git a/docs/defaults/chart/separator.md b/docs/defaults/chart/separator.md index 03956b37..e3fa678d 100644 --- a/docs/defaults/chart/separator.md +++ b/docs/defaults/chart/separator.md @@ -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 | diff --git a/docs/defaults/chart/tautulli.md b/docs/defaults/chart/tautulli.md index 28b5989c..f9101b7f 100644 --- a/docs/defaults/chart/tautulli.md +++ b/docs/defaults/chart/tautulli.md @@ -2,11 +2,13 @@ The `tautulli` Default Metadata File is used to create collections based on Tautulli/Plex Charts. -This Default file requires [Tautulli Authentication](../../config/tautulli) +![](../images/tautulli.png) -**This file works with Movie and Show Libraries.** +## Requirements & Recommendations -![](../images/tautulli.png) +Supported Library Types: Movie, Show + +Requirements: [Tautulli Authentication](../../config/tautulli) ## Collections Section 01 diff --git a/docs/defaults/chart/tmdb.md b/docs/defaults/chart/tmdb.md index 0a9a59fa..0465607a 100644 --- a/docs/defaults/chart/tmdb.md +++ b/docs/defaults/chart/tmdb.md @@ -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 | diff --git a/docs/defaults/chart/trakt.md b/docs/defaults/chart/trakt.md index dd86e4a6..65d3245f 100644 --- a/docs/defaults/chart/trakt.md +++ b/docs/defaults/chart/trakt.md @@ -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 | diff --git a/docs/defaults/movie/content_rating_us.md b/docs/defaults/movie/content_rating_us.md index 2c735f10..8e4ee493 100644 --- a/docs/defaults/movie/content_rating_us.md +++ b/docs/defaults/movie/content_rating_us.md @@ -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 | diff --git a/docs/defaults/movie/country.md b/docs/defaults/movie/country.md index ec98ce27..bdf935a5 100644 --- a/docs/defaults/movie/country.md +++ b/docs/defaults/movie/country.md @@ -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 | diff --git a/docs/defaults/movie/decade.md b/docs/defaults/movie/decade.md index 99353a70..f5f66863 100644 --- a/docs/defaults/movie/decade.md +++ b/docs/defaults/movie/decade.md @@ -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 " -**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 | diff --git a/docs/defaults/movie/director.md b/docs/defaults/movie/director.md index aec0b990..56eff1a8 100644 --- a/docs/defaults/movie/director.md +++ b/docs/defaults/movie/director.md @@ -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 | diff --git a/docs/defaults/movie/franchise.md b/docs/defaults/movie/franchise.md index b3230a4e..533d5e0a 100644 --- a/docs/defaults/movie/franchise.md +++ b/docs/defaults/movie/franchise.md @@ -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 | diff --git a/docs/defaults/movie/producer.md b/docs/defaults/movie/producer.md index f47a3cb6..a2dd0dbb 100644 --- a/docs/defaults/movie/producer.md +++ b/docs/defaults/movie/producer.md @@ -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 | diff --git a/docs/defaults/movie/seasonal.md b/docs/defaults/movie/seasonal.md index 41b5fc01..f4d9e294 100644 --- a/docs/defaults/movie/seasonal.md +++ b/docs/defaults/movie/seasonal.md @@ -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 | diff --git a/docs/defaults/movie/universe.md b/docs/defaults/movie/universe.md index 9884f2f4..ada4b986 100644 --- a/docs/defaults/movie/universe.md +++ b/docs/defaults/movie/universe.md @@ -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 | diff --git a/docs/defaults/movie/writer.md b/docs/defaults/movie/writer.md index 0de75cc0..64bc0bca 100644 --- a/docs/defaults/movie/writer.md +++ b/docs/defaults/movie/writer.md @@ -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 | diff --git a/docs/defaults/overlay_list.md b/docs/defaults/overlay_list.md index c80b0708..e086c7d8 100644 --- a/docs/defaults/overlay_list.md +++ b/docs/defaults/overlay_list.md @@ -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 | ✅ | ✅ | ❌ | ✅ | | [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" | ✅ | ✅ | ❌ | ❌ | +| [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 | ✅ | ✅ | ✅ | ✅ | diff --git a/docs/defaults/overlays/audio_codec.md b/docs/defaults/overlays/audio_codec.md index a6d10e0a..10e9391f 100644 --- a/docs/defaults/overlays/audio_codec.md +++ b/docs/defaults/overlays/audio_codec.md @@ -2,11 +2,13 @@ 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.** +![](images/audio_codec.png) -**Designed for [TRaSH Guides](https://trash-guides.info/) filename naming scheme.** +## Requirements & Recommendations -![](images/audio_codec.png) +Supported Overlay Level: Movie, Show, Season, Episode + +Recommendations: Designed for [TRaSH Guides](https://trash-guides.info/) filename naming scheme ## Supported Audio Codecs diff --git a/docs/defaults/overlays/commonsense.md b/docs/defaults/overlays/commonsense.md index ebd4c652..9e282f98 100644 --- a/docs/defaults/overlays/commonsense.md +++ b/docs/defaults/overlays/commonsense.md @@ -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 | diff --git a/docs/defaults/overlays/direct_play.md b/docs/defaults/overlays/direct_play.md index 0e64f628..4046243d 100644 --- a/docs/defaults/overlays/direct_play.md +++ b/docs/defaults/overlays/direct_play.md @@ -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: diff --git a/docs/defaults/overlays/episode_info.md b/docs/defaults/overlays/episode_info.md index fc207e61..e71c6336 100644 --- a/docs/defaults/overlays/episode_info.md +++ b/docs/defaults/overlays/episode_info.md @@ -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: diff --git a/docs/defaults/overlays/flixpatrol.md b/docs/defaults/overlays/flixpatrol.md index 6be6fa4a..ed4460d1 100644 --- a/docs/defaults/overlays/flixpatrol.md +++ b/docs/defaults/overlays/flixpatrol.md @@ -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 | diff --git a/docs/defaults/overlays/language_count.md b/docs/defaults/overlays/language_count.md index c15a4083..e5cdf29b 100644 --- a/docs/defaults/overlays/language_count.md +++ b/docs/defaults/overlays/language_count.md @@ -2,11 +2,11 @@ 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.** +![](images/language_count.png) -**Designed for [TRaSH Guides](https://trash-guides.info/) filename naming scheme.** +## Requirements & Recommendations -![](images/language_count.png) +Supported Overlay Level: Movie, Show, Season, Episode ## Supported Audio/Subtitle Languages diff --git a/docs/defaults/overlays/languages.md b/docs/defaults/overlays/languages.md index 85450431..b36feed5 100644 --- a/docs/defaults/overlays/languages.md +++ b/docs/defaults/overlays/languages.md @@ -2,11 +2,11 @@ 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.** +![](images/language.png) -**Designed for [TRaSH Guides](https://trash-guides.info/) filename naming scheme.** +## Requirements & Recommendations -![](images/language.png) +Supported library types: Movie & Show ## Supported Audio/Subtitle Language Flags diff --git a/docs/defaults/overlays/mediastinger.md b/docs/defaults/overlays/mediastinger.md index 4d77605c..af821bc4 100644 --- a/docs/defaults/overlays/mediastinger.md +++ b/docs/defaults/overlays/mediastinger.md @@ -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: diff --git a/docs/defaults/overlays/ratings.md b/docs/defaults/overlays/ratings.md index 80193fc1..eabf641c 100644 --- a/docs/defaults/overlays/ratings.md +++ b/docs/defaults/overlays/ratings.md @@ -2,13 +2,17 @@ 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 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. -**This file works with Movie and Show Libraries.** +![](images/ratings_overlay.png) -**If no template variables are set this file will do nothing.** +## Requirements & Recommendations -![](images/ratings_overlay.png) +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 diff --git a/docs/defaults/overlays/resolution.md b/docs/defaults/overlays/resolution.md index 19655f35..abbdead2 100644 --- a/docs/defaults/overlays/resolution.md +++ b/docs/defaults/overlays/resolution.md @@ -2,11 +2,11 @@ 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.** +![](images/resolution.png) -**Designed for [TRaSH Guides](https://trash-guides.info/) filename naming scheme.** +## Requirements & Recommendations -![](images/resolution.png) +Supported Overlay Level: Movie, Show, Episode ## Supported Resolutions diff --git a/docs/defaults/overlays/ribbon.md b/docs/defaults/overlays/ribbon.md index d7b0a580..3cd8a6bd 100644 --- a/docs/defaults/overlays/ribbon.md +++ b/docs/defaults/overlays/ribbon.md @@ -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 | diff --git a/docs/defaults/overlays/runtimes.md b/docs/defaults/overlays/runtimes.md index f1c89fdf..2be1a81f 100644 --- a/docs/defaults/overlays/runtimes.md +++ b/docs/defaults/overlays/runtimes.md @@ -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: diff --git a/docs/defaults/overlays/status.md b/docs/defaults/overlays/status.md index 11fc10f7..9a736358 100644 --- a/docs/defaults/overlays/status.md +++ b/docs/defaults/overlays/status.md @@ -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 | diff --git a/docs/defaults/overlays/streaming.md b/docs/defaults/overlays/streaming.md index 93c61ae8..3bb5f505 100644 --- a/docs/defaults/overlays/streaming.md +++ b/docs/defaults/overlays/streaming.md @@ -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 | diff --git a/docs/defaults/overlays/versions.md b/docs/defaults/overlays/versions.md index bad2f75a..b7d72f29 100644 --- a/docs/defaults/overlays/versions.md +++ b/docs/defaults/overlays/versions.md @@ -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: diff --git a/docs/defaults/overlays/video_format.md b/docs/defaults/overlays/video_format.md index 08bed7af..c7813c8a 100644 --- a/docs/defaults/overlays/video_format.md +++ b/docs/defaults/overlays/video_format.md @@ -2,11 +2,13 @@ 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.** +![](images/video_format.png) -**Designed for [TRaSH Guides](https://trash-guides.info/) filename naming scheme.** +## Requirements & Recommendations -![](images/video_format.png) +Supported Overlay Level: Movie, Show, Season, Episode + +Recommendations: Designed for [TRaSH Guides](https://trash-guides.info/) filename naming scheme ## Supported Video Formats diff --git a/docs/defaults/show/content_rating_us.md b/docs/defaults/show/content_rating_us.md index 9059fc18..29c10758 100644 --- a/docs/defaults/show/content_rating_us.md +++ b/docs/defaults/show/content_rating_us.md @@ -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 | diff --git a/docs/defaults/show/country.md b/docs/defaults/show/country.md index 97338398..3d51f48c 100644 --- a/docs/defaults/show/country.md +++ b/docs/defaults/show/country.md @@ -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 | diff --git a/docs/defaults/show/decade.md b/docs/defaults/show/decade.md index 1c9ff665..4dfb3372 100644 --- a/docs/defaults/show/decade.md +++ b/docs/defaults/show/decade.md @@ -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 " -**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 | diff --git a/docs/defaults/show/franchise.md b/docs/defaults/show/franchise.md index 96965adc..c081bbb3 100644 --- a/docs/defaults/show/franchise.md +++ b/docs/defaults/show/franchise.md @@ -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 | diff --git a/docs/defaults/show/network.md b/docs/defaults/show/network.md index 6ca4a456..78537406 100644 --- a/docs/defaults/show/network.md +++ b/docs/defaults/show/network.md @@ -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 |