2022-11-08 03:02:07 +00:00
|
|
|
## Overlays
|
|
|
|
|
|
2024-01-07 08:07:13 +00:00
|
|
|
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.
|
2022-11-08 03:02:07 +00:00
|
|
|
|
2024-01-07 08:07:13 +00:00
|
|
|
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.
|
2022-11-08 03:02:07 +00:00
|
|
|
|
2024-01-07 08:07:13 +00:00
|
|
|
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).
|
2022-11-08 03:02:07 +00:00
|
|
|
|
2024-01-07 08:07:13 +00:00
|
|
|
These overlays are applied by calling the below paths into the `overlay_files` [section](../config/files.md) of your
|
|
|
|
|
config.yml
|
2022-11-08 03:02:07 +00:00
|
|
|
|
2023-08-09 19:26:36 +00:00
|
|
|
### Chart Overlays
|
|
|
|
|
|
2023-12-13 21:44:44 +00:00
|
|
|
| Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
|
|
|
|
|
|:-------------------------------------|:-------------|:-----------------------------------------|:------------------------------------------:|:------------------------------------------:|:----------------------------------------:|:----------------------------------------:|
|
|
|
|
|
| [Ribbon](overlays/ribbon.md) | `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 } |
|
2023-08-09 19:26:36 +00:00
|
|
|
|
|
|
|
|
### Content Overlays
|
|
|
|
|
|
2023-12-13 21:44:44 +00:00
|
|
|
| Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
|
|
|
|
|
|:-------------------------------------------|:---------------|:-------------------------------------------------|:------------------------------------------:|:------------------------------------------:|:----------------------------------------:|:------------------------------------------:|
|
|
|
|
|
| [Episode Info](overlays/episode_info.md) | `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](overlays/mediastinger.md) | `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 } |
|
|
|
|
|
| [Ratings](overlays/ratings.md)<sup>1</sup> | `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](overlays/status.md) | `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 } |
|
2023-08-09 19:26:36 +00:00
|
|
|
|
|
|
|
|
<sup>1</sup> Requires Template Variables to function
|
|
|
|
|
|
2024-01-07 08:07:13 +00:00
|
|
|
### Content Rating Overlays
|
|
|
|
|
|
|
|
|
|
| Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
|
|
|
|
|
|:------------------------------------------------------------------|:--------------------------|:------------------------------------|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:|
|
|
|
|
|
| [US Content Ratings (Movie)](overlays/content_rating_us_movie.md) | `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)](overlays/content_rating_us_show.md) | `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](overlays/content_rating_uk.md) | `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](overlays/content_rating_de.md) | `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](overlays/commonsense.md) | `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 } |
|
|
|
|
|
|
|
|
|
|
<sup>1</sup> Requires Template Variables to function
|
|
|
|
|
|
2023-08-09 19:26:36 +00:00
|
|
|
### Media Overlays
|
|
|
|
|
|
2024-01-07 08:07:13 +00:00
|
|
|
| Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
|
|
|
|
|
|:------------------------------------------------------------|:-----------------|:--------------------------------------------------------------------------|:------------------------------------------:|:-------------------------------------------------:|:-------------------------------------------------:|:------------------------------------------:|
|
|
|
|
|
| [Aspect Ratio](overlays/aspect.md)<sup>1</sup> | `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 Codec](overlays/audio_codec.md)<sup>1</sup> | `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](overlays/language_count.md) | `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](overlays/languages.md) | `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/Editions](overlays/resolution.md)<sup>2</sup> | `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](overlays/runtimes.md) | `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](overlays/versions.md) | `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 Format](overlays/video_format.md)<sup>1</sup> | `video_format` | "REMUX", "HDTV" | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-exclamation:{ .orange } | :fontawesome-solid-circle-exclamation:{ .orange } | :fontawesome-solid-circle-check:{ .green } |
|
2023-01-24 16:49:21 +00:00
|
|
|
|
2023-11-15 14:00:48 +00:00
|
|
|
<sup>1</sup> Designed to use the [TRaSH Guides](https://trash-guides.info/) filename naming scheme
|
2023-11-15 11:44:43 +00:00
|
|
|
|
2024-01-07 08:07:13 +00:00
|
|
|
<sup>2</sup> Editions overlay is designed to use the Editions field within Plex [which requires Plex Pass to use] or the
|
|
|
|
|
[TRaSH Guides](https://trash-guides.info/) filename naming scheme
|
2023-08-09 19:26:36 +00:00
|
|
|
|
|
|
|
|
### Production Overlays
|
|
|
|
|
|
2023-12-13 21:44:44 +00:00
|
|
|
| Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
|
|
|
|
|
|:-----------------------------------|:------------|:------------------------------------------------|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:|
|
|
|
|
|
| [Network](overlays/network.md) | `network` | "ABC", "CBS" | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
|
|
|
|
| [Streaming](overlays/streaming.md) | `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](overlays/studio.md) | `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 } |
|
2023-08-09 19:26:36 +00:00
|
|
|
|
|
|
|
|
### Utility Overlays
|
|
|
|
|
|
2024-01-07 08:07:13 +00:00
|
|
|
| Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
|
|
|
|
|
|:---------------------------------------|:--------------|:-------------------|:------------------------------------------:|:-------------------------------------------------:|:-------------------------------------------------:|:------------------------------------------:|
|
|
|
|
|
| [Direct Play](overlays/direct_play.md) | `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 } |
|
