5.8 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 ❗ 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 commonsense age-rating since only Movies and Shows are rated by CommonSense.
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 CommonSense age rating would apply to all episodes).
These overlays are applied by calling the below paths into the overlay_path section of your config.yml
Chart Overlays
| Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
|---|---|---|---|---|---|---|
| FlixPatrol | flixpatrol |
"Streaming service logo with words "TOP" | ✅ | ✅ | ❌ | ❌ |
| Ribbon | ribbon |
IMDb Top 250 Ribbon, RT Fresh Ribbon | ✅ | ✅ | ❌ | ❌ |
Content Overlays
| Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
|---|---|---|---|---|---|---|
| Episode Info | episode_info |
"S01E01", "S02E09" | ❌ | ❌ | ❌ | ✅ |
| Mediastinger | mediastinger |
Mediastinger Logo for After/During Credit Scenes | ✅ | ✅ | ❌ | ❌ |
| Ratings1 | ratings |
IMDb Audience Rating, Metacritic Critic Rating | ✅ | ✅ | ❌ | ✅ |
| Status | status |
Airing, Returning, Canceled, Ended | ❌ | ✅ | ❌ | ❌ |
1 Requires Template Variables to function
Media Overlays
| Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
|---|---|---|---|---|---|---|
| Aspect Ratio1 | aspect |
"1.33","1.78" | ✅ | ✅ | ✅ | ✅ |
| Audio Codec1 | audio_codec |
Dolby Atmos logo, DTS logo | ✅ | ✅ | ✅ | ✅ |
| Audio/Subtitle Language Count | language_count |
Dual-Audio, Multi-Audio, Dual-Subtitle, Multi-Subtitle | ✅ | ✅ | ✅ | ✅ |
| Audio/Subtitle Language Flags | languages |
Flags Based on the Audio/Subtitles a file has | ✅ | ✅ | ✅ | ✅ |
| Resolution/Editions2 | resolution |
4K Dolby Vision logo, 720P logo, "Director's Cut", "Criterion Collection" | ✅ | ✅ | ❌ | ✅ |
| Runtimes | runtimes |
"Runtime: 1h 30m" | ✅ | ✅ | ❌ | ✅ |
| Versions | versions |
Multiple Versions logo | ✅ | ✅ | ✅ | ✅ |
| Video Format1 | video_format |
"REMUX", "HDTV" | ✅ | ❗ | ❗ | ✅ |
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" | ❌ | ✅ | ✅ | ✅ |
| Streaming | streaming |
Netflix logo, Hulu logo | ✅ | ✅ | ❌ | ❌ |
| Studio | studio |
"Warner Bros. Pictures", "Amblin Entertainment" | ✅ | ✅ | ✅ | ✅ |
Utility Overlays
| Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
|---|---|---|---|---|---|---|
| Direct Play | direct_play |
"Direct Play Only" | ✅ | ❗ | ❗ | ✅ |