From 5fe07c79253c3cd332f2d9dd63aa251b3d570a9c Mon Sep 17 00:00:00 2001 From: YozoraXCII <96386153+YozoraXCII@users.noreply.github.com> Date: Sat, 21 Jan 2023 00:36:20 +0000 Subject: [PATCH] Add sup highlights for mandatory requirements --- docs/defaults/collection_list.md | 55 +++++++++++++++++--------------- docs/defaults/overlay_list.md | 39 +++++++++++----------- 2 files changed, 50 insertions(+), 44 deletions(-) diff --git a/docs/defaults/collection_list.md b/docs/defaults/collection_list.md index a8518844..b7d90e03 100644 --- a/docs/defaults/collection_list.md +++ b/docs/defaults/collection_list.md @@ -4,35 +4,38 @@ These files can generally be used on both Movie and Show library-types, or are p These collections are applied by calling the below paths into the `metadata_path` section of your config.yml -### Chart Collections +### Award Collections -| Default | Path | Example Collections | Works with Movies | Works with Shows | -|:-----------------------------------|:------------------|:-------------------------------------------|:-----------------:|:----------------:| -| [Chart Separator](chart/separator) | `separator_chart` | Chart Collections | ✅ | ✅ | -| [AniList](chart/anilist) | `anilist` | AniList Popular, AniList Season | ✅ | ✅ | -| [Basic](chart/basic) | `basic` | Newly Released, New Episodes | ✅ | ✅ | -| [FlixPatrol](chart/flixpatrol) | `flixpatrol` | Top Disney, Top Hbo, Top Hulu, Top Netflix | ✅ | ✅ | -| [IMDb](chart/imdb) | `imdb` | IMDb Popular, IMDb Top 250 | ✅ | ✅ | -| [MyAnimeList](chart/myanimelist) | `myanimelist` | MyAnimeList Popular, MyAnimeList Top Rated | ✅ | ✅ | -| [Other](chart/other) | `other_chart` | AniDB Popular, Common Sense Selection | ✅ | ✅ | -| [Tautulli](chart/tautulli) | `tautulli` | Plex Popular, Plex Watched | ✅ | ✅ | -| [TMDb](chart/tmdb) | `tmdb` | TMDb Popular, TMDb Airing Today | ✅ | ✅ | -| [Trakt](chart/trakt) | `trakt` | Trakt Popular, Trakt Trending | ✅ | ✅ | +| Default | Path | Example Collections | Works with Movies | Works with Shows | +|:-----------------------------------------------------------|:------------------|:--------------------------------------------|:--------------------:|:---------------------:| +| [Award Separator](award/separator) | `separator_award` | Award Collections | ✅ | ✅ | +| [British Academy of Film and Television Arts](award/bafta) | `bafta` | BAFTA Best Films, BAFTA 2021 | ✅1 | ❌1 | +| [Cannes](award/cannes) | `cannes` | Cannes - Palme d'or, Cannes 2018 | ✅1 | ❌1 | +| [Critics Choice](award/choice) | `choice` | Critics Choice Awards 2020 | ✅1 | ✅1 | +| [Emmys](award/emmy) | `emmy` | Emmys 2021 | ✅ | ✅ | +| [Golden Globes](award/golden) | `golden` | Best Motion Pictures | ✅ | ✅ | +| [Academy Awards (Oscars)](award/oscars) | `oscars` | Best Picture Winners | ✅ | ❌ | +| [Independent Spirit](award/spirit) | `spirit` | Independent Spirit Awards 2021 | ✅1 | ❌1 | +| [Sundance](award/sundance) | `sundance` | Sundance Grand Jury Winners | ✅1 | ❌1 | +| [Other](award/other) | `other_award` | Berlinale Golden Bears, Venice Golden Lions | ✅1 | ❌1 | +1 Requires [Trakt Authentication](../config/trakt) -### Award Collections +### Chart Collections -| Default | Path | Example Collections | Works with Movies | Works with Shows | -|:-----------------------------------------------------------|:------------------|:--------------------------------------------|:-----------------:|:----------------:| -| [Award Separator](award/separator) | `separator_award` | Award Collections | ✅ | ✅ | -| [British Academy of Film and Television Arts](award/bafta) | `bafta` | BAFTA Best Films, BAFTA 2021 | ✅ | ❌ | -| [Cannes](award/cannes) | `cannes` | Cannes - Palme d'or, Cannes 2018 | ✅ | ❌ | -| [Critics Choice](award/choice) | `choice` | Critics Choice Awards 2020 | ✅ | ✅ | -| [Emmys](award/emmy) | `emmy` | Emmys 2021 | ✅ | ✅ | -| [Golden Globes](award/golden) | `golden` | Best Motion Pictures | ✅ | ✅ | -| [Academy Awards (Oscars)](award/oscars) | `oscars` | Best Picture Winners | ✅ | ❌ | -| [Independent Spirit](award/spirit) | `spirit` | Independent Spirit Awards 2021 | ✅ | ❌ | -| [Sundance](award/sundance) | `sundance` | Sundance Grand Jury Winners | ✅ | ❌ | -| [Other](award/other) | `other_award` | Berlinale Golden Bears, Venice Golden Lions | ✅ | ❌ | +| Default | Path | Example Collections | Works with Movies | Works with Shows | +|:-----------------------------------|:------------------|:-------------------------------------------|:-------------------:|:-------------------:| +| [Chart Separator](chart/separator) | `separator_chart` | Chart Collections | ✅ | ✅ | +| [AniList](chart/anilist) | `anilist` | AniList Popular, AniList Season | ✅ | ✅ | +| [Basic](chart/basic) | `basic` | Newly Released, New Episodes | ✅ | ✅ | +| [FlixPatrol](chart/flixpatrol) | `flixpatrol` | Top Disney, Top Hbo, Top Hulu, Top Netflix | ✅ | ✅ | +| [IMDb](chart/imdb) | `imdb` | IMDb Popular, IMDb Top 250 | ✅ | ✅ | +| [MyAnimeList](chart/myanimelist) | `myanimelist` | MyAnimeList Popular, MyAnimeList Top Rated | ✅ | ✅ | +| [Other](chart/other) | `other_chart` | AniDB Popular, Common Sense Selection | ✅ | ✅ | +| [Tautulli](chart/tautulli) | `tautulli` | Plex Popular, Plex Watched | ✅2 | ✅2 | +| [TMDb](chart/tmdb) | `tmdb` | TMDb Popular, TMDb Airing Today | ✅ | ✅ | +| [Trakt](chart/trakt) | `trakt` | Trakt Popular, Trakt Trending | ✅1 | ✅1 | +1 Requires [Trakt Authentication](../config/trakt) +2 Requires [Tautulli Authentication](../config/tautulli) ### General Collections diff --git a/docs/defaults/overlay_list.md b/docs/defaults/overlay_list.md index e086c7d8..3d19c3e1 100644 --- a/docs/defaults/overlay_list.md +++ b/docs/defaults/overlay_list.md @@ -10,21 +10,24 @@ These overlays are applied by calling the below paths into the `overlay_path` [s ### Overlay Files -| Default | path | Example Overlays | Movies | Shows | Seasons | Episodes | -|:-----------------------------------------------|:-----------------|:--------------------------------------------------------------------------|:--------:|:---------:|:---------:|:--------:| -| [Audio Codec](overlays/audio_codec) | `audio_codec` | Dolby Atmos logo, DTS logo | ✅ | ✅ | ✅ | ✅ | -| [CommonSense Age Rating](overlays/commonsense) | `commonsense` | "3+", "16+" | ✅ | ✅ | ❗ | ❗ | -| [Direct Play](overlays/direct_play) | `direct_play` | "Direct Play Only" | ✅ | ❗ | ❗ | ✅ | -| [Episode Info](overlays/episode_info) | `episode_info` | "S01E01", "S02E09" | ❌ | ❌ | ❌ | ✅ | -| [FlixPatrol](overlays/flixpatrol) | `flixpatrol` | "Streaming service logo with words "TOP" | ✅ | ✅ | ❌ | ❌ | -| [Language Count](overlays/language_count) | `language_count` | Dual-Audio, Multi-Audio, Dual-Subtitle, Multi-Subtitle | ✅ | ✅ | ✅ | ✅ | -| [Languages](overlays/languages) | `languages` | Flags Based on the Audio/Subtitles a file has | ✅ | ✅ | ✅ | ✅ | -| [Mediastinger](overlays/mediastinger) | `mediastinger` | Mediastinger Logo for After/During Credit Scenes | ✅ | ✅ | ❌ | ❌ | -| [Ratings](overlays/ratings) | `ratings` | IMDb Audience Rating, Metacritic Critic Rating | ✅ | ✅ | ❌ | ✅ | -| [Resolution/Editions](overlays/resolution) | `resolution` | 4K Dolby Vision logo, 720P logo, "Director's Cut", "Criterion Collection" | ✅ | ✅ | ❌ | ✅ | -| [Ribbon](overlays/ribbon) | `ribbon` | IMDb Top 250 Ribbon, RT Fresh Ribbon | ✅ | ✅ | ❌ | ❌ | -| [Runtimes](overlays/runtimes) | `runtimes` | "Runtime: 1h 30m" | ✅ | ✅ | ❌ | ✅ | -| [Status](overlays/status) | `status` | Airing, Returning, Canceled, Ended | ❌ | ✅ | ❌ | ❌ | -| [Streaming](overlays/streaming) | `streaming` | Netflix logo, Hulu logo | ✅ | ✅ | ❌ | ❌ | -| [Versions](overlays/versions) | `versions` | Multiple Versions logo | ✅ | ✅ | ✅ | ✅ | -| [Video Format](overlays/video_format) | `video_format` | "REMUX", "HDTV" | ✅ | ❗ | ❗ | ✅ | +| Default | path | Example Overlays | Movies | Shows | Seasons | Episodes | +|:-----------------------------------------------|:-----------------|:--------------------------------------------------------------------------|:--------------------:|:--------------------:|:-------------------:|:--------------------:| +| [Audio Codec](overlays/audio_codec) | `audio_codec` | Dolby Atmos logo, DTS logo | ✅1 | ✅1 | ✅1 | ✅1 | +| [CommonSense Age Rating](overlays/commonsense) | `commonsense` | "3+", "16+" | ✅ | ✅ | ❗ | ❗ | +| [Direct Play](overlays/direct_play) | `direct_play` | "Direct Play Only" | ✅ | ❗ | ❗ | ✅ | +| [Episode Info](overlays/episode_info) | `episode_info` | "S01E01", "S02E09" | ❌ | ❌ | ❌ | ✅ | +| [FlixPatrol](overlays/flixpatrol) | `flixpatrol` | "Streaming service logo with words "TOP" | ✅ | ✅ | ❌ | ❌ | +| [Language Count](overlays/language_count) | `language_count` | Dual-Audio, Multi-Audio, Dual-Subtitle, Multi-Subtitle | ✅ | ✅ | ✅ | ✅ | +| [Languages](overlays/languages) | `languages` | Flags Based on the Audio/Subtitles a file has | ✅ | ✅ | ✅ | ✅ | +| [Mediastinger](overlays/mediastinger) | `mediastinger` | Mediastinger Logo for After/During Credit Scenes | ✅ | ✅ | ❌ | ❌ | +| [Ratings](overlays/ratings) | `ratings` | IMDb Audience Rating, Metacritic Critic Rating | ✅3 | ✅3 | ❌ | ✅3 | +| [Resolution/Editions](overlays/resolution) | `resolution` | 4K Dolby Vision logo, 720P logo, "Director's Cut", "Criterion Collection" | ✅2 | ✅2 | ❌ | ✅2 | +| [Ribbon](overlays/ribbon) | `ribbon` | IMDb Top 250 Ribbon, RT Fresh Ribbon | ✅ | ✅ | ❌ | ❌ | +| [Runtimes](overlays/runtimes) | `runtimes` | "Runtime: 1h 30m" | ✅ | ✅ | ❌ | ✅ | +| [Status](overlays/status) | `status` | Airing, Returning, Canceled, Ended | ❌ | ✅ | ❌ | ❌ | +| [Streaming](overlays/streaming) | `streaming` | Netflix logo, Hulu logo | ✅ | ✅ | ❌ | ❌ | +| [Versions](overlays/versions) | `versions` | Multiple Versions logo | ✅ | ✅ | ✅ | ✅ | +| [Video Format](overlays/video_format) | `video_format` | "REMUX", "HDTV" | ✅1 | ❗ | ❗ | ✅1 | +1 Designed for [TRaSH Guides](https://trash-guides.info/) filename naming scheme +2 Requires Plex Pass or [TRaSH Guides](https://trash-guides.info/) filename naming scheme +3 Requires Template Variables to function \ No newline at end of file