Plex-Meta-Manager/docs/defaults/overlays.md
2022-10-24 17:01:58 -04:00

4.3 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

Overlay Files

Default path Example Overlays Movies Shows Seasons Episodes
Audio Codec audio_codec Dolby Atmos logo, DTS logo
CommonSense Age Rating commonsense "3+", "16+"
Direct Play direct_play "Direct Play Only"
Episode Info episode_info "S01E01", "S02E09"
FlixPatrol flixpatrol "Streaming service logo with words "TOP"
Language Count language_count Dual-Audio, Multi-Audio, Dual-Subtitle, Multi-Subtitle
Languages languages Flags Based on the Audio/Subtitles a file has
Mediastinger mediastinger Mediastinger Logo for After/During Credit Scenes
Ratings ratings IMDb Audience Rating, Metacritic Critic Rating
Resolution/Editions resolution 4K Dolby Vision logo, 720P logo, "Director's Cut", "Criterion Collection"
Ribbon ribbon IMDb Top 250 Ribbon, RT Fresh Ribbon
Runtimes runtimes "Runtime: 1h 30m"
Status status Airing, Returning, Canceled, Ended
Streaming streaming Netflix logo, Hulu logo
Versions versions Multiple Versions logo
Video Format video_format "REMUX", "HDTV"