Mirrors/Plex-Meta-Manager
2
0
Fork 0
mirror of https://github.com/meisnate12/Plex-Meta-Manager synced 2024-09-20 06:22:07 +00:00
Code Issues Projects Releases Packages Wiki Activity

[119] update overlay defaults yaml and wiki

Browse source
This commit is contained in:
meisnate12 2022-10-17 02:48:08 -04:00
parent 8a277e815b
commit 74175687c4
136 changed files with 3012 additions and 3644 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CHANGELOG
View file

@ -6,7 +6,7 @@ Updated pathvalidate requirement to 2.5.2
**New Site to request and vote for Features Requests on at [features.metamanager.wiki](https://features.metamanager.wiki/)**
# New Features
Added support for editions in `plex_search`, `smart_filter`, special text overlays, and metadata editing.
Added support for editions in `plex_search`, `smart_filter`, `filters`, special text overlays, and metadata editing.
Added `item_edition` [item metadata detail](https://metamanager.wiki/en/latest/metadata/details/metadata.html#item-metadata-details) to update the edition of items in a collection
Added `edition` [dynamic collection type](https://metamanager.wiki/en/latest/metadata/dynamic.html#edition)
Added `last_episode_aired_or_never` [date filter](https://metamanager.wiki/en/latest/metadata/filters.html#date-filters). thanks @axsuul#0591

2
README.md
View file

@ -77,7 +77,7 @@ Below are some user-curated collections which have been created by Plex Meta Man
## Default and User Submitted Metadata/Overlay Files
The overlays and collection built in the images above can be easily added to any plex by using the [PMM Defaults](https://metamanager.wiki/en/latest/home/guides/defaults.html). These Files were created by the PMM team to make it easier than ever to have customized collections and overlays.
The overlays and collection built in the images above can be easily added to any plex by using the [PMM Defaults](https://metamanager.wiki/en/latest/defaults/defaults.html). These Files were created by the PMM team to make it easier than ever to have customized collections and overlays.
To see user submitted Metadata configuration files, and you to even add your own, go to the [Plex Meta Manager Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs).

2
VERSION
View file

@ -1 +1 @@
1.17.3-develop118
1.17.3-develop119

4
defaults/chart/flixpatrol.yml
View file

@ -34,10 +34,10 @@ dynamic_collections:
type: custom
data:
netflix: Netflix
disney: Disney
disney: Disney+
hbo: HBO
hulu: Hulu
paramount: Paramount Plus
paramount: Paramount+
prime: Prime Video
title_format: <<key_name>> Top <<limit>>
template:

2
defaults/movie/universe.yml
View file

@ -60,7 +60,7 @@ dynamic_collections:
- custom
template_variables:
trakt_list:
star: https://trakt.tv/users/donxy/lists/dc-animated-movie-universe
star: https://trakt.tv/users/zorge88/lists/star-wars
dca: https://trakt.tv/users/donxy/lists/dc-animated-movie-universe
dcu: https://trakt.tv/users/donxy/lists/dc-extended-universe
mcu: https://trakt.tv/users/donxy/lists/marvel-cinematic-universe

262
defaults/overlays/audio_codec.yml
View file

@ -1,159 +1,137 @@
#############################################################
# Audio Codec Overlays #
##############################################################################
# Audio Codec Overlay #
# Created by Yozora, Bullmoose20, & Sohjiro #
# Credit to Magic815 for base images #
#############################################################
# Designed for TRaSH Guides filename naming scheme #
# https://trash-guides.info/ #
# #
# Call this from your config.yml (Movie or Show): #
# If nothing is specified these are the defaults #
# #
# overlay_path: #
# - git: PMM/overlays/audio_codec #
# template_variables: #
# # Set episode or season to overlay #
# overlay_level: #
# # Set the horizontal offset for the overlay #
# horizontal_offset: 0 #
# # Set the horizontal align for the overlay #
# horizontal_align: center #
# # Set the vertical offset for the overlay #
# vertical_offset: 15 #
# # Set the vertical align for the overlay #
# vertical_align: top #
# # Set the back color for the overlay #
# back_color: "#00000099" #
# # Set the back radius for the overlay #
# back_radius: 30 #
# # Set the back width for the overlay #
# back_width: 305 #
# # Sets the style of overlay: standard or compact #
# style: compact #
# #
# # Use the Opus overlay #
# use_opus: true #
# # Use the MP3 overlay #
# use_mp3: true #
# # Use the Dolby-Digital overlay #
# use_digital: true #
# # Use the AAC overlay #
# use_aac: true #
# # Use the DTS overlay #
# use_dts: true #
# # Use the DTS-ES overlay #
# use_es: true #
# # Use the Dolby-Digital-Plus overlay #
# use_plus: true #
# # Use the DTS-HD-HRA overlay #
# use_hra: true #
# # Use the PCM overlay #
# use_pcm: true #
# # Use the FLAC overlay #
# use_flac: true #
# # Use the DTS-HD-MA overlay #
# use_hd: true #
# # Use the Dolby-TrueHD overlay #
# use_truehd: true #
# # Use the DD+/E-AC3 Atmos overlay #
# use_plus-atmos: true #
# # Use the Dolby-Atmos (undefined) overlay #
# use_atmos: true #
# # Use the DTS-X overlay #
# use_x: true #
# # Use the Dolby TrueHD Atmos overlay #
# use_truehd-atmos: true #
#############################################################
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
# https://metamanager.wiki/en/latest/defaults/overlays/audio_codec.html #
##############################################################################
templates:
AudioCodec:
optional:
- overlay_level
- use_<<slug>>
default:
overlay: <<overlay_name>>
horizontal_offset: 0
horizontal_align: center
vertical_offset: 15
vertical_align: top
style: compact
standard_value: 105
back_color: "#00000099"
back_radius: 30
back_width: 305
external_templates:
pmm: templates
template_variables:
conditionals:
height:
back_height:
default: 105
conditions:
- style: standard
value: <<standard_value>>
overlay_level: <<overlay_level>>
allowed_library_types: <<use_<<slug>>>>
ignore_blank_results: true
overlay:
name: <<overlay_name>>
pmm: audio_codec/<<style>>/<<slug>>
standard_value: 105
style: compact
group: audio_codec
weight: <<weight>>
horizontal_offset: <<horizontal_offset>>
horizontal_align: <<horizontal_align>>
vertical_offset: <<vertical_offset>>
vertical_align: <<vertical_align>>
back_color: <<back_color>>
back_radius: <<back_radius>>
back_width: <<back_width>>
back_height: <<height>>
horizontal_offset: 0
horizontal_align: center
vertical_offset: 15
vertical_align: top
back_width: 305
pmm: audio_codec/<<style>>/<<key>>
templates:
audio_codec:
default:
regex_<<key>>: <<regex>>
conditionals:
regex:
conditions:
- key: truehd_atmos
value: '(?i)(?=.*\b(true[ .-]?hd))(?=.*\b(atmos(\b|\d)))'
- key: dtsx
value: 'dts[-. ]?x(?!\d)'
- key: plus_atmos
value: '(?i)((?=.*([^-]DD[P+](?!A)|eac3))(?=.*\b(atmos(\b|\d))))|(?=.*\b(DDPA(\b|\d)))'
- key: dolby_atmos
value: '(?i)^(?!.*([^-]DD[P+](?!A)|eac3|true[ .-]?hd))(?=.*\b(atmos(\b|\d))).*'
- key: truehd
value: '(?i)^(?!.*(atmos))(?=.*\b(true[ .-]?hd)\b).*'
- key: ma
value: '(?i)dts[ .-]?(ma\b|hd[ .-]?ma|hd)(?!china|r)'
- key: flac
value: '(?i)\bFLAC(\b|\d)'
- key: pcm
value: '(?i)\b(l?)PCM(\b|\d)'
- key: hra
value: '(?i)dts[ ._-]?(hd[. ]?)?(hr|hi)'
- key: plus
value: '(?i)(?!.*(atmos))(?=.*\b([^-]DD[P+](?!A)|eac3)\b).*'
- key: dtses
value: '(?i)dts[-. ]?es\b'
- key: dts
value: '(?i)\bDTS(\b|\d)'
- key: digital
value: '(?i)\bDD[^a-z+]|(?<!e)ac3'
- key: aac
value: '(?i)\b(aac|stereo|2[ .]0)\b'
- key: mp3
value: '(?i)\bmp3(\b|\d)'
- key: opus
value: '(?i)\bOPUS(\b|\d)'
ignore_blank_results: true
plex_all: true
filters:
- audio_track_title.regex: <<regex>>
- filepath.regex: <<regex>>
- audio_track_title.regex: <<regex_<<key>>>>
- filepath.regex: <<regex_<<key>>>>
overlays:
Opus:
template: {name: AudioCodec, weight: 250, slug: opus, regex: '(?i)\bOPUS(\b|\d)'}
MP3:
template: {name: AudioCodec, weight: 500, slug: mp3, regex: '(?i)\bmp3(\b|\d)'}
AAC:
template: {name: AudioCodec, weight: 700, slug: aac, regex: '(?i)\b(aac|stereo|2[ .]0)\b'}
Dolby-Digital:
template: {name: AudioCodec, weight: 750, slug: digital, regex: '(?i)\bDD[^a-z+]|(?<!e)ac3'}
DTS:
template: {name: AudioCodec, weight: 1250, slug: dts, regex: '(?i)\bDTS(\b|\d)'}
DTS-ES:
template: {name: AudioCodec, weight: 1500, slug: dtses, regex: '(?i)dts[-. ]?es\b'}
Dolby-Digital-Plus:
template: {name: AudioCodec, weight: 1750, slug: plus, regex: '(?i)(?!.*(atmos))(?=.*\b([^-]DD[P+](?!A)|eac3)\b).*'}
DTS-HD-HRA:
template: {name: AudioCodec, weight: 2000, slug: hra, regex: '(?i)dts[ ._-]?(hd[. ]?)?(hr|hi)'}
PCM:
template: {name: AudioCodec, weight: 2200, slug: pcm, regex: '(?i)\b(l?)PCM(\b|\d)'}
FLAC:
template: {name: AudioCodec, weight: 2250, slug: flac, regex: '(?i)\bFLAC(\b|\d)'}
DTS-HD-MA:
template: {name: AudioCodec, weight: 2500, slug: ma, regex: '(?i)dts[ .-]?(ma\b|hd[ .-]?ma|hd)(?!china|r)'}
Dolby-TrueHD:
template: {name: AudioCodec, weight: 2750, slug: truehd, regex: '(?i)^(?!.*(atmos))(?=.*\b(true[ .-]?hd)\b).*'}
Dolby-Digital-Plus-Atmos:
template: {name: AudioCodec, weight: 3000, slug: plus_atmos, standard_value: 189, regex: '(?i)((?=.*([^-]DD[P+](?!A)|eac3))(?=.*\b(atmos(\b|\d))))|(?=.*\b(DDPA(\b|\d)))'}
Dolby-Atmos:
template: {name: AudioCodec, weight: 3000, slug: dolby_atmos, regex: '(?i)^(?!.*([^-]DD[P+](?!A)|eac3|true[ .-]?hd))(?=.*\b(atmos(\b|\d))).*'}
Dolby-TrueHD-Atmos:
variables: {key: truehd_atmos, weight: 160, standard_value: 189}
template: [name: standard, name: audio_codec]
DTS-X:
template: {name: AudioCodec, weight: 4500, slug: dtsx, regex: 'dts[-. ]?x(?!\d)'}
variables: {key: dtsx, weight: 150}
template: [name: standard, name: audio_codec]
Dolby-TrueHD-Atmos:
template: {name: AudioCodec, weight: 5000, slug: truehd_atmos, standard_value: 189, regex: '(?i)(?=.*\b(true[ .-]?hd))(?=.*\b(atmos(\b|\d)))'}
Dolby-Digital-Plus-Atmos:
variables: {key: plus_atmos, weight: 140, standard_value: 189}
template: [name: standard, name: audio_codec]
Dolby-Atmos:
variables: {key: dolby_atmos, weight: 130}
template: [name: standard, name: audio_codec]
Dolby-TrueHD:
variables: {key: truehd, weight: 120}
template: [name: standard, name: audio_codec]
DTS-HD-MA:
variables: {key: ma, weight: 110}
template: [name: standard, name: audio_codec]
FLAC:
variables: {key: flac, weight: 100}
template: [name: standard, name: audio_codec]
PCM:
variables: {key: pcm, weight: 90}
template: [name: standard, name: audio_codec]
DTS-HD-HRA:
variables: {key: hra, weight: 80}
template: [name: standard, name: audio_codec]
Dolby-Digital-Plus:
variables: {key: plus, weight: 70}
template: [name: standard, name: audio_codec]
DTS-ES:
variables: {key: dtses, weight: 60}
template: [name: standard, name: audio_codec]
DTS:
variables: {key: dts, weight: 50}
template: [name: standard, name: audio_codec]
Dolby-Digital:
variables: {key: digital, weight: 40}
template: [name: standard, name: audio_codec]
AAC:
variables: {key: aac, weight: 30}
template: [name: standard, name: audio_codec]
MP3:
variables: {key: mp3, weight: 20}
template: [name: standard, name: audio_codec]
Opus:
variables: {key: opus, weight: 10}
template: [name: standard, name: audio_codec]

73
defaults/overlays/audio_language.yml
View file

@ -1,71 +1,42 @@
#############################################################
##############################################################################
# Audio Language Overlay #
# Created by Yozora, Bullmoose20, & Sohjiro #
# Credit to Magic815 for base images #
#############################################################
# Designed for TRaSH Guides filename naming scheme #
# https://trash-guides.info/ #
# #
# Call this from your config.yml (Movie or Show): #
# If nothing is specified these are the defaults #
# #
# overlay_path: #
# - pmm: audio_language #
# template_variables: #
# # Set episode or season to overlay #
# overlay_level: #
# # Set the horizontal offset for the overlay #
# horizontal_offset: 0 #
# # Set the horizontal align for the overlay #
# horizontal_align: center #
# # Set the vertical offset for the overlay #
# vertical_offset: 30 #
# # Set the vertical align for the overlay #
# vertical_align: bottom #
#############################################################
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
# https://metamanager.wiki/en/latest/defaults/overlays/audio_language.html #
##############################################################################
templates:
AudioLanguage:
optional:
- overlay_level
- gte
- gt
- lt
default:
overlay: <<overlay_name>>
external_templates:
pmm: templates
template_variables:
group: audio_language
horizontal_offset: 0
horizontal_align: center
vertical_offset: 30
vertical_align: bottom
back_color: "#00000099"
back_radius: 30
back_width: 188
back_height: 105
overlay_level: <<overlay_level>>
pmm: <<overlay_name>>
templates:
audio_language:
default:
minimum: 2
optional:
- lt
ignore_blank_results: true
overlay:
name: <<overlay_name>>
pmm: <<overlay>>
group: audio_language
weight: <<weight>>
horizontal_offset: <<horizontal_offset>>
horizontal_align: <<horizontal_align>>
vertical_offset: <<vertical_offset>>
vertical_align: <<vertical_align>>
back_color: <<back_color>>
back_radius: <<back_radius>>
back_width: <<back_width>>
back_height: <<back_height>>
plex_all: true
filters:
audio_language.count_gte: <<gte>>
audio_language.count_gt: <<gt>>
audio_language.count_gte: <<minimum>>
audio_language.count_lt: <<lt>>
overlays:
Dual-Audio:
template: {name: AudioLanguage, weight: 10, gte: 2, lt: 3}
variables: {key: dual, weight: 20, lt: 3}
template: [name: standard, name: audio_language]
Multi-Audio:
template: {name: AudioLanguage, weight: 20, gt: 2}
variables: {key: multi, weight: 10}
template: [name: standard, name: audio_language]

171
defaults/overlays/commonsense.yml
View file

@ -1,98 +1,43 @@
#############################################################
##############################################################################
# Commonsense Overlay #
# Created by Yozora, Bullmoose20, & Sohjiro #
# Credit to Magic815 for base images #
#############################################################
# #
# Call this from your config.yml (Movie or Show): #
# If nothing is specified these are the defaults #
# #
# overlay_path: #
# - pmm: commonsense #
# template_variables: #
# # Set text you want before the rating #
# pre_text: "" #
# # Set episode or season to overlay #
# overlay_level: #
# # Set the horizontal offset for the overlay #
# horizontal_offset: 15 #
# # Set the horizontal align for the overlay #
# horizontal_align: left #
# # Set the vertical offset for the overlay #
# vertical_offset: 270 #
# # Set the vertical align for the overlay #
# vertical_align: bottom #
# # Set the font for the overlay #
# font: fonts/Inter-Medium.ttf #
# # Set the font size for the overlay #
# font_size: 55 #
# # Set the font color for the overlay #
# font_color: "#FFFFFF" #
# # Set the back color for the overlay #
# back_color: "#00000099" #
# # Set the back radius for the overlay #
# back_radius: 30 #
# # Set the back width for the overlay #
# back_width: 305 #
# # Set the back height for the overlay #
# back_height: 105 #
# #
# # Use the NR overlay #
# use_nr: true #
# #
# operations: #
# mass_content_rating_update: mdb_commonsense #
#############################################################
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
# https://metamanager.wiki/en/latest/defaults/overlays/commonsense.html #
##############################################################################
templates:
Content-Rating:
external_templates:
pmm: templates
template_variables:
conditionals:
pre:
default: <<pre_text>>
conditions:
- overlay_name: NR
value: ""
rating_style:
default: "+"
value: <<pre_nr_text>>
post:
default: <<post_text>>
conditions:
- overlay_name: NR
value: ""
optional:
- overlay_level
- use_<<slug>>
default:
value: <<post_nr_text>>
key: <<overlay_name>>
pre_text: ""
overlay: <<overlay_name>>
post_text: "+"
pre_nr_text: ""
post_nr_text: ""
horizontal_offset: 15
horizontal_align: left
vertical_offset: 270
vertical_align: bottom
font: fonts/Inter-Medium.ttf
font_size: 55
font_color: "#FFFFFF"
back_color: "#00000099"
back_radius: 30
back_width: 305
back_height: 105
overlay_level: <<overlay_level>>
allowed_library_types: <<use_<<slug>>>>
ignore_blank_results: true
overlay:
name: text(<<pre>><<overlay_name>><<rating_style>>)
horizontal_offset: <<horizontal_offset>>
horizontal_align: <<horizontal_align>>
vertical_offset: <<vertical_offset>>
vertical_align: <<vertical_align>>
font: <<font>>
font_size: <<font_size>>
font_color: <<font_color>>
back_color: <<back_color>>
back_radius: <<back_radius>>
back_width: <<back_width>>
back_height: <<back_height>>
pmm: Commonsense
addon_position: left
addon_offset: 15
final_name: text(<<pre>><<overlay_name>><<post>>)
templates:
commonsense:
ignore_blank_results: true
plex_search:
validate: false
any:
@ -100,40 +45,78 @@ templates:
overlays:
1:
template: {name: Content-Rating, rating: "1, 0, 01, 00, G, TV-G, TV-Y"}
template:
- name: standard
- {name: commonsense, rating: "1, 0, 01, 00, G, TV-G, TV-Y"}
2:
template: {name: Content-Rating, rating: "2, 02"}
template:
- name: standard
- {name: commonsense, rating: "2, 02"}
3:
template: {name: Content-Rating, rating: "3, 03"}
template:
- name: standard
- {name: commonsense, rating: "3, 03"}
4:
template: {name: Content-Rating, rating: "4, 04"}
template:
- name: standard
- {name: commonsense, rating: "4, 04"}
5:
template: {name: Content-Rating, rating: "5, 05"}
template:
- name: standard
- {name: commonsense, rating: "5, 05"}
6:
template: {name: Content-Rating, rating: "6, 06, GP, PG, M/PG, TV-PG"}
template:
- name: standard
- {name: commonsense, rating: "6, 06, GP, PG, M/PG, TV-PG"}
7:
template: {name: Content-Rating, rating: "7, 07, TV-Y7, TV-Y7-FV"}
template:
- name: standard
- {name: commonsense, rating: "7, 07, TV-Y7, TV-Y7-FV"}
8:
template: {name: Content-Rating, rating: "8, 08"}
template:
- name: standard
- {name: commonsense, rating: "8, 08"}
9:
template: {name: Content-Rating, rating: "9, 09"}
template:
- name: standard
- {name: commonsense, rating: "9, 09"}
10:
template: {name: Content-Rating, rating: "10"}
template:
- name: standard
- {name: commonsense, rating: "10"}
11:
template: {name: Content-Rating, rating: "11"}
template:
- name: standard
- {name: commonsense, rating: "11"}
12:
template: {name: Content-Rating, rating: "12"}
template:
- name: standard
- {name: commonsense, rating: "12"}
13:
template: {name: Content-Rating, rating: "13, PG-13"}
template:
- name: standard
- {name: commonsense, rating: "13, PG-13"}
14:
template: {name: Content-Rating, rating: "14, TV-14"}
template:
- name: standard
- {name: commonsense, rating: "14, TV-14"}
15:
template: {name: Content-Rating, rating: "15"}
template:
- name: standard
- {name: commonsense, rating: "15"}
16:
template: {name: Content-Rating, rating: "16, Passed, Approved, Open"}
template:
- name: standard
- {name: commonsense, rating: "16, Passed, Approved, Open"}
17:
template: {name: Content-Rating, rating: "17"}
template:
- name: standard
- {name: commonsense, rating: "17"}
18:
template: {name: Content-Rating, rating: "18, NC-17, M, TV-MA, R, X"}
template:
- name: standard
- {name: commonsense, rating: "18, NC-17, M, TV-MA, R, X"}
NR:
template: {name: Content-Rating, slug: nr, rating: "None, NR, Not Rated, Unrated"}
template:
- {name: standard, key: nr}
- {name: commonsense, rating: "None, NR, Not Rated, Unrated"}

55
defaults/overlays/direct_play.yml
View file

@ -1,59 +1,26 @@
#############################################################
# Direct Play Banner Overlay #
##############################################################################
# Direct Play Overlay #
# Created by Yozora, Bullmoose20, & Sohjiro #
# Credit to Magic815 for base images #
#############################################################
# Designed for TRaSH Guides filename naming scheme #
# https://trash-guides.info/ #
# #
# Call this from your config.yml (Movie or Show): #
# If nothing is specified these are the defaults #
# #
# overlay_path: #
# - git: PMM/overlays/direct_play #
# template_variables: #
# # Set episode or season to overlay #
# overlay_level: #
# # Set the horizontal offset for the overlay #
# horizontal_offset: 0 #
# # Set the horizontal align for the overlay #
# horizontal_align: center #
# # Set the vertical offset for the overlay #
# vertical_offset: 150 #
# # Set the vertical align for the overlay #
# vertical_align: bottom #
#############################################################
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
# https://metamanager.wiki/en/latest/defaults/overlays/direct_play.html #
##############################################################################
templates:
direct:
optional:
- overlay_level
default:
external_templates:
pmm: templates
template_variables:
horizontal_offset: 0
horizontal_align: center
vertical_offset: 150
vertical_align: bottom
back_color: "#00000099"
back_radius: 30
back_width: 305
back_height: 170
collection_level: <<overlay_level>>
overlay:
name: Direct-Play
pmm: Direct-Play
horizontal_offset: <<horizontal_offset>>
horizontal_align: <<horizontal_align>>
vertical_offset: <<vertical_offset>>
vertical_align: <<vertical_align>>
back_color: <<back_color>>
back_radius: <<back_radius>>
back_width: <<back_width>>
back_height: <<back_height>>
pmm: <<overlay_name>>
overlays:
Direct Play:
Direct-Play:
template:
name: direct
name: standard
plex_search:
any:
resolution.regex: '(?i)2160|4k'

195
defaults/overlays/edition.yml
View file

@ -1,195 +0,0 @@
#############################################################
# Special Release Overlay #
# Created by Yozora, Bullmoose20, & Sohjiro #
# Credit to Magic815 for base images #
#############################################################
# Designed for TRaSH Guides filename naming scheme #
# https://trash-guides.info/ #
# #
# Call this from your config.yml (Movie or Show): #
# If nothing is specified these are the defaults #
# #
# overlay_path: #
# - pmm: special_release #
# template_variables: #
# # Set episode or season to overlay #
# overlay_level: #
# # Set the horizontal offset for the overlay #
# horizontal_offset: 15 #
# # Set the horizontal align for the overlay #
# horizontal_align: left #
# # Set the vertical offset for the overlay #
# vertical_offset: 99 #
# # Set the vertical align for the overlay #
# vertical_align: top #
# #
# # Use the Director's Cut overlay #
# use_directorscut: true #
# # Use the Extended overlay #
# use_extended: true #
# # Use the Uncut overlay #
# use_uncut: true #
# # Use the Unrated overlay #
# use_unrated: true #
# # Use the Special overlay #
# use_special: true #
# # Use the Final Cut overlay #
# use_finalcut: true #
# # Use the Anniversary overlay #
# use_anniversary: true #
# # Use the Collectors overlay #
# use_collector: true #
# # Use the International overlay #
# use_international: true #
# # Use the Theatrical overlay #
# use_theatrical: true #
# # Use the Ultimate overlay #
# use_ultimate: true #
# # Use the IMAX-E overlay #
# use_enhanced: true #
# # Use the IMAX overlay #
# use_imax: true #
# # Use the Remastered overlay #
# use_remastered: true #
# # Use the Criterion overlay #
# use_criterion: true #
#############################################################
templates:
Edition:
conditionals:
vertical_offset:
default: 15
conditions:
- dovetail: true
value: 99
suppress_overlays:
conditions:
- dovetail: true
value:
- 4K-DV
- 4K-HDR
- 4K
- 1080P-DV
- 1080P-HDR
- 1080P
- 720P-DV
- 720P-HDR
- 720P
- 576P-DV
- 576P-HDR
- 576P
- 480P-DV
- 480P-HDR
- 480P
- DV
- HDR
- dovetail: false
value:
- <<overlay_name>>-Dovetail
back_width:
conditions:
- dovetail: false
value: 305
back_height:
conditions:
- dovetail: false
value: 105
optional:
- overlay_level
- use_<<slug>>
- search
default:
overlay: <<overlay_name>>
horizontal_offset: 15
horizontal_align: left
vertical_align: top
back_color: "#00000099"
back_radius: 30
collection_level: <<overlay_level>>
allowed_library_types: <<use_<<slug>>>>
ignore_blank_results: true
suppress_overlays: <<suppress_overlays>>
overlay:
name: <<overlay_name>>
pmm: edition/<<slug>>
group: edition
weight: <<weight>>
horizontal_offset: <<horizontal_offset>>
horizontal_align: <<horizontal_align>>
vertical_offset: <<vertical_offset>>
vertical_align: <<vertical_align>>
back_color: <<back_color>>
back_radius: <<back_radius>>
back_width: <<back_width>>
back_height: <<back_height>>
plex_search:
all:
edition: <<search>>
overlays:
Directors-Cut:
template: {name: Edition, weight: 150, slug: directorscut, search: Director, dovetail: false}
Directors-Cut-Dovetail:
template: {name: Edition, weight: 150, slug: directorscut, search: Director, dovetail: true}
Extended-Edition:
template: {name: Edition, weight: 140, slug: extended, search: Extended, dovetail: false}
Extended-Edition-Dovetail:
template: {name: Edition, weight: 140, slug: extended, search: Extended, dovetail: true}
Uncut-Edition:
template: {name: Edition, weight: 130, slug: uncut, search: Uncut, dovetail: false}
Uncut-Edition-Dovetail:
template: {name: Edition, weight: 130, slug: uncut, search: Uncut, dovetail: true}
Unrated-Edition:
template: {name: Edition, weight: 120, slug: unrated, search: Unrated, dovetail: false}
Unrated-Edition-Dovetail:
template: {name: Edition, weight: 120, slug: unrated, search: Unrated, dovetail: true}
Special-Edition:
template: {name: Edition, weight: 110, slug: special, search: Special, dovetail: false}
Special-Edition-Dovetail:
template: {name: Edition, weight: 110, slug: special, search: Special, dovetail: true}
Final-Cut:
template: {name: Edition, weight: 100, slug: finalcut, search: Final, dovetail: false}
Final-Cut-Dovetail:
template: {name: Edition, weight: 100, slug: finalcut, search: Final, dovetail: true}
Anniversary-Edition:
template: {name: Edition, weight: 90, slug: anniversary, search: Anniversary, dovetail: false}
Anniversary-Edition-Dovetail:
template: {name: Edition, weight: 90, slug: anniversary, search: Anniversary, dovetail: true}
Collectors-Edition:
template: {name: Edition, weight: 80, slug: collector, search: Collector, dovetail: false}
Collectors-Edition-Dovetail:
template: {name: Edition, weight: 80, slug: collector, search: Collector, dovetail: true}
International-Cut:
template: {name: Edition, weight: 70, slug: international, search: International, dovetail: false}
International-Cut-Dovetail:
template: {name: Edition, weight: 70, slug: international, search: International, dovetail: true}
Theatrical-Cut:
template: {name: Edition, weight: 60, slug: theatrical, search: Theatrical, dovetail: false}
Theatrical-Cut-Dovetail:
template: {name: Edition, weight: 60, slug: theatrical, search: Theatrical, dovetail: true}
Ultimate-Cut:
template: {name: Edition, weight: 50, slug: ultimate, search: Ultimate, dovetail: false}
Ultimate-Cut-Dovetail:
template: {name: Edition, weight: 50, slug: ultimate, search: Ultimate, dovetail: true}
IMAX:
template: {name: Edition, weight: 30, slug: imax, search: Imax, dovetail: false}
IMAX-Dovetail:
template: {name: Edition, weight: 30, slug: imax, search: Imax, dovetail: true}
Remastered:
template: {name: Edition, weight: 20, slug: remastered, search: Remaster, dovetail: false}
Remastered-Dovetail:
template: {name: Edition, weight: 20, slug: remastered, search: Remaster, dovetail: true}

69
defaults/overlays/episode_info.yml
View file

@ -1,72 +1,25 @@
#############################################################
##############################################################################
# Episode Info Overlay #
# Created by Yozora, Bullmoose20, & Sohjiro #
# Credit to Magic815 for base images #
#############################################################
# Call this from your config.yml (Show): #
# overlay_path: #
# - pmm: episode_info #
# template_variables: #
# # Set episode or season to overlay #
# overlay_level: #
# # Set the horizontal offset for the overlay #
# horizontal_offset: 15 #
# # Set the horizontal align for the overlay #
# horizontal_align: right #
# # Set the vertical offset for the overlay #
# vertical_offset: 150 #
# # Set the vertical align for the overlay #
# vertical_align: bottom #
# # Set the font for the overlay #
# font: fonts/Inter-Medium.ttf #
# # Set the font size for the overlay #
# font_size: 55 #
# # Set the font color for the overlay #
# font_color: "#FFFFFF" #
# # Set the back color for the overlay #
# back_color: "#00000099" #
# # Set the back radius for the overlay #
# back_radius: 30 #
# # Set the back width for the overlay #
# back_width: 305 #
# # Set the back height for the overlay #
# back_height: 105 #
#############################################################
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
# https://metamanager.wiki/en/latest/defaults/overlays/episode_info.html #
##############################################################################
templates:
text_episode_info:
optional:
- overlay_level
default:
overlay: <<overlay_name>>
external_templates:
pmm: templates
template_variables:
allowed_libraries: show
horizontal_offset: 15
horizontal_align: right
vertical_offset: 150
vertical_align: bottom
font: fonts/Inter-Medium.ttf
font_size: 55
font_color: "#FFFFFF"
back_color: "#00000099"
back_radius: 30
back_width: 305
back_height: 105
overlay_level: <<overlay_level>>
overlay:
name: text(S<<season_number0>>E<<episode_number0>>)
horizontal_offset: <<horizontal_offset>>
horizontal_align: <<horizontal_align>>
vertical_offset: <<vertical_offset>>
vertical_align: <<vertical_align>>
font: <<font>>
font_size: <<font_size>>
font_color: <<font_color>>
back_color: <<back_color>>
back_radius: <<back_radius>>
back_width: <<back_width>>
back_height: <<back_height>>
overlay_level: episode
final_name: text(S<<season_number0>>E<<episode_number0>>)
overlays:
Episode Info:
template:
- name: text_episode_info
name: standard
plex_all: true

109
defaults/overlays/flixpatrol.yml
View file

@ -1,86 +1,67 @@
##############################################################################
# FlixPatrol Overlays #
# Created by Yozora, Bullmoose20, anon_fawks, & Sohjiro #
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
# https://metamanager.wiki/en/latest/defaults/overlays/flixpatrol.html #
##############################################################################
external_templates:
pmm: templates
template_variables:
queue: position
limit: 10
limit_<<key>>: <<limit>>
pre_text: TOP
style: round
back_width: 160
back_height: 160
font_size: 50
addon_position: top
addon_offset: 30
back_padding: 15
pmm: logo/<<style>>/<<key>>
final_name: text(<<pre_text>><<limit_<<key>>>>)
queues:
flixpatrol_position:
position:
right:
- horizontal_offset: 30 # This is the first position
- horizontal_offset: 30
horizontal_align: right
vertical_offset: 465
vertical_align: top
- horizontal_offset: 30 # This is the second position
- horizontal_offset: 30
horizontal_align: right
vertical_offset: 670
vertical_align: top
- horizontal_offset: 30 # This is the third position
- horizontal_offset: 30
horizontal_align: right
vertical_offset: 875
vertical_align: top
left:
- horizontal_offset: 30 # This is the first position
- horizontal_offset: 30
horizontal_align: left
vertical_offset: 465
vertical_align: top
- horizontal_offset: 30 # This is the second position
- horizontal_offset: 30
horizontal_align: left
vertical_offset: 670
vertical_align: top
- horizontal_offset: 30 # This is the third position
- horizontal_offset: 30
horizontal_align: left
vertical_offset: 875
vertical_align: top
templates:
FlixPatrol:
optional:
- use_<<key>>
- time_window_<<key>>
- location_<<key>>
flixpatrol:
default:
style: round
overlay: <<overlay_name>>
slug: <<key>>
horizontal_offset: 15
horizontal_align: left
vertical_offset: 15
vertical_align: top
font: fonts/Inter-Bold.ttf
font_size: 50
font_color: "#FFFFFF"
back_color: "#00000099"
back_radius: 30
back_width: 160
back_height: 160
back_align: center
back_padding: 15
addon_position: top
addon_offset: 30
time_window: last_week
time_window_<<key>>: <<time_window>>
location: united_states
location: world
location_<<key>>: <<location>>
limit: 10
limit_<<key>>: <<limit>>
weight_<<key>>: <<weight>>
ignore_blank_results: true
allowed_library_types: <<use_<<key>>>>
overlay:
name: text(TOP<<limit>>)
queue: flixpatrol_position
weight: <<weight_<<key>>>>
horizontal_offset: <<horizontal_offset>>
horizontal_align: <<horizontal_align>>
vertical_offset: <<vertical_offset>>
vertical_align: <<vertical_align>>
font: <<font>>
font_size: <<font_size>>
font_color: <<font_color>>
back_radius: <<back_radius>>
back_color: <<back_color>>
back_width: <<back_width>>
back_height: <<back_height>>
back_align: <<back_align>>
back_padding: <<back_padding>>
pmm: logo/<<style>>/<<key>>
addon_position: <<addon_position>>
addon_offset: <<addon_offset>>
flixpatrol_top:
platform: <<slug>>
location: <<location_<<key>>>>
@ -88,15 +69,27 @@ templates:
limit: <<limit_<<key>>>>
overlays:
Netflix:
template: {name: FlixPatrol, weight: 600, key: netflix}
variables: {key: netflix, weight: 60}
template: [name: standard, name: flixpatrol]
Disney:
template: {name: FlixPatrol, weight: 500, key: disney}
variables: {key: disney, weight: 50}
template: [name: standard, name: flixpatrol]
HBO:
template: {name: FlixPatrol, weight: 400, key: hbo}
variables: {key: hbo, weight: 40}
template: [name: standard, name: flixpatrol]
Hulu:
template: {name: FlixPatrol, weight: 300, key: hulu}
variables: {key: hulu, weight: 30}
template: [name: standard, name: flixpatrol]
Paramount:
template: {name: FlixPatrol, weight: 200, key: paramount, slug: paramount_plus}
variables: {key: paramount, weight: 20, slug: paramount_plus}
template: [name: standard, name: flixpatrol]
Prime:
template: {name: FlixPatrol, weight: 100, key: prime, slug: amazon_prime}
variables: {key: prime, weight: 10, slug: amazon_prime}
template: [name: standard, name: flixpatrol]

59
defaults/overlays/mediastinger.yml
View file

@ -1,63 +1,26 @@
#############################################################
# Mediastinger Overlay #
##############################################################################
# MediaStinger Overlay #
# Created by Yozora, Bullmoose20, & Sohjiro #
# Credit to Magic815 for base images #
#############################################################
# Call this from your config.yml (Movie or Show): #
# overlay_path: #
# - git: PMM/overlays/mediastinger #
# template_variables: #
# # Set episode or season to overlay #
# overlay_level: #
# # Set the horizontal offset for the overlay #
# horizontal_offset: 200 #
# # Set the horizontal align for the overlay #
# horizontal_align: right #
# # Set the vertical offset for the overlay #
# vertical_offset: 15 #
# # Set the vertical align for the overlay #
# vertical_align: top #
# # Set the back color for the overlay #
# back_color: "#00000099" #
# # Set the back radius for the overlay #
# back_radius: 30 #
# # Set the back width for the overlay #
# back_width: 105 #
# # Set the back height for the overlay #
# back_height: 105 #
#############################################################
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
# https://metamanager.wiki/en/latest/defaults/overlays/mediastinger.html #
##############################################################################
templates:
stinger:
optional:
- overlay_level
default:
overlay: <<overlay_name>>
external_templates:
pmm: templates
template_variables:
allowed_libraries: movie
horizontal_offset: 200
horizontal_align: right
vertical_offset: 15
vertical_align: top
back_color: "#00000099"
back_radius: 30
back_width: 105
back_height: 105
overlay_level: <<overlay_level>>
overlay:
name: <<overlay_name>>
pmm: Mediastinger
horizontal_offset: <<horizontal_offset>>
horizontal_align: <<horizontal_align>>
vertical_offset: <<vertical_offset>>
vertical_align: <<vertical_align>>
back_color: <<back_color>>
back_radius: <<back_radius>>
back_width: <<back_width>>
back_height: <<back_height>>
pmm: <<overlay_name>>
overlays:
Mediastinger:
template:
- name: stinger
name: standard
plex_all: true
filters:
tmdb_keyword: aftercreditsstinger, duringcreditsstinger

170
defaults/overlays/ratings.yml
View file

@ -1,98 +1,43 @@
#############################################################
# Ratings Overlay #
##############################################################################
# Ratings Overlays #
# Created by Yozora, Bullmoose20, & Sohjiro #
# Credit to Magic815 for base images #
#############################################################
# Call this from your config.yml (Movie or Show): #
# If nothing is specified nothing will show up at least #
# one rating# must be set #
# #
# overlay_path: #
# - git: PMM/overlays/ratings #
# template_variables: #
# #
# # Set rating type for rating1, rating2, and/or #
# rating3 #
# # Rating Types: critic, audience, user #
# #
# rating1: critic #
# rating2: audience #
# rating3: user #
# #
# # Set rating image for rating1, rating2, and/or #
# rating3 #
# # Rating Images: anidb, imdb, letterboxd, tmdb, #
# metacritic, rt_popcorn, rt_tomato, trakt, #
# mal #
# #
# rating1_image: imdb #
# rating2_image: rt_popcorn #
# rating3_image: tmdb #
# #
# # Sets the position to display the ratings #
# # horizontal_position: left, right, center #
# # vertical_position: top, bottom, center #
# #
# horizontal_position: left #
# vertical_position: center #
# #
# # Sets the alignment to display the ratings #
# # rating_alignment: horizontal, vertical #
# #
# rating_alignment: vertical #
# #
# # Set as 'episode' to overlay episodes #
# #
# overlay_level: #
# #
# Movies: #
# overlay_path: #
# - git: PMM/overlays/ratings #
# template_variables: #
# rating1: critic #
# rating2: audience #
# rating3: user #
# rating1_image: imdb #
# rating2_image: rt_popcorn #
# rating3_image: tmdb #
# operations: #
# mass_critic_rating_update: imdb #
# mass_audience_rating_update: mdb_tomatoesaudience #
# mass_user_rating_update: tmdb #
# TV Shows: #
# overlay_path: #
# - git: PMM/overlays/ratings #
# template_variables: #
# rating1: critic #
# rating2: audience #
# rating3: user #
# rating1_image: imdb #
# rating2_image: rt_popcorn #
# rating3_image: tmdb #
# - git: PMM/overlays/ratings #
# template_variables: #
# rating1: critic #
# rating2: audience #
# rating1_image: imdb #
# rating2_image: tmdb #
# operations: #
# mass_critic_rating_update: imdb #
# mass_audience_rating_update: mdb_tomatoesaudience #
# mass_user_rating_update: tmdb #
# mass_episode_critic_rating_update: imdb #
# mass_episode_audience_rating_update: tmdb #
#############################################################
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
# https://metamanager.wiki/en/latest/defaults/overlays/ratings.html #
##############################################################################
templates:
Rating:
optional:
- overlay_level
default:
font: fonts/Inter-Bold.ttf
font_size: 63
rating<<rating_num>>_font: <<font>>
rating<<rating_num>>_font_size: <<font_size>>
rating<<rating_num>>_file: <<file>>
rating<<rating_num>>_url: <<url>>
rating<<rating_num>>_git: <<git>>
rating<<rating_num>>_repo: <<repo>>
pmm: rating/<<rating<<rating_num>>_image_url>><<image_extra>>
rating<<rating_num>>_pmm: <<pmm>>
weight: 100
font: fonts/Inter-Bold.ttf
rating<<rating_num>>_font: <<font>>
rating<<rating_num>>_font_style: <<font_style>>
font_size: 63
rating<<rating_num>>_font_size: <<font_size>>
font_color: "#FFFFFF"
rating<<rating_num>>_font_color: <<font_color>>
rating<<rating_num>>_stroke_width: <<stroke_width>>
rating<<rating_num>>_stroke_color: <<stroke_color>>
back_color: "#00000099"
rating<<rating_num>>_back_color: <<back_color>>
rating<<rating_num>>_back_width: <<back_width>>
rating<<rating_num>>_back_height: <<back_height>>
rating<<rating_num>>_back_align: <<back_align>>
back_padding: 15
rating<<rating_num>>_back_padding: <<back_padding>>
back_radius: 30
rating<<rating_num>>_back_radius: <<back_radius>>
rating<<rating_num>>_back_line_color: <<back_line_color>>
rating<<rating_num>>_back_line_width: <<back_line_width>>
addon_offset: 15
rating<<rating_num>>_addon_offset: <<addon_offset>>
rating<<rating_num>>_addon_position: <<addon_position>>
side: left
horizontal_position: left
vertical_position: center
@ -110,6 +55,18 @@ templates:
h3_offset: 660
ch2_offset: 160
ch3_offset: 335
optional:
- file
- url
- git
- repo
- overlay_level
- font_style
- back_align
- stroke_width
- stroke_color
- back_line_color
- back_line_width
conditionals:
mdblist_top:
conditions:
@ -472,29 +429,38 @@ templates:
<<rating<<rating_num>>>>_rating.<<lsuffix>>: <<lte>>
mdblist_list: <<mdblist_top>>
imdb_chart: <<imdb_top>>
collection_level: <<overlay_level>>
overlay_level: <<overlay_level>>
allowed_library_types: <<run_this>>
ignore_blank_results: true
overlay:
name: text(<<rating<<rating_num>>>>_rating<<rating<<rating_num>>_style>>)
file: <<rating<<rating_num>>_file>>
url: <<rating<<rating_num>>_url>>
git: <<rating<<rating_num>>_git>>
repo: <<rating<<rating_num>>_repo>>
pmm: <<rating<<rating_num>>_pmm>>
group: rating<<rating_num>>_group
weight: <<weight>>
horizontal_offset: <<rating<<rating_num>>_horizontal_offset>>
horizontal_align: <<rating<<rating_num>>_horizontal_align>>
vertical_offset: <<rating<<rating_num>>_vertical_offset>>
vertical_align: <<rating<<rating_num>>_vertical_align>>
group: rating<<rating_num>>_group
weight: <<weight>>
font: <<rating<<rating_num>>_font>>
font_style: <<rating<<rating_num>>_font_style>>
font_size: <<rating<<rating_num>>_font_size>>
font_color: "#FFFFFF"
back_color: "#00000099"
back_radius: 30
back_width: <<back_width>>
back_height: <<back_height>>
back_align: center
back_padding: 15
pmm: rating/<<rating<<rating_num>>_image_url>><<image_extra>>
addon_position: <<addon_position>>
addon_offset: 15
font_color: <<rating<<rating_num>>_font_color>>
stroke_width: <<rating<<rating_num>>_stroke_width>>
stroke_color: <<rating<<rating_num>>_stroke_color>>
back_color: <<rating<<rating_num>>_back_color>>
back_width: <<rating<<rating_num>>_back_width>>
back_height: <<rating<<rating_num>>_back_height>>
back_align: <<rating<<rating_num>>_back_align>>
back_padding: <<rating<<rating_num>>_back_padding>>
back_radius: <<rating<<rating_num>>_back_radius>>
back_line_color: <<rating<<rating_num>>_back_line_color>>
back_line_width: <<rating<<rating_num>>_back_line_width>>
addon_offset: <<rating<<rating_num>>_addon_offset>>
addon_position: <<rating<<rating_num>>_addon_position>>
overlays:

437
defaults/overlays/resolution.yml
View file

@ -1,45 +1,38 @@
#############################################################
# Resolution Overlay #
##############################################################################
# Resolution/Edition Overlay #
# Created by Yozora, Bullmoose20, & Sohjiro #
# Credit to Magic815 for base images #
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
# https://metamanager.wiki/en/latest/defaults/overlays/resolution.html #
#############################################################
##############################################################################
templates:
Resolution:
external_templates:
pmm: templates
template_variables:
conditionals:
res:
conditions:
- resolution: 4k
value: "(?i)2160|4k"
- resolution: 1080p
value: "(?i)1080|2k"
- resolution: 720p
value: "(?i)720|hd"
- resolution: 576p
value: "(?i)576"
- resolution: 480p
value: "(?i)480|sd"
dolby_vision:
conditions:
- alt: dv
value: true
hdr:
conditions:
- alt: hdr
value: true
back_align:
conditions:
- dovetail: true
value: top
back_height:
default: 105
conditions:
- dovetail: true
value: 189
suppress_overlays:
default: <<overlay_name>>-Dovetail
conditions:
- dovetail: true
- type: edition_dovetail
value:
- 4K-DV
- 4K-HDR
- 4K
- 1080P-DV
- 1080P-HDR
- 1080P
- 720P-DV
- 720P-HDR
- 720P
- 576P-DV
- 576P-HDR
- 576P
- 480P-DV
- 480P-HDR
- 480P
- DV
- HDR
- type: resolution_dovetail
value:
- Directors-Cut
- Extended-Edition
@ -56,44 +49,109 @@ templates:
- IMAX
- Remastered
- Criterion
- dovetail: false
value:
- <<overlay_name>>-Dovetail
optional:
- overlay_level
- use_<<resolution>>
- use_<<alt>>
- all
default:
resolution: ""
alt: ""
vertical_offset:
default: 15
conditions:
- type: edition_dovetail
value: 99
back_width:
conditions:
- type: [edition, resolution, resolution_dovetail]
value: 305
back_height:
conditions:
- type: [edition, resolution]
value: 105
- type: resolution_dovetail
value: 189
back_align:
conditions:
- type: resolution_dovetail
value: top
pmm:
conditions:
- type: [edition, edition_dovetail]
value: edition/<<key>>
- type: [resolution, resolution_dovetail]
value: resolution/<<key>><<alt>>
group:
conditions:
- type: [edition, edition_dovetail]
value: edition
- type: [resolution, resolution_dovetail]
value: resolution
horizontal_offset: 15
horizontal_align: left
vertical_offset: 15
vertical_align: top
back_color: "#00000099"
back_radius: 30
back_width: 305
collection_level: <<overlay_level>>
ignore_blank_results: true
templates:
edition:
conditionals:
regex1:
conditions:
- key: enhanced
value: '(?i)\bIMAX Enhanced\b|^(?=.*(DSNP|Disney\+|CORE(?=[ ._-]web[ ._-]?(dl|rip)\b)|\bBC(?=[ ._-]web[ ._-]?(dl|rip)\b)|IMAX[- .]Enhanced)\b)(?=.*\b(IMAX|IMAX[- .]Enhanced)\b).*'
- key: imax
value: '(?i)\bIMAX\b'
- key: criterion
value: '(?i)Criterion'
regex2:
conditions:
- key: criterion
value: '(?i)\[CC\]'
optional:
- search
- use_<<key>>
- use_edition
- allowed_libraries
allowed_library_types:
- <<use_<<resolution>>>>
- <<use_<<key>>>>
- <<use_edition>>
- <<allowed_libraries>>
ignore_blank_results: true
plex_all: true
filters:
- edition: <<search>>
- filepath.regex:
- <<regex1>>
- <<regex2>>
- 'edition-(?i)\b(4k )?<<search>>(s|ed)?\b' # New TRaSH naming
- '(?<=[0-9]{4}[)}>\]]\s)\b(4k )?<<search>>(s|ed)?\b' # Original TRaSH naming
resolution:
conditionals:
res:
conditions:
- key: 4k
value: "(?i)2160|4k"
- key: 1080p
value: "(?i)1080|2k"
- key: 720p
value: "(?i)720|hd"
- key: 576p
value: "(?i)576"
- key: 480p
value: "(?i)480|sd"
dolby_vision:
conditions:
- alt: dv
value: true
hdr:
conditions:
- alt: hdr
value: true
optional:
- all
- use_<<key>>
- use_<<alt>>
- use_resolution
- allowed_libraries
allowed_library_types:
- <<use_<<key>>>>
- <<use_<<alt>>>>
suppress_overlays: <<suppress_overlays>>
overlay:
name: <<overlay_name>>
pmm: resolution/<<resolution>><<alt>>
group: res
weight: <<weight>>
horizontal_offset: <<horizontal_offset>>
horizontal_align: <<horizontal_align>>
vertical_offset: <<vertical_offset>>
vertical_align: <<vertical_align>>
back_color: <<back_color>>
back_radius: <<back_radius>>
back_width: <<back_width>>
back_height: <<back_height>>
back_align: <<back_align>>
- <<allowed_libraries>>
- <<use_resolution>>
ignore_blank_results: true
plex_all: <<all>>
plex_search:
all:
@ -104,89 +162,198 @@ templates:
overlays:
4K-DV:
template: {name: Resolution, weight: 150, resolution: 4k, alt: dv, dovetail: false}
4K-DV-Dovetail:
template: {name: Resolution, weight: 150, resolution: 4k, alt: dv, dovetail: true}
4K-HDR:
template: {name: Resolution, weight: 140, resolution: 4k, alt: hdr, dovetail: false}
variables: {key: 4k, alt: dv, weight: 150, type: resolution_dovetail, allowed_libraries: movie}
template: [name: standard, name: resolution]
4K-HDR-Dovetail:
template: {name: Resolution, weight: 140, resolution: 4k, alt: hdr, dovetail: true}
4K:
template: {name: Resolution, weight: 130, resolution: 4k, dovetail: false}
variables: {key: 4k, alt: hdr, weight: 140, type: resolution_dovetail, allowed_libraries: movie}
template: [name: standard, name: resolution]
4K-Dovetail:
template: {name: Resolution, weight: 130, resolution: 4k, dovetail: true}
1080P-DV:
template: {name: Resolution, weight: 120, resolution: 1080p, alt: dv, dovetail: false}
variables: {key: 4k, alt: "", weight: 130, type: resolution_dovetail, allowed_libraries: movie}
template: [name: standard, name: resolution]
1080P-DV-Dovetail:
template: {name: Resolution, weight: 120, resolution: 1080p, alt: dv, dovetail: true}
1080P-HDR:
template: {name: Resolution, weight: 110, resolution: 1080p, alt: hdr, dovetail: false}
variables: {key: 1080p, alt: dv, weight: 120, type: resolution_dovetail, allowed_libraries: movie}
template: [name: standard, name: resolution]
1080P-HDR-Dovetail:
template: {name: Resolution, weight: 110, resolution: 1080p, alt: hdr, dovetail: true}
1080P:
template: {name: Resolution, weight: 100, resolution: 1080p, dovetail: false}
variables: {key: 1080p, alt: hdr, weight: 110, type: resolution_dovetail, allowed_libraries: movie}
template: [name: standard, name: resolution]
1080P-Dovetail:
template: {name: Resolution, weight: 100, resolution: 1080p, dovetail: true}
720P-DV:
template: {name: Resolution, weight: 90, resolution: 720p, alt: dv, dovetail: false}
variables: {key: 1080p, alt: "", weight: 100, type: resolution_dovetail, allowed_libraries: movie}
template: [name: standard, name: resolution]
720P-DV-Dovetail:
template: {name: Resolution, weight: 90, resolution: 720p, alt: dv, dovetail: true}
720P-HDR:
template: {name: Resolution, weight: 80, resolution: 720p, alt: hdr, dovetail: false}
variables: {key: 720p, alt: dv, weight: 90, type: resolution_dovetail, allowed_libraries: movie}
template: [name: standard, name: resolution]
720P-HDR-Dovetail:
template: {name: Resolution, weight: 80, resolution: 720p, alt: hdr, dovetail: true}
720P:
template: {name: Resolution, weight: 70, resolution: 720p, dovetail: false}
variables: {key: 720p, alt: hdr, weight: 80, type: resolution_dovetail, allowed_libraries: movie}
template: [name: standard, name: resolution]
720P-Dovetail:
template: {name: Resolution, weight: 70, resolution: 720p, dovetail: true}
576P-DV:
template: {name: Resolution, weight: 60, resolution: 576p, alt: dv, dovetail: false}
variables: {key: 720p, alt: "", weight: 70, type: resolution_dovetail, allowed_libraries: movie}
template: [name: standard, name: resolution]
576P-DV-Dovetail:
template: {name: Resolution, weight: 60, resolution: 576p, alt: dv, dovetail: true}
576P-HDR:
template: {name: Resolution, weight: 50, resolution: 576p, alt: hdr, dovetail: false}
variables: {key: 576p, alt: dv, weight: 60, type: resolution_dovetail, allowed_libraries: movie}
template: [name: standard, name: resolution]
576P-HDR-Dovetail:
template: {name: Resolution, weight: 50, resolution: 576p, alt: hdr, dovetail: true}
576P:
template: {name: Resolution, weight: 40, resolution: 576p, dovetail: false}
variables: {key: 576p, alt: hdr, weight: 50, type: resolution_dovetail, allowed_libraries: movie}
template: [name: standard, name: resolution]
576P-Dovetail:
template: {name: Resolution, weight: 40, resolution: 576p, dovetail: true}
480P-DV:
template: {name: Resolution, weight: 30, resolution: 480p, alt: dv, dovetail: false}
variables: {key: 576p, alt: "", weight: 40, type: resolution_dovetail, allowed_libraries: movie}
template: [name: standard, name: resolution]
480P-DV-Dovetail:
template: {name: Resolution, weight: 30, resolution: 480p, alt: dv, dovetail: true}
480P-HDR:
template: {name: Resolution, weight: 20, resolution: 480p, alt: hdr, dovetail: false}
variables: {key: 480p, alt: dv, weight: 30, type: resolution_dovetail, allowed_libraries: movie}
template: [name: standard, name: resolution]
480P-HDR-Dovetail:
template: {name: Resolution, weight: 20, resolution: 480p, alt: hdr, dovetail: true}
480P:
template: {name: Resolution, weight: 10, resolution: 480p, dovetail: false}
variables: {key: 480p, alt: hdr, weight: 20, type: resolution_dovetail, allowed_libraries: movie}
template: [name: standard, name: resolution]
480P-Dovetail:
template: {name: Resolution, weight: 10, resolution: 480p, dovetail: true}
DV:
template: {name: Resolution, weight: 5, alt: dv, all: true, dovetail: false}
variables: {key: 480p, alt: "", weight: 10, type: resolution_dovetail, allowed_libraries: movie}
template: [name: standard, name: resolution]
DV-Dovetail:
template: {name: Resolution, weight: 5, alt: dv, all: true, dovetail: true}
HDR:
template: {name: Resolution, weight: 1, alt: hdr, dovetail: false}
variables: {key: "", alt: dv, weight: 5, type: resolution_dovetail, all: true, allowed_libraries: movie}
template: [name: standard, name: resolution]
HDR-Dovetail:
template: {name: Resolution, weight: 1, alt: hdr, dovetail: true}
variables: {key: "", alt: hdr, weight: 1, type: resolution_dovetail, allowed_libraries: movie}
template: [name: standard, name: resolution]
Directors-Cut-Dovetail:
variables: {key: directorscut, weight: 150, search: Director, type: edition_dovetail, allowed_libraries: movie}
template: [name: standard, name: edition]
Extended-Edition-Dovetail:
variables: {key: extended, weight: 140, search: Extend, type: edition_dovetail, allowed_libraries: movie}
template: [name: standard, name: edition]
Uncut-Edition-Dovetail:
variables: {key: uncut, weight: 130, search: Uncut, type: edition_dovetail, allowed_libraries: movie}
template: [name: standard, name: edition]
Unrated-Edition-Dovetail:
variables: {key: unrated, weight: 120, search: Unrat, type: edition_dovetail, allowed_libraries: movie}
template: [name: standard, name: edition]
Special-Edition-Dovetail:
variables: {key: special, weight: 110, search: Special, type: edition_dovetail, allowed_libraries: movie}
template: [name: standard, name: edition]
Final-Cut-Dovetail:
variables: {key: finalcut, weight: 100, search: Final, type: edition_dovetail, allowed_libraries: movie}
template: [name: standard, name: edition]
Anniversary-Edition-Dovetail:
variables: {key: anniversary, weight: 90, search: Anniversary, type: edition_dovetail, allowed_libraries: movie}
template: [name: standard, name: edition]
Collectors-Edition-Dovetail:
variables: {key: collector, weight: 80, search: Collector, type: edition_dovetail, allowed_libraries: movie}
template: [name: standard, name: edition]
International-Cut-Dovetail:
variables: {key: international, weight: 70, search: International, type: edition_dovetail, allowed_libraries: movie}
template: [name: standard, name: edition]
Theatrical-Cut-Dovetail:
variables: {key: theatrical, weight: 60, search: Theatrical, type: edition_dovetail, allowed_libraries: movie}
template: [name: standard, name: edition]
Ultimate-Cut-Dovetail:
variables: {key: ultimate, weight: 50, search: Ultimate, type: edition_dovetail, allowed_libraries: movie}
template: [name: standard, name: edition]
IMAX-E-Dovetail:
variables: {key: enhanced, weight: 40, type: edition_dovetail, allowed_libraries: movie}
template: [name: standard, name: edition]
IMAX-Dovetail:
variables: {key: imax, weight: 30, search: Imax, type: edition_dovetail, allowed_libraries: movie}
template: [name: standard, name: edition]
Remastered-Dovetail:
variables: {key: remastered, weight: 20, search: Remaster, type: edition_dovetail, allowed_libraries: movie}
template: [name: standard, name: edition]
Criterion-Dovetail:
variables: {key: criterion, weight: 10, type: edition_dovetail, allowed_libraries: movie}
template: [name: standard, name: edition]
4K-DV:
variables: {key: 4k, alt: dv, weight: 150, type: resolution}
template: [name: standard, name: resolution]
4K-HDR:
variables: {key: 4k, alt: hdr, weight: 140, type: resolution}
template: [name: standard, name: resolution]
4K:
variables: {key: 4k, alt: "", weight: 130, type: resolution}
template: [name: standard, name: resolution]
1080P-DV:
variables: {key: 1080p, alt: dv, weight: 120, type: resolution}
template: [name: standard, name: resolution]
1080P-HDR:
variables: {key: 1080p, alt: hdr, weight: 110, type: resolution}
template: [name: standard, name: resolution]
1080P:
variables: {key: 1080p, alt: "", weight: 100, type: resolution}
template: [name: standard, name: resolution]
720P-DV:
variables: {key: 720p, alt: dv, weight: 90, type: resolution}
template: [name: standard, name: resolution]
720P-HDR:
variables: {key: 720p, alt: hdr, weight: 80, type: resolution}
template: [name: standard, name: resolution]
720P:
variables: {key: 720p, alt: "", weight: 70, type: resolution}
template: [name: standard, name: resolution]
576P-DV:
variables: {key: 576p, alt: dv, weight: 60, type: resolution}
template: [name: standard, name: resolution]
576P-HDR:
variables: {key: 576p, alt: hdr, weight: 50, type: resolution}
template: [name: standard, name: resolution]
576P:
variables: {key: 576p, alt: "", weight: 40, type: resolution}
template: [name: standard, name: resolution]
480P-DV:
variables: {key: 480p, alt: dv, weight: 30, type: resolution}
template: [name: standard, name: resolution]
480P-HDR:
variables: {key: 480p, alt: hdr, weight: 20, type: resolution}
template: [name: standard, name: resolution]
480P:
variables: {key: 480p, alt: "", weight: 10, type: resolution}
template: [name: standard, name: resolution]
DV:
variables: {key: "", alt: dv, weight: 5, type: resolution, all: true}
template: [name: standard, name: resolution]
HDR:
variables: {key: "", alt: hdr, weight: 1, type: resolution}
template: [name: standard, name: resolution]
Directors-Cut:
variables: {key: directorscut, weight: 150, search: Director, type: edition, allowed_libraries: movie}
template: [name: standard, name: edition]
Extended-Edition:
variables: {key: extended, weight: 140, search: Extend, type: edition, allowed_libraries: movie}
template: [name: standard, name: edition]
Uncut-Edition:
variables: {key: uncut, weight: 130, search: Uncut, type: edition, allowed_libraries: movie}
template: [name: standard, name: edition]
Unrated-Edition:
variables: {key: unrated, weight: 120, search: Unrat, type: edition, allowed_libraries: movie}
template: [name: standard, name: edition]
Special-Edition:
variables: {key: special, weight: 110, search: Special, type: edition, allowed_libraries: movie}
template: [name: standard, name: edition]
Final-Cut:
variables: {key: finalcut, weight: 100, search: Final, type: edition, allowed_libraries: movie}
template: [name: standard, name: edition]
Anniversary-Edition:
variables: {key: anniversary, weight: 90, search: Anniversary, type: edition, allowed_libraries: movie}
template: [name: standard, name: edition]
Collectors-Edition:
variables: {key: collector, weight: 80, search: Collector, type: edition, allowed_libraries: movie}
template: [name: standard, name: edition]
International-Cut:
variables: {key: international, weight: 70, search: International, type: edition, allowed_libraries: movie}
template: [name: standard, name: edition]
Theatrical-Cut:
variables: {key: theatrical, weight: 60, search: Theatrical, type: edition, allowed_libraries: movie}
template: [name: standard, name: edition]
Ultimate-Cut:
variables: {key: ultimate, weight: 50, search: Ultimate, type: edition, allowed_libraries: movie}
template: [name: standard, name: edition]
IMAX-E:
variables: {key: enhanced, weight: 40, type: edition, allowed_libraries: movie}
template: [name: standard, name: edition]
IMAX:
variables: {key: imax, weight: 30, type: edition, allowed_libraries: movie}
template: [name: standard, name: edition]
Remastered:
variables: {key: remastered, weight: 20, search: Remaster, type: edition, allowed_libraries: movie}
template: [name: standard, name: edition]
Criterion:
variables: {key: criterion, weight: 10, type: edition, allowed_libraries: movie}
template: [name: standard, name: edition]

76
defaults/overlays/ribbon.yml
View file

@ -1,70 +1,48 @@
#############################################################
##############################################################################
# Ribbon Overlay #
# Created by Yozora, Bullmoose20, & Sohjiro #
# Credit to Magic815 for base images #
#############################################################
# Call this from your config.yml (Movie or Show): #
# - pmm: ribbon #
# template_variables: #
# #
# # For each overlay use the "key" to set #
# # the options. #
# # Available overlays #
# # KEY COLLECTION #
# # oscars Academy Awards (Oscars) #
# # imdb IMDb Top 250 #
# # rotten Rotten Tomatoes Certified Fresh#
# # metacritic Metacritic Must See #
# # common Commonsense Selection #
# #
# # Available options. Replace "key" with the #
# # desired collection's key from the chart above. #
# #
# # Turn the collection on/off #
# use_key: true #
# # Determines collection order in its section #
# # Sets the weight for that overlay #
# weight_key: #
#############################################################
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
# https://metamanager.wiki/en/latest/defaults/overlays/ribbon.html #
##############################################################################
templates:
Ribbon:
default:
weight_<<key>>: <<weight>>
optional:
- mdb_key
- imdb_key
- allowed_libraries
- use_<<key>>
mdblist_list: https://mdblist.com/lists/plexmetamanager/<<mdb_key>><<library_type>>s
imdb_chart: <<imdb_key>>_<<library_type>>s
allowed_library_types:
- <<use_<<key>>>>
- <<allowed_libraries>>
overlay:
name: <<overlay_name>>
pmm: ribbon/<<key>>
external_templates:
pmm: templates
template_variables:
group: ribbon
weight: <<weight_<<key>>>>
pmm: ribbon/<<key>>
horizontal_offset: 0
horizontal_align: right
vertical_offset: 0
vertical_align: bottom
templates:
ribbon:
optional:
- mdb_key
- imdb_key
mdblist_list: https://mdblist.com/lists/plexmetamanager/<<mdb_key>><<library_type>>s
imdb_chart: <<imdb_key>>_<<library_type>>s
overlays:
Oscars Best Picture:
variables: {key: oscars, weight: 50}
template: {name: standard, allowed_libraries: movie}
imdb_list: https://www.imdb.com/search/title/?groups=best_picture_winner
template: {name: Ribbon, key: oscars, weight: 40, allowed_libraries: movie}
IMDb Top 250:
template: {name: Ribbon, imdb_key: top, key: imdb, weight: 30}
variables: {key: imdb, weight: 40, imdb_key: top}
template: [name: standard, name: ribbon]
Rotten Tomatoes Certified Fresh:
template: {name: Ribbon, mdb_key: certifiedfresh, key: rotten, weight: 20}
variables: {key: rotten, weight: 30, mdb_key: certifiedfresh}
template: [name: standard, name: ribbon]
Metacritic Must See:
template: {name: Ribbon, mdb_key: metacriticmustsee, key: metacritic, weight: 10}
variables: {key: metacritic, weight: 20, mdb_key: metacriticmustsee}
template: [name: standard, name: ribbon]
Commonsense Selection:
template: {name: Ribbon, mdb_key: cssfamilies, key: common, weight: 5}
variables: {key: common, weight: 10, mdb_key: cssfamilies}
template: [name: standard, name: ribbon]

76
defaults/overlays/runtimes.yml
View file

@ -1,72 +1,28 @@
#############################################################
# Episodes Runtime Overlay #
##############################################################################
# Runtimes Overlay #
# Created by Yozora, Bullmoose20, & Sohjiro #
# Credit to Magic815 for base images #
#############################################################
# Call this from your config.yml (Show): #
# overlay_path: #
# - pmm: runtimes #
# template_variables: #
# # Set episode or season to overlay #
# overlay_level: #
# # Set the horizontal offset for the overlay #
# horizontal_offset: 15 #
# # Set the horizontal align for the overlay #
# horizontal_align: right #
# # Set the vertical offset for the overlay #
# vertical_offset: 30 #
# # Set the vertical align for the overlay #
# vertical_align: bottom #
# # Set the font for the overlay #
# font: fonts/Inter-Medium.ttf #
# # Set the font size for the overlay #
# font_size: 55 #
# # Set the font color for the overlay #
# font_color: "#FFFFFF" #
# # Set the back color for the overlay #
# back_color: "#00000099" #
# # Set the back radius for the overlay #
# back_radius: 30 #
# # Set the back width for the overlay #
# back_width: 600 #
# # Set the back height for the overlay #
# back_height: 105 #
#############################################################
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
# https://metamanager.wiki/en/latest/defaults/overlays/runtimes.html #
##############################################################################
templates:
text_runtime_info:
optional:
- overlay_level
default:
overlay: <<overlay_name>>
external_templates:
pmm: templates
template_variables:
conditionals:
overlay_level:
conditions:
- library_type: show
value: episode
horizontal_offset: 15
horizontal_align: right
vertical_offset: 30
vertical_align: bottom
font: fonts/Inter-Medium.ttf
font_size: 55
font_color: "#FFFFFF"
back_color: "#00000099"
back_radius: 30
back_width: 600
back_height: 105
collection_level: <<overlay_level>>
overlay:
name: "text(Runtime: <<runtimeH>>h <<runtimeM>>m)"
horizontal_offset: <<horizontal_offset>>
horizontal_align: <<horizontal_align>>
vertical_offset: <<vertical_offset>>
vertical_align: <<vertical_align>>
font: <<font>>
font_size: <<font_size>>
font_color: <<font_color>>
back_color: <<back_color>>
back_radius: <<back_radius>>
back_width: <<back_width>>
back_height: <<back_height>>
final_name: "text(Runtime: <<runtimeH>>h <<runtimeM>>m)"
overlays:
runtime_info:
template:
- name: text_runtime_info
plex_all: true
template:
name: standard

208
defaults/overlays/special_release.yml
View file

@ -1,208 +0,0 @@
#############################################################
# Special Release Overlay #
# Created by Yozora, Bullmoose20, & Sohjiro #
# Credit to Magic815 for base images #
#############################################################
# Designed for TRaSH Guides filename naming scheme #
# https://trash-guides.info/ #
# #
# Call this from your config.yml (Movie or Show): #
# If nothing is specified these are the defaults #
# #
# overlay_path: #
# - pmm: special_release #
# template_variables: #
# # Set episode or season to overlay #
# overlay_level: #
# # Set the horizontal offset for the overlay #
# horizontal_offset: 15 #
# # Set the horizontal align for the overlay #
# horizontal_align: left #
# # Set the vertical offset for the overlay #
# vertical_offset: 99 #
# # Set the vertical align for the overlay #
# vertical_align: top #
# #
# # Use the Director's Cut overlay #
# use_directorscut: true #
# # Use the Extended overlay #
# use_extended: true #
# # Use the Uncut overlay #
# use_uncut: true #
# # Use the Unrated overlay #
# use_unrated: true #
# # Use the Special overlay #
# use_special: true #
# # Use the Final Cut overlay #
# use_finalcut: true #
# # Use the Anniversary overlay #
# use_anniversary: true #
# # Use the Collectors overlay #
# use_collector: true #
# # Use the International overlay #
# use_international: true #
# # Use the Theatrical overlay #
# use_theatrical: true #
# # Use the Ultimate overlay #
# use_ultimate: true #
# # Use the IMAX-E overlay #
# use_enhanced: true #
# # Use the IMAX overlay #
# use_imax: true #
# # Use the Remastered overlay #
# use_remastered: true #
# # Use the Criterion overlay #
# use_criterion: true #
#############################################################
templates:
Edition:
conditionals:
vertical_offset:
default: 15
conditions:
- dovetail: true
value: 99
suppress_overlays:
conditions:
- dovetail: true
value:
- 4K-DV
- 4K-HDR
- 4K
- 1080P-DV
- 1080P-HDR
- 1080P
- 720P-DV
- 720P-HDR
- 720P
- 576P-DV
- 576P-HDR
- 576P
- 480P-DV
- 480P-HDR
- 480P
- DV
- HDR
- dovetail: false
value:
- <<overlay_name>>-Dovetail
back_width:
conditions:
- dovetail: false
value: 305
back_height:
conditions:
- dovetail: false
value: 105
optional:
- overlay_level
- use_<<slug>>
- search
default:
overlay: <<overlay_name>>
horizontal_offset: 15
horizontal_align: left
vertical_align: top
back_color: "#00000099"
back_radius: 30
collection_level: <<overlay_level>>
allowed_library_types: <<use_<<slug>>>>
ignore_blank_results: true
suppress_overlays: <<suppress_overlays>>
overlay:
name: <<overlay_name>>
pmm: edition/<<slug>>
group: edition
weight: <<weight>>
horizontal_offset: <<horizontal_offset>>
horizontal_align: <<horizontal_align>>
vertical_offset: <<vertical_offset>>
vertical_align: <<vertical_align>>
back_color: <<back_color>>
back_radius: <<back_radius>>
back_width: <<back_width>>
back_height: <<back_height>>
plex_all: true
filters:
filepath.regex:
- <<regex1>>
- <<regex2>>
- 'edition-(?i)\b<<search>>\b' # New TRaSH naming
- '(?<=[0-9]{4}[)}>\]]\s)\b<<search>>\b' # Original TRaSH naming
overlays:
Directors-Cut:
template: {name: Edition, weight: 150, slug: directorscut, search: (Director|Directors), dovetail: false}
Directors-Cut-Dovetail:
template: {name: Edition, weight: 150, slug: directorscut, search: (Director|Directors), dovetail: true}
Extended-Edition:
template: {name: Edition, weight: 140, slug: extended, search: Extended, dovetail: false}
Extended-Edition-Dovetail:
template: {name: Edition, weight: 140, slug: extended, search: Extended, dovetail: true}
Uncut-Edition:
template: {name: Edition, weight: 130, slug: uncut, search: Uncut, dovetail: false}
Uncut-Edition-Dovetail:
template: {name: Edition, weight: 130, slug: uncut, search: Uncut, dovetail: true}
Unrated-Edition:
template: {name: Edition, weight: 120, slug: unrated, search: Unrated, dovetail: false}
Unrated-Edition-Dovetail:
template: {name: Edition, weight: 120, slug: unrated, search: Unrated, dovetail: true}
Special-Edition:
template: {name: Edition, weight: 110, slug: special, search: Special, dovetail: false}
Special-Edition-Dovetail:
template: {name: Edition, weight: 110, slug: special, search: Special, dovetail: true}
Final-Cut:
template: {name: Edition, weight: 100, slug: finalcut, search: Final, dovetail: false}
Final-Cut-Dovetail:
template: {name: Edition, weight: 100, slug: finalcut, search: Final, dovetail: true}
Anniversary-Edition:
template: {name: Edition, weight: 90, slug: anniversary, search: Anniversary, dovetail: false}
Anniversary-Edition-Dovetail:
template: {name: Edition, weight: 90, slug: anniversary, search: Anniversary, dovetail: true}
Collectors-Edition:
template: {name: Edition, weight: 80, slug: collector, search: (Collector|Collectors), dovetail: false}
Collectors-Edition-Dovetail:
template: {name: Edition, weight: 80, slug: collector, search: (Collector|Collectors), dovetail: true}
International-Cut:
template: {name: Edition, weight: 70, slug: international, search: International, dovetail: false}
International-Cut-Dovetail:
template: {name: Edition, weight: 70, slug: international, search: International, dovetail: true}
Theatrical-Cut:
template: {name: Edition, weight: 60, slug: theatrical, search: Theatrical, dovetail: false}
Theatrical-Cut-Dovetail:
template: {name: Edition, weight: 60, slug: theatrical, search: Theatrical, dovetail: true}
Ultimate-Cut:
template: {name: Edition, weight: 50, slug: ultimate, search: Ultimate, dovetail: false}
Ultimate-Cut-Dovetail:
template: {name: Edition, weight: 50, slug: ultimate, search: Ultimate, dovetail: true}
IMAX-E:
template: {name: Edition, weight: 40, slug: enhanced, dovetail: false, regex1: '(?i)\bIMAX Enhanced\b|^(?=.*(DSNP|Disney\+|CORE(?=[ ._-]web[ ._-]?(dl|rip)\b)|\bBC(?=[ ._-]web[ ._-]?(dl|rip)\b)|IMAX[- .]Enhanced)\b)(?=.*\b(IMAX|IMAX[- .]Enhanced)\b).*'}
IMAX-E-Dovetail:
template: {name: Edition, weight: 40, slug: enhanced, dovetail: true, regex1: '(?i)\bIMAX Enhanced\b|^(?=.*(DSNP|Disney\+|CORE(?=[ ._-]web[ ._-]?(dl|rip)\b)|\bBC(?=[ ._-]web[ ._-]?(dl|rip)\b)|IMAX[- .]Enhanced)\b)(?=.*\b(IMAX|IMAX[- .]Enhanced)\b).*'}
IMAX:
template: {name: Edition, weight: 30, slug: imax, dovetail: false, regex1: '(?i)\bIMAX\b'}
IMAX-Dovetail:
template: {name: Edition, weight: 30, slug: imax, dovetail: true, regex1: '(?i)\bIMAX\b'}
Remastered:
template: {name: Edition, weight: 20, slug: remastered, search: (Remaster|Remastered|4k Remaster|4k Remastered), dovetail: false}
Remastered-Dovetail:
template: {name: Edition, weight: 20, slug: remastered, search: (Remaster|Remastered|4k Remaster|4k Remastered), dovetail: true}
Criterion:
template: {name: Edition, weight: 10, slug: criterion, dovetail: false, regex1: '(?i)Criterion', regex2: '(?i)\[CC\]'}
Criterion-Dovetail:
template: {name: Edition, weight: 10, slug: criterion, dovetail: true, regex1: '(?i)Criterion', regex2: '(?i)\[CC\]'}

119
defaults/overlays/status.yml
View file

@ -1,41 +1,29 @@
#############################################################
# Status Overlays #
##############################################################################
# Status Overlay #
# Created by Yozora, Bullmoose20, & Sohjiro #
# Credit to Magic815 for base images #
#############################################################
# Call this from your config.yml (Show): #
# If nothing is specified these are the defaults #
# #
# overlay_path: #
# - pmm: status #
# template_variables: #
# # Set the horizontal offset for the overlay #
# horizontal_offset: 15 #
# # Set the horizontal align for the overlay #
# horizontal_align: left #
# # Set the vertical offset for the overlay #
# vertical_offset: 330 #
# # Set the vertical align for the overlay #
# vertical_align: top #
# # Set the back color for the overlay #
# back_color: "#00000099" #
# # Set the back radius for the overlay #
# back_radius: 30 #
# # Set the back width for the overlay #
# back_width: 305 #
# #
# # Use the ended overlay #
# use_ended: true #
# # Use the airing overlay #
# use_airing: true #
# # Use the canceled overlay #
# use_canceled: true #
# # Number of days since last episode air date #
# last: 14 #
#############################################################
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
# https://metamanager.wiki/en/latest/defaults/overlays/status.html #
##############################################################################
external_templates:
pmm: templates
template_variables:
text_<<key>>: <<text>>
group: status
horizontal_offset: 15
horizontal_align: left
vertical_offset: 330
vertical_align: top
font_size: 50
back_width: 305
back_height: 105
allowed_libraries: show
final_name: text(<<text_<<key>>>>)
templates:
tmdb_status:
status:
optional:
- last
conditionals:
all:
conditions:
@ -45,59 +33,28 @@ templates:
conditions:
- key: [ended, returning, canceled]
value: <<key>>
optional:
- use_<<key>>
- back_width
- last
default:
key: <<tmdb>>
horizontal_offset: 15
horizontal_align: left
vertical_offset: 330
vertical_align: top
font: fonts/Inter-Medium.ttf
font_size: 50
font_color: "#FFFFFF"
back_color: "#00000099"
back_radius: 30
back_width: 305
back_height: 105
weight_<<key>>: <<weight>>
text_<<key>>: <<text>>
all: true
ignore_blank_results: true
allowed_library_types: <<use_<<key>>>>
overlay:
name: text(<<text_<<key>>>>)
group: tmdb_status
weight: <<weight_<<key>>>>
horizontal_offset: <<horizontal_offset>>
horizontal_align: <<horizontal_align>>
vertical_offset: <<vertical_offset>>
vertical_align: <<vertical_align>>
font: <<font>>
font_size: <<font_size>>
font_color: <<font_color>>
back_color: <<back_color>>
back_radius: <<back_radius>>
back_width: <<back_width>>
back_height: <<back_height>>
plex_search:
any:
episode_air_date: <<last>>
plex_all: <<all>>
filters:
tmdb_status: <<tmdb>>
status: <<tmdb>>
overlays:
ended_shows:
template: {name: tmdb_status, key: ended, text: ENDED, weight: 30}
canceled_shows:
template: {name: tmdb_status, key: canceled, text: CANCELED, weight: 40}
returning_shows:
template: {name: tmdb_status, key: returning, text: RETURNING, weight: 50}
airing_shows:
template: {name: tmdb_status, key: airing, last: 14, text: AIRING, weight: 60}
variables: {key: airing, weight: 40, text: AIRING, last: 14}
template: [name: standard, name: status]
returning_shows:
variables: {key: returning, weight: 30, text: RETURNING}
template: [name: standard, name: status]
canceled_shows:
variables: {key: canceled, weight: 20, text: CANCELED}
template: [name: standard, name: status]
ended_shows:
variables: {key: ended, weight: 10, text: ENDED}
template: [name: standard, name: status]

108
defaults/overlays/streaming.yml
View file

@ -1,108 +1,62 @@
#############################################################
##############################################################################
# Streaming Overlay #
# Created by Yozora, Bullmoose20, & Sohjiro #
# Credit to Magic815 for base images #
#############################################################
# Call this from your config.yml (Movie or Show): #
# If nothing is specified these are the defaults #
# #
# overlay_path: #
# - git: PMM/overlays/streaming #
# template_variables: #
# # Set the horizontal offset for the overlay #
# horizontal_offset: 15 #
# # Set the horizontal align for the overlay #
# horizontal_align: left #
# # Set the vertical offset for the overlay #
# vertical_offset: 150 #
# # Set the vertical align for the overlay #
# vertical_align: bottom #
# # Set the back color for the overlay #
# back_color: "#00000099" #
# # Set the back radius for the overlay #
# back_radius: 30 #
# # Set the back width for the overlay #
# back_width: 305 #
# # Set the back height for the overlay #
# back_height: 105 #
# #
# # Use the Amazon overlay #
# use_amazon: true #
# # Use the AppleTV overlay #
# use_appletv: true #
# # Use the Disney overlay #
# use_disney: true #
# # Use the HBO-Max overlay #
# use_hbomax: true #
# # Use the Hulu overlay #
# use_hulu: true #
# # Use the Netflix overlay #
# use_netflix: true #
# # Use the Paramount overlay #
# use_paramount: true #
# # Use the Peacock overlay #
# use_peacock: true #
# # Use the YouTube overlay #
# use_youtube: true #
#############################################################
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
# https://metamanager.wiki/en/latest/defaults/overlays/streaming.html #
##############################################################################
templates:
Streaming:
optional:
- overlay_level
- use_<<slug>>
default:
overlay: <<overlay_name>>
external_templates:
pmm: templates
template_variables:
group: streaming
horizontal_offset: 15
horizontal_align: left
vertical_offset: 150
vertical_align: bottom
back_color: "#00000099"
back_radius: 30
back_width: 305
back_height: 105
allowed_library_types: <<use_<<slug>>>>
ignore_blank_results: true
overlay:
name: <<overlay_name>>
pmm: streaming/<<overlay>>
group: streaming
weight: <<weight>>
horizontal_offset: <<horizontal_offset>>
horizontal_align: <<horizontal_align>>
vertical_offset: <<vertical_offset>>
vertical_align: <<vertical_align>>
back_color: <<back_color>>
back_radius: <<back_radius>>
back_width: <<back_width>>
back_height: <<back_height>>
mdblist_list: https://mdblist.com/lists/plexmetamanager/<<slug>>-<<library_type>>s
templates:
streaming:
ignore_blank_results: true
mdblist_list: https://mdblist.com/lists/plexmetamanager/<<key>>-<<library_type>>s
overlays:
Netflix:
template: {name: Streaming, weight: 200, slug: netflix}
variables: {key: netflix, weight: 90}
template: [name: standard, name: streaming]
Prime:
template: {name: Streaming, weight: 190, slug: amazon}
variables: {key: amazon, weight: 80}
template: [name: standard, name: streaming]
Disney:
template: {name: Streaming, weight: 180, slug: disney}
variables: {key: disney, weight: 70}
template: [name: standard, name: streaming]
HBO-Max:
template: {name: Streaming, weight: 170, slug: hbomax}
variables: {key: hbomax, weight: 60}
template: [name: standard, name: streaming]
YouTube:
template: {name: Streaming, weight: 160, slug: youtube}
variables: {key: youtube, weight: 50}
template: [name: standard, name: streaming]
Hulu:
template: {name: Streaming, weight: 150, slug: hulu}
variables: {key: hulu, weight: 40}
template: [name: standard, name: streaming]
Paramount:
template: {name: Streaming, weight: 140, slug: paramount}
variables: {key: paramount, weight: 30}
template: [name: standard, name: streaming]
AppleTV:
template: {name: Streaming, weight: 130, slug: appletv}
variables: {key: appletv, weight: 20}
template: [name: standard, name: streaming]
Peacock:
template: {name: Streaming, weight: 120, slug: peacock}
variables: {key: peacock, weight: 10}
template: [name: standard, name: streaming]

76
defaults/overlays/templates.yml Normal file
View file

@ -0,0 +1,76 @@
templates:
standard:
default:
horizontal_offset: 0
horizontal_align: left
vertical_offset: 0
vertical_align: top
font: fonts/Inter-Medium.ttf
font_size: 55
font_color: "#FFFFFF"
back_color: "#00000099"
back_radius: 30
weight_<<key>>: <<weight>>
final_name: <<overlay_name>>
optional:
- overlay_level
- use_<<key>>
- use_<<alt>>
- allowed_libraries
- suppress_overlays
- file
- url
- git
- repo
- pmm
- group
- queue
- weight
- font_style
- stroke_width
- stroke_color
- back_width
- back_height
- back_align
- back_padding
- back_line_color
- back_line_width
- addon_offset
- addon_position
overlay_level: <<overlay_level>>
allowed_library_types:
- <<use_<<key>>>>
- <<use_<<alt>>>>
- <<allowed_libraries>>
suppress_overlays: <<suppress_overlays>>
overlay:
name: <<final_name>>
file: <<file>>
url: <<url>>
git: <<git>>
repo: <<repo>>
pmm: <<pmm>>
group: <<group>>
queue: <<queue>>
weight: <<weight_<<key>>>>
horizontal_offset: <<horizontal_offset>>
horizontal_align: <<horizontal_align>>
vertical_offset: <<vertical_offset>>
vertical_align: <<vertical_align>>
font: <<font>>
font_style: <<font_style>>
font_size: <<font_size>>
font_color: <<font_color>>
stroke_width: <<stroke_width>>
stroke_color: <<stroke_color>>
back_color: <<back_color>>
back_width: <<back_width>>
back_height: <<back_height>>
back_align: <<back_align>>
back_padding: <<back_padding>>
back_radius: <<back_radius>>
back_line_color: <<back_line_color>>
back_line_width: <<back_line_width>>
addon_offset: <<addon_offset>>
addon_position: <<addon_position>>

71
defaults/overlays/versions.yml
View file

@ -1,34 +1,25 @@
#############################################################
##############################################################################
# Versions Overlay #
# Created by Yozora, Bullmoose20, & Sohjiro #
# Credit to Magic815 for base images #
#############################################################
# Call this from your config.yml (Movie or Show): #
# overlay_path: #
# - git: PMM/overlays/versions #
# template_variables: #
# # Set episode or season or show to overlay #
# overlay_level: #
# # Set the horizontal offset for the overlay #
# horizontal_offset: 15 #
# # Set the horizontal align for the overlay #
# horizontal_align: right #
# # Set the vertical offset for the overlay #
# vertical_offset: 150 #
# # Set the vertical align for the overlay #
# vertical_align: top #
# # Set the back color for the overlay #
# back_color: "#00000099" #
# # Set the back radius for the overlay #
# back_radius: 30 #
# # Set the back width for the overlay #
# back_width: 105 #
# # Set the back height for the overlay #
# back_height: 105 #
#############################################################
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
# https://metamanager.wiki/en/latest/defaults/overlays/versions.html #
##############################################################################
external_templates:
pmm: templates
template_variables:
group: streaming
horizontal_offset: 15
horizontal_align: right
vertical_offset: 150
vertical_align: top
back_width: 105
back_height: 105
pmm: <<overlay_name>>
templates:
Versions:
versions:
conditionals:
version_style:
default: "duplicate"
@ -38,32 +29,8 @@ templates:
plex_search:
all:
<<version_style>>: true
optional:
- overlay_level
default:
horizontal_offset: 15
horizontal_align: right
vertical_offset: 150
vertical_align: top
back_color: "#00000099"
back_radius: 30
back_width: 105
back_height: 105
overlay_level: <<overlay_level>>
ignore_blank_results: true
overlay:
name: versions
horizontal_offset: <<horizontal_offset>>
horizontal_align: <<horizontal_align>>
vertical_offset: <<vertical_offset>>
vertical_align: <<vertical_align>>
back_color: <<back_color>>
back_radius: <<back_radius>>
back_width: <<back_width>>
back_height: <<back_height>>
pmm: versions
overlays:
Duplicate Versions:
template:
- name: Versions
versions:
template: [name: standard, name: versions]

126
defaults/overlays/video_format.yml
View file

@ -1,92 +1,42 @@
#############################################################
# Video Format Overlays #
##############################################################################
# Video Format Overlay #
# Created by Yozora, Bullmoose20, & Sohjiro #
# Credit to Magic815 for base images #
#############################################################
# Designed for TRaSH Guides filename naming scheme #
# https://trash-guides.info/ #
# #
# Call this from your config.yml (Movie or Show): #
# If nothing is specified these are the defaults #
# #
# overlay_path: #
# - git: PMM/overlays/video_format #
# template_variables: #
# # Set episode or season to overlay #
# overlay_level: #
# # Set the horizontal offset for the overlay #
# horizontal_offset: 15 #
# # Set the horizontal align for the overlay #
# horizontal_align: left #
# # Set the vertical offset for the overlay #
# vertical_offset: 30 #
# # Set the vertical align for the overlay #
# vertical_align: bottom #
# # Set the font for the overlay #
# font: fonts/Inter-Medium.ttf #
# # Set the font size for the overlay #
# font_size: 55 #
# # Set the font color for the overlay #
# font_color: "#FFFFFF" #
# # Set the back color for the overlay #
# back_color: "#00000099" #
# # Set the back radius for the overlay #
# back_radius: 30 #
# # Set the back width for the overlay #
# back_width: 305 #
# # Set the back height for the overlay #
# back_height: 105 #
# #
# # Use the Remux overlay #
# use_remux: true #
# # Use the Blu-Ray overlay #
# use_bluray: true #
# # Use the WEB overlay #
# use_web: true #
# # Use the HDTV overlay #
# use_hdtv: true #
# # Use the DVD overlay #
# use_dvd: true #
# # Use the SDTV overlay #
# use_sdtv: true #
#############################################################
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
# https://metamanager.wiki/en/latest/defaults/overlays/video_format.html #
##############################################################################
templates:
VideoFormat:
optional:
- overlay_level
- use_<<slug>>
default:
overlay: <<overlay_name>>
external_templates:
pmm: templates
template_variables:
text_<<key>>: <<overlay_name>>
group: quality
horizontal_offset: 15
horizontal_align: left
vertical_offset: 30
vertical_align: bottom
font: fonts/Inter-Medium.ttf
font_size: 55
font_color: "#FFFFFF"
back_color: "#00000099"
back_radius: 30
back_width: 305
back_height: 105
overlay_level: <<overlay_level>>
allowed_library_types: <<use_<<slug>>>>
final_name: text(<<text_<<key>>>>)
templates:
video_format:
conditionals:
filepath:
conditions:
- key: remux
value: '(?i)\[Remux'
- key: bluray
value: '(?i)\[Blu[ ._-]?ray|\[BD|\[BR|\[HD[ ._-]?DVD'
- key: web
value: '(?i)Web[ ._-]?(dl|rip)'
- key: hdtv
value: '(?i)HD[ ._-]?TV'
- key: dvd
value: '(?i)\[DVD'
- key: sdtv
value: '(?i)SD[ ._-]?TV'
ignore_blank_results: true
overlay:
name: text(<<overlay_name>>)
group: quality
weight: <<weight>>
horizontal_offset: <<horizontal_offset>>
horizontal_align: <<horizontal_align>>
vertical_offset: <<vertical_offset>>
vertical_align: <<vertical_align>>
font: <<font>>
font_size: <<font_size>>
font_color: <<font_color>>
back_color: <<back_color>>
back_radius: <<back_radius>>
back_width: <<back_width>>
back_height: <<back_height>>
plex_all: true
filters:
filepath.regex: <<filepath>>
@ -94,19 +44,25 @@ templates:
overlays:
REMUX:
template: {name: VideoFormat, weight: 50, slug: remux, filepath: '(?i)\[Remux'}
variables: {key: remux, weight: 60}
template: [name: standard, name: video_format]
BLU-RAY:
template: {name: VideoFormat, weight: 40, slug: bluray, filepath: '(?i)\[Blu[ ._-]?ray|\[BD|\[BR|\[HD[ ._-]?DVD'}
variables: {key: bluray, weight: 50}
template: [name: standard, name: video_format]
WEB:
template: {name: VideoFormat, weight: 30, slug: web, filepath: '(?i)Web[ ._-]?(dl|rip)'}
variables: {key: web, weight: 40}
template: [name: standard, name: video_format]
HDTV:
template: {name: VideoFormat, weight: 20, slug: hdtv, filepath: '(?i)HD[ ._-]?TV'}
variables: {key: hdtv, weight: 30}
template: [name: standard, name: video_format]
DVD:
template: {name: VideoFormat, weight: 10, slug: dvd, filepath: '(?i)\[DVD'}
variables: {key: dvd, weight: 20}
template: [name: standard, name: video_format]
SDTV:
template: {name: VideoFormat, weight: 5, slug: sdtv, filepath: '(?i)SD[ ._-]?TV'}
variables: {key: sdtv, weight: 10}
template: [name: standard, name: video_format]

17
docs/_templates/navbar.html vendored
View file

@ -32,11 +32,24 @@
<li class="divider"></li>
{% elif sublink[0] == "_menu" %}
<li class="dropdown-submenu">
<a tabindex="-1" href="#">{{ sublink[1] }}</a>
<a tabindex="-1" href="{{ sublink[2] }}">{{ sublink[1] }}</a>
<ul class="dropdown-menu">
{%- for subsublink in sublink[2] %}
{%- for subsublink in sublink[3] %}
{% if subsublink[0] == "_divider" %}
<li class="divider"></li>
{% elif subsublink[0] == "_menu" %}
<li class="dropdown-submenu">
<a tabindex="-1" href="{{ subsublink[2] }}">{{ subsublink[1] }}</a>
<ul class="dropdown-menu">
{%- for subsubsublink in subsublink[3] %}
{% if subsubsublink[0] == "_divider" %}
<li class="divider"></li>
{% else %}
<li><a href="{{ pathto(*subsubsublink[1:]) }}">{{ subsubsublink[0] }}</a></li>
{% endif %}
{%- endfor %}
</ul>
</li>
{% else %}
<li><a href="{{ pathto(*subsublink[1:]) }}">{{ subsublink[0] }}</a></li>
{% endif %}

305
docs/conf.py
View file

@ -119,27 +119,22 @@ html_theme_options = {
("_menu", "Essentials", [
("Plex Meta Manager", "index"),
("_divider", ),
("_menu", "Installation", [
("_menu", "Installation", "home/installation", [
("Installing Plex Meta Manager", "home/installation"),
("_divider", ),
("Local Walkthrough", "home/guides/local"),
("Docker Walkthrough", "home/guides/docker"),
("QNAP Walkthrough", "home/guides/qnap"),
("Synology Walkthrough", "home/guides/synology"),
("_divider", ),
("unRAID Walkthrough", "home/guides/unraid"),
("Kubernetes Walkthrough", "home/guides/kubernetes"),
("Docker images", "home/guides/alternative-docker"),
("QNAP Walkthrough", "home/guides/qnap"),
("Synology Walkthrough", "home/guides/synology"),
]),
("Docker Images", "home/guides/alternative-docker"),
("Log Files", "home/logs"),
("Run Commands & Environment Variables", "home/environmental"),
("Knowledgebase/FAQ", "home/kb"),
("_divider", ),
("Configuration File", "config/configuration"),
("Log Files", "home/logs"),
("Metadata Files", "metadata/metadata"),
("Overlay Files", "metadata/overlay"),
("Playlist Files", "metadata/playlist"),
("_divider", ),
("Default Metadata & Overlays Files", "home/guides/defaults"),
("Scheduling Guide", "home/guides/scheduling"),
("Image Asset Directory Guide", "home/guides/assets"),
("Formula 1 Metadata Guide", "home/guides/formula"),
@ -156,6 +151,29 @@ html_theme_options = {
("Libraries/Playlists", "config/libraries"),
("Path Types", "config/paths"),
("Operations", "config/operations"),
("_menu", "Operations", "config/operations", [
("Assets For All", "config/operations.html#assets-for-all"),
("Delete Collections With Less", "config/operations.html#delete-collections-with-less"),
("Delete Unmanaged Collections", "config/operations.html#delete-unmanaged-collections"),
("Mass Genre Update", "config/operations.html#mass-genre-update"),
("Mass Content Rating Update", "config/operations.html#mass-content-rating-update"),
("Mass Original Title Update", "config/operations.html#mass-original-title-update"),
("Mass Originally Available Update", "config/operations.html#mass-originally-available-update"),
("Mass * Rating Update", "config/operations.html#mass--rating-update"),
("Mass Episode * Rating Update", "config/operations.html#mass-episode--rating-update"),
("Mass IMDb Parental Labels", "config/operations.html#mass-imdb-parental-labels"),
("Mass Collection Mode", "config/operations.html#mass-collection-mode"),
("Update Blank Track Titles", "config/operations.html#update-blank-track-titles"),
("Remove Title Parentheses", "config/operations.html#remove-title-parentheses"),
("Split Duplicates", "config/operations.html#split-duplicates"),
("Radarr Add All", "config/operations.html#radarr-add-all"),
("Radarr Remove By Tag", "config/operations.html#radarr-remove-by-tag"),
("Sonarr Add All", "config/operations.html#sonarr-add-all"),
("Sonarr Remove By Tag", "config/operations.html#sonarr-remove-by-tag"),
("Genre Mapper", "config/operations.html#genre-mapper"),
("Content Rating Mapper", "config/operations.html#content-rating-mapper"),
("Metadata Backup", "config/operations.html#metadata-backup"),
]),
("Settings", "config/settings"),
("Webhooks", "config/webhooks"),
("_divider", ),
@ -173,13 +191,17 @@ html_theme_options = {
("Notifiarr", "config/notifiarr"),
]),
("_menu", "Defaults", [
("PMM Defaults", "defaults/readme"),
("PMM Files", "defaults/files"),
("Defaults Usage Guide", "defaults/guide"),
("Defaults Files", "defaults/files"),
("_divider", ),
("_menu", "Collections", "defaults/variables", [
("Collections", "defaults/defaults"),
("Shared Variables", "defaults/variables"),
("_divider", ),
("_menu", "Award Collections", [
("Separators", "defaults/separators"),
("_menu", "Award", "#", [
("Awards Separator", "defaults/award/separator"),
("_divider", ),
("_divider",),
("Academy Awards (Oscars)", "defaults/award/oscars"),
("British Academy of Film Awards", "defaults/award/bafta"),
("Cannes File Festival Awards", "defaults/award/cannes"),
@ -190,9 +212,9 @@ html_theme_options = {
("Sundance File Festival Awards", "defaults/award/sundance"),
("Other Awards", "defaults/award/other"),
]),
("_menu", "Chart Collections", [
("_menu", "Chart", "#", [
("Chart Separator", "defaults/chart/separator"),
("_divider", ),
("_divider",),
("Basic Charts", "defaults/chart/basic"),
("AniList Charts", "defaults/chart/anilist"),
("Flixpatrol Charts", "defaults/chart/flixpatrol"),
@ -203,63 +225,65 @@ html_theme_options = {
("Trakt Charts", "defaults/chart/trakt"),
("Other Charts", "defaults/chart/other"),
]),
("_menu", "Movie Collections", [
("Actor Collections", "defaults/both/actor"),
("Audio Language Collections", "defaults/both/audio_language"),
("Content Ratings (US) Collections", "defaults/movie/content_rating_us"),
("Content Ratings (UK) Collections", "defaults/both/content_rating_uk"),
("Country Collections", "defaults/movie/country"),
("Decade Collections", "defaults/movie/decade"),
("Director Collections", "defaults/movie/director"),
("Franchise Collections", "defaults/movie/franchise"),
("Genre Collections", "defaults/both/genre"),
("Producer Collections", "defaults/movie/producer"),
("Resolution Collections", "defaults/both/resolution"),
("Resolution Standards Collections", "defaults/both/resolution_standards"),
("Seasonal Collections", "defaults/movie/seasonal"),
("Streaming Collections", "defaults/both/streaming"),
("Studio Collections", "defaults/both/studio"),
("Subtitle Language Collections", "defaults/both/subtitle_language"),
("Universe Collections", "defaults/movie/universe"),
("Writer Collections", "defaults/movie/writer"),
("Year Collections", "defaults/both/year"),
("_menu", "Movie", "#", [
("Actors", "defaults/both/actor"),
("Audio Languages", "defaults/both/audio_language"),
("Content Ratings (US)", "defaults/movie/content_rating_us"),
("Content Ratings (UK)", "defaults/both/content_rating_uk"),
("Countries", "defaults/movie/country"),
("Decades", "defaults/movie/decade"),
("Directors", "defaults/movie/director"),
("Franchises", "defaults/movie/franchise"),
("Genres", "defaults/both/genre"),
("Producers", "defaults/movie/producer"),
("Resolutions", "defaults/both/resolution"),
("Resolution Standards", "defaults/both/resolution_standards"),
("Seasonal", "defaults/movie/seasonal"),
("Streaming", "defaults/both/streaming"),
("Studios", "defaults/both/studio"),
("Subtitle Languages", "defaults/both/subtitle_language"),
("Universes", "defaults/movie/universe"),
("Writers", "defaults/movie/writer"),
("Years", "defaults/both/year"),
]),
("_menu", "Show", "#", [
("Actors", "defaults/both/actor"),
("Audio Languages", "defaults/both/audio_language"),
("Content Ratings (US)", "defaults/show/content_rating_us"),
("Content Ratings (UK)", "defaults/both/content_rating_uk"),
("Countries", "defaults/show/country"),
("Decades", "defaults/show/decade"),
("Franchises", "defaults/show/franchise"),
("Genres", "defaults/both/genre"),
("Networks", "defaults/show/network"),
("Resolutions", "defaults/both/resolution"),
("Resolution Standards", "defaults/both/resolution_standards"),
("Streaming", "defaults/both/streaming"),
("Studios", "defaults/both/studio"),
("Subtitle Languages", "defaults/both/subtitle_language"),
("Years", "defaults/both/year"),
]),
("_menu", "Show Collections", [
("Actor Collections", "defaults/both/actor"),
("Audio Language Collections", "defaults/both/audio_language"),
("Content Ratings (US) Collections", "defaults/show/content_rating_us"),
("Content Ratings (UK) Collections", "defaults/both/content_rating_uk"),
("Country Collections", "defaults/show/country"),
("Decade Collections", "defaults/show/decade"),
("Franchise Collections", "defaults/show/franchise"),
("Genre Collections", "defaults/both/genre"),
("Network Collections", "defaults/show/network"),
("Resolution Collections", "defaults/both/resolution"),
("Resolution Standards Collections", "defaults/both/resolution_standards"),
("Streaming Collections", "defaults/both/streaming"),
("Studio Collections", "defaults/both/studio"),
("Subtitle Language Collections", "defaults/both/subtitle_language"),
("Year Collections", "defaults/both/year"),
]),
("Playlists", "defaults/playlist"),
("Separators", "defaults/separators"),
("_menu", "Overlays", [
("Default Overlays", "defaults/overlays/readme"),
("Audio Codec Overlay", "defaults/overlays/audio_codec"),
("Audio Languages Overlay", "defaults/overlays/audio_language"),
("Common Sense Age Ratings Overlay", "defaults/overlays/commonsense"),
("Direct Play Only Overlay", "defaults/overlays/direct_play"),
("Edition Overlay", "defaults/overlays/edition"),
("Episode Info Overlay", "defaults/overlays/episode_info"),
("After Credit Overlay", "defaults/overlays/mediastinger"),
("Ratings Overlay", "defaults/overlays/ratings"),
("Resolution Overlay", "defaults/overlays/resolution"),
("Ribbon Overlay", "defaults/overlays/ribbon"),
("Runtimes Overlay", "defaults/overlays/runtimes"),
("Special Release Overlay", "defaults/overlays/special_release"),
("Streaming Overlay", "defaults/overlays/streaming"),
("Versions Overlay", "defaults/overlays/versions"),
("Video Format Overlay", "defaults/overlays/video_format"),
("_menu", "Overlays", "defaults/overlays/defaults", [
("Overlays", "defaults/overlays/defaults"),
("Shared Variables", "defaults/overlays/variables"),
("_divider", ),
("Audio Codec", "defaults/overlays/audio_codec"),
("Audio Languages", "defaults/overlays/audio_language"),
("Common Sense Age Ratings", "defaults/overlays/commonsense"),
("Direct Play Only", "defaults/overlays/direct_play"),
("Edition", "defaults/overlays/edition"),
("Episode Info", "defaults/overlays/episode_info"),
("After Credit", "defaults/overlays/mediastinger"),
("Ratings", "defaults/overlays/ratings"),
("Resolution", "defaults/overlays/resolution"),
("Ribbon", "defaults/overlays/ribbon"),
("Runtimes", "defaults/overlays/runtimes"),
("Special Release", "defaults/overlays/special_release"),
("Streaming", "defaults/overlays/streaming"),
("Versions", "defaults/overlays/versions"),
("Video Format", "defaults/overlays/video_format"),
]),
]),
("_menu", "Files", [
@ -270,32 +294,129 @@ html_theme_options = {
("Templates", "metadata/templates"),
("Filters", "metadata/filters"),
("Dynamic Collections", "metadata/dynamic"),
("_menu", "Editing Media Metadata", [
("_menu", "Editing Media Metadata", "#", [
("Editing Movie Metadata", "metadata/metadata/movie"),
("Editing TV Metadata", "metadata/metadata/show"),
("Editing Music Metadata", "metadata/metadata/music"),
]),
("_menu", "Builders", [
("Plex Builders", "metadata/builders/plex"),
("Smart Builders", "metadata/builders/smart"),
("TMDb Builders", "metadata/builders/tmdb"),
("TVDb Builders", "metadata/builders/tvdb"),
("IMDb Builders", "metadata/builders/imdb"),
("Trakt Builders", "metadata/builders/trakt"),
("Tautulli Builders", "metadata/builders/tautulli"),
("Radarr Builders", "metadata/builders/radarr"),
("Sonarr Builders", "metadata/builders/sonarr"),
("MdbList Builders", "metadata/builders/mdblist"),
("Letterboxd Builders", "metadata/builders/letterboxd"),
("ICheckMovies Builders", "metadata/builders/icheckmovies"),
("FlixPatrol Builders", "metadata/builders/flixpatrol"),
("Reciperr Builders", "metadata/builders/reciperr"),
("StevenLu Builders", "metadata/builders/stevenlu"),
("AniDB Builders", "metadata/builders/anidb"),
("AniList Builders", "metadata/builders/anilist"),
("MyAnimeList Builders", "metadata/builders/myanimelist"),
("_menu", "Builders", "#", [
("_menu", "Plex Builders", "metadata/builders/plex", [
("Plex All", "metadata/builders/plex.html#plex-all"),
("Plex Watchlist", "metadata/builders/plex.html#plex-watchlist"),
("Plex Pilots", "metadata/builders/plex.html#plex-pilots"),
("Plex Collectionless", "metadata/builders/plex.html#plex-collectionless"),
("Plex Search", "metadata/builders/plex.html#plex-search"),
]),
("_menu", "Details", [
("_menu", "Smart Builders", "metadata/builders/smart", [
("Smart Label", "metadata/builders/smart.html#smart-label"),
("Smart Filter", "metadata/builders/smart.html#smart-filter"),
]),
("_menu", "TMDb Builders", "metadata/builders/tmdb", [
("TMDb Collection", "metadata/builders/tmdb.html#tmdb-collection"),
("TMDb List", "metadata/builders/tmdb.html#tmdb-list"),
("TMDb Actor", "metadata/builders/tmdb.html#tmdb-actor"),
("TMDb Crew", "metadata/builders/tmdb.html#tmdb-crew"),
("TMDb Director", "metadata/builders/tmdb.html#tmdb-director"),
("TMDb Producer", "metadata/builders/tmdb.html#tmdb-producer"),
("TMDb Writer", "metadata/builders/tmdb.html#tmdb-writer"),
("TMDb Movie", "metadata/builders/tmdb.html#tmdb-movie"),
("TMDb Show", "metadata/builders/tmdb.html#tmdb-show"),
("TMDb Company", "metadata/builders/tmdb.html#tmdb-company"),
("TMDb Network", "metadata/builders/tmdb.html#tmdb-network"),
("TMDb Keyword", "metadata/builders/tmdb.html#tmdb-keyword"),
("TMDb Popular", "metadata/builders/tmdb.html#tmdb-popular"),
("TMDb Now Playing", "metadata/builders/tmdb.html#tmdb-now-playing"),
("TMDb Top Rated", "metadata/builders/tmdb.html#tmdb-top-rated"),
("TMDb Upcoming", "metadata/builders/tmdb.html#tmdb-upcoming"),
("TMDb Airing Today", "metadata/builders/tmdb.html#tmdb-airing-today"),
("TMDb On the Air", "metadata/builders/tmdb.html#tmdb-on-the-air"),
("TMDb Trending Daily", "metadata/builders/tmdb.html#tmdb-trending-daily"),
("TMDb Trending Weekly", "metadata/builders/tmdb.html#tmdb-trending-weekly"),
("TMDb Discover", "metadata/builders/tmdb.html#tmdb-discover"),
]),
("_menu", "TVDb Builders", "metadata/builders/tvdb", [
("TVDb List", "metadata/builders/tvdb.html#tvdb-list"),
("TVDb Movie", "metadata/builders/tvdb.html#tvdb-movie"),
("TVDb Show", "metadata/builders/tvdb.html#tvdb-show"),
]),
("_menu", "IMDb Builders", "metadata/builders/imdb", [
("IMDb ID", "metadata/builders/imdb.html#imdb-id"),
("IMDb Chart", "metadata/builders/imdb.html#imdb-chart"),
("IMDb List", "metadata/builders/imdb.html#imdb-list"),
("IMDb Watchlist", "metadata/builders/imdb.html#imdb-watchlist"),
]),
("_menu", "Trakt Builders", "metadata/builders/trakt", [
("Trakt List", "metadata/builders/trakt.html#trakt-list"),
("Trakt Chart", "metadata/builders/trakt.html#trakt-chart"),
("Trakt Userlist", "metadata/builders/trakt.html#trakt-userlist"),
("Trakt Recommendations", "metadata/builders/trakt.html#trakt-recommendations"),
("Trakt Box Office", "metadata/builders/trakt.html#trakt-box-office"),
]),
("_menu", "Tautulli Builders", "metadata/builders/tautulli", [
("Tautulli Popular/Watched", "metadata/builders/tautulli.html#tautulli-popular-watched"),
]),
("_menu", "Radarr Builders", "metadata/builders/radarr", [
("Radarr All", "metadata/builders/radarr.html#radarr-all"),
("Radarr Taglist", "metadata/builders/radarr.html#radarr-taglist"),
]),
("_menu", "Sonarr Builders", "metadata/builders/sonarr", [
("Sonarr All", "metadata/builders/sonarr.html#sonarr-all"),
("Sonarr Taglist", "metadata/builders/sonarr.html#sonarr-taglist"),
]),
("_menu", "MdbList Builders", "metadata/builders/mdblist", [
("MdbList List", "metadata/builders/mdblist.html#mdblist-list"),
]),
("_menu", "Letterboxd Builders", "metadata/builders/letterboxd", [
("Letterboxd List", "metadata/builders/letterboxd.html#letterboxd-list"),
]),
("_menu", "ICheckMovies Builders", "metadata/builders/icheckmovies", [
("ICheckMovies List", "metadata/builders/icheckmovies.html#icheckmovies-list"),
]),
("_menu", "FlixPatrol Builders", "metadata/builders/flixpatrol", [
("FlixPatrol Top Platform", "metadata/builders/flixpatrol.html#flixpatrol-top"),
("FlixPatrol Popular", "metadata/builders/flixpatrol.html#flixpatrol-popular"),
("FlixPatrol demographicURLTop Platform", "metadata/builders/flixpatrol.html#flixpatrol-url"),
]),
("_menu", "Reciperr Builders", "metadata/builders/reciperr", [
("Reciperr List", "metadata/builders/reciperr.html#reciperr-list"),
]),
("_menu", "StevenLu Builders", "metadata/builders/stevenlu", [
("StevenLu List", "metadata/builders/stevenlu.html#stevenlu-s-popular-movies-list"),
]),
("_menu", "AniDB Builders", "metadata/builders/anidb", [
("AniDB ID", "metadata/builders/anidb.html#anidb-id"),
("AniDB Relation", "metadata/builders/anidb.html#anidb-relation"),
("AniDB Popular", "metadata/builders/anidb.html#anidb-popular"),
("AniDB Tag", "metadata/builders/anidb.html#anidb-tag"),
]),
("_menu", "AniList Builders", "metadata/builders/anilist", [
("AniList Top Rated", "metadata/builders/anilist.html#anilist-top-rated"),
("AniList Anilist Popular", "metadata/builders/anilist.html#anilist-anilist-popular"),
("AniList Trending", "metadata/builders/anilist.html#anilist-trending"),
("AniList Relations", "metadata/builders/anilist.html#anilist-relations"),
("AniList Studio", "metadata/builders/anilist.html#anilist-studio"),
("AniList ID", "metadata/builders/anilist.html#anilist-id"),
("AniList UserList", "metadata/builders/anilist.html#anilist-userlist"),
("AniList Search", "metadata/builders/anilist.html#anilist-search"),
]),
("_menu", "MyAnimeList Builders", "metadata/builders/myanimelist", [
("MyAnimeList Search", "metadata/builders/myanimelist.html#myanimelist-search"),
("MyAnimeList Top All", "metadata/builders/myanimelist.html#myanimelist-top-all"),
("MyAnimeList Top Airing", "metadata/builders/myanimelist.html#myanimelist-top-airing"),
("MyAnimeList Top Upcoming", "metadata/builders/myanimelist.html#myanimelist-top-upcoming"),
("MyAnimeList Top TV Series", "metadata/builders/myanimelist.html#myanimelist-top-tv-series"),
("MyAnimeList Top Movies", "metadata/builders/myanimelist.html#myanimelist-top-movies"),
("MyAnimeList Top OVA Series", "metadata/builders/myanimelist.html#myanimelist-top-ova-series"),
("MyAnimeList Top Specials", "metadata/builders/myanimelist.html#myanimelist-top-specials"),
("MyAnimeList Most Popular", "metadata/builders/myanimelist.html#myanimelist-most-popular"),
("MyAnimeList Most Favorited", "metadata/builders/myanimelist.html#myanimelist-most-favorited"),
("MyAnimeList Suggested", "metadata/builders/myanimelist.html#myanimelist-suggested"),
("MyAnimeList ID", "metadata/builders/myanimelist.html#myanimelist-id"),
("MyAnimeList UserList", "metadata/builders/myanimelist.html#myanimelist-userlist"),
("MyAnimeList Seasonal", "metadata/builders/myanimelist.html#myanimelist-seasonal"),
]),
]),
("_menu", "Details", "#", [
("Setting Details", "metadata/details/setting"),
("Schedule Details", "metadata/details/schedule"),
("Metadata Details", "metadata/details/metadata"),

300
docs/config/operations.md
View file

@ -17,34 +17,264 @@ libraries:
The available attributes for the operations attribute are as follows
| Attribute | Description |
|:--------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `assets_for_all` | Search in assets for images for every item in your library.<br>**Values:** `true` or `false` |
| `delete_collections_with_less` | Deletes every collection with less than the given number of items.<br>**Values:** number greater than 0 |
| `delete_unmanaged_collections` | Deletes every unmanaged collection<br>**Values:** `true` or `false` |
| `mass_genre_update` | Updates every item's genres in the library to the chosen site's genres<br>**Values:** <table class="clearTable"><tr><td>`tmdb`</td><td>Use TMDb for Genres</td></tr><tr><td>`tvdb`</td><td>Use TVDb for Genres</td></tr><tr><td>`imdb`</td><td>Use IMDb for Genres</td></tr><tr><td>`omdb`</td><td>Use IMDb through OMDb for Genres</td></tr><tr><td>`anidb`</td><td>Use AniDB Tags for Genres</td></tr><tr><td>`mal`</td><td>Use MyAnimeList for Genres</td></tr><tr><td>`lock`</td><td>Lock Genre Field</td></tr><tr><td>`unlock`</td><td>Unlock Genre Field</td></tr><tr><td>`remove`</td><td>Remove all Genres and Lock Field</td></tr><tr><td>`reset`</td><td>Remove all Genres and Unlock Field</td></tr></table> |
| `mass_content_rating_update` | Updates every item's content rating in the library to the chosen site's content rating<br>**Values:** <table class="clearTable"><tr><td>`mdb`</td><td>Use MdbList for Content Ratings</td></tr><tr><td>`mdb_commonsense`</td><td>Use Commonsense Rating through MDbList for Content Ratings</td></tr><tr><td>`mdb_commonsense0`</td><td>Use Commonsense Rating with Zero Padding through MDbList for Content Ratings</td></tr><tr><td>`omdb`</td><td>Use IMDb through OMDb for Content Ratings</td></tr><tr><td>`mal`</td><td>Use MyAnimeList for Content Ratings</td></tr><tr><td>`lock`</td><td>Lock Content Rating Field</td></tr><tr><td>`unlock`</td><td>Unlock Content Rating Field</td></tr><tr><td>`remove`</td><td>Remove Content Rating and Lock Field</td></tr><tr><td>`reset`</td><td>Remove Content Rating and Unlock Field</td></tr></table> |
| `mass_original_title_update` | Updates every item's original title in the library to the chosen site's content rating<br>**Values:** <table class="clearTable"><tr><td>`anidb`</td><td>Use AniDB Main Title for Original Titles</td></tr><tr><td>`anidb_official`</td><td>Use AniDB Official Title based on the language attribute in the config file for Original Titles</td></tr><tr><td>`mal`</td><td>Use MyAnimeList Main Title for Original Titles</td></tr><tr><td>`mal_english`</td><td>Use MyAnimeList English Title for Original Titles</td></tr><tr><td>`mal_japanese`</td><td>Use MyAnimeList Japanese Title for Original Titles</td></tr><tr><td>`lock`</td><td>Lock Original Title Field</td></tr><tr><td>`unlock`</td><td>Unlock Original Title Field</td></tr><tr><td>`remove`</td><td>Remove Original Title and Lock Field</td></tr><tr><td>`reset`</td><td>Remove Original Title and Unlock Field</td></tr></table> |
| `mass_originally_available_update` | Updates every item's originally available date in the library to the chosen site's date<br>**Values:** <table class="clearTable"><tr><td>`tmdb`</td><td>Use TMDb Release Date</td></tr><tr><td>`tvdb`</td><td>Use TVDb Release Date</td></tr><tr><td>`omdb`</td><td>Use IMDb Release Date through OMDb</td></tr><tr><td>`mdb`</td><td>Use MdbList Release Date</td></tr><tr><td>`anidb`</td><td>Use AniDB Release Date</td></tr><tr><td>`mal`</td><td>Use MyAnimeList Release Date</td></tr><tr><td>`lock`</td><td>Lock Originally Available Field</td></tr><tr><td>`unlock`</td><td>Unlock Originally Available Field</td></tr><tr><td>`remove`</td><td>Remove Originally Available and Lock Field</td></tr><tr><td>`reset`</td><td>Remove Originally Available and Unlock Field</td></tr></table> |
| `mass_audience_rating_update`/<br>`mass_critic_rating_update`/<br>`mass_user_rating_update` | Updates every item's audience/critic/user rating in the library to the chosen site's rating<br>**Values:** <table class="clearTable"><tr><td>`tmdb`</td><td>Use TMDb Rating</td></tr><tr><td>`imdb`</td><td>Use IMDb Rating</td></tr><tr><td>`trakt_user`</td><td>Use Trakt User's Personal Rating</td></tr><tr><td>`omdb`</td><td>Use IMDbRating through OMDb</td></tr><tr><td>`mdb`</td><td>Use MdbList Score</td></tr><tr><td>`mdb_imdb`</td><td>Use IMDb Rating through MDbList</td></tr><tr><td>`mdb_metacritic`</td><td>Use Metacritic Rating through MDbList</td></tr><tr><td>`mdb_metacriticuser`</td><td>Use Metacritic User Rating through MDbList</td></tr><tr><td>`mdb_trakt`</td><td>Use Trakt Rating through MDbList</td></tr><tr><td>`mdb_tomatoes`</td><td>Use Rotten Tomatoes Rating through MDbList</td></tr><tr><td>`mdb_tomatoesaudience`</td><td>Use Rotten Tomatoes Audience Rating through MDbList</td></tr><tr><td>`mdb_tmdb`</td><td>Use TMDb Rating through MDbList</td></tr><tr><td>`mdb_letterboxd`</td><td>Use Letterboxd Rating through MDbList</td></tr><tr><td>`mdb_myanimelist`</td><td>Use MyAnimeList Rating through MDbList</td></tr><tr><td>`anidb_rating`</td><td>Use AniDB Rating</td></tr><tr><td>`anidb_average`</td><td>Use AniDB Average</td></tr><tr><td>`anidb_score`</td><td>Use AniDB Review Score</td></tr><tr><td>`mal`</td><td>Use MyAnimeList Score</td></tr><tr><td>`lock`</td><td>Lock Rating Field</td></tr><tr><td>`unlock`</td><td>Unlock Rating Field</td></tr><tr><td>`remove`</td><td>Remove Rating and Lock Field</td></tr><tr><td>`reset`</td><td>Remove Rating and Unlock Field</td></tr></table> |
| `mass_episode_audience_rating_update`/<br>`mass_episode_critic_rating_update`/<br>`mass_episode_user_rating_update` | Updates every item's episode's audience/critic/user rating in the library to the chosen site's rating<br>**Values:** <table class="clearTable"><tr><td>`tmdb`</td><td>Use TMDb Rating</td></tr><tr><td>`imdb`</td><td>Use IMDb Rating</td></tr><tr><td>`lock`</td><td>Lock Rating Field</td></tr><tr><td>`unlock`</td><td>Unlock Rating Field</td></tr><tr><td>`remove`</td><td>Remove Rating and Lock Field</td></tr><tr><td>`reset`</td><td>Remove Rating and Unlock Field</td></tr></table> |
| `mass_imdb_parental_labels` | Updates every item's labels in the library to match the IMDb Parental Guide<br>**Values** `with_none` or `without_none` |
| `mass_collection_mode` | Updates every Collection in your library to the specified Collection Mode<br>**Values:** `default`: Library default<br>`hide`: Hide Collection<br>`hide_items`: Hide Items in this Collection<br>`show_items`: Show this Collection and its Items<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`hide`</td><td>Hide Collection</td></tr><tr><td>`hide_items`</td><td>Hide Items in this Collection</td></tr><tr><td>`show_items`</td><td>Show this Collection and its Items</td></tr></table> |
| `update_blank_track_titles` | Search though every track in a music library and replace any blank track titles with the tracks sort title<br>**Values:** `true` or `false` |
| `remove_title_parentheses` | Search through every title and remove all ending parentheses in an items title if the title isn not locked.<br>**Values:** `true` or `false` |
| `split_duplicates` | Splits all duplicate movies/shows found in this library<br>**Values:** `true` or `false` |
| `radarr_add_all` | Adds every item in the library to Radarr. The existing paths in plex will be used as the root folder of each item, if the paths in Plex are not the same as your Radarr paths you can use the `plex_path` and `radarr_path` [Radarr](radarr) details to convert the paths.<br>**Values:** `true` or `false` |
| `radarr_remove_by_tag` | Removes every item from Radarr with the Tags given<br>**Values:** List or comma separated string of tags |
| `sonarr_add_all` | Adds every item in the library to Sonarr. The existing paths in plex will be used as the root folder of each item, if the paths in Plex are not the same as your Sonarr paths you can use the `plex_path` and `sonarr_path` [Sonarr](sonarr) details to convert the paths.<br>**Values:** `true` or `false` |
| `sonarr_remove_by_tag` | Removes every item from Sonarr with the Tags given<br>**Values:** List or comma separated string of tags |
| [`genre_mapper`](#genre-mapper) | Allows genres to be changed to other genres or be removed from every item in your library.<br>**Values:** [see below for usage](#genre-mapper) |
| [`content_rating_mapper`](#content-rating-mapper) | Allows content ratings to be changed to other content ratings or be removed from every item in your library.<br>**Values:** [see below for usage](#content-rating-mapper) |
| [`metadata_backup`](#metadata-backup) | Creates/Maintains a PMM [Metadata File](../metadata/metadata) with a full `metadata` mapping based on the library's items locked attributes.<br>**Values:** [see below for usage](#metadata-backup) |
|:----------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------|
| [Assets For All](#assets-for-all) | Search in assets for images for every item in your library. |
| [Delete Collections With Less](#delete-collections-with-less) | Deletes every collection with less than the given number of items. |
| [Delete Unmanaged Collections](#delete-unmanaged-collections) | Deletes every unmanaged collection. |
| [Mass Genre Update](#mass-genre-update) | Updates every item's genres in the library to the chosen site's genres. |
| [Mass Content Rating Update](#mass-content-rating-update) | Updates every item's content rating in the library to the chosen site's content rating. |
| [Mass Original Title Update](#mass-original-title-update) | Updates every item's original title in the library to the chosen site's original title. |
| [Mass Originally Available Update](#mass-originally-available-update) | Updates every item's originally available date in the library to the chosen site's date. |
| [Mass * Rating Update](#mass--rating-update) | Updates every item's audience/critic/user rating in the library to the chosen site's rating. |
| [Mass Episode * Rating Update](#mass-episode--rating-update) | Updates every item's episode's audience/critic/user rating in the library to the chosen site's rating |
| [Mass IMDb Parental Labels](#mass-imdb-parental-labels) | Updates every item's labels in the library to match the IMDb Parental Guide. |
| [Mass Collection Mode](#mass-collection-mode) | Updates every Collection in your library to the specified Collection Mode. |
| [Update Blank Track Titles](#update-blank-track-titles) | Search though every track in a music library and replace any blank track titles with the tracks sort title. |
| [Remove Title Parentheses](#remove-title-parentheses) | Search through every title and remove all ending parentheses in an items title if the title isn not locked. |
| [Split Duplicates](#split-duplicates) | Splits all duplicate movies/shows found in this library. |
| [Radarr Add All](#radarr-add-all) | Adds every item in the library to Radarr. |
| [Radarr Remove By Tag](#radarr-remove-by-tag) | Removes every item from Radarr with the Tags given. |
| [Sonarr Add All](#sonarr-add-all) | Adds every item in the library to Sonarr. |
| [Sonarr Remove By Tag](#sonarr-remove-by-tag) | Removes every item from Sonarr with the Tags given. |
| [Genre Mapper](#genre-mapper) | Allows genres to be changed to other genres or be removed from every item in your library. |
| [Content Rating Mapper](#content-rating-mapper) | Allows content ratings to be changed to other content ratings or be removed from every item in your library. |
| [Metadata Backup](#metadata-backup) | Creates/Maintains a PMM [Metadata File](../metadata/metadata) with a full `metadata` mapping based on the library's items locked attributes. |
## Assets For All
Search in assets for images for every item in your library.
**Attribute:** `assets_for_all`
**Values:** `true` or `false`
## Delete Collections With Less
Deletes every collection with less than the given number of items.
**Attribute:** `delete_collections_with_less`
**Values:** number greater than 0
## Delete Unmanaged Collections
Deletes every collection that doesn't have the PMM label.
**Attribute:** `delete_unmanaged_collections`
**Values:** `true` or `false`
## Mass Genre Update
Updates every item's genres in the library to the chosen site's genres.
**Attribute:** `mass_genre_update`
**Values:**
| Value | Description |
|:---------|:-----------------------------------|
| `tmdb` | Use TMDb for Genres |
| `tvdb` | Use TVDb for Genres |
| `imdb` | Use IMDb for Genres |
| `omdb` | Use IMDb through OMDb for Genres |
| `anidb` | Use AniDB Tags for Genres |
| `mal` | Use MyAnimeList for Genres |
| `lock` | Lock Genre Field |
| `unlock` | Unlock Genre Field |
| `remove` | Remove all Genres and Lock Field |
| `reset` | Remove all Genres and Unlock Field |
## Mass Content Rating Update
Updates every item's content rating in the library to the chosen site's content rating.
**Attribute:** `mass_content_rating_update`
**Values:**
| Value | Description |
|:-------------------|:-----------------------------------------------------------------------------|
| `mdb` | Use MdbList for Content Ratings |
| `mdb_commonsense` | Use Commonsense Rating through MDbList for Content Ratings |
| `mdb_commonsense0` | Use Commonsense Rating with Zero Padding through MDbList for Content Ratings |
| `omdb` | Use IMDb through OMDb for Content Ratings |
| `mal` | Use MyAnimeList for Content Ratings |
| `lock` | Lock Content Rating Field |
| `unlock` | Unlock Content Rating Field |
| `remove` | Remove Content Rating and Lock Field |
| `reset` | Remove Content Rating and Unlock Field |
## Mass Original Title Update
Updates every item's original title in the library to the chosen site's original title.
**Attribute:** `mass_original_title_update`
**Values:**
| Value | Description |
|:-----------------|:------------------------------------------------------------------------------------------------|
| `anidb` | Use AniDB Main Title for Original Titles |
| `anidb_official` | Use AniDB Official Title based on the language attribute in the config file for Original Titles |
| `mal` | Use MyAnimeList Main Title for Original Titles |
| `mal_english` | Use MyAnimeList English Title for Original Titles |
| `mal_japanese` | Use MyAnimeList Japanese Title for Original Titles |
| `lock` | Lock Original Title Field |
| `unlock` | Unlock Original Title Field |
| `remove` | Remove Original Title and Lock Field |
| `reset` | Remove Original Title and Unlock Field |
## Mass Originally Available Update
Updates every item's originally available date in the library to the chosen site's date.
**Attribute:** `mass_original_title_update`
**Values:**
| Value | Description |
|:---------|:---------------------------------------------|
| `tmdb` | Use TMDb Release Date |
| `tvdb` | Use TVDb Release Date |
| `omdb` | Use IMDb Release Date through OMDb |
| `mdb` | Use MdbList Release Date |
| `anidb` | Use AniDB Release Date |
| `mal` | Use MyAnimeList Release Date |
| `lock` | Lock Originally Available Field |
| `unlock` | Unlock Originally Available Field |
| `remove` | Remove Originally Available and Lock Field |
| `reset` | Remove Originally Available and Unlock Field |
## Mass * Rating Update
Updates every item's audience/critic/user rating in the library to the chosen site's rating.
**Attribute:** `mass_audience_rating_update`/`mass_critic_rating_update`/`mass_user_rating_update`
**Values:**
| Value | Description |
|:-----------------------|:----------------------------------------------------|
| `tmdb` | Use TMDb Rating |
| `imdb` | Use IMDb Rating |
| `trakt_user` | Use Trakt User's Personal Rating |
| `omdb` | Use IMDbRating through OMDb |
| `mdb` | Use MdbList Score |
| `mdb_imdb` | Use IMDb Rating through MDbList |
| `mdb_metacritic` | Use Metacritic Rating through MDbList |
| `mdb_metacriticuser` | Use Metacritic User Rating through MDbList |
| `mdb_trakt` | Use Trakt Rating through MDbList |
| `mdb_tomatoes` | Use Rotten Tomatoes Rating through MDbList |
| `mdb_tomatoesaudience` | Use Rotten Tomatoes Audience Rating through MDbList |
| `mdb_tmdb` | Use TMDb Rating through MDbList |
| `mdb_letterboxd` | Use Letterboxd Rating through MDbList |
| `mdb_myanimelist` | Use MyAnimeList Rating through MDbList |
| `anidb_rating` | Use AniDB Rating |
| `anidb_average` | Use AniDB Average |
| `anidb_score` | Use AniDB Review Score |
| `mal` | Use MyAnimeList Score |
| `lock` | Lock Rating Field |
| `unlock` | Unlock Rating Field |
| `remove` | Remove Rating and Lock Field |
| `reset` | Remove Rating and Unlock Field |
## Mass Episode * Rating Update
Updates every item's episode's audience/critic/user rating in the library to the chosen site's rating.
**Attribute:** `mass_episode_audience_rating_update`/`mass_episode_critic_rating_update`/`mass_episode_user_rating_update`
**Values:**
| Value | Description |
|:---------|:-------------------------------|
| `tmdb` | Use TMDb Rating |
| `imdb` | Use IMDb Rating |
| `lock` | Lock Rating Field |
| `unlock` | Unlock Rating Field |
| `remove` | Remove Rating and Lock Field |
| `reset` | Remove Rating and Unlock Field |
## Mass IMDb Parental Labels
Updates every item's labels in the library to match the IMDb Parental Guide
**Attribute:** `mass_imdb_parental_labels`
**Values** `with_none` or `without_none` |
## Mass Collection Mode
Updates every Collection in your library to the specified Collection Mode.
**Attribute:** `mass_collection_mode`
**Values:** `default`: Library default<br>`hide`: Hide Collection<br>`hide_items`: Hide Items in this Collection<br>`show_items`: Show this Collection and its Items<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`hide`</td><td>Hide Collection</td></tr><tr><td>`hide_items`</td><td>Hide Items in this Collection</td></tr><tr><td>`show_items`</td><td>Show this Collection and its Items</td></tr></table> |
## Update Blank Track Titles`
Search though every track in a music library and replace any blank track titles with the tracks sort title.
**Attribute:** `update_blank_track_titles`
**Values:** `true` or `false` |
## Remove Title Parentheses
Search through every title and remove all ending parentheses in an items title if the title isn not locked.
**Attribute:** `remove_title_parentheses`
**Values:** `true` or `false` |
## Split Duplicates
Splits all duplicate movies/shows found in this library.
**Attribute:** `split_duplicates`
**Values:** `true` or `false` |
## Radarr Add All
Adds every item in the library to Radarr. The existing paths in plex will be used as the root folder of each item, if the paths in Plex are not the same as your Radarr paths you can use the `plex_path` and `radarr_path` [Radarr](radarr) details to convert the paths.
**Attribute:** `radarr_add_all`
**Values:** `true` or `false` |
## Radarr Remove By Tag`
Removes every item from Radarr with the Tags given.
**Attribute:** `radarr_remove_by_tag`
**Values:** List or comma separated string of tags |
## Sonarr Add All
Adds every item in the library to Sonarr. The existing paths in plex will be used as the root folder of each item, if the paths in Plex are not the same as your Sonarr paths you can use the `plex_path` and `sonarr_path` [Sonarr](sonarr) details to convert the paths.
**Attribute:** `sonarr_add_all`
**Values:** `true` or `false` |
## Sonarr Remove By Tag
Removes every item from Sonarr with the Tags given.
**Attribute:** `sonarr_remove_by_tag`
**Values:** List or comma separated string of tags |
## Genre Mapper
You can use the `genre_mapper` operation to map genres in your library.
Maps genres in your library to be changed to other genres.
Each attribute under `genre_mapper` is a separate mapping and has two parts.
**Attribute:** `genre_mapper`
**Values:** Each attribute under `genre_mapper` is a separate mapping and has two parts.
* The key (`Action/Adventure, Action & Adventure` in the example below) is what genres you want mapped to the value.
* The value (`Action` in the example below) is what the genres will end up as.
@ -76,9 +306,11 @@ This example will change go through every item in your library and change the ge
## Content Rating Mapper
You can use the `content_rating_mapper` operation to map content ratings in your library.
Maps content ratings in your library to be changed to other content ratings.
Each attribute under `content_rating_mapper` is a separate mapping and has two parts.
**Attribute:** `content_rating_mapper`
**Values:** Each attribute under `content_rating_mapper` is a separate mapping and has two parts.
* The key (`PG`, `PG-13` in the example below) is what content ratings you want mapped to the value.
* The value (`Y-10` in the example below) is what the content ratings will end up as.
@ -114,7 +346,9 @@ Creates/Maintains a Plex Meta Manager [Metadata File](../metadata/metadata) with
If you point to an existing Metadata File then PMM will Sync the changes to the file, so you won't lose non plex changes in the file.
There are a few different options to determine how the `metadata_backup` works.
**Attribute:** `metadata_backup`
**Values:** There are a few different options to determine how the `metadata_backup` works.
| Attribute | Description |
|:--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@ -122,3 +356,15 @@ There are a few different options to determine how the `metadata_backup` works.
| `exclude` | Exclude all listed attributes from being saved in the metadata file<br>**Values:** Comma-separated string or list of attributes |
| `sync_tags` | All Tag Attributes will have the `.sync` option and blank attribute will be added to sync to as well<br>**Default:** `false`<br>**Values:** `true` or `false` |
| `add_blank_entries` | Will add a line for entries that have no metadata changes<br>**Default:** `true`<br>**Values:** `true` or `false` |
**Example:**
```yaml
library:
Movies:
operations:
metadata_backup:
path: config/Movie_Backup.yml
sync_tags: true
add_blank_entries: false
```

2
docs/defaults/award/bafta.md
View file

@ -32,7 +32,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:---------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/award/cannes.md
View file

@ -32,7 +32,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:---------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/award/choice.md
View file

@ -34,7 +34,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:---------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/award/emmy.md
View file

@ -32,7 +32,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:---------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/award/golden.md
View file

@ -33,7 +33,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:---------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/award/oscars.md
View file

@ -31,7 +31,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:---------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/award/other.md
View file

@ -34,7 +34,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/award/separator.md
View file

@ -32,7 +32,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
**[Shared Variables](../variables) are NOT available to this default file.**
**[Shared Collection Variables](../variables) are NOT available to this default file.**
| Variable | Description & Values |
|:-----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/award/spirit.md
View file

@ -31,7 +31,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:---------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/award/sundance.md
View file

@ -32,7 +32,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:---------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/both/actor.md
View file

@ -39,7 +39,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/both/audio_language.md
View file

@ -34,7 +34,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:-------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

4
docs/defaults/both/content_rating_cs.md
View file

@ -4,7 +4,7 @@ The `content_rating_cs` Default Metadata File is used to dynamically create coll
If you do not use the Common Sense-based rating system within Plex, this file will attempt to match the ratings in your library to the respective rating system.
Use the [Library Operation](../../config/operations) `mass_content_rating_update` with either `mdb_commonsense` or `mdb_commonsense0` to update Plex to the Common Sense Rating.
Use the [Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with either `mdb_commonsense` or `mdb_commonsense0` to update Plex to the Common Sense Rating.
**This file works with Movie and TV Libraries.**
@ -38,7 +38,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:-------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/both/content_rating_uk.md
View file

@ -36,7 +36,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:-------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/both/genre.md
View file

@ -35,7 +35,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/both/resolution.md
View file

@ -35,7 +35,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:---------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/both/resolution_standards.md
View file

@ -38,7 +38,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:---------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/both/streaming.md
View file

@ -45,7 +45,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:--------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/both/studio.md
View file

@ -35,7 +35,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:---------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/both/subtitle_language.md
View file

@ -34,7 +34,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:----------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/both/year.md
View file

@ -33,7 +33,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/chart/anilist.md
View file

@ -35,7 +35,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/chart/basic.md
View file

@ -33,7 +33,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:----------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

8
docs/defaults/chart/flixpatrol.md
View file

@ -9,12 +9,12 @@ The `flixpatrol` Default Metadata File is used to create collections based on Fl
## Collections Section 01
| Collection | Key | Description |
|:------------------------------------|:-----------:|:------------------------------------------------------------------------------|
|:---------------------------------|:-----------:|:---------------------------------------------------------------------------|
| `Netflix Top 10 Moves/Shows` | `netflix` | Collection of the Top Movies/Shows on Netflix according to FlixPatrol. |
| `Disney Top 10 Moves/Shows` | `disney` | Collection of the Top Movies/Shows on Disney Plus according to FlixPatrol. |
| `Disney+ Top 10 Moves/Shows` | `disney` | Collection of the Top Movies/Shows on Disney+ according to FlixPatrol. |
| `HBO Top 10 Moves/Shows` | `hbo` | Collection of the Top Movies/Shows on HBO according to FlixPatrol. |
| `Hulu Top 10 Moves/Shows` | `hulu` | Collection of the Top Movies/Shows on Hulu according to FlixPatrol. |
| `Paramount Plus Top 10 Moves/Shows` | `paramount` | Collection of the Top Movies/Shows on Paramount Plus according to FlixPatrol. |
| `Paramount+ Top 10 Moves/Shows` | `paramount` | Collection of the Top Movies/Shows on Paramount+ according to FlixPatrol. |
| `Prime Video Top 10 Moves/Shows` | `prime` | Collection of the Top Movies/Shows on Prime Video according to FlixPatrol. |
## Config
@ -37,7 +37,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:---------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/chart/imdb.md
View file

@ -34,7 +34,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/chart/myanimelist.md
View file

@ -36,7 +36,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/chart/other.md
View file

@ -35,7 +35,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/chart/separator.md
View file

@ -32,7 +32,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
**[Shared Variables](../variables) are NOT available to this default file.**
**[Shared Collection Variables](../variables) are NOT available to this default file.**
| Variable | Description & Values |
|:-----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/chart/tautulli.md
View file

@ -35,7 +35,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/chart/tmdb.md
View file

@ -36,7 +36,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/chart/trakt.md
View file

@ -36,7 +36,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

0
docs/defaults/defaults.md Normal file
View file

140
docs/defaults/files.md
View file

@ -10,54 +10,59 @@ These collections are applied by calling the below paths into the `metadata_path
### Chart Collections
| Source | config.yml entry | Example Collections Created | Works with Movies | Works with Shows |
|:------------|:--------------------|----------------------------------------------|:-----------------:|:----------------:|
| AniList | `anilist` | AniList Popular, AniList Season | &#9989; | &#9989; |
| Basic | `basic` | Newly Released, New Episodes | &#9989; | &#9989; |
| FlixPatrol | `flixpatrol` | Top Disney, Top Hbo, Top Hulu, Top Netflix | &#9989; | &#9989; |
| IMDb | `imdb` | IMDb Popular, IMDb Top 250 | &#9989; | &#9989; |
| MyAnimeList | `myanimelist` | MyAnimeList Popular, MyAnimeList Top Rated | &#9989; | &#9989; |
| Other | `other` | AniDB Popular, Common Sense Selection | &#9989; | &#9989; |
| Tautulli | `tautulli` | Plex Popular, Plex Watched | &#9989; | &#9989; |
| TMDb | `tmdb` | TMDb Popular, TMDb Airing Today | &#9989; | &#9989; |
| Trakt | `trakt` | Trakt Popular, Trakt Trending | &#9989; | &#9989; |
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|:-----------------------------------|:-----------------:|:-------------------------------------------|:-----------------:|:----------------:|
| [Chart Separator](chart/separator) | `separator_chart` | Chart Collections | &#9989; | &#9989; |
| [AniList](chart/anilist) | `anilist` | AniList Popular, AniList Season | &#9989; | &#9989; |
| [Basic](chart/basic) | `basic` | Newly Released, New Episodes | &#9989; | &#9989; |
| [FlixPatrol](chart/flixpatrol) | `flixpatrol` | Top Disney, Top Hbo, Top Hulu, Top Netflix | &#9989; | &#9989; |
| [IMDb](chart/imdb) | `imdb` | IMDb Popular, IMDb Top 250 | &#9989; | &#9989; |
| [MyAnimeList](chart/myanimelist) | `myanimelist` | MyAnimeList Popular, MyAnimeList Top Rated | &#9989; | &#9989; |
| [Other](chart/other) | `other_chart` | AniDB Popular, Common Sense Selection | &#9989; | &#9989; |
| [Tautulli](chart/tautulli) | `tautulli` | Plex Popular, Plex Watched | &#9989; | &#9989; |
| [TMDb](chart/tmdb) | `tmdb` | TMDb Popular, TMDb Airing Today | &#9989; | &#9989; |
| [Trakt](chart/trakt) | `trakt` | Trakt Popular, Trakt Trending | &#9989; | &#9989; |
### Award Collections
| Award Show | config.yml entry | Example Collections Created | Works with Movies | Works with Shows |
|:---------------|:-----------------|----------------------------------|:-----------------:|:----------------:|
| BAFTA | `bafta` | BAFTA Best Films, BAFTA 2021 | &#9989; | &#10060; |
| Cannes | `cannes` | Cannes - Palme d'or, Cannes 2018 | &#9989; | &#10060; |
| Critics Choice | `choice` | Critics Choice Awards 2020 | &#9989; | &#9989; |
| Emmys | `emmy` | Emmys 2021 | &#9989; | &#9989; |
| Golden Globes | `golden` | Best Motion Pictures | &#9989; | &#9989; |
| Oscars | `oscars` | Best Picture Winners | &#9989; | &#9989; |
| Spirit | `spirit` | Independent Spirit Awards 2021 | &#9989; | &#10060; |
| Sundance | `sundance` | Sundance Grand Jury Winners | &#9989; | &#9989; |
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|:-----------------------------------------------------------|:-----------------:|:--------------------------------------------|:-----------------:|:----------------:|
| [Award Separator](award/separator) | `separator_award` | Award Collections | &#9989; | &#9989; |
| [British Academy of Film and Television Arts](award/bafta) | `bafta` | BAFTA Best Films, BAFTA 2021 | &#9989; | &#10060; |
| [Cannes](award/cannes) | `cannes` | Cannes - Palme d'or, Cannes 2018 | &#9989; | &#10060; |
| [Critics Choice](award/choice) | `choice` | Critics Choice Awards 2020 | &#9989; | &#9989; |
| [Emmys](award/emmy) | `emmy` | Emmys 2021 | &#9989; | &#9989; |
| [Golden Globes](award/golden) | `golden` | Best Motion Pictures | &#9989; | &#9989; |
| [Academy Awards (Oscars)](award/oscars) | `oscars` | Best Picture Winners | &#9989; | &#9989; |
| [Independent Spirit](award/spirit) | `spirit` | Independent Spirit Awards 2021 | &#9989; | &#10060; |
| [Sundance](award/sundance) | `sundance` | Sundance Grand Jury Winners | &#9989; | &#9989; |
| [Other](award/other) | `other_award` | Berlinale Golden Bears, Venice Golden Lions | &#9989; | &#10060; |
### General Collections
| Theme | config.yml entry | Example Collections Created | Works with Movies | Works with Shows |
|:--------------------|:---------------------------------------|:-------------------------------------------------------|:-----------------:|:----------------:|
| Actor | `actor` | Chris Hemsworth, Margot Robbie | &#9989; | &#9989; |
| Audio Language | `audio_language` | French Audio, Korean Audio | &#9989; | &#9989; |
| Content Rating (UK) | `content_rating_uk` | U, PG, 12A | &#9989; | &#9989; |
| Content Rating (US) | `content_rating_us` | G, PG, NC-17 | &#9989; | &#9989; |
| Country | `country` | Belgium, India | &#9989; | &#9989; |
| Decade | `decade` | Best of 2012, Best of 2022 | &#9989; | &#9989; |
| Director | `director` | Steven Spielberg (Director), Olivia Wilde (Director) | &#9989; | &#10060; |
| Franchise | `franchise` | Star Wars: Skywalker Saga, Godzilla (Anime) | &#9989; | &#9989; |
| Genre | `genre` | Action, Drama, Science Fiction | &#9989; | &#9989; |
| Network | `network` | Disney Channel, Lifetime | &#10060; | &#9989; |
| Producer | `producer` | James Cameron (Producer), Reese Witherspoon (Producer) | &#9989; | &#10060; |
| Resolution | `resolution` OR `resolution_standards` | 4K, 1080 OR Ultra HD, Full HD | &#9989; | &#9989; |
| Seasonal | `seasonal` | Easter, Christmas | &#9989; | &#10060; |
| Streaming | `streaming` | Disney+ Movies, HBO Max Shows | &#9989; | &#9989; |
| Studio | `studio` | DreamWorks Studios, Walt Disney Pictures | &#9989; | &#9989; |
| Subtitle Language | `subtitle_language` | German Subtitles, Swedish Subtitles | &#9989; | &#9989; |
| Universe | `universe` | Marvel Cinematic Universal, Wizarding World | &#9989; | &#10060; |
| Year | `year` | Best of 2010, Best of 2019 | &#9989; | &#9989; |
| Writer | `writer` | James Cameron (Writer), Lilly Wachowski (Writer) | &#9989; | &#10060; |
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|:------------------------------------------------------------------------------------|:----------------------:|:-------------------------------------------------------|:-----------------:|:----------------:|
| [Actor](both/actor) | `actor` | Chris Hemsworth, Margot Robbie | &#9989; | &#9989; |
| [Audio Language](both/audio_language) | `audio_language` | French Audio, Korean Audio | &#9989; | &#9989; |
| [Common Sense Content Rating](both/content_rating_cs) | `content_rating_cs` | 1, 2, 3, 4, 5, 6, 15, 16, 17, 18 | &#9989; | &#9989; |
| [Content Rating (UK)](both/content_rating_uk) | `content_rating_uk` | U, PG, 12A | &#9989; | &#9989; |
| Content Rating (US) [Movie](movie/content_rating_us)/[Show](show/content_rating_us) | `content_rating_us` | G, PG, NC-17 | &#9989; | &#9989; |
| Country [Movie](movie/country)/[Show](show/country) | `country` | Belgium, India | &#9989; | &#9989; |
| Decade [Movie](movie/decade)/[Show](show/decade) | `decade` | Best of 2012, Best of 2022 | &#9989; | &#9989; |
| [Director](movie/director) | `director` | Steven Spielberg (Director), Olivia Wilde (Director) | &#9989; | &#10060; |
| Franchise [Movie](movie/franchise)/[Show](show/franchise) | `franchise` | Star Wars: Skywalker Saga, Godzilla (Anime) | &#9989; | &#9989; |
| [Genre](both/genre) | `genre` | Action, Drama, Science Fiction | &#9989; | &#9989; |
| [Network](show/network) | `network` | Disney Channel, Lifetime | &#10060; | &#9989; |
| [Producer](movie/producer) | `producer` | James Cameron (Producer), Reese Witherspoon (Producer) | &#9989; | &#10060; |
| [Resolution](both/resolution) | `resolution` | 4K Movies, 1080p Movies, 720p Movies | &#9989; | &#9989; |
| [Resolution Standards](both/resolution_standards) | `resolution_standards` | 4K, 1080 OR Ultra HD, Full HD | &#9989; | &#9989; |
| [Seasonal](movie/seasonal) | `seasonal` | Easter, Christmas | &#9989; | &#10060; |
| [Streaming](both/streaming) | `streaming` | Disney+ Movies, HBO Max Shows | &#9989; | &#9989; |
| [Studio](both/studio) | `studio` | DreamWorks Studios, Walt Disney Pictures | &#9989; | &#9989; |
| [Subtitle Language](both/subtitle_language) | `subtitle_language` | German Subtitles, Swedish Subtitles | &#9989; | &#9989; |
| [Universe](movie/universe) | `universe` | Marvel Cinematic Universal, Wizarding World | &#9989; | &#10060; |
| [Year](both/year) | `year` | Best of 2010, Best of 2019 | &#9989; | &#9989; |
| [Writer](movie/writer) | `writer` | James Cameron (Writer), Lilly Wachowski (Writer) | &#9989; | &#10060; |
## Overlays
@ -71,24 +76,23 @@ These overlays are applied by calling the below paths into the `overlay_path:` [
### Overlay Files
| Theme | path | Example Overlays | Movies | Shows | Seasons | Episodes |
|:-----------------------|:---------------------------|------------------------------------------------|:--------:|:---------:|:---------:|:--------:|
| Audio Codec | `audio_codec` | Dolby Atmos logo, DTS logo | &#9989; | &#9989; | &#9989; | &#9989; |
| Audio Language | `audio_language` | French Audio, Korean Audio | &#9989; | &#9989; | &#9989; | &#9989; |
| CommonSense Age Rating | `commonsense` | "3+", "16+" | &#9989; | &#9989; | &#10071; | &#10071; |
| Direct Play | `direct_play` | "Direct Play Only" | &#9989; | &#10071; | &#10071; | &#9989; |
| Editions | `editions` | Director's Cut logo, IMAX logo | &#9989; | &#10060; | &#10060; | &#10060; |
| Episode Info | `episode_info` | "S01E01", "S02E09" | &#10060; | &#10060; | &#10060; | &#9989; |
| FlixPatrol | `flixpatrol` | "Streaming service logo with words "TOP" | &#9989; | &#9989; | &#10060; | &#10060; |
| Mediastinger | `mediastinger` | Mediastinger logo | &#9989; | &#9989; | &#10060; | &#10060; |
| Ratings | `ratings` | IMDb Audience Rating, Metacritic Critic Rating | &#9989; | &#9989; | &#10060; | &#9989; |
| Resolution | `resolution` | 4K Dolby Vision logo, 720P logo | &#9989; | &#9989; | &#10060; | &#9989; |
| Ribbon | `ribbon` | IMDb Top 250 Ribbon, RT Fresh Ribbon | &#9989; | &#9989; | &#10060; | &#10060; |
| Runtimes | `runtimes` | "Runtime: 1h 30m" | &#9989; | &#9989; | &#10060; | &#10060; |
| Special Releases | `special_release` | "Director's Cut", "Criterion Collection" | &#9989; | &#9989; | &#10071; | &#10071; |
| Streaming | `streaming` | Netflix logo, Hulu logo | &#9989; | &#9989; | &#10060; | &#10060; |
| Versions | `versions` | Multiple Versions logo | &#9989; | &#9989; | &#9989; | &#9989; |
| Video Format | `video_format` | "REMUX", "HDTV" | &#9989; | &#10071; | &#10071; | &#9989; |
| Default | path | Example Overlays | Movies | Shows | Seasons | Episodes |
|:-----------------------------------------------|:-----------------:|:--------------------------------------------------------------------------|:--------:|:---------:|:---------:|:--------:|
| [Audio Codec](overlays/audio_codec) | `audio_codec` | Dolby Atmos logo, DTS logo | &#9989; | &#9989; | &#9989; | &#9989; |
| [Audio Language](overlays/audio_language) | `audio_language` | French Audio, Korean Audio | &#9989; | &#9989; | &#9989; | &#9989; |
| [CommonSense Age Rating](overlays/commonsense) | `commonsense` | "3+", "16+" | &#9989; | &#9989; | &#10071; | &#10071; |
| [Direct Play](overlays/direct_play) | `direct_play` | "Direct Play Only" | &#9989; | &#10071; | &#10071; | &#9989; |
| [Episode Info](overlays/episode_info) | `episode_info` | "S01E01", "S02E09" | &#10060; | &#10060; | &#10060; | &#9989; |
| [FlixPatrol](overlays/flixpatrol) | `flixpatrol` | "Streaming service logo with words "TOP" | &#9989; | &#9989; | &#10060; | &#10060; |
| [Mediastinger](overlays/mediastinger) | `mediastinger` | Mediastinger Logo for After/During Credit Scenes | &#9989; | &#9989; | &#10060; | &#10060; |
| [Ratings](overlays/ratings) | `ratings` | IMDb Audience Rating, Metacritic Critic Rating | &#9989; | &#9989; | &#10060; | &#9989; |
| [Resolution/Editions](overlays/resolution) | `resolution` | 4K Dolby Vision logo, 720P logo, "Director's Cut", "Criterion Collection" | &#9989; | &#9989; | &#10060; | &#9989; |
| [Ribbon](overlays/ribbon) | `ribbon` | IMDb Top 250 Ribbon, RT Fresh Ribbon | &#9989; | &#9989; | &#10060; | &#10060; |
| [Runtimes](overlays/runtimes) | `runtimes` | "Runtime: 1h 30m" | &#9989; | &#9989; | &#10060; | &#10060; |
| [Status](overlays/status) | `status` | Airing, Returning, Canceled, Ended | &#10060; | &#9989; | &#10060; | &#10060; |
| [Streaming](overlays/streaming) | `streaming` | Netflix logo, Hulu logo | &#9989; | &#9989; | &#10060; | &#10060; |
| [Versions](overlays/versions) | `versions` | Multiple Versions logo | &#9989; | &#9989; | &#9989; | &#9989; |
| [Video Format](overlays/video_format) | `video_format` | "REMUX", "HDTV" | &#9989; | &#10071; | &#10071; | &#9989; |
## Playlists
@ -96,7 +100,17 @@ These files apply playlists to the "Playlists" section of Plex and are applied b
### Playlist Files
| Theme | path | Example Overlays |
|:-----------------------|:-----------|-------------------------------------------------------|
| Playlist | `playlist` | Arrowverse (Timeline Order), Pokémon (Timeline Order) |
| Default | path | Example Overlays |
|:---------------------|:----------:|:-------------------------------------------------------|
| [Playlist](playlist) | `playlist` | Arrowverse (Timeline Order), Pokémon (Timeline Order) |
| greg |
|:--------------------------------------------------------------------------:|
| Video Format Overlay |
| Created by Yozora, Bullmoose20, & Sohjiro |
| EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL |
| https://metamanager.wiki/en/latest/defaults/overlays/ratings.html |
||
##############################################################################

0
docs/defaults/guide.md Normal file
View file

0
docs/home/guides/movie-overlays2-annotated.png → docs/defaults/images/movie-overlays2-annotated.png
View file

Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1.4 MiB

After

Width:  |  Height:  |  Size: 1.4 MiB

2
docs/defaults/movie/content_rating_us.md
View file

@ -33,7 +33,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:-------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/movie/country.md
View file

@ -37,7 +37,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/movie/decade.md
View file

@ -30,7 +30,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/movie/director.md
View file

@ -36,7 +36,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:-------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/movie/franchise.md
View file

@ -31,7 +31,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
**[Shared Variables](../variables) are NOT available to this default file.**
**[Shared Collection Variables](../variables) are NOT available to this default file.**
| Variable | Description & Values |
|:-----------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/movie/producer.md
View file

@ -36,7 +36,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:-------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

2
docs/defaults/movie/seasonal.md
View file

@ -41,7 +41,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:--------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

4
docs/defaults/movie/universe.md
View file

@ -43,7 +43,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@ -99,7 +99,7 @@ data:
```yaml
trakt_list:
star: https://trakt.tv/users/donxy/lists/dc-animated-movie-universe
star: https://trakt.tv/users/zorge88/lists/star-wars
dca: https://trakt.tv/users/donxy/lists/dc-animated-movie-universe
dcu: https://trakt.tv/users/donxy/lists/dc-extended-universe
mcu: https://trakt.tv/users/donxy/lists/marvel-cinematic-universe

2
docs/defaults/movie/writer.md
View file

@ -36,7 +36,7 @@ Template Variables can be used to manipulate the file in various ways to slightl
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
All [Shared Collection Variables](../variables) are available as well as the additional Variables below which can be used to customize the file.
| Variable | Description & Values |
|:------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

102
docs/defaults/overlays/audio_codec.md
View file

@ -1,50 +1,94 @@
# Audio Codec Default Overlay File
# Audio Codec Overlay
The `audio_codec` Overlay File is used to create an overlay based on the audio codec available on each item within your library.
The `audio_codec` Default Overlay File is used to create an overlay based on the audio codec available on each item within your library.
**This file works with Movie and TV Libraries.**
Example Overlays Created:
**Designed for [TRaSH Guides](https://trash-guides.info/) filename naming scheme**
![](../images/audio_codec_ov.png)
![](images/audio_codec.png)
## Supported Audio Codecs
| Audio Codec | Key | Weight |
|:-----------------------|:--------------:|:------:|
| Dolby TrueHD Atmos | `truehd_atmos` | `160` |
| DTS-X | `dtsx` | `150` |
| Dolby Digital+ / E-AC3 | `plus_atmos` | `140` |
| Dolby Atmos | `dolby_atmos` | `130` |
| Dolby TrueHD | `truehd` | `120` |
| DTS-HD-MA | `ma` | `110` |
| FLAC | `flac` | `100` |
| PCM | `pcm` | `90` |
| DTS-HD-HRA | `hra` | `80` |
| Dolby Digital+ | `plus` | `70` |
| DTS-ES | `dtses` | `60` |
| DTS | `dts` | `50` |
| Dolby Digital | `digital` | `40` |
| AAC | `aac` | `30` |
| MP3 | `mp3` | `20` |
| Opus | `opus` | `10` |
#### Standard Style
Below is a screenshot of the alternative Standard (`standard`) style which can be set via the `style` template variable.
![](images/audio_codec2.png)
## Config
The below YAML in your config.yml will create the overlays:
```yaml
libraries:
Movies:
overlay_path:
- pmm: audio_codec
TV Shows:
overlay_path:
- pmm: audio_codec
- pmm: audio_codec
template_variables:
overlay_level: season
- pmm: audio_codec
template_variables:
overlay_level: episode
```
## Template Variables
Template Variables can be used to manipulate the file from the default settings which are provided.
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
A key system is used to control each overlay that is created by the file. Each key refers to one overlay and is used to control multiple template variables.
All [Shared Overlay Variables](variables) are available with the default values below as well as the additional Variables below which can be used to customize the file.
Below are the keys and what they refer to:
| Variable | Default |
|:--------------------|:-----------:|
| `horizontal_offset` | `0` |
| `horizontal_align` | `center` |
| `vertical_offset` | `15` |
| `vertical_align` | `top` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_height` | `105`/`189` |
| Key | Audio Codec |
|:-------------|:-----------------------|
| opus | Opus |
| mp3 | MP3 |
| digital | Dolby Digital |
| aac | AAC |
| dts | DTS |
| es | DTS-ES |
| plus | Dolby Digital+ |
| hra | DTS-HD-HRA |
| pcm | PCM |
| flac | FLAC |
| hd | DTS-HD-MA |
| truehd | Dolby TrueHD |
| plus-atmos | Dolby Digital+ / E-AC3 |
| atmos | Dolby Atmos |
| x | DTS-X |
| truehd-atmos | Dolby TrueHD Atmos |
| Variable | Description & Values |
|:-----------------|:-------------------------------------------------------------------------------------------------------------|
| `style` | **Description:** Choose the Overlay Style.<br>**Default:** `compact`<br>**Values:** `compact` or `standard` |
| `overlay_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` |
| `weight_<<key>>` | **Description:** Controls the weight of the Overlay. Higher numbers have priority.<br>**Values:** Any Number |
The below is an example config.yml extract with some Template Variables added in to change how the file works.
Further information on the universal template attributes and editing Overlay Files via template variables can be found [here]()
```yaml
libraries:
Movies:
overlay_path:
- pmm: audio_codec
template_variables:
use_opus: false
use_mp3: false
style: standard
```

67
docs/defaults/overlays/audio_language.md
View file

@ -1,34 +1,73 @@
# Audio Language Default Overlay File
# Audio Language Overlay
The `audio_language` Overlay File is used to create an overlay based on the number of audio languages available on each item within your library.
The `audio_language` Default Overlay File is used to create an overlay based on the number of audio languages available on each item within your library.
Example Overlays Created:
**This file works with Movie and TV Libraries.**
![](../images/audio_language_ov.png)
**Designed for [TRaSH Guides](https://trash-guides.info/) filename naming scheme**
![](images/audio_language.png)
## Supported Audio Languages
| Audio Codec | Key | Weight |
|:------------|:-------:|:------:|
| Dual | `dual` | `20` |
| Multi | `multi` | `10` |
## Config
The below YAML in your config.yml will create the overlays:
```yaml
libraries:
Movies:
overlay_path:
- pmm: audio_language
TV Shows:
overlay_path:
- pmm: audio_language
- pmm: audio_language
template_variables:
overlay_level: season
- pmm: audio_language
template_variables:
overlay_level: episode
```
## Template Variables
Template Variables can be used to manipulate the file from the default settings which are provided.
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
A key system is used to control each overlay that is created by the file. Each key refers to one overlay and is used to control multiple template variables.
All [Shared Overlay Variables](variables) are available with the default values below as well as the additional Variables below which can be used to customize the file.
Below are the keys and what they refer to:
| Variable | Default |
|:--------------------|:-----------:|
| `horizontal_offset` | `0` |
| `horizontal_align` | `center` |
| `vertical_offset` | `30` |
| `vertical_align` | `bottom` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `188` |
| `back_height` | `105` |
| Key | Audio Languages |
|:------|:---------------------------------------|
| dual | Dual Audio (i.e. 2 languages) |
| multi | Multi Audio (i.e. 3 or more languages) |
Further information on the universal template attributes and editing Overlay Files via template variables can be found [here]()
| Variable | Description & Values |
|:-----------------|:-------------------------------------------------------------------------------------------------------------|
| `minimum` | **Description:** Choose the minimum for the `multi` Overlay.<br>**Default:** `2` <br>**Values:** Any Number |
| `overlay_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` |
| `weight_<<key>>` | **Description:** Controls the weight of the Overlay. Higher numbers have priority.<br>**Values:** Any Number |
The below is an example config.yml extract with some Template Variables added in to change how the file works.
```yaml
libraries:
Movies:
overlay_path:
- pmm: audio_codec
template_variables:
use_opus: false
use_mp3: false
```

92
docs/defaults/overlays/commonsense.md
View file

@ -1,35 +1,99 @@
# CommonSense Age Rating Default Overlay File
# CommonSense Age Rating Overlay
The `commonsense` Overlay File is used to create an overlay based on the CommonSense Age Rating on each item within your library.
The `commonsense` Default Overlay File is used to create an overlay based on the CommonSense Age Rating on each item within your library.
Note that this file requires the `mass_content_rating: mdb_commonsense` operation to be set against your library so that the content ratings are taken from CommonSense.
Use the [Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with either `mdb_commonsense` or `mdb_commonsense0` to update Plex to the Common Sense Rating.
Example Overlays Created:
**This file works with Movie and TV Libraries.**
![](../images/commonsense_ov.png)
![](images/commonsense.png)
## Supported CommonSense Age Rating
| Rating | Key |
|:-------|:----:|
| 1+ | `1` |
| 2+ | `2` |
| 3+ | `3` |
| 4+ | `4` |
| 5+ | `5` |
| 6+ | `6` |
| 7+ | `7` |
| 8+ | `8` |
| 9+ | `9` |
| 10+ | `10` |
| 11+ | `11` |
| 12+ | `12` |
| 13+ | `13` |
| 14+ | `14` |
| 15+ | `15` |
| 16+ | `16` |
| 17+ | `17` |
| 18+ | `18` |
| NR | `nr` |
## Config
The below YAML in your config.yml will create the overlays:
```yaml
libraries:
Movies:
overlay_path:
- pmm: commonsense
TV Shows:
overlay_path:
- pmm: commonsense
- pmm: commonsense
template_variables:
overlay_level: season
- pmm: commonsense
template_variables:
overlay_level: episode
```
## Template Variables
Template Variables can be used to manipulate the file from the default settings which are provided.
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings.
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
A key system is used to control the overlays that is created by the file. Each key refers to one overlay and is used to control multiple template variables.
All [Shared Overlay Variables](variables) are available with the default values below as well as the additional Variables below which can be used to customize the file.
Below are the keys and what they refer to:
| Variable | Default |
|:--------------------|:-----------:|
| `horizontal_offset` | `15` |
| `horizontal_align` | `left` |
| `vertical_offset` | `270` |
| `vertical_align` | `bottom` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_height` | `105` |
| Key | Age Rating |
|:------|:-----------|
| nr | Not Rated |
Further information on the universal template attributes and editing Overlay Files via template variables can be found [here]()
| Variable | Description & Values |
|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `font` | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Medium.ttf`<br>**Values:** Path to font file |
| `font_style` | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style |
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `55`<br>**Values:** Any Number greater then 0 |
| `font_color` | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any Number greater then 0 |
| `stroke_color` | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
| `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any Number greater then 0 |
| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `left`<br>**Values:** `left`, `right`, `top`, `bottom` |
| `pre_text` | **Description:** Choose the text before the key for the Overlay.<br>**Values:** Any String |
| `post_text` | **Description:** Choose the text after the key for the Overlay.<br>**Default:** `+`<br>**Values:** Any String |
| `pre_nr_text` | **Description:** Choose the text before the `nr` key for the Overlay.<br>**Values:** Any String |
| `post_nr_text` | **Description:** Choose the text after the `nr` key for the Overlay.<br>**Values:** Any String |
| `overlay_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` |
The below is an example config.yml extract with some Template Variables added in to change how the file works.
```yaml
libraries:
Movies:
overlay_path:
- pmm: commonsense
template_variables:
pre_text: "CS"
```

0
docs/defaults/overlays/defaults.md Normal file
View file

50
docs/defaults/overlays/direct_play.md
View file

@ -1,23 +1,61 @@
# Direct Play Default Overlay File
# Direct Play Overlay
The `direct_play` Overlay File is used to create an overlay to indicate items that cannot be transcoded and instead only support Direct Play (i.e. if you use Tautulli to kill 4K transcoding)
The `direct_play` Default Overlay File is used to create an overlay to indicate items that cannot be transcoded and instead only support Direct Play (i.e. if you use Tautulli to kill 4K transcoding)
Example Overlays Created:
**This file works with Movie and TV Libraries.**
![](../images/direct_play_ov.png)
![](images/direct_play.png)
## Config
The below YAML in your config.yml will create the overlays:
```yaml
libraries:
Movies:
overlay_path:
- pmm: direct_play
TV Shows:
overlay_path:
- pmm: direct_play
- pmm: direct_play
template_variables:
overlay_level: season
- pmm: direct_play
template_variables:
overlay_level: episode
```
## Template Variables
This Overlay File has no individual template variables that can be set.
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
Further information on the universal template attributes and editing Overlay Files via template variables can be found [here]()
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Overlay Variables](variables) are available with the default values below as well as the additional Variables below which can be used to customize the file.
| Variable | Default |
|:--------------------|:-----------:|
| `horizontal_offset` | `0` |
| `horizontal_align` | `center` |
| `vertical_offset` | `150` |
| `vertical_align` | `bottom` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_height` | `170` |
| Variable | Description & Values |
|:----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `overlay_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` |
The below is an example config.yml extract with some Template Variables added in to change how the file works.
```yaml
libraries:
Movies:
overlay_path:
- pmm: direct_play
template_variables:
overlay_level: episode
```

74
docs/defaults/overlays/edition.md
View file

@ -1 +1,73 @@
To be updated once fixed
# Edition Overlays
The `audio_codec` Default Overlay File is used to create an overlay based on the audio codec available on each item within your library.
**This file only works with Movie Libraries.**
**Designed for [TRaSH Guides](https://trash-guides.info/) filename naming scheme**
![](images/edition.png)
## Supported Editions
| Edition | Key | Weight |
|:--------------------|:---------------:|:------:|
| Directors Cut | `directorscut` | `150` |
| Extended Edition | `extended` | `140` |
| Uncut Edition | `uncut` | `130` |
| Unrated Edition | `unrated` | `120` |
| Special Edition | `special` | `110` |
| Final Cut | `finalcut` | `100` |
| Anniversary Edition | `anniversary` | `90` |
| Collectors Edition | `collector` | `80` |
| International Cut | `international` | `70` |
| Theatrical Cut | `theatrical` | `60` |
| Ultimate Cut | `ultimate` | `50` |
| IMAX | `imax` | `30` |
| Remastered | `remastered` | `20` |
## Config
The below YAML in your config.yml will create the overlays:
```yaml
libraries:
Movies:
overlay_path:
- pmm: edition
```
## Template Variables
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Overlay Variables](variables) are available with the default values below as well as the additional Variables below which can be used to customize the file.
| Variable | Default |
|:--------------------|:-----------:|
| `horizontal_offset` | `15` |
| `horizontal_align` | `left` |
| `vertical_offset` | `15`/`99` |
| `vertical_align` | `top` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_height` | `105` |
| Variable | Description & Values |
|:-----------------|:-------------------------------------------------------------------------------------------------------------|
| `weight_<<key>>` | **Description:** Controls the weight of the Overlay. Higher numbers have priority.<br>**Values:** Any Number |
The below is an example config.yml extract with some Template Variables added in to change how the file works.
```yaml
libraries:
Movies:
overlay_path:
- pmm: edition
template_variables:
weight_ultimate: 95
use_international: false
```

49
docs/defaults/overlays/episode_info.md
View file

@ -1,24 +1,57 @@
# Episode Info Default Overlay File
# Episode Info Overlay
The `episode_info` Overlay File is used to create an overlay based on the episode numbering within a given series in your library.
The `episode_info` Default Overlay File is used to create an overlay on the episode title card on the episode numbering within a given series in your library.
Note that this file should only be used against show libraries and is not expected to work against movie libraries.
**This file only works with TV Libraries.**
Example Overlays Created:
![](images/episode_info.png)
![](../images/episode_info_ov.png)
## Config
The below YAML in your config.yml will create the overlays:
```yaml
libraries:
Movies:
TV Shows:
overlay_path:
- pmm: episode_info
```
## Template Variables
This Overlay File has no individual template variables that can be set.
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
Further information on the universal template attributes and editing Overlay Files via template variables can be found [here]()
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Overlay Variables](variables) are available with the default values below as well as the additional Variables below which can be used to customize the file.
| Variable | Default |
|:--------------------|:-----------:|
| `horizontal_offset` | `15` |
| `horizontal_align` | `left` |
| `vertical_offset` | `270` |
| `vertical_align` | `bottom` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_height` | `105` |
| Variable | Description & Values |
|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `font` | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Medium.ttf`<br>**Values:** Path to font file |
| `font_style` | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style |
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `55`<br>**Values:** Any Number greater then 0 |
| `font_color` | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any Number greater then 0 |
| `stroke_color` | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
The below is an example config.yml extract with some Template Variables added in to change how the file works.
```yaml
libraries:
Movies:
overlay_path:
- pmm: episode_info
template_variables:
font_color: "#FFFFFF99"
```

84
docs/defaults/overlays/flixpatrol.md Normal file
View file

@ -0,0 +1,84 @@
# FlixPatrol Top Overlays
The `flixpatrol` Default Overlay File is used to create an overlay based on the Top Lists from FlixPatrol on items within your library.
**This file works with Movie and TV Libraries.**
![](images/flixpatrol.png)
## Supported Services
| Service | Key | Weight |
|:------------|:-----------:|:------:|
| Netflix | `netflix` | `60` |
| Disney+ | `disney` | `50` |
| HBO | `hbo` | `40` |
| Hulu | `hulu` | `30` |
| Paramount+ | `paramount` | `20` |
| Prime Video | `prime` | `10` |
## Config
The below YAML in your config.yml will create the overlays:
```yaml
libraries:
Movies:
overlay_path:
- pmm: flixpatrol
TV Shows:
overlay_path:
- pmm: flixpatrol
```
## Template Variables
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Overlay Variables](variables) except `horizontal_offset`, `horizontal_align`, `vertical_offset`, and `vertical_align` are available with the default values below as well as the additional Variables below which can be used to customize the file.
| Variable | Default |
|:--------------------|:-----------------:|
| `horizontal_offset` | `30` |
| `horizontal_align` | `left`/`right` |
| `vertical_offset` | `465`/`670`/`875` |
| `vertical_align` | `top` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `160` |
| `back_height` | `160` |
| `back_padding` | `15` |
| Variable | Description & Values |
|:----------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `position` | **Description:** Changes the position of the Overlays.<br>**Default:** `right`<br>**Values:** `right`, `left`, or List of Coordinates |
| `style` | **Description:** Changes the style of the Logo Image.<br>**Default:** `round`<br>**Values:** `round` or `square` |
| `pre_text` | **Description:** Changes the text before the number.<br>**Default:** `TOP`<br>**Values:** Any String |
| `limit` | **Description:** Changes the Builder Limit for all overlays in a Defaults file.<br>**Default:** `10`<br>**Values:** Any Number greater then 0 |
| `limit_<<key>>` | **Description:** Changes the Builder Limit of the specified key's overlay.<br>**Default:** `limit`<br>**Values:** Any Number greater then 0 |
| `location` | **Description:** Changes the Builder Location for all overlays in a Defaults file.<br>**Default:** `world`<br>**Values:** [`location` Attribute Options](../../metadata/builders/flixpatrol.md#top-platform-attributes) |
| `location_<<key>>` | **Description:** Changes the Builder Location of the specified key's overlay.<br>**Default:** `location`<br>**Values:** [`location` Attribute Options](../../metadata/builders/flixpatrol.md#top-platform-attributes) |
| `time_window` | **Description:** Changes the Builder Time Window for all overlays in a Defaults file.<br>**Default:** `last_week`<br>**Values:** [`time_window` Attribute Options](../../metadata/builders/flixpatrol.md#top-platform-attributes) |
| `time_window_<<key>>` | **Description:** Changes the Builder Time Window of the specified key's overlay.<br>**Default:** `time_window`<br>**Values:** [`time_window` Attribute Options](../../metadata/builders/flixpatrol.md#top-platform-attributes) |
| `weight_<<key>>` | **Description:** Controls the weight of the Overlay. Higher numbers have priority.<br>**Values:** Any Number |
| `font` | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Medium.ttf`<br>**Values:** Path to font file |
| `font_style` | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style |
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `50`<br>**Values:** Any Number greater then 0 |
| `font_color` | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any Number greater then 0 |
| `stroke_color` | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
| `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `30`<br>**Values:** Any Number greater then 0 |
| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `top`<br>**Values:** `left`, `right`, `top`, `bottom` |
The below is an example config.yml extract with some Template Variables added in to change how the file works.
```yaml
libraries:
Movies:
overlay_path:
- pmm: flixpatrol
template_variables:
location: united_states
```

104
docs/defaults/overlays/flixpatrol.yml
View file

@ -1,104 +0,0 @@
queues:
flixpatrol_position:
right:
- horizontal_offset: 30 # This is the first position
horizontal_align: right
vertical_offset: 465
vertical_align: top
- horizontal_offset: 30 # This is the second position
horizontal_align: right
vertical_offset: 670
vertical_align: top
- horizontal_offset: 30 # This is the third position
horizontal_align: right
vertical_offset: 875
vertical_align: top
left:
- horizontal_offset: 30 # This is the first position
horizontal_align: left
vertical_offset: 465
vertical_align: top
- horizontal_offset: 30 # This is the second position
horizontal_align: left
vertical_offset: 670
vertical_align: top
- horizontal_offset: 30 # This is the third position
horizontal_align: left
vertical_offset: 875
vertical_align: top
templates:
FlixPatrol:
optional:
- use_<<key>>
- time_window_<<key>>
- location_<<key>>
- overlay_level
default:
style: round
overlay: <<overlay_name>>
slug: <<key>>
horizontal_offset: 15
horizontal_align: left
vertical_offset: 15
vertical_align: top
font: fonts/Inter-Bold.ttf
font_size: 50
font_color: "#FFFFFF"
back_color: "#00000099"
back_radius: 30
back_width: 165
back_height: 165
back_align: center
back_padding: 15
addon_position: top
addon_offset: 30
time_window: last_week
time_window_<<key>>: <<time_window>>
location: united_states
location_<<key>>: <<location>>
limit: 10
limit_<<key>>: <<limit>>
weight_<<key>>: <<weight>>
overlay_level: <<overlay_level>>
ignore_blank_results: true
allowed_library_types: <<use_<<key>>>>
overlay:
name: text(TOP<<limit>>)
queue: flixpatrol_position
weight: <<weight_<<key>>>>
horizontal_offset: <<horizontal_offset>>
horizontal_align: <<horizontal_align>>
vertical_offset: <<vertical_offset>>
vertical_align: <<vertical_align>>
font: <<font>>
font_size: <<font_size>>
font_color: <<font_color>>
back_radius: <<back_radius>>
back_color: <<back_color>>
back_width: <<back_width>>
back_height: <<back_height>>
back_align: <<back_align>>
back_padding: <<back_padding>>
pmm: logo/<<style>>/<<key>>
addon_position: <<addon_position>>
addon_offset: <<addon_offset>>
flixpatrol_top:
platform: <<slug>>
location: <<location_<<key>>>>
time_window: <<time_window_<<key>>>>
limit: <<limit_<<key>>>>
overlays:
Netflix:
template: {name: FlixPatrol, weight: 600, key: netflix}
Disney:
template: {name: FlixPatrol, weight: 500, key: disney}
HBO:
template: {name: FlixPatrol, weight: 400, key: hbo}
Hulu:
template: {name: FlixPatrol, weight: 300, key: hulu}
Paramount:
template: {name: FlixPatrol, weight: 200, key: paramount, slug: paramount_plus}
Prime:
template: {name: FlixPatrol, weight: 100, key: prime, slug: amazon_prime}

0
docs/defaults/images/audio_codec_ov.png → docs/defaults/overlays/images/audio_codec.png
View file

Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 319 KiB

After

Width:  |  Height:  |  Size: 319 KiB

0
docs/defaults/images/audio_language_ov.png → docs/defaults/overlays/images/audio_language.png
View file

Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 318 KiB

After

Width:  |  Height:  |  Size: 318 KiB

0
docs/defaults/images/commonsense_ov.png → docs/defaults/overlays/images/commonsense.png
View file

Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 318 KiB

After

Width:  |  Height:  |  Size: 318 KiB

0
docs/defaults/images/direct_play_ov.png → docs/defaults/overlays/images/direct_play.png
View file

Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 318 KiB

After

Width:  |  Height:  |  Size: 318 KiB

0
docs/defaults/images/episode_info_ov.png → docs/defaults/overlays/images/episode_info.png
View file

Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 424 KiB

After

Width:  |  Height:  |  Size: 424 KiB

48
docs/defaults/overlays/mediastinger.md Normal file
View file

@ -0,0 +1,48 @@
# MediaStinger Overlay
The `mediastinger` Default Overlay File is used to create an overlay based on if there's an after/during credit scene on each movie within your library.
**This file only works with Movie Libraries.**
![](images/mediastinger.png)
## Config
The below YAML in your config.yml will create the overlays:
```yaml
libraries:
Movies:
overlay_path:
- pmm: mediastinger
```
## Template Variables
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Overlay Variables](variables) are available with the default values below as well as the additional Variables below which can be used to customize the file.
| Variable | Default |
|:--------------------|:-----------:|
| `horizontal_offset` | `200` |
| `horizontal_align` | `right` |
| `vertical_offset` | `15` |
| `vertical_align` | `top` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `105` |
| `back_height` | `105` |
The below is an example config.yml extract with some Template Variables added in to change how the file works.
```yaml
libraries:
Movies:
overlay_path:
- pmm: mediastinger
template_variables:
font_color: "#FFFFFF99"
```

63
docs/defaults/overlays/mediastinger.yml
View file

@ -1,63 +0,0 @@
#############################################################
# Mediastinger Overlay #
# Created by Yozora, Bullmoose20, & Sohjiro #
# Credit to Magic815 for base images #
#############################################################
# Call this from your config.yml (Movie or Show): #
# overlay_path: #
# - git: PMM/overlays/mediastinger #
# template_variables: #
# # Set episode or season to overlay #
# overlay_level: #
# # Set the horizontal offset for the overlay #
# horizontal_offset: 200 #
# # Set the horizontal align for the overlay #
# horizontal_align: right #
# # Set the vertical offset for the overlay #
# vertical_offset: 15 #
# # Set the vertical align for the overlay #
# vertical_align: top #
# # Set the back color for the overlay #
# back_color: "#00000099" #
# # Set the back radius for the overlay #
# back_radius: 30 #
# # Set the back width for the overlay #
# back_width: 105 #
# # Set the back height for the overlay #
# back_height: 105 #
#############################################################
templates:
stinger:
optional:
- overlay_level
default:
overlay: <<overlay_name>>
horizontal_offset: 200
horizontal_align: right
vertical_offset: 15
vertical_align: top
back_color: "#00000099"
back_radius: 30
back_width: 105
back_height: 105
overlay_level: <<overlay_level>>
overlay:
name: <<overlay_name>>
pmm: Mediastinger
horizontal_offset: <<horizontal_offset>>
horizontal_align: <<horizontal_align>>
vertical_offset: <<vertical_offset>>
vertical_align: <<vertical_align>>
back_color: <<back_color>>
back_radius: <<back_radius>>
back_width: <<back_width>>
back_height: <<back_height>>
overlays:
Mediastinger:
template:
- name: stinger
plex_all: true
filters:
tmdb_keyword: aftercreditsstinger, duringcreditsstinger

144
docs/defaults/overlays/ratings.md Normal file
View file

@ -0,0 +1,144 @@
# Ratings Overlays
The `ratings` Default Overlay File is used to create an overlay based on if there's an after credit scene on each item within your library.
This file only updates the overlays based on the data in Plex. Use the [Mass * Rating Update Library Operation](../../config/operations.md#mass--rating-update) and the [Mass Episode * Rating Update Library Operation](../../config/operations.md#mass-episode--rating-update) to update Plex to the Ratings you want on the Overlay.
**This file works with Movie and TV Libraries.**
**If no template variables are set this file will do nothing.**
![](images/ratings.png)
## Config
The below YAML in your config.yml will create the overlays:
```yaml
Movies:
overlay_path:
- pmm: ratings
template_variables:
rating1: critic
rating2: audience
rating3: user
rating1_image: imdb
rating2_image: rt_popcorn
rating3_image: tmdb
operations:
mass_critic_rating_update: imdb
mass_audience_rating_update: mdb_tomatoesaudience
mass_user_rating_update: tmdb
TV Shows:
overlay_path:
- pmm: ratings
template_variables:
rating1: critic
rating2: audience
rating3: user
rating1_image: imdb
rating2_image: rt_popcorn
rating3_image: tmdb
- pmm: ratings
template_variables:
overlay_level: episode
rating1: critic
rating2: audience
rating1_image: imdb
rating2_image: tmdb
operations:
mass_critic_rating_update: imdb
mass_audience_rating_update: mdb_tomatoesaudience
mass_user_rating_update: tmdb
mass_episode_critic_rating_update: imdb
mass_episode_audience_rating_update: tmdb
```
## Template Variables
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Overlay Variables](variables) are available with the default values below as well as the additional Variables below which can be used to customize the file.
All [Shared Overlay Variables](variables) can be appended by `rating1_`, `rating2_`, or `rating3_` to change that attribute on each rating individually.
| Variable | Default |
|:--------------------|:-----------:|
| `horizontal_offset` | `200` |
| `horizontal_align` | `right` |
| `vertical_offset` | `15` |
| `vertical_align` | `top` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `105` |
| `back_height` | `105` |
| `back_padding` | `15` |
| `back_radius` | `30` |
| `back_height` | `105` |
| Variable | Description & Values |
|:-----------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `rating1` | **Description:** Choose the rating to display in rating1.<br>**Values:** `critic`, `audience`, or `user` |
| `rating1_image` | **Description:** Choose the rating image to display in rating1.<br>**Values:** `anidb`, `imdb`, `letterboxd`, `tmdb`, `metacritic`, `rt_popcorn`, `rt_tomato`, `trakt`, or `mal` |
| `rating2` | **Description:** Choose the rating to display in rating2.<br>**Values:** `critic`, `audience`, or `user` |
| `rating2_image` | **Description:** Choose the rating image to display in rating2.<br>**Values:** `anidb`, `imdb`, `letterboxd`, `tmdb`, `metacritic`, `rt_popcorn`, `rt_tomato`, `trakt`, or `mal` |
| `rating3` | **Description:** Choose the rating to display in rating3.<br>**Values:** `critic`, `audience`, or `user` |
| `rating3_image` | **Description:** Choose the rating image to display in rating3.<br>**Values:** `anidb`, `imdb`, `letterboxd`, `tmdb`, `metacritic`, `rt_popcorn`, `rt_tomato`, `trakt`, or `mal` |
| `horizontal_position` | **Description:** Choose the horizontal position for the rating group.<br>**Values:** `left`, `right`, or `center` |
| `vertical_position` | **Description:** Choose the vertical position for the rating group.<br>**Values:** `top`, `bottom`, or `center` |
| `rating_alignment` | **Description:** Choose the display alignment for the rating group.<br>**Values:** `horizontal`, or `vertical` |
| `font`<sup>1</sup> | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Bold.ttf`<br>**Values:** Path to font file |
| `font_style`<sup>1</sup> | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style |
| `font_size`<sup>1</sup> | **Description:** Choose the font size for the Overlay.<br>**Default:** `63`<br>**Values:** Any Number greater then 0 |
| `font_color`<sup>1</sup> | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
| `stroke_width`<sup>1</sup> | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any Number greater then 0 |
| `stroke_color`<sup>1</sup> | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
| `addon_offset`<sup>1</sup> | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any Number greater then 0 |
| `addon_position`<sup>1</sup> | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `left`<br>**Values:** `left`, `right`, `top`, `bottom` |
| `overlay_level` | **Description:** Choose the Overlay Level.<br>**Values:** `episode` |
1. These Variables can be appended by `rating1_`, `rating2_`, or `rating3_` to change that attribute on each rating individually.
The below is an example config.yml extract with some Template Variables added in to change how the file works.
```yaml
Movies:
overlay_path:
- pmm: ratings
template_variables:
rating1: critic
rating2: audience
rating3: user
rating1_image: imdb
rating2_image: rt_popcorn
rating3_image: tmdb
operations:
mass_critic_rating_update: imdb
mass_audience_rating_update: mdb_tomatoesaudience
mass_user_rating_update: tmdb
TV Shows:
overlay_path:
- pmm: ratings
template_variables:
rating1: critic
rating2: audience
rating3: user
rating1_image: imdb
rating2_image: rt_popcorn
rating3_image: tmdb
- pmm: ratings
template_variables:
overlay_level: episode
rating1: critic
rating2: audience
rating1_image: imdb
rating2_image: tmdb
operations:
mass_critic_rating_update: imdb
mass_audience_rating_update: mdb_tomatoesaudience
mass_user_rating_update: tmdb
mass_episode_critic_rating_update: imdb
mass_episode_audience_rating_update: tmdb
```

520
docs/defaults/overlays/ratings.yml
View file

@ -1,520 +0,0 @@
#############################################################
# Ratings Overlay #
# Created by Yozora, Bullmoose20, & Sohjiro #
# Credit to Magic815 for base images #
#############################################################
# Call this from your config.yml (Movie or Show): #
# If nothing is specified nothing will show up at least #
# one rating# must be set #
# #
# overlay_path: #
# - git: PMM/overlays/ratings #
# template_variables: #
# #
# # Set rating type for rating1, rating2, and/or #
# rating3 #
# # Rating Types: critic, audience, user #
# #
# rating1: critic #
# rating2: audience #
# rating3: user #
# #
# # Set rating image for rating1, rating2, and/or #
# rating3 #
# # Rating Images: anidb, imdb, letterboxd, tmdb, #
# metacritic, rt_popcorn, rt_tomato, trakt, #
# mal #
# #
# rating1_image: imdb #
# rating2_image: rt_popcorn #
# rating3_image: tmdb #
# #
# # Sets the position to display the ratings #
# # horizontal_position: left, right, center #
# # vertical_position: top, bottom, center #
# #
# horizontal_position: left #
# vertical_position: center #
# #
# # Sets the alignment to display the ratings #
# # rating_alignment: horizontal, vertical #
# #
# rating_alignment: vertical #
# #
# # Set as 'episode' to overlay episodes #
# #
# overlay_level: #
# #
# Movies: #
# overlay_path: #
# - git: PMM/overlays/ratings #
# template_variables: #
# rating1: critic #
# rating2: audience #
# rating3: user #
# rating1_image: imdb #
# rating2_image: rt_popcorn #
# rating3_image: tmdb #
# operations: #
# mass_critic_rating_update: imdb #
# mass_audience_rating_update: mdb_tomatoesaudience #
# mass_user_rating_update: tmdb #
# TV Shows: #
# overlay_path: #
# - git: PMM/overlays/ratings #
# template_variables: #
# rating1: critic #
# rating2: audience #
# rating3: user #
# rating1_image: imdb #
# rating2_image: rt_popcorn #
# rating3_image: tmdb #
# - git: PMM/overlays/ratings #
# template_variables: #
# rating1: critic #
# rating2: audience #
# rating1_image: imdb #
# rating2_image: tmdb #
# operations: #
# mass_critic_rating_update: imdb #
# mass_audience_rating_update: mdb_tomatoesaudience #
# mass_user_rating_update: tmdb #
# mass_episode_critic_rating_update: imdb #
# mass_episode_audience_rating_update: tmdb #
#############################################################
templates:
Rating:
optional:
- overlay_level
default:
font: fonts/Inter-Bold.ttf
font_size: 63
rating<<rating_num>>_font: <<font>>
rating<<rating_num>>_font_size: <<font_size>>
weight: 100
side: left
horizontal_position: left
vertical_position: center
rating_alignment: vertical
rating1: none
rating2: none
rating3: none
center_offset: 0
standard_offset: 30
v2_offset: 235
v3_offset: 440
cv2_offset: 105
cv3_offset: 205
h2_offset: 345
h3_offset: 660
ch2_offset: 160
ch3_offset: 335
conditionals:
mdblist_top:
conditions:
- image_level: Top
rating<<rating_num>>_image: rt_tomato
value: https://mdblist.com/lists/plexmetamanager/certifiedfresh<<library_type>>s
- image_level: Top
rating<<rating_num>>_image: metacritic
value: https://mdblist.com/lists/plexmetamanager/metacriticmustsee<<library_type>>s
imdb_top:
conditions:
- image_level: Top
rating<<rating_num>>_image: imdb
value: top_<<library_type>>s
run_this:
default: true
conditions:
- image_level: Top
rating<<rating_num>>_image: [anidb, letterboxd, rt_popcorn, mdblist, tmdb, trakt, mal]
value: false
- image_level: Top
overlay_level: episode
value: false
- rating<<rating_num>>: none
value: false
rating<<rating_num>>_style:
default: ""
conditions:
- rating<<rating_num>>_image: [rt_popcorn, rt_tomato, tmdb]
value: "%"
- rating<<rating_num>>_image: metacritic
value: "0"
image_extra:
default: ""
conditions:
- rating<<rating_num>>_image: [imdb, rt_tomato, metacritic]
image_level: Top
value: Top
- rating<<rating_num>>_image: [rt_popcorn, rt_tomato]
value: <<image_level>>
rating<<rating_num>>_image_url:
conditions:
- rating<<rating_num>>_image: anidb
value: Anidb
- rating<<rating_num>>_image: imdb
value: IMDb
- rating<<rating_num>>_image: letterboxd
value: Letterboxd
- rating<<rating_num>>_image: mdblist
value: MDBList
- rating<<rating_num>>_image: metacritic
value: Metacritic
- rating<<rating_num>>_image: rt_popcorn
value: RT-Aud-
- rating<<rating_num>>_image: rt_tomato
value: RT-Crit-
- rating<<rating_num>>_image: tmdb
value: TMDb
- rating<<rating_num>>_image: trakt
value: Trakt
- rating<<rating_num>>_image: mal
value: MAL
rating<<rating_num>>_horizontal_align:
default: left
conditions:
- horizontal_position: right
value: right
- horizontal_position: center
value: center
rating<<rating_num>>_vertical_align:
default: center
conditions:
- vertical_position: top
value: top
- vertical_position: bottom
value: bottom
rating1_horizontal_offset:
default: <<standard_offset>>
conditions:
- rating_alignment: vertical
horizontal_position: center
value: <<center_offset>>
- rating_alignment: horizontal
horizontal_position: center
rating2: none
rating3: none
value: <<center_offset>>
- rating_alignment: horizontal
horizontal_position: center
rating2: none
value: -<<ch2_offset>>
- rating_alignment: horizontal
horizontal_position: center
rating3: none
value: -<<ch2_offset>>
- rating_alignment: horizontal
horizontal_position: center
value: -<<ch3_offset>>
- rating_alignment: horizontal
horizontal_position: right
rating2: none
rating3: none
value: <<standard_offset>>
- rating_alignment: horizontal
horizontal_position: right
rating2: none
value: <<h2_offset>>
- rating_alignment: horizontal
horizontal_position: right
rating3: none
value: <<h2_offset>>
- rating_alignment: horizontal
horizontal_position: right
value: <<h3_offset>>
rating1_vertical_offset:
default: <<standard_offset>>
conditions:
- rating_alignment: horizontal
vertical_position: center
value: <<center_offset>>
- rating_alignment: vertical
vertical_position: center
rating2: none
rating3: none
value: <<center_offset>>
- rating_alignment: vertical
vertical_position: center
rating2: none
value: -<<cv2_offset>>
- rating_alignment: vertical
vertical_position: center
rating3: none
value: -<<cv2_offset>>
- rating_alignment: vertical
vertical_position: center
value: -<<cv3_offset>>
- rating_alignment: vertical
vertical_position: bottom
rating2: none
rating3: none
value: <<standard_offset>>
- rating_alignment: vertical
vertical_position: bottom
rating2: none
value: <<v2_offset>>
- rating_alignment: vertical
vertical_position: bottom
rating3: none
value: <<v2_offset>>
- rating_alignment: vertical
vertical_position: bottom
value: <<v3_offset>>
rating2_horizontal_offset:
default: <<standard_offset>>
conditions:
- rating_alignment: vertical
horizontal_position: center
value: <<center_offset>>
- rating_alignment: horizontal
horizontal_position: center
rating1: none
rating3: none
value: <<center_offset>>
- rating_alignment: horizontal
horizontal_position: center
rating1: none
value: -<<ch2_offset>>
- rating_alignment: horizontal
horizontal_position: center
rating3: none
value: -<<ch2_offset>>
- rating_alignment: horizontal
horizontal_position: center
value: -<<ch3_offset>>
- rating_alignment: horizontal
horizontal_position: right
rating1: none
rating3: none
value: <<standard_offset>>
- rating_alignment: horizontal
horizontal_position: right
rating1: none
value: <<h2_offset>>
- rating_alignment: horizontal
horizontal_position: right
rating3: none
value: <<h2_offset>>
- rating_alignment: horizontal
horizontal_position: right
value: <<h3_offset>>
- rating_alignment: horizontal
horizontal_position: left
rating1: none
value: <<standard_offset>>
- rating_alignment: horizontal
horizontal_position: left
value: <<h2_offset>>
rating2_vertical_offset:
default: <<standard_offset>>
conditions:
- rating_alignment: horizontal
vertical_position: center
value: <<center_offset>>
- rating_alignment: vertical
vertical_position: center
rating1: none
rating3: none
value: <<center_offset>>
- rating_alignment: vertical
vertical_position: center
rating1: none
value: -<<cv2_offset>>
- rating_alignment: vertical
vertical_position: center
rating3: none
value: <<cv2_offset>>
- rating_alignment: vertical
vertical_position: center
value: <<center_offset>>
- rating_alignment: vertical
vertical_position: bottom
rating1: none
rating3: none
value: <<standard_offset>>
- rating_alignment: vertical
vertical_position: bottom
rating1: none
value: <<v2_offset>>
- rating_alignment: vertical
vertical_position: bottom
rating3: none
value: <<standard_offset>>
- rating_alignment: vertical
vertical_position: bottom
value: <<v2_offset>>
- rating_alignment: vertical
vertical_position: top
rating1: none
value: <<standard_offset>>
- rating_alignment: vertical
vertical_position: top
value: <<v2_offset>>
rating3_horizontal_offset:
default: <<standard_offset>>
conditions:
- rating_alignment: vertical
horizontal_position: center
value: <<center_offset>>
- rating_alignment: horizontal
horizontal_position: center
rating1: none
rating2: none
value: <<center_offset>>
- rating_alignment: horizontal
horizontal_position: center
rating1: none
value: <<ch2_offset>>
- rating_alignment: horizontal
horizontal_position: center
rating2: none
value: <<ch2_offset>>
- rating_alignment: horizontal
horizontal_position: center
value: <<ch3_offset>>
- rating_alignment: horizontal
horizontal_position: left
rating1: none
rating2: none
value: <<standard_offset>>
- rating_alignment: horizontal
horizontal_position: left
rating1: none
value: <<h2_offset>>
- rating_alignment: horizontal
horizontal_position: left
rating2: none
value: <<h2_offset>>
- rating_alignment: horizontal
horizontal_position: left
value: <<h3_offset>>
rating3_vertical_offset:
default: <<standard_offset>>
conditions:
- rating_alignment: horizontal
vertical_position: center
value: <<center_offset>>
- rating_alignment: vertical
vertical_position: center
rating1: none
rating2: none
value: <<center_offset>>
- rating_alignment: vertical
vertical_position: center
rating1: none
value: <<cv2_offset>>
- rating_alignment: vertical
vertical_position: center
rating2: none
value: <<cv2_offset>>
- rating_alignment: vertical
vertical_position: center
value: <<cv3_offset>>
- rating_alignment: vertical
vertical_position: top
rating1: none
rating2: none
value: <<standard_offset>>
- rating_alignment: vertical
vertical_position: top
rating1: none
value: <<v2_offset>>
- rating_alignment: vertical
vertical_position: top
rating2: none
value: <<v2_offset>>
- rating_alignment: vertical
vertical_position: top
value: <<v3_offset>>
back_width:
default: 160
conditions:
- rating_alignment: horizontal
value: 270
back_height:
default: 160
conditions:
- rating_alignment: horizontal
value: 80
addon_position:
default: top
conditions:
- rating_alignment: horizontal
value: left
gte:
default: 0.0
conditions:
- image_level: Fresh
value: 6.0
lte:
default: 6.0
conditions:
- image_level: Fresh
value: 10.0
gsuffix:
conditions:
- rating<<rating_num>>: [critic, audience, user]
image_level: [Fresh, Rotten]
value: gte
lsuffix:
conditions:
- rating<<rating_num>>: [critic, audience, user]
image_level: Fresh
value: lte
- rating<<rating_num>>: [critic, audience, user]
image_level: Rotten
value: lt
plex_search:
all:
<<rating<<rating_num>>>>_rating.<<gsuffix>>: <<gte>>
<<rating<<rating_num>>>>_rating.<<lsuffix>>: <<lte>>
mdblist_list: <<mdblist_top>>
imdb_chart: <<imdb_top>>
collection_level: <<overlay_level>>
allowed_library_types: <<run_this>>
ignore_blank_results: true
overlay:
name: text(<<rating<<rating_num>>>>_rating<<rating<<rating_num>>_style>>)
horizontal_offset: <<rating<<rating_num>>_horizontal_offset>>
horizontal_align: <<rating<<rating_num>>_horizontal_align>>
vertical_offset: <<rating<<rating_num>>_vertical_offset>>
vertical_align: <<rating<<rating_num>>_vertical_align>>
group: rating<<rating_num>>_group
weight: <<weight>>
font: <<rating<<rating_num>>_font>>
font_size: <<rating<<rating_num>>_font_size>>
font_color: "#FFFFFF"
back_color: "#00000099"
back_radius: 30
back_width: <<back_width>>
back_height: <<back_height>>
back_align: center
back_padding: 15
pmm: rating/<<rating<<rating_num>>_image_url>><<image_extra>>
addon_position: <<addon_position>>
addon_offset: 15
overlays:
Rating1Rotten:
template: {name: Rating, rating_num: "1", image_level: Rotten}
Rating1Fresh:
template: {name: Rating, rating_num: "1", image_level: Fresh}
Rating1Top:
template: {name: Rating, weight: 110, rating_num: "1", image_level: Top}
Rating2Rotten:
template: {name: Rating, rating_num: "2", image_level: Rotten}
Rating2Fresh:
template: {name: Rating, rating_num: "2", image_level: Fresh}
Rating2Top:
template: {name: Rating, weight: 110, rating_num: "2", image_level: Top}
Rating3Rotten:
template: {name: Rating, rating_num: "3", image_level: Rotten}
Rating3Fresh:
template: {name: Rating, rating_num: "3", image_level: Fresh}
Rating3Top:
template: {name: Rating, weight: 110, rating_num: "3", image_level: Top}

103
docs/defaults/overlays/resolution.md Normal file
View file

@ -0,0 +1,103 @@
# Resolution/Edition Overlay
The `resolution` Default Overlay File is used to create an overlay based on the resolutions and editions available on each item within your library.
**This file works with Movie and TV Libraries.**
**Designed for [TRaSH Guides](https://trash-guides.info/) filename naming scheme**
![](images/resolution.png)
## Supported Resolutions
| Resolution | Key |
|:---------------|:---------:|
| 4K | `4k` |
| 1080P | `1080p` |
| 720P | `720p` |
| 576P | `576p` |
| 480P | `480p` |
| DV | `dv` |
| HDR | `hdr` |
## Supported Editions
| Edition | Key | Weight |
|:--------------------|:---------------:|:------:|
| Director's Cut | `directorscut` | `150` |
| Extended Edition | `extended` | `140` |
| Uncut Edition | `uncut` | `130` |
| Unrated Edition | `unrated` | `120` |
| Special Edition | `special` | `110` |
| Final Cut | `finalcut` | `100` |
| Anniversary Edition | `anniversary` | `90` |
| Collector's Edition | `collector` | `80` |
| International Cut | `international` | `70` |
| Theatrical Cut | `theatrical` | `60` |
| Ultimate Cut | `ultimate` | `50` |
| IMAX Enhanced | `enhanced` | `40` |
| IMAX | `imax` | `30` |
| Remastered | `remastered` | `20` |
| Criterion | `criterion` | `10` |
## Config
The below YAML in your config.yml will create the overlays:
```yaml
libraries:
Movies:
overlay_path:
- pmm: resolution
TV Shows:
overlay_path:
- pmm: resolution
- pmm: resolution
template_variables:
overlay_level: season
- pmm: resolution
template_variables:
overlay_level: episode
```
## Template Variables
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Overlay Variables](variables) are available with the default values below as well as the additional Variables below which can be used to customize the file.
| Variable | Default |
|:--------------------|:-----------:|
| `horizontal_offset` | `15` |
| `horizontal_align` | `left` |
| `vertical_offset` | `15` |
| `vertical_align` | `top` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_height` | `105`/`189` |
| Variable | Description & Values |
|:-----------------|:-----------------------------------------------------------------------------------------------------------------------------------------------|
| `use_resolution` | **Description:** Turns off all Resolution Overlays in the Defaults file.<br>**Values:** `false` to turn off the overlays |
| `use_edition` | **Description:** Turns off all Edition Overlays in the Defaults file.<br>**Values:** `false` to turn off the overlays |
| `overlay_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` |
| `weight_<<key>>` | **Description:** Controls the weight of the Overlay. Higher numbers have priority. **Only works with Edition keys.**<br>**Values:** Any Number |
The below is an example config.yml extract with some Template Variables added in to change how the file works.
```yaml
libraries:
Movies:
overlay_path:
- pmm: resolution
template_variables:
use_dv: false
use_hdr: false
use_1080p: false
use_720p: false
use_576p: false
use_480p: false
```

192
docs/defaults/overlays/resolution.yml
View file

@ -1,192 +0,0 @@
#############################################################
# Resolution Overlay #
# Created by Yozora, Bullmoose20, & Sohjiro #
# Credit to Magic815 for base images #
# https://metamanager.wiki/en/latest/defaults/overlays/resolution.html #
#############################################################
templates:
Resolution:
conditionals:
res:
conditions:
- resolution: 4k
value: "(?i)2160|4k"
- resolution: 1080p
value: "(?i)1080|2k"
- resolution: 720p
value: "(?i)720|hd"
- resolution: 576p
value: "(?i)576"
- resolution: 480p
value: "(?i)480|sd"
dolby_vision:
conditions:
- alt: dv
value: true
hdr:
conditions:
- alt: hdr
value: true
back_align:
conditions:
- dovetail: true
value: top
back_height:
default: 105
conditions:
- dovetail: true
value: 189
suppress_overlays:
conditions:
- dovetail: true
value:
- Directors-Cut
- Extended-Edition
- Uncut-Edition
- Unrated-Edition
- Special-Edition
- Final-Cut
- Anniversary-Edition
- Collectors-Edition
- International-Cut
- Theatrical-Cut
- Ultimate-Cut
- IMAX-E
- IMAX
- Remastered
- Criterion
- dovetail: false
value:
- <<overlay_name>>-Dovetail
optional:
- overlay_level
- use_<<resolution>>
- use_<<alt>>
- all
default:
resolution: ""
alt: ""
horizontal_offset: 15
horizontal_align: left
vertical_offset: 15
vertical_align: top
back_color: "#00000099"
back_radius: 30
back_width: 305
collection_level: <<overlay_level>>
ignore_blank_results: true
allowed_library_types:
- <<use_<<resolution>>>>
- <<use_<<alt>>>>
suppress_overlays: <<suppress_overlays>>
overlay:
name: <<overlay_name>>
pmm: resolution/<<resolution>><<alt>>
group: res
weight: <<weight>>
horizontal_offset: <<horizontal_offset>>
horizontal_align: <<horizontal_align>>
vertical_offset: <<vertical_offset>>
vertical_align: <<vertical_align>>
back_color: <<back_color>>
back_radius: <<back_radius>>
back_width: <<back_width>>
back_height: <<back_height>>
back_align: <<back_align>>
plex_all: <<all>>
plex_search:
all:
resolution.regex: <<res>>
hdr: <<hdr>>
filters:
has_dolby_vision: <<dolby_vision>>
overlays:
4K-DV:
template: {name: Resolution, weight: 150, resolution: 4k, alt: dv, dovetail: false}
4K-DV-Dovetail:
template: {name: Resolution, weight: 150, resolution: 4k, alt: dv, dovetail: true}
4K-HDR:
template: {name: Resolution, weight: 140, resolution: 4k, alt: hdr, dovetail: false}
4K-HDR-Dovetail:
template: {name: Resolution, weight: 140, resolution: 4k, alt: hdr, dovetail: true}
4K:
template: {name: Resolution, weight: 130, resolution: 4k, dovetail: false}
4K-Dovetail:
template: {name: Resolution, weight: 130, resolution: 4k, dovetail: true}
1080P-DV:
template: {name: Resolution, weight: 120, resolution: 1080p, alt: dv, dovetail: false}
1080P-DV-Dovetail:
template: {name: Resolution, weight: 120, resolution: 1080p, alt: dv, dovetail: true}
1080P-HDR:
template: {name: Resolution, weight: 110, resolution: 1080p, alt: hdr, dovetail: false}
1080P-HDR-Dovetail:
template: {name: Resolution, weight: 110, resolution: 1080p, alt: hdr, dovetail: true}
1080P:
template: {name: Resolution, weight: 100, resolution: 1080p, dovetail: false}
1080P-Dovetail:
template: {name: Resolution, weight: 100, resolution: 1080p, dovetail: true}
720P-DV:
template: {name: Resolution, weight: 90, resolution: 720p, alt: dv, dovetail: false}
720P-DV-Dovetail:
template: {name: Resolution, weight: 90, resolution: 720p, alt: dv, dovetail: true}
720P-HDR:
template: {name: Resolution, weight: 80, resolution: 720p, alt: hdr, dovetail: false}
720P-HDR-Dovetail:
template: {name: Resolution, weight: 80, resolution: 720p, alt: hdr, dovetail: true}
720P:
template: {name: Resolution, weight: 70, resolution: 720p, dovetail: false}
720P-Dovetail:
template: {name: Resolution, weight: 70, resolution: 720p, dovetail: true}
576P-DV:
template: {name: Resolution, weight: 60, resolution: 576p, alt: dv, dovetail: false}
576P-DV-Dovetail:
template: {name: Resolution, weight: 60, resolution: 576p, alt: dv, dovetail: true}
576P-HDR:
template: {name: Resolution, weight: 50, resolution: 576p, alt: hdr, dovetail: false}
576P-HDR-Dovetail:
template: {name: Resolution, weight: 50, resolution: 576p, alt: hdr, dovetail: true}
576P:
template: {name: Resolution, weight: 40, resolution: 576p, dovetail: false}
576P-Dovetail:
template: {name: Resolution, weight: 40, resolution: 576p, dovetail: true}
480P-DV:
template: {name: Resolution, weight: 30, resolution: 480p, alt: dv, dovetail: false}
480P-DV-Dovetail:
template: {name: Resolution, weight: 30, resolution: 480p, alt: dv, dovetail: true}
480P-HDR:
template: {name: Resolution, weight: 20, resolution: 480p, alt: hdr, dovetail: false}
480P-HDR-Dovetail:
template: {name: Resolution, weight: 20, resolution: 480p, alt: hdr, dovetail: true}
480P:
template: {name: Resolution, weight: 10, resolution: 480p, dovetail: false}
480P-Dovetail:
template: {name: Resolution, weight: 10, resolution: 480p, dovetail: true}
DV:
template: {name: Resolution, weight: 5, alt: dv, all: true, dovetail: false}
DV-Dovetail:
template: {name: Resolution, weight: 5, alt: dv, all: true, dovetail: true}
HDR:
template: {name: Resolution, weight: 1, alt: hdr, dovetail: false}
HDR-Dovetail:
template: {name: Resolution, weight: 1, alt: hdr, dovetail: true}

62
docs/defaults/overlays/ribbon.md Normal file
View file

@ -0,0 +1,62 @@
# Ribbon Overlays
The `ribbon` Default Overlay File is used to create a ribbon overlay based on the Top Lists of various sites on each item within your library.
**This file works with Movie and TV Libraries.**
![](images/ribbon.png)
## Supported Ribbon
| Ribbon | Key | Weight |
|:--------------------------------|:------------:|:------:|
| Oscars Best Picture | `oscars` | `50` |
| IMDb Top 250 | `imdb` | `40` |
| Rotten Tomatoes Certified Fresh | `rotten` | `30` |
| Metacritic Must See | `metacritic` | `20` |
| Commonsense Selection | `common` | `10` |
## Config
The below YAML in your config.yml will create the overlays:
```yaml
libraries:
Movies:
overlay_path:
- pmm: ribbon
TV Shows:
overlay_path:
- pmm: ribbon
```
## Template Variables
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Overlay Variables](variables) are available with the default values below as well as the additional Variables below which can be used to customize the file.
| Variable | Default |
|:--------------------|:--------:|
| `horizontal_offset` | `0` |
| `horizontal_align` | `right` |
| `vertical_offset` | `0` |
| `vertical_align` | `bottom` |
| Variable | Description & Values |
|:-----------------|:-------------------------------------------------------------------------------------------------------------|
| `weight_<<key>>` | **Description:** Controls the weight of the Overlay. Higher numbers have priority.<br>**Values:** Any Number |
The below is an example config.yml extract with some Template Variables added in to change how the file works.
```yaml
libraries:
Movies:
overlay_path:
- pmm: ribbon
template_variables:
weight_metacritic: 35
use_common: false
```

70
docs/defaults/overlays/ribbon.yml
View file

@ -1,70 +0,0 @@
#############################################################
# Ribbon Overlay #
# Created by Yozora, Bullmoose20, & Sohjiro #
# Credit to Magic815 for base images #
#############################################################
# Call this from your config.yml (Movie or Show): #
# - pmm: ribbon #
# template_variables: #
# #
# # For each overlay use the "key" to set #
# # the options. #
# # Available overlays #
# # KEY COLLECTION #
# # oscars Academy Awards (Oscars) #
# # imdb IMDb Top 250 #
# # rotten Rotten Tomatoes Certified Fresh#
# # metacritic Metacritic Must See #
# # common Commonsense Selection #
# #
# # Available options. Replace "key" with the #
# # desired collection's key from the chart above. #
# #
# # Turn the collection on/off #
# use_key: true #
# # Determines collection order in its section #
# # Sets the weight for that overlay #
# weight_key: #
#############################################################
templates:
Ribbon:
default:
weight_<<key>>: <<weight>>
optional:
- mdb_key
- imdb_key
- allowed_libraries
- use_<<key>>
mdblist_list: https://mdblist.com/lists/plexmetamanager/<<mdb_key>><<library_type>>s
imdb_chart: <<imdb_key>>_<<library_type>>s
allowed_library_types:
- <<use_<<key>>>>
- <<allowed_libraries>>
overlay:
name: <<overlay_name>>
pmm: ribbon/<<key>>
group: ribbon
weight: <<weight_<<key>>>>
horizontal_offset: 0
horizontal_align: right
vertical_offset: 0
vertical_align: bottom
overlays:
Oscars Best Picture:
imdb_list: https://www.imdb.com/search/title/?groups=best_picture_winner
template: {name: Ribbon, key: oscars, weight: 40, allowed_libraries: movie}
IMDb Top 250:
template: {name: Ribbon, imdb_key: top, key: imdb, weight: 30}
Rotten Tomatoes Certified Fresh:
template: {name: Ribbon, mdb_key: certifiedfresh, key: rotten, weight: 20}
Metacritic Must See:
template: {name: Ribbon, mdb_key: metacriticmustsee, key: metacritic, weight: 10}
Commonsense Selection:
template: {name: Ribbon, mdb_key: cssfamilies, key: common, weight: 5}

59
docs/defaults/overlays/runtimes.md Normal file
View file

@ -0,0 +1,59 @@
# Runtimes Overlay
The `runtimes` Default Overlay File is used to create an overlay on of the movie or episodes runtime for all items in your library.
**This file works with Movie and TV Libraries.**
![](images/runtimes.png)
## Config
The below YAML in your config.yml will create the overlays:
```yaml
libraries:
Movies:
overlay_path:
- pmm: runtimes
TV Shows:
overlay_path:
- pmm: runtimes
```
## Template Variables
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Overlay Variables](variables) are available with the default values below as well as the additional Variables below which can be used to customize the file.
| Variable | Default |
|:--------------------|:-----------:|
| `horizontal_offset` | `15` |
| `horizontal_align` | `right` |
| `vertical_offset` | `30` |
| `vertical_align` | `bottom` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `600` |
| `back_height` | `105` |
| Variable | Description & Values |
|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `font` | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Medium.ttf`<br>**Values:** Path to font file |
| `font_style` | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style |
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `55`<br>**Values:** Any Number greater then 0 |
| `font_color` | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any Number greater then 0 |
| `stroke_color` | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
The below is an example config.yml extract with some Template Variables added in to change how the file works.
```yaml
libraries:
TV Shows:
overlay_path:
- pmm: runtimes
font: fonts/Inter-Bold.ttf
```

72
docs/defaults/overlays/runtimes.yml
View file

@ -1,72 +0,0 @@
#############################################################
# Episodes Runtime Overlay #
# Created by Yozora, Bullmoose20, & Sohjiro #
# Credit to Magic815 for base images #
#############################################################
# Call this from your config.yml (Show): #
# overlay_path: #
# - pmm: runtimes #
# template_variables: #
# # Set episode or season to overlay #
# overlay_level: #
# # Set the horizontal offset for the overlay #
# horizontal_offset: 15 #
# # Set the horizontal align for the overlay #
# horizontal_align: right #
# # Set the vertical offset for the overlay #
# vertical_offset: 30 #
# # Set the vertical align for the overlay #
# vertical_align: bottom #
# # Set the font for the overlay #
# font: fonts/Inter-Medium.ttf #
# # Set the font size for the overlay #
# font_size: 55 #
# # Set the font color for the overlay #
# font_color: "#FFFFFF" #
# # Set the back color for the overlay #
# back_color: "#00000099" #
# # Set the back radius for the overlay #
# back_radius: 30 #
# # Set the back width for the overlay #
# back_width: 600 #
# # Set the back height for the overlay #
# back_height: 105 #
#############################################################
templates:
text_runtime_info:
optional:
- overlay_level
default:
overlay: <<overlay_name>>
horizontal_offset: 15
horizontal_align: right
vertical_offset: 30
vertical_align: bottom
font: fonts/Inter-Medium.ttf
font_size: 55
font_color: "#FFFFFF"
back_color: "#00000099"
back_radius: 30
back_width: 600
back_height: 105
collection_level: <<overlay_level>>
overlay:
name: "text(Runtime: <<runtimeH>>h <<runtimeM>>m)"
horizontal_offset: <<horizontal_offset>>
horizontal_align: <<horizontal_align>>
vertical_offset: <<vertical_offset>>
vertical_align: <<vertical_align>>
font: <<font>>
font_size: <<font_size>>
font_color: <<font_color>>
back_color: <<back_color>>
back_radius: <<back_radius>>
back_width: <<back_width>>
back_height: <<back_height>>
overlays:
runtime_info:
template:
- name: text_runtime_info
plex_all: true

208
docs/defaults/overlays/special_release.yml
View file

@ -1,208 +0,0 @@
#############################################################
# Special Release Overlay #
# Created by Yozora, Bullmoose20, & Sohjiro #
# Credit to Magic815 for base images #
#############################################################
# Designed for TRaSH Guides filename naming scheme #
# https://trash-guides.info/ #
# #
# Call this from your config.yml (Movie or Show): #
# If nothing is specified these are the defaults #
# #
# overlay_path: #
# - pmm: special_release #
# template_variables: #
# # Set episode or season to overlay #
# overlay_level: #
# # Set the horizontal offset for the overlay #
# horizontal_offset: 15 #
# # Set the horizontal align for the overlay #
# horizontal_align: left #
# # Set the vertical offset for the overlay #
# vertical_offset: 99 #
# # Set the vertical align for the overlay #
# vertical_align: top #
# #
# # Use the Director's Cut overlay #
# use_directorscut: true #
# # Use the Extended overlay #
# use_extended: true #
# # Use the Uncut overlay #
# use_uncut: true #
# # Use the Unrated overlay #
# use_unrated: true #
# # Use the Special overlay #
# use_special: true #
# # Use the Final Cut overlay #
# use_finalcut: true #
# # Use the Anniversary overlay #
# use_anniversary: true #
# # Use the Collectors overlay #
# use_collector: true #
# # Use the International overlay #
# use_international: true #
# # Use the Theatrical overlay #
# use_theatrical: true #
# # Use the Ultimate overlay #
# use_ultimate: true #
# # Use the IMAX-E overlay #
# use_enhanced: true #
# # Use the IMAX overlay #
# use_imax: true #
# # Use the Remastered overlay #
# use_remastered: true #
# # Use the Criterion overlay #
# use_criterion: true #
#############################################################
templates:
Edition:
conditionals:
vertical_offset:
default: 15
conditions:
- dovetail: true
value: 99
suppress_overlays:
conditions:
- dovetail: true
value:
- 4K-DV
- 4K-HDR
- 4K
- 1080P-DV
- 1080P-HDR
- 1080P
- 720P-DV
- 720P-HDR
- 720P
- 576P-DV
- 576P-HDR
- 576P
- 480P-DV
- 480P-HDR
- 480P
- DV
- HDR
- dovetail: false
value:
- <<overlay_name>>-Dovetail
back_width:
conditions:
- dovetail: false
value: 305
back_height:
conditions:
- dovetail: false
value: 105
optional:
- overlay_level
- use_<<slug>>
- search
default:
overlay: <<overlay_name>>
horizontal_offset: 15
horizontal_align: left
vertical_align: top
back_color: "#00000099"
back_radius: 30
collection_level: <<overlay_level>>
allowed_library_types: <<use_<<slug>>>>
ignore_blank_results: true
suppress_overlays: <<suppress_overlays>>
overlay:
name: <<overlay_name>>
pmm: edition/<<slug>>
group: edition
weight: <<weight>>
horizontal_offset: <<horizontal_offset>>
horizontal_align: <<horizontal_align>>
vertical_offset: <<vertical_offset>>
vertical_align: <<vertical_align>>
back_color: <<back_color>>
back_radius: <<back_radius>>
back_width: <<back_width>>
back_height: <<back_height>>
plex_all: true
filters:
filepath.regex:
- <<regex1>>
- <<regex2>>
- 'edition-(?i)\b<<search>>\b' # New TRaSH naming
- '(?<=[0-9]{4}[)}>\]]\s)\b<<search>>\b' # Original TRaSH naming
overlays:
Directors-Cut:
template: {name: Edition, weight: 150, slug: directorscut, search: (Director|Directors), dovetail: false}
Directors-Cut-Dovetail:
template: {name: Edition, weight: 150, slug: directorscut, search: (Director|Directors), dovetail: true}
Extended-Edition:
template: {name: Edition, weight: 140, slug: extended, search: Extended, dovetail: false}
Extended-Edition-Dovetail:
template: {name: Edition, weight: 140, slug: extended, search: Extended, dovetail: true}
Uncut-Edition:
template: {name: Edition, weight: 130, slug: uncut, search: Uncut, dovetail: false}
Uncut-Edition-Dovetail:
template: {name: Edition, weight: 130, slug: uncut, search: Uncut, dovetail: true}
Unrated-Edition:
template: {name: Edition, weight: 120, slug: unrated, search: Unrated, dovetail: false}
Unrated-Edition-Dovetail:
template: {name: Edition, weight: 120, slug: unrated, search: Unrated, dovetail: true}
Special-Edition:
template: {name: Edition, weight: 110, slug: special, search: Special, dovetail: false}
Special-Edition-Dovetail:
template: {name: Edition, weight: 110, slug: special, search: Special, dovetail: true}
Final-Cut:
template: {name: Edition, weight: 100, slug: finalcut, search: Final, dovetail: false}
Final-Cut-Dovetail:
template: {name: Edition, weight: 100, slug: finalcut, search: Final, dovetail: true}
Anniversary-Edition:
template: {name: Edition, weight: 90, slug: anniversary, search: Anniversary, dovetail: false}
Anniversary-Edition-Dovetail:
template: {name: Edition, weight: 90, slug: anniversary, search: Anniversary, dovetail: true}
Collectors-Edition:
template: {name: Edition, weight: 80, slug: collector, search: (Collector|Collectors), dovetail: false}
Collectors-Edition-Dovetail:
template: {name: Edition, weight: 80, slug: collector, search: (Collector|Collectors), dovetail: true}
International-Cut:
template: {name: Edition, weight: 70, slug: international, search: International, dovetail: false}
International-Cut-Dovetail:
template: {name: Edition, weight: 70, slug: international, search: International, dovetail: true}
Theatrical-Cut:
template: {name: Edition, weight: 60, slug: theatrical, search: Theatrical, dovetail: false}
Theatrical-Cut-Dovetail:
template: {name: Edition, weight: 60, slug: theatrical, search: Theatrical, dovetail: true}
Ultimate-Cut:
template: {name: Edition, weight: 50, slug: ultimate, search: Ultimate, dovetail: false}
Ultimate-Cut-Dovetail:
template: {name: Edition, weight: 50, slug: ultimate, search: Ultimate, dovetail: true}
IMAX-E:
template: {name: Edition, weight: 40, slug: enhanced, dovetail: false, regex1: '(?i)\bIMAX Enhanced\b|^(?=.*(DSNP|Disney\+|CORE(?=[ ._-]web[ ._-]?(dl|rip)\b)|\bBC(?=[ ._-]web[ ._-]?(dl|rip)\b)|IMAX[- .]Enhanced)\b)(?=.*\b(IMAX|IMAX[- .]Enhanced)\b).*'}
IMAX-E-Dovetail:
template: {name: Edition, weight: 40, slug: enhanced, dovetail: true, regex1: '(?i)\bIMAX Enhanced\b|^(?=.*(DSNP|Disney\+|CORE(?=[ ._-]web[ ._-]?(dl|rip)\b)|\bBC(?=[ ._-]web[ ._-]?(dl|rip)\b)|IMAX[- .]Enhanced)\b)(?=.*\b(IMAX|IMAX[- .]Enhanced)\b).*'}
IMAX:
template: {name: Edition, weight: 30, slug: imax, dovetail: false, regex1: '(?i)\bIMAX\b'}
IMAX-Dovetail:
template: {name: Edition, weight: 30, slug: imax, dovetail: true, regex1: '(?i)\bIMAX\b'}
Remastered:
template: {name: Edition, weight: 20, slug: remastered, search: (Remaster|Remastered|4k Remaster|4k Remastered), dovetail: false}
Remastered-Dovetail:
template: {name: Edition, weight: 20, slug: remastered, search: (Remaster|Remastered|4k Remaster|4k Remastered), dovetail: true}
Criterion:
template: {name: Edition, weight: 10, slug: criterion, dovetail: false, regex1: '(?i)Criterion', regex2: '(?i)\[CC\]'}
Criterion-Dovetail:
template: {name: Edition, weight: 10, slug: criterion, dovetail: true, regex1: '(?i)Criterion', regex2: '(?i)\[CC\]'}

71
docs/defaults/overlays/status.md Normal file
View file

@ -0,0 +1,71 @@
# Status Overlay
The `status` Default Overlay File is used to create an overlay on a show detailing its Current Airing Status for all shows in your library.
**This file only works with TV Libraries.**
![](images/status.png)
## Supported Status
| Audio Codec | Key | Weight |
|:------------|:-----------:|:------:|
| AIRING | `airing` | `40` |
| RETURNING | `returning` | `30` |
| CANCELED | `canceled` | `20` |
| ENDED | `ended` | `10` |
## Config
The below YAML in your config.yml will create the overlays:
```yaml
libraries:
Movies:
overlay_path:
- pmm: status
TV Shows:
overlay_path:
- pmm: status
```
## Template Variables
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Overlay Variables](variables) are available with the default values below as well as the additional Variables below which can be used to customize the file.
| Variable | Default |
|:--------------------|:-----------:|
| `horizontal_offset` | `15` |
| `horizontal_align` | `left` |
| `vertical_offset` | `330` |
| `vertical_align` | `top` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_height` | `105` |
| Variable | Description & Values |
|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `last` | **Description:** Episode Air Date in the last number of days for the AIRING Overlay.<br>**Default:** `14`<br>**Values:** Any Number greater then 0 |
| `text_<<key>>` | **Description:** Choose the text for the Overlay.<br>**Default:** <table class="clearTable"><tr><th>Key</th><th>Default</th></tr><tr><td>`airing`</td><td>`AIRING`</td></tr><tr><td>`returning`</td><td>`RETURNING`</td></tr><tr><td>`canceled`</td><td>`CANCELED`</td></tr><tr><td>`ended`</td><td>`ENDED`</td></tr></table><br>**Values:** Any String |
| `weight_<<key>>` | **Description:** Controls the weight of the Overlay. Higher numbers have priority.<br>**Values:** Any Number |
| `font` | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Medium.ttf`<br>**Values:** Path to font file |
| `font_style` | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style |
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `50`<br>**Values:** Any Number greater then 0 |
| `font_color` | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any Number greater then 0 |
| `stroke_color` | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
The below is an example config.yml extract with some Template Variables added in to change how the file works.
```yaml
libraries:
Movies:
overlay_path:
- pmm: status
text_canceled: CANCELLED
```

71
docs/defaults/overlays/streaming.md Normal file
View file

@ -0,0 +1,71 @@
# Streaming Services Overlay
The `streaming` Default Overlay File is used to create an overlay based on the streaming service the file is found on for each item within your library.
**This file works with Movie and TV Libraries.**
![](images/streaming.png)
## Supported Streaming Services
| Streaming Service | Key | Weight |
|:------------------|:-----------:|:------:|
| Netflix | `netflix` | `90` |
| Prime Video | `amazon` | `80` |
| Disney+ | `disney` | `70` |
| HBO Max | `hbomax` | `60` |
| YouTube | `youtube` | `50` |
| Hulu | `hulu` | `40` |
| Paramount+ | `paramount` | `30` |
| AppleTV | `appletv` | `20` |
| Peacock | `peacock` | `10` |
## Config
The below YAML in your config.yml will create the overlays:
```yaml
libraries:
Movies:
overlay_path:
- pmm: streaming
TV Shows:
overlay_path:
- pmm: streaming
```
## Template Variables
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Overlay Variables](variables) are available with the default values below as well as the additional Variables below which can be used to customize the file.
| Variable | Default |
|:--------------------|:-----------:|
| `horizontal_offset` | `15` |
| `horizontal_align` | `left` |
| `vertical_offset` | `150` |
| `vertical_align` | `bottom` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_height` | `105` |
| Variable | Description & Values |
|:-----------------|:-------------------------------------------------------------------------------------------------------------|
| `weight_<<key>>` | **Description:** Controls the weight of the Overlay. Higher numbers have priority.<br>**Values:** Any Number |
The below is an example config.yml extract with some Template Variables added in to change how the file works.
```yaml
libraries:
Movies:
overlay_path:
- pmm: streaming
template_variables:
use_peacock: false
use_youtube: false
weight_youtube: 5
```

109
docs/defaults/overlays/streaming.yml
View file

@ -1,109 +0,0 @@
#############################################################
# Streaming Overlay #
# Created by Yozora, Bullmoose20, & Sohjiro #
# Credit to Magic815 for base images #
#############################################################
# Call this from your config.yml (Movie or Show): #
# If nothing is specified these are the defaults #
# #
# overlay_path: #
# - git: PMM/overlays/streaming #
# template_variables: #
# # Set the horizontal offset for the overlay #
# horizontal_offset: 15 #
# # Set the horizontal align for the overlay #
# horizontal_align: left #
# # Set the vertical offset for the overlay #
# vertical_offset: 150 #
# # Set the vertical align for the overlay #
# vertical_align: bottom #
# # Set the back color for the overlay #
# back_color: "#00000099" #
# # Set the back radius for the overlay #
# back_radius: 30 #
# # Set the back width for the overlay #
# back_width: 305 #
# # Set the back height for the overlay #
# back_height: 105 #
# #
# # Use the Amazon overlay #
# use_amazon: true #
# # Use the AppleTV overlay #
# use_appletv: true #
# # Use the Disney overlay #
# use_disney: true #
# # Use the HBO-Max overlay #
# use_hbomax: true #
# # Use the Hulu overlay #
# use_hulu: true #
# # Use the Netflix overlay #
# use_netflix: true #
# # Use the Paramount overlay #
# use_paramount: true #
# # Use the Peacock overlay #
# use_peacock: true #
# # Use the YouTube overlay #
# use_youtube: true #
#############################################################
templates:
Streaming:
optional:
- overlay_level
- use_<<slug>>
default:
overlay: <<overlay_name>>
horizontal_offset: 15
horizontal_align: left
vertical_offset: 150
vertical_align: bottom
back_color: "#00000099"
back_radius: 30
back_width: 305
back_height: 105
overlay_level: <<overlay_level>>
allowed_library_types: <<use_<<slug>>>>
ignore_blank_results: true
overlay:
name: <<overlay_name>>
pmm: streaming/<<overlay>>
group: streaming
weight: <<weight>>
horizontal_offset: <<horizontal_offset>>
horizontal_align: <<horizontal_align>>
vertical_offset: <<vertical_offset>>
vertical_align: <<vertical_align>>
back_color: <<back_color>>
back_radius: <<back_radius>>
back_width: <<back_width>>
back_height: <<back_height>>
mdblist_list: https://mdblist.com/lists/plexmetamanager/<<slug>>-<<library_type>>s
overlays:
Netflix:
template: {name: Streaming, weight: 200, slug: netflix}
Prime:
template: {name: Streaming, weight: 190, slug: amazon}
Disney:
template: {name: Streaming, weight: 180, slug: disney}
HBO-Max:
template: {name: Streaming, weight: 170, slug: hbomax}
YouTube:
template: {name: Streaming, weight: 160, slug: youtube}
Hulu:
template: {name: Streaming, weight: 150, slug: hulu}
Paramount:
template: {name: Streaming, weight: 140, slug: paramount}
AppleTV:
template: {name: Streaming, weight: 130, slug: appletv}
Peacock:
template: {name: Streaming, weight: 120, slug: peacock}

30
docs/defaults/overlays/variables.md Normal file
View file

@ -0,0 +1,30 @@
# Shared Overlay Template Variables
There are some `templates_variables` that all the PMM Defaults expect `franchise` can use to manipulate the file from the default settings which are provided.
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
Below are the available variables which can be used to customize the file.
| Variable | Description & Values |
|:--------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_<<key>>`<sup>1</sup> | **Description:** Turns off individual Overlays in a Defaults file.<br>**Values:** `false` to turn off the overlay |
| `file` | **Description:** Controls the image associated with the Overlay to a local file. Use `pmm: null` with this to no use the default image.<br>**Values:** Filepath to Overlay Image |
| `url` | **Description:** Controls the image associated with the Overlay to a url. Use `pmm: null` with this to no use the default image.<br>**Values:** URL to Overlay Image |
| `git` | **Description:** Controls the image associated with the Overlay to the git repo. Use `pmm: null` with this to no use the default image.<br>**Values:** Git Path to Overlay Image |
| `repo` | **Description:** Controls the image associated with the Overlay to a custom repo. Use `pmm: null` with this to no use the default image.<br>**Values:** Repo Path to Overlay Image |
| `pmm` | **Description:** Controls the image associated with the Overlay to a pmm file.<br>**Values:** PMM Overlay Image |
| `horizontal_offset` | **Description:** Controls the Horizontal Offset of this overlay. Can be a %.<br>**Values:** Number 0 or greater or 0%-100% |
| `horizontal_align` | **Description:** Controls the Horizontal Alignment of the overlay.<br>**Values:** `left`, `center`, or `right` |
| `vertical_offset` | **Description:** Controls the Vertical Offset of this overlay. Can be a %.<br>**Values:** Number 0 or greater or 0%-100% |
| `vertical_align` | **Description:** Controls the Vertical Alignment of the overlay.<br>**Values:** `top`, `center`, or `bottom` |
| `back_color` | **Description:** Controls the Backdrop Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
| `back_width` | **Description:** Controls the Backdrop Width for the Text Overlay. If `back_width` is not specified the Backdrop Sizes to the text<br>**Values:** Any Number greater then 0 |
| `back_height` | **Description:** Controls the Backdrop Height for the Text Overlay. If `back_height` is not specified the Backdrop Sizes to the text<br>**Values:** Any Number greater then 0 |
| `back_align` | **Description:** Controls the Alignment for the Text Overlay inside the backdrop. If `back_align` is not specified the Backdrop Centers the text.<br>**Values:** `left`, `right`, `center`, `top`, or `bottom` |
| `back_padding` | **Description:** Controls the Backdrop Padding for the Text Overlay.<br>**Values:** Any Number greater then 0 |
| `back_radius` | **Description:** Controls the Backdrop Radius for the Text Overlay.<br>**Values:** Any Number greater then 0 |
| `back_line_color` | **Description:** Controls the Backdrop Line Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
| `back_line_width` | **Description:** Controls the Backdrop Line Width for the Text Overlay.<br>**Values:** Any Number greater then 0 |
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.

61
docs/defaults/overlays/versions.md Normal file
View file

@ -0,0 +1,61 @@
# Versions Overlay
The `versions` Default Overlay File is used to create an overlay based on if there's multiple versions on each item within your library.
**This file works with Movie and TV Libraries.**
![](images/versions.png)
## Config
The below YAML in your config.yml will create the overlays:
```yaml
libraries:
Movies:
overlay_path:
- pmm: versions
TV Shows:
overlay_path:
- pmm: versions
- pmm: versions
template_variables:
overlay_level: season
- pmm: versions
template_variables:
overlay_level: episode
```
## Template Variables
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
All [Shared Overlay Variables](variables) are available with the default values below as well as the additional Variables below which can be used to customize the file.
| Variable | Default |
|:--------------------|:-----------:|
| `horizontal_offset` | `15` |
| `horizontal_align` | `right` |
| `vertical_offset` | `150` |
| `vertical_align` | `top` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `105` |
| `back_height` | `105` |
| Variable | Description & Values |
|:-----------------|:-------------------------------------------------------------------------------------------------------------|
| `overlay_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` |
The below is an example config.yml extract with some Template Variables added in to change how the file works.
```yaml
libraries:
Movies:
overlay_path:
- pmm: versions
template_variables:
font_color: "#FFFFFF99"
```

Some files were not shown because too many files have changed in this diff Show more