Plex
/
Plex-Meta-Manager
mirror of https://github.com/meisnate12/Plex-Meta-Manager.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

[84] Updated defaults menu layout

Browse Source
pull/1551/head
meisnate12 1 year ago
parent a654092fff
commit 406b13e2d8
4 changed files with 210 additions and 151 deletions
Show Stats Download Patch File Download Diff File

2
VERSION
Unescape View File

@ -1 +1 @@
1.19.0-develop83 1.19.0-develop84

145
docs/conf.py
Unescape View File

@ -239,67 +239,62 @@ html_theme_options = {
("Chart Separator", "defaults/chart/separator"), ("Chart Separator", "defaults/chart/separator"),
("_divider",), ("_divider",),
("Basic Charts", "defaults/chart/basic"), ("Basic Charts", "defaults/chart/basic"),
("AniList Charts", "defaults/chart/anilist"),
("Flixpatrol Charts", "defaults/chart/flixpatrol"),
("IMDb Charts", "defaults/chart/imdb"),
("MyAnimeList Charts", "defaults/chart/myanimelist"),
("Tautulli Charts", "defaults/chart/tautulli"), ("Tautulli Charts", "defaults/chart/tautulli"),
("IMDb Charts", "defaults/chart/imdb"),
("TMDb Charts", "defaults/chart/tmdb"), ("TMDb Charts", "defaults/chart/tmdb"),
("Trakt Charts", "defaults/chart/trakt"), ("Trakt Charts", "defaults/chart/trakt"),
("Flixpatrol Charts", "defaults/chart/flixpatrol"),
("AniList Charts", "defaults/chart/anilist"),
("MyAnimeList Charts", "defaults/chart/myanimelist"),
("Other Charts", "defaults/chart/other"), ("Other Charts", "defaults/chart/other"),
]), ]),
("_menu", "Movie", "defaults/collections", "#general-collections", [ ("_menu", "Content", "defaults/collections", "#content-collections", [
("Actors", "defaults/both/actor"), ("Genres", "defaults/both/genre"),
("Aspect Ratio", "defaults/both/aspect"), ("Franchises (Movie)", "defaults/movie/franchise"),
("Audio Languages", "defaults/both/audio_language"), ("Franchises (TV)", "defaults/show/franchise"),
("Universes", "defaults/both/universe"),
("Based On...", "defaults/both/based"), ("Based On...", "defaults/both/based"),
("Collectionless", "defaults/both/collectionless"), ]),
("Common Sense Media Content Ratings", "defaults/both/content_rating_cs"), ("_menu", "Content Rating", "defaults/collections", "#content-rating-collections", [
("US Content Ratings (Movie)", "defaults/movie/content_rating_us"),
("US Content Ratings (TV)", "defaults/show/content_rating_us"),
("UK Content Ratings", "defaults/both/content_rating_uk"),
("MyAnimeList Content Ratings", "defaults/both/content_rating_mal"), ("MyAnimeList Content Ratings", "defaults/both/content_rating_mal"),
("Content Ratings (US)", "defaults/movie/content_rating_us"), ("Common Sense Media Content Ratings", "defaults/both/content_rating_cs"),
("Content Ratings (UK)", "defaults/both/content_rating_uk"), ]),
("Countries", "defaults/movie/country"), ("_menu", "Location", "defaults/collections", "#location-collections", [
("Regions", "defaults/movie/region"), ("Countries (Movie)", "defaults/movie/country"),
("Continents", "defaults/movie/continent"), ("Countries (TV)", "defaults/show/country"),
("Decades", "defaults/movie/decade"), ("Regions (Movie)", "defaults/movie/region"),
("Directors", "defaults/movie/director"), ("Regions (TV)", "defaults/show/region"),
("Franchises", "defaults/movie/franchise"), ("Continents (Movie)", "defaults/movie/continent"),
("Genres", "defaults/both/genre"), ("Continents (TV)", "defaults/show/continent"),
("Producers", "defaults/movie/producer"), ]),
("_menu", "Media", "defaults/collections", "#media-collections", [
("Aspect Ratios", "defaults/both/aspect"),
("Resolutions", "defaults/both/resolution"), ("Resolutions", "defaults/both/resolution"),
("Seasonal", "defaults/movie/seasonal"), ("Audio Languages", "defaults/both/audio_language"),
("Streaming", "defaults/both/streaming"),
("Studios", "defaults/both/studio"),
("Anime Studios", "defaults/both/studio_anime"),
("Subtitle Languages", "defaults/both/subtitle_language"), ("Subtitle Languages", "defaults/both/subtitle_language"),
("Universes", "defaults/both/universe"),
("Writers", "defaults/movie/writer"),
("Years", "defaults/both/year"),
]), ]),
("_menu", "Show", "defaults/collections", "#general-collections", [ ("_menu", "Production", "defaults/collections", "#production-collections", [
("Actors", "defaults/both/actor"),
("Aspect Ratio", "defaults/both/aspect"),
("Audio Languages", "defaults/both/audio_language"),
("Based On...", "defaults/both/based"),
("Collectionless", "defaults/both/collectionless"),
("Common Sense Media Content Ratings", "defaults/both/content_rating_cs"),
("MyAnimeList Content Ratings", "defaults/both/content_rating_mal"),
("US Content Ratings", "defaults/show/content_rating_us"),
("UK Content Ratings", "defaults/both/content_rating_uk"),
("Countries", "defaults/show/country"),
("Regions", "defaults/show/region"),
("Continents", "defaults/show/continent"),
("Decades", "defaults/show/decade"),
("Franchises", "defaults/show/franchise"),
("Genres", "defaults/both/genre"),
("Networks", "defaults/show/network"), ("Networks", "defaults/show/network"),
("Resolutions", "defaults/both/resolution"),
("Streaming", "defaults/both/streaming"), ("Streaming", "defaults/both/streaming"),
("Studios", "defaults/both/studio"), ("Studios", "defaults/both/studio"),
("Anime Studios", "defaults/both/studio_anime"), ]),
("Subtitle Languages", "defaults/both/subtitle_language"), ("_menu", "People", "defaults/collections", "#people-collections", [
("Universes", "defaults/both/universe"), ("Actors", "defaults/both/actor"),
("Directors", "defaults/movie/director"),
("Producers", "defaults/movie/producer"),
("Writers", "defaults/movie/writer"),
]),
("_menu", "Time", "defaults/collections", "#time-collections", [
("Seasonal", "defaults/movie/seasonal"),
("Years", "defaults/both/year"), ("Years", "defaults/both/year"),
("Decades (Movie)", "defaults/movie/decade"),
("Decades (TV)", "defaults/show/decade"),
]),
("_menu", "Utility", "defaults/collections", "#utility-collections", [
("Collectionless", "defaults/both/collectionless"),
]), ]),
]), ]),
("Playlists", "defaults/playlist"), ("Playlists", "defaults/playlist"),
@ -307,28 +302,40 @@ html_theme_options = {
("Overlays", "defaults/overlays"), ("Overlays", "defaults/overlays"),
("Shared Variables", "defaults/overlay_variables"), ("Shared Variables", "defaults/overlay_variables"),
("_divider", ), ("_divider", ),
("Aspect Ratio", "defaults/overlays/aspect"), ("_menu", "Chart", "defaults/overlays", "#chart-overlays", [
("Audio Codec", "defaults/overlays/audio_codec"), ("FlixPatrol Top", "defaults/overlays/flixpatrol"),
("Common Sense Age Ratings", "defaults/overlays/commonsense"), ("Ribbon", "defaults/overlays/ribbon"),
("Content Ratings (UK)", "defaults/overlays/content_rating_uk"), ]),
("Content Ratings (US Movie)", "defaults/overlays/content_rating_us_movie"), ("_menu", "Content", "defaults/overlays", "#content-overlays", [
("Content Ratings (US Show)", "defaults/overlays/content_rating_us_show"), ("Episode Info", "defaults/overlays/episode_info"),
("Direct Play Only", "defaults/overlays/direct_play"), ("MediaStinger", "defaults/overlays/mediastinger"),
("Episode Info", "defaults/overlays/episode_info"), ("Ratings", "defaults/overlays/ratings"),
("FlixPatrol Top", "defaults/overlays/flixpatrol"), ("Status", "defaults/overlays/status"),
("Audio/Subtitle Language Count", "defaults/overlays/language_count"), ]),
("Audio/Subtitle Language Flags", "defaults/overlays/languages"), ("_menu", "Content Rating", "defaults/overlays", "#content-rating-overlays", [
("MediaStinger", "defaults/overlays/mediastinger"), ("US Content Ratings (Movie)", "defaults/overlays/content_rating_us_movie"),
("Networks", "defaults/overlays/network"), ("US Content Ratings (Show)", "defaults/overlays/content_rating_us_show"),
("Ratings", "defaults/overlays/ratings"), ("UK Content Ratings", "defaults/overlays/content_rating_uk"),
("Resolution/Edition", "defaults/overlays/resolution"), ("Common Sense Age Ratings", "defaults/overlays/commonsense"),
("Ribbon", "defaults/overlays/ribbon"), ]),
("Runtimes", "defaults/overlays/runtimes"), ("_menu", "Media", "defaults/overlays", "#media-overlays", [
("Status", "defaults/overlays/status"), ("Aspect Ratio", "defaults/overlays/aspect"),
("Streaming", "defaults/overlays/streaming"), ("Audio Codec", "defaults/overlays/audio_codec"),
("Studios", "defaults/overlays/studio"), ("Audio/Subtitle Language Count", "defaults/overlays/language_count"),
("Versions", "defaults/overlays/versions"), ("Audio/Subtitle Language Flags", "defaults/overlays/languages"),
("Video Format", "defaults/overlays/video_format"), ("Resolution/Edition", "defaults/overlays/resolution"),
("Runtimes", "defaults/overlays/runtimes"),
("Versions", "defaults/overlays/versions"),
("Video Format", "defaults/overlays/video_format"),
]),
("_menu", "Production", "defaults/overlays", "#production-overlays", [
("Networks", "defaults/overlays/network"),
("Streaming", "defaults/overlays/streaming"),
("Studios", "defaults/overlays/studio"),
]),
("_menu", "Utility", "defaults/overlays", "#utility-overlays", [
("Direct Play Only", "defaults/overlays/direct_play"),
]),
]), ]),
]), ]),
("_menu", "Files", [ ("_menu", "Files", [

143
docs/defaults/collection_list.md
Unescape View File

@ -6,66 +6,101 @@ These collections are applied by calling the below paths into the `metadata_path
### Award Collections ### Award Collections
| Default | Path | Example Collections | Works with Movies | Works with Shows | | Default | Path | Example Collections | Works with Movies | Works with Shows |
|:-----------------------------------------------------------|:------------------|:--------------------------------------------|:--------------------:|:-------------------:| |:------------------------------------------------|:------------------|:--------------------------------------------|:--------------------:|:-------------------:|
| [Award Separator](award/separator) | `separator_award` | Award Collections | ✅ | ✅ | | [Award Separator](award/separator) | `separator_award` | Award Collections | ✅ | ✅ |
| [British Academy of Film and Television Arts](award/bafta) | `bafta` | BAFTA Best Films, BAFTA 2021 | &#9989;<sup>1</sup> | &#10060; | | [Academy Awards (Oscars)](award/oscars) | `oscars` | Best Picture Winners | &#9989; | &#10060; |
| [Cannes](award/cannes) | `cannes` | Cannes - Palme d'or, Cannes 2018 | &#9989;<sup>1</sup> | &#10060; | | [British Academy of Film Awards](award/bafta) | `bafta` | BAFTA Best Films, BAFTA 2021 | &#9989;<sup>1</sup> | &#10060; |
| [Critics Choice](award/choice) | `choice` | Critics Choice Awards 2020 | &#9989;<sup>1</sup> | &#9989;<sup>1</sup> | | [Cannes Film Festival Awards](award/cannes) | `cannes` | Cannes - Palme d'or, Cannes 2018 | &#9989;<sup>1</sup> | &#10060; |
| [Emmys](award/emmy) | `emmy` | Emmys 2021 | &#9989; | &#9989; | | [Critics Choice Awards](award/choice) | `choice` | Critics Choice Awards 2020 | &#9989;<sup>1</sup> | &#9989;<sup>1</sup> |
| [Golden Globes](award/golden) | `golden` | Best Motion Pictures | &#9989; | &#9989; | | [Emmy Awards](award/emmy) | `emmy` | Emmys 2021 | &#9989; | &#9989; |
| [Academy Awards (Oscars)](award/oscars) | `oscars` | Best Picture Winners | &#9989; | &#10060; | | [Golden Globe Awards](award/golden) | `golden` | Best Motion Pictures | &#9989; | &#9989; |
| [Independent Spirit](award/spirit) | `spirit` | Independent Spirit Awards 2021 | &#9989;<sup>1</sup> | &#10060; | | [Independent Spirit Awards](award/spirit) | `spirit` | Independent Spirit Awards 2021 | &#9989;<sup>1</sup> | &#10060; |
| [Sundance](award/sundance) | `sundance` | Sundance Grand Jury Winners | &#9989;<sup>1</sup> | &#10060; | | [Sundance Film Festival Awards](award/sundance) | `sundance` | Sundance Grand Jury Winners | &#9989;<sup>1</sup> | &#10060; |
| [Other](award/other) | `other_award` | Berlinale Golden Bears, Venice Golden Lions | &#9989;<sup>1</sup> | &#10060; | | [Other Awards](award/other) | `other_award` | Berlinale Golden Bears, Venice Golden Lions | &#9989;<sup>1</sup> | &#10060; |
<sup>1</sup> Requires [Trakt Authentication](../config/trakt) <sup>1</sup> Requires [Trakt Authentication](../config/trakt)
### Chart Collections ### Chart Collections
| Default | Path | Example Collections | Works with Movies | Works with Shows | | Default | Path | Example Collections | Works with Movies | Works with Shows |
|:-----------------------------------|:------------------|:-------------------------------------------|:-------------------:|:-------------------:| |:----------------------------------------|:------------------|:-------------------------------------------|:-------------------:|:-------------------:|
| [Chart Separator](chart/separator) | `separator_chart` | Chart Collections | &#9989; | &#9989; | | [Chart Separator](chart/separator) | `separator_chart` | Chart Collections | &#9989; | &#9989; |
| [AniList](chart/anilist) | `anilist` | AniList Popular, AniList Season | &#9989; | &#9989; | | [Basic Charts](chart/basic) | `basic` | Newly Released, New Episodes | &#9989; | &#9989; |
| [Basic](chart/basic) | `basic` | Newly Released, New Episodes | &#9989; | &#9989; | | [Tautulli Charts](chart/tautulli) | `tautulli` | Plex Popular, Plex Watched | &#9989;<sup>2</sup> | &#9989;<sup>2</sup> |
| [FlixPatrol](chart/flixpatrol) | `flixpatrol` | Top Disney, Top Max, Top Hulu, Top Netflix | &#9989; | &#9989; | | [IMDb Charts](chart/imdb) | `imdb` | IMDb Popular, IMDb Top 250 | &#9989; | &#9989; |
| [IMDb](chart/imdb) | `imdb` | IMDb Popular, IMDb Top 250 | &#9989; | &#9989; | | [TMDb Charts](chart/tmdb) | `tmdb` | TMDb Popular, TMDb Airing Today | &#9989; | &#9989; |
| [MyAnimeList](chart/myanimelist) | `myanimelist` | MyAnimeList Popular, MyAnimeList Top Rated | &#9989; | &#9989; | | [Trakt Charts](chart/trakt) | `trakt` | Trakt Popular, Trakt Trending | &#9989;<sup>1</sup> | &#9989;<sup>1</sup> |
| [Other](chart/other) | `other_chart` | AniDB Popular, Common Sense Selection | &#9989; | &#9989; | | [FlixPatrol Charts](chart/flixpatrol) | `flixpatrol` | Top Disney, Top Max, Top Hulu, Top Netflix | &#9989; | &#9989; |
| [Tautulli](chart/tautulli) | `tautulli` | Plex Popular, Plex Watched | &#9989;<sup>2</sup> | &#9989;<sup>2</sup> | | [AniList Charts](chart/anilist) | `anilist` | AniList Popular, AniList Season | &#9989; | &#9989; |
| [TMDb](chart/tmdb) | `tmdb` | TMDb Popular, TMDb Airing Today | &#9989; | &#9989; | | [MyAnimeList Charts](chart/myanimelist) | `myanimelist` | MyAnimeList Popular, MyAnimeList Top Rated | &#9989; | &#9989; |
| [Trakt](chart/trakt) | `trakt` | Trakt Popular, Trakt Trending | &#9989;<sup>1</sup> | &#9989;<sup>1</sup> | | [Other Charts](chart/other) | `other_chart` | AniDB Popular, Common Sense Selection | &#9989; | &#9989; |
<sup>1</sup> Requires [Trakt Authentication](../config/trakt) <sup>1</sup> Requires [Trakt Authentication](../config/trakt)
<sup>2</sup> Requires [Tautulli Authentication](../config/tautulli) <sup>2</sup> Requires [Tautulli Authentication](../config/tautulli)
### General Collections ### Content Collections
| Default | Path | Example Collections | Works with Movies | Works with Shows | | Default | Path | Example Collections | Works with Movies | Works with Shows |
|:------------------------------------------------------------------------------------|:---------------------|:-------------------------------------------------------|:-----------------:|:----------------:| |:-----------------------------------------------------------|:------------|:--------------------------------------------|:-----------------:|:----------------:|
| [Actor](both/actor) | `actor` | Chris Hemsworth, Margot Robbie | &#9989; | &#9989; | | [Genres](both/genre) | `genre` | Action, Drama, Science Fiction | &#9989; | &#9989; |
| [Audio Language](both/audio_language) | `audio_language` | French Audio, Korean Audio | &#9989; | &#9989; | | Franchises [Movie](movie/franchise)/[Show](show/franchise) | `franchise` | Star Wars: Skywalker Saga, Godzilla (Anime) | &#9989; | &#9989; |
| [Based On...](both/based) | `based` | Based on a Book, Based on a True Story | &#9989; | &#9989; | | [Universes](both/universe) | `universe` | Marvel Cinematic Universal, Wizarding World | &#9989; | &#9989; |
| [Collectionless](both/collectionless) | `collectionless` | Collectionless | &#9989; | &#9989; | | [Based On...](both/based) | `based` | Based on a Book, Based on a True Story | &#9989; | &#9989; |
| [Common Sense Content Rating](both/content_rating_cs) | `content_rating_cs` | 1, 2, 3, 4, 5, 6, 15, 16, 17, 18 | &#9989; | &#9989; |
| [MyAnimeList Content Rating](both/content_rating_mal) | `content_rating_mal` | G, PG, PG-13, R, R+, Rx | &#9989; | &#9989; | ### Content Rating Collections
| [Content Rating (UK)](both/content_rating_uk) | `content_rating_uk` | U, PG, 12A | &#9989; | &#9989; |
| Content Rating (US) [Movie](movie/content_rating_us)/[Show](show/content_rating_us) | `content_rating_us` | G, PG, NC-17 | &#9989; | &#9989; | | Default | Path | Example Collections | Works with Movies | Works with Shows |
| Country [Movie](movie/country)/[Show](show/country) | `country` | Belgium, India | &#9989; | &#9989; | |:-----------------------------------------------------------------------------------|:---------------------|:---------------------------------|:-----------------:|:----------------:|
| Region [Movie](movie/region)/[Show](show/region) | `region` | Iberia, Balkans | &#9989; | &#9989; | | US Content Ratings [Movie](movie/content_rating_us)/[Show](show/content_rating_us) | `content_rating_us` | G, PG, NC-17 | &#9989; | &#9989; |
| Continent [Movie](movie/continent)/[Show](show/continent) | `continent` | Asia, North America | &#9989; | &#9989; | | [UK Content Ratings](both/content_rating_uk) | `content_rating_uk` | U, PG, 12A | &#9989; | &#9989; |
| Decade [Movie](movie/decade)/[Show](show/decade) | `decade` | Best of 2012, Best of 2022 | &#9989; | &#9989; | | [MyAnimeList Content Ratings](both/content_rating_mal) | `content_rating_mal` | G, PG, PG-13, R, R+, Rx | &#9989; | &#9989; |
| [Director](movie/director) | `director` | Steven Spielberg (Director), Olivia Wilde (Director) | &#9989; | &#10060; | | [Common Sense Media Content Ratings](both/content_rating_cs) | `content_rating_cs` | 1, 2, 3, 4, 5, 6, 15, 16, 17, 18 | &#9989; | &#9989; |
| Franchise [Movie](movie/franchise)/[Show](show/franchise) | `franchise` | Star Wars: Skywalker Saga, Godzilla (Anime) | &#9989; | &#9989; |
| [Genre](both/genre) | `genre` | Action, Drama, Science Fiction | &#9989; | &#9989; | ### Location Collections
| [Network](show/network) | `network` | Disney Channel, Lifetime | &#10060; | &#9989; |
| [Producer](movie/producer) | `producer` | James Cameron (Producer), Reese Witherspoon (Producer) | &#9989; | &#10060; | | Default | Path | Example Collections | Works with Movies | Works with Shows |
| [Resolution](both/resolution) | `resolution` | 4K Movies, 1080p Movies, 720p Movies | &#9989; | &#9989; | |:-----------------------------------------------------------|:------------|:-----------------------|:-----------------:|:----------------:|
| [Seasonal](movie/seasonal) | `seasonal` | Easter, Christmas | &#9989; | &#10060; | | Countries [Movie](movie/country)/[Show](show/country) | `country` | Belgium, India | &#9989; | &#9989; |
| [Streaming](both/streaming) | `streaming` | Disney+ Movies, Max Shows | &#9989; | &#9989; | | Regions [Movie](movie/region)/[Show](show/region) | `region` | Iberia, Balkans | &#9989; | &#9989; |
| [Studio](both/studio) | `studio` | DreamWorks Studios, Walt Disney Pictures | &#9989; | &#9989; | | Continents [Movie](movie/continent)/[Show](show/continent) | `continent` | Asia, North America | &#9989; | &#9989; |
| [Anime Studio](both/studio_anime) | `studio_anime` | Bones, Studio Ghibli, Toei Animation | &#9989; | &#9989; |
| [Subtitle Language](both/subtitle_language) | `subtitle_language` | German Subtitles, Swedish Subtitles | &#9989; | &#9989; | ### Media Collections
| [Universe](both/universe) | `universe` | Marvel Cinematic Universal, Wizarding World | &#9989; | &#9989; |
| [Year](both/year) | `year` | Best of 2010, Best of 2019 | &#9989; | &#9989; | | Default | Path | Example Collections | Works with Movies | Works with Shows |
| [Writer](movie/writer) | `writer` | James Cameron (Writer), Lilly Wachowski (Writer) | &#9989; | &#10060; | |:---------------------------------------------|:--------------------|:-------------------------------------|:-----------------:|:----------------:|
| [Aspect Ratios](both/aspect) | `aspect` | 1.33, 1.65, 1.78, 1.85, 2.77 | &#9989; | &#9989; |
| [Resolutions](both/resolution) | `resolution` | 4K Movies, 1080p Movies, 720p Movies | &#9989; | &#9989; |
| [Audio Languages](both/audio_language) | `audio_language` | French Audio, Korean Audio | &#9989; | &#9989; |
| [Subtitle Languages](both/subtitle_language) | `subtitle_language` | German Subtitles, Swedish Subtitles | &#9989; | &#9989; |
### Production Collections
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|:----------------------------|:------------|:-----------------------------------------|:-----------------:|:----------------:|
| [Networks](show/network) | `network` | Disney Channel, Lifetime | &#10060; | &#9989; |
| [Streaming](both/streaming) | `streaming` | Disney+ Movies, Max Shows | &#9989; | &#9989; |
| [Studios](both/studio) | `studio` | DreamWorks Studios, Walt Disney Pictures | &#9989; | &#9989; |
### People Collections
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|:----------------------------|:-----------|:-------------------------------------------------------|:-----------------:|:----------------:|
| [Actors](both/actor) | `actor` | Chris Hemsworth, Margot Robbie | &#9989; | &#9989; |
| [Directors](movie/director) | `director` | Steven Spielberg (Director), Olivia Wilde (Director) | &#9989; | &#10060; |
| [Producers](movie/producer) | `producer` | James Cameron (Producer), Reese Witherspoon (Producer) | &#9989; | &#10060; |
| [Writers](movie/writer) | `writer` | James Cameron (Writer), Lilly Wachowski (Writer) | &#9989; | &#10060; |
### Time Collections
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|:--------------------------------------------------|:-----------|:---------------------------|:-----------------:|:----------------:|
| [Seasonal](movie/seasonal) | `seasonal` | Easter, Christmas | &#9989; | &#10060; |
| [Years](both/year) | `year` | Best of 2010, Best of 2019 | &#9989; | &#9989; |
| Decades [Movie](movie/decade)/[Show](show/decade) | `decade` | Best of 2012, Best of 2022 | &#9989; | &#9989; |
### Utility Collections
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|:--------------------------------------|:-----------------|:-------------------------|:-----------------:|:----------------:|
| [Collectionless](both/collectionless) | `collectionless` | Collectionless | &#9989; | &#9989; |

71
docs/defaults/overlay_list.md
Unescape View File

@ -8,33 +8,50 @@ In the scenario where there is missing data such as age ratings for episodes, th
These overlays are applied by calling the below paths into the `overlay_path` [section](../config/libraries.md#overlay-path) of your config.yml 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 ### Chart Overlays
| Default | path | Example Overlays | Movies | Shows | Seasons | Episodes | | Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
|:--------------------------------------------------------------------|:--------------------------|:--------------------------------------------------------------------------|:-------------------:|:-------------------:|:-------------------:|:-------------------:| |:----------------------------------|:-------------|:-----------------------------------------|:--------:|:-------:|:--------:|:--------:|
| [Aspect Ratio](overlays/aspect) | `aspect` | "1.33","1.78" | &#9989;<sup>1</sup> | &#9989;<sup>1</sup> | &#9989;<sup>1</sup> | &#9989;<sup>1</sup> | | [FlixPatrol](overlays/flixpatrol) | `flixpatrol` | "Streaming service logo with words "TOP" | &#9989; | &#9989; | &#10060; | &#10060; |
| [Audio Codec](overlays/audio_codec) | `audio_codec` | Dolby Atmos logo, DTS logo | &#9989;<sup>1</sup> | &#9989;<sup>1</sup> | &#9989;<sup>1</sup> | &#9989;<sup>1</sup> | | [Ribbon](overlays/ribbon) | `ribbon` | IMDb Top 250 Ribbon, RT Fresh Ribbon | &#9989; | &#9989; | &#10060; | &#10060; |
| [CommonSense Age Rating](overlays/commonsense) | `commonsense` | "3+", "16+" | &#9989; | &#9989; | &#10071; | &#10071; |
| [Content Rating UK (BBFC)](overlays/content_rating_uk) | `content_rating_uk` | "12", "12a" | &#9989; | &#9989; | &#10071; | &#10071; | ### Content Overlays
| [Content Rating US Movies (MPAA)](overlays/content_rating_us_movie) | `content_rating_us_movie` | "PG", "PG-13" | &#9989; | &#10060; | &#10071; | &#10071; |
| [Content Rating US Shows (MPAA)](overlays/content_rating_us_show) | `content_rating_us_show` | "TV-Y", "TV-MA" | &#10060; | &#9989; | &#10071; | &#10071; | | Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
| [Direct Play](overlays/direct_play) | `direct_play` | "Direct Play Only" | &#9989; | &#10071; | &#10071; | &#9989; | |:----------------------------------------|:---------------|:-------------------------------------------------|:--------:|:--------:|:--------:|:--------:|
| [Episode Info](overlays/episode_info) | `episode_info` | "S01E01", "S02E09" | &#10060; | &#10060; | &#10060; | &#9989; | | [Episode Info](overlays/episode_info) | `episode_info` | "S01E01", "S02E09" | &#10060; | &#10060; | &#10060; | &#9989; |
| [FlixPatrol](overlays/flixpatrol) | `flixpatrol` | "Streaming service logo with words "TOP" | &#9989; | &#9989; | &#10060; | &#10060; | | [Mediastinger](overlays/mediastinger) | `mediastinger` | Mediastinger Logo for After/During Credit Scenes | &#9989; | &#9989; | &#10060; | &#10060; |
| [Language Count](overlays/language_count) | `language_count` | Dual-Audio, Multi-Audio, Dual-Subtitle, Multi-Subtitle | &#9989; | &#9989; | &#9989; | &#9989; | | [Ratings](overlays/ratings)<sup>1</sup> | `ratings` | IMDb Audience Rating, Metacritic Critic Rating | &#9989; | &#9989; | &#10060; | &#9989; |
| [Languages](overlays/languages) | `languages` | Flags Based on the Audio/Subtitles a file has | &#9989; | &#9989; | &#9989; | &#9989; | | [Status](overlays/status) | `status` | Airing, Returning, Canceled, Ended | &#10060; | &#9989; | &#10060; | &#10060; |
| [Mediastinger](overlays/mediastinger) | `mediastinger` | Mediastinger Logo for After/During Credit Scenes | &#9989; | &#9989; | &#10060; | &#10060; |
| [Network](overlays/network) | `network` | "ABC", "CBS" | &#10060; | &#9989; | &#9989; | &#9989; | <sup>1</sup> Requires Template Variables to function
| [Ratings](overlays/ratings) | `ratings` | IMDb Audience Rating, Metacritic Critic Rating | &#9989;<sup>3</sup> | &#9989;<sup>3</sup> | &#10060; | &#9989;<sup>3</sup> |
| [Resolution/Editions](overlays/resolution) | `resolution` | 4K Dolby Vision logo, 720P logo, "Director's Cut", "Criterion Collection" | &#9989;<sup>2</sup> | &#9989;<sup>2</sup> | &#10060; | &#9989;<sup>2</sup> | ### Media Overlays
| [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; | &#9989; | | Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
| [Status](overlays/status) | `status` | Airing, Returning, Canceled, Ended | &#10060; | &#9989; | &#10060; | &#10060; | |:---------------------------------------------------------|:-----------------|:--------------------------------------------------------------------------|:-------:|:--------:|:--------:|:--------:|
| [Streaming](overlays/streaming) | `streaming` | Netflix logo, Hulu logo | &#9989; | &#9989; | &#10060; | &#10060; | | [Aspect Ratio](overlays/aspect)<sup>1</sup> | `aspect` | "1.33","1.78" | &#9989; | &#9989; | &#9989; | &#9989; |
| [Studio](overlays/studio) | `studio` | "Warner Bros. Pictures", "Amblin Entertainment" | &#9989; | &#9989; | &#9989; | &#9989; | | [Audio Codec](overlays/audio_codec)<sup>1</sup> | `audio_codec` | Dolby Atmos logo, DTS logo | &#9989; | &#9989; | &#9989; | &#9989; |
| [Versions](overlays/versions) | `versions` | Multiple Versions logo | &#9989; | &#9989; | &#9989; | &#9989; | | [Audio/Subtitle Language Count](overlays/language_count) | `language_count` | Dual-Audio, Multi-Audio, Dual-Subtitle, Multi-Subtitle | &#9989; | &#9989; | &#9989; | &#9989; |
| [Video Format](overlays/video_format) | `video_format` | "REMUX", "HDTV" | &#9989;<sup>1</sup> | &#10071; | &#10071; | &#9989;<sup>1</sup> | | [Audio/Subtitle Language Flags](overlays/languages) | `languages` | Flags Based on the Audio/Subtitles a file has | &#9989; | &#9989; | &#9989; | &#9989; |
| [Resolution/Editions](overlays/resolution)<sup>2</sup> | `resolution` | 4K Dolby Vision logo, 720P logo, "Director's Cut", "Criterion Collection" | &#9989; | &#9989; | &#10060; | &#9989; |
| [Runtimes](overlays/runtimes) | `runtimes` | "Runtime: 1h 30m" | &#9989; | &#9989; | &#10060; | &#9989; |
| [Versions](overlays/versions) | `versions` | Multiple Versions logo | &#9989; | &#9989; | &#9989; | &#9989; |
| [Video Format](overlays/video_format)<sup>1</sup> | `video_format` | "REMUX", "HDTV" | &#9989; | &#10071; | &#10071; | &#9989; |
<sup>1</sup> Designed for [TRaSH Guides](https://trash-guides.info/) filename naming scheme <sup>1</sup> Designed for [TRaSH Guides](https://trash-guides.info/) filename naming scheme
<sup>2</sup> Requires Plex Pass or [TRaSH Guides](https://trash-guides.info/) filename naming scheme <sup>2</sup> Requires Plex Pass or [TRaSH Guides](https://trash-guides.info/) filename naming scheme
<sup>3</sup> Requires Template Variables to function
### Production Overlays
| Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
|:--------------------------------|:------------|:------------------------------------------------|:--------:|:-------:|:--------:|:--------:|
| [Network](overlays/network) | `network` | "ABC", "CBS" | &#10060; | &#9989; | &#9989; | &#9989; |
| [Streaming](overlays/streaming) | `streaming` | Netflix logo, Hulu logo | &#9989; | &#9989; | &#10060; | &#10060; |
| [Studio](overlays/studio) | `studio` | "Warner Bros. Pictures", "Amblin Entertainment" | &#9989; | &#9989; | &#9989; | &#9989; |
### Utility Overlays
| Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
|:------------------------------------|:--------------|:-------------------|:-------:|:--------:|:--------:|:--------:|
| [Direct Play](overlays/direct_play) | `direct_play` | "Direct Play Only" | &#9989; | &#10071; | &#10071; | &#9989; |

Write Preview
Loading…
Cancel
Save