12 KiB
Overlays
These files apply overlays and can generally be used on both Movie and Show library-types, and often works at the season and episode-level too.
It should be noted that when an overlay has :fontawesome-solid-circle-exclamation:{ .orange } for a season or episode, it normally means that whilst the overlay can technically be applied at the level, it wasn't designed for this purpose. For example, a show's season cannot have a resolution since it is not a video file, and an episode cannot have a common sense age-rating since only Movies and Shows are rated by Common Sense.
In the scenario where there is missing data such as age ratings for episodes, then generally the highest-level data available will be applied at the lower level (i.e. a Show's Common Sense age rating would apply to all episodes).
These overlays are applied by calling the below paths into the overlay_files
section of your
config.yml
Chart Overlays
Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
---|---|---|---|---|---|---|
FlixPatrol | flixpatrol |
"Streaming service logo with words "TOP" | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } |
Ribbon | ribbon |
IMDb Top 250 Ribbon, RT Fresh Ribbon | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } |
Content Overlays
Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
---|---|---|---|---|---|---|
Episode Info | episode_info |
"S01E01", "S02E09" | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } |
Mediastinger | mediastinger |
Mediastinger Logo for After/During Credit Scenes | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } |
Ratings1 | ratings |
IMDb Audience Rating, Metacritic Critic Rating | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } |
Status | status |
Airing, Returning, Canceled, Ended | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } |
1 Requires Template Variables to function
Content Rating Overlays
Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
---|---|---|---|---|---|---|
US Content Ratings (Movie) | content_rating_us_movie |
G, PG, PG-13, R, NC-17, NR | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } |
US Content Ratings (Show) | content_rating_us_show |
TV-G, TV-Y, TV-PG, TV-14, TV-MA, NR | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
UK Content Ratings | content_rating_uk |
U, PG, 12, 12a, 15, 18, R18, NR | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
DE Content Ratings | content_rating_de |
0, 6, 12, 16, 18, BPjM, NR | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
Common Sense Age Rating | commonsense |
1+, 2+, 3+, 4+, ..., 17+, 18+, NR | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
1 Requires Template Variables to function
Media Overlays
Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
---|---|---|---|---|---|---|
Aspect Ratio1 | aspect |
"1.33","1.78" | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
Audio Codec1 | audio_codec |
Dolby Atmos logo, DTS logo | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
Audio/Subtitle Language Count | language_count |
Dual-Audio, Multi-Audio, Dual-Subtitle, Multi-Subtitle | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
Audio/Subtitle Language Flags | languages |
Flags Based on the Audio/Subtitles a file has | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
Resolution/Editions2 | resolution |
4K Dolby Vision logo, 720P logo, "Director's Cut", "Criterion Collection" | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } |
Runtimes | runtimes |
"Runtime: 1h 30m" | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } |
Versions | versions |
Multiple Versions logo | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
Video Format1 | video_format |
"REMUX", "HDTV" | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-exclamation:{ .orange } | :fontawesome-solid-circle-exclamation:{ .orange } | :fontawesome-solid-circle-check:{ .green } |
1 Designed to use the TRaSH Guides filename naming scheme
2 Editions overlay is designed to use the Editions field within Plex [which requires Plex Pass to use] or the TRaSH Guides filename naming scheme
Production Overlays
Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
---|---|---|---|---|---|---|
Network | network |
"ABC", "CBS" | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
Streaming | streaming |
Netflix logo, Hulu logo | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } |
Studio | studio |
"Warner Bros. Pictures", "Amblin Entertainment" | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
Utility Overlays
Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
---|---|---|---|---|---|---|
Direct Play | direct_play |
"Direct Play Only" | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-exclamation:{ .orange } | :fontawesome-solid-circle-exclamation:{ .orange } | :fontawesome-solid-circle-check:{ .green } |