2022-11-08 03:02:07 +00:00
## 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 ](../config/libraries.md#overlay-path ) of your config.yml
2023-08-09 19:26:36 +00:00
### Chart Overlays
| Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
|:----------------------------------|:-------------|:-----------------------------------------|:--------:|:-------:|:--------:|:--------:|
| [FlixPatrol ](overlays/flixpatrol ) | `flixpatrol` | "Streaming service logo with words "TOP" | ✅ | ✅ | ❌ | ❌ |
| [Ribbon ](overlays/ribbon ) | `ribbon` | IMDb Top 250 Ribbon, RT Fresh Ribbon | ✅ | ✅ | ❌ | ❌ |
### Content Overlays
| Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
|:----------------------------------------|:---------------|:-------------------------------------------------|:--------:|:--------:|:--------:|:--------:|
| [Episode Info ](overlays/episode_info ) | `episode_info` | "S01E01", "S02E09" | ❌ | ❌ | ❌ | ✅ |
| [Mediastinger ](overlays/mediastinger ) | `mediastinger` | Mediastinger Logo for After/During Credit Scenes | ✅ | ✅ | ❌ | ❌ |
| [Ratings ](overlays/ratings )< sup > 1</ sup > | `ratings` | IMDb Audience Rating, Metacritic Critic Rating | ✅ | ✅ | ❌ | ✅ |
| [Status ](overlays/status ) | `status` | Airing, Returning, Canceled, Ended | ❌ | ✅ | ❌ | ❌ |
< sup > 1< / sup > Requires Template Variables to function
### Media Overlays
| Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
|:---------------------------------------------------------|:-----------------|:--------------------------------------------------------------------------|:-------:|:--------:|:--------:|:--------:|
| [Aspect Ratio ](overlays/aspect )< sup > 1</ sup > | `aspect` | "1.33","1.78" | ✅ | ✅ | ✅ | ✅ |
| [Audio Codec ](overlays/audio_codec )< sup > 1</ sup > | `audio_codec` | Dolby Atmos logo, DTS logo | ✅ | ✅ | ✅ | ✅ |
| [Audio/Subtitle Language Count ](overlays/language_count ) | `language_count` | Dual-Audio, Multi-Audio, Dual-Subtitle, Multi-Subtitle | ✅ | ✅ | ✅ | ✅ |
| [Audio/Subtitle Language Flags ](overlays/languages ) | `languages` | Flags Based on the Audio/Subtitles a file has | ✅ | ✅ | ✅ | ✅ |
| [Resolution/Editions ](overlays/resolution )< sup > 2</ sup > | `resolution` | 4K Dolby Vision logo, 720P logo, "Director's Cut", "Criterion Collection" | ✅ | ✅ | ❌ | ✅ |
| [Runtimes ](overlays/runtimes ) | `runtimes` | "Runtime: 1h 30m" | ✅ | ✅ | ❌ | ✅ |
| [Versions ](overlays/versions ) | `versions` | Multiple Versions logo | ✅ | ✅ | ✅ | ✅ |
| [Video Format ](overlays/video_format )< sup > 1</ sup > | `video_format` | "REMUX", "HDTV" | ✅ | ❗ | ❗ | ✅ |
2023-01-24 16:49:21 +00:00
2023-01-21 00:36:20 +00:00
< 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
2023-08-09 19:26:36 +00:00
### Production Overlays
| Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
|:--------------------------------|:------------|:------------------------------------------------|:--------:|:-------:|:--------:|:--------:|
| [Network ](overlays/network ) | `network` | "ABC", "CBS" | ❌ | ✅ | ✅ | ✅ |
| [Streaming ](overlays/streaming ) | `streaming` | Netflix logo, Hulu logo | ✅ | ✅ | ❌ | ❌ |
| [Studio ](overlays/studio ) | `studio` | "Warner Bros. Pictures", "Amblin Entertainment" | ✅ | ✅ | ✅ | ✅ |
### Utility Overlays
| Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
|:------------------------------------|:--------------|:-------------------|:-------:|:--------:|:--------:|:--------:|
| [Direct Play ](overlays/direct_play ) | `direct_play` | "Direct Play Only" | ✅ | ❗ | ❗ | ✅ |
