You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Plex-Meta-Manager/docs/defaults/overlay_variables.md

6.0 KiB

Variable Description & Values
use_<<key>>1 Description: Turns off individual Overlays in a Defaults file.
Values: false to turn off the overlay
file Description: Controls the images associated with all the Overlays to a local file.
Values: Filepath to Overlay Image
file_<<key>>1 Description: Controls the image associated with this key's Overlay to a local file.
Values: Filepath to Overlay Image
url Description: Controls the images associated with all the Overlays to a url.
Values: URL to Overlay Image
url_<<key>>1 Description: Controls the image associated with this key's Overlay to a url.
Values: URL to Overlay Image
git Description: Controls the images associated with all the Overlays to the git repo.
Values: Git Path to Overlay Image
git_<<key>>1 Description: Controls the image associated with this key's Overlay to the git repo.
Values: Git Path to Overlay Image
repo Description: Controls the images associated with all the Overlays to a custom repo.
Values: Repo Path to Overlay Image
repo_<<key>>1 Description: Controls the image associated with this key's Overlay to a custom repo.
Values: Repo Path to Overlay Image
horizontal_offset Description: Controls the Horizontal Offset of this overlay. Can be a %.
Values: Number 0 or greater or 0%-100%
horizontal_align Description: Controls the Horizontal Alignment of the overlay.
Values: left, center, or right
vertical_offset Description: Controls the Vertical Offset of this overlay. Can be a %.
Values: Number 0 or greater or 0%-100%
vertical_align Description: Controls the Vertical Alignment of the overlay.
Values: top, center, or bottom
back_color Description: Controls the Backdrop Color for the Text Overlay.
Values: Color Hex Code in format #RGB, #RGBA, #RRGGBB or #RRGGBBAA
AA is transparency; 00 [transparent] to FF [opaque]
back_width Description: Controls the Backdrop Width for the Text Overlay. If back_width is not specified the Backdrop Sizes to the text
Values: Any number greater than 0
back_height Description: Controls the Backdrop Height for the Text Overlay. If back_height is not specified the Backdrop Sizes to the text
Values: Any number greater than 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.
Values: left, right, center, top, or bottom
back_padding Description: Controls the Backdrop Padding for the Text Overlay.
Values: Any number greater than 0
back_radius Description: Controls the Backdrop Radius for the Text Overlay.
Values: Any number greater than 0
back_line_color Description: Controls the Backdrop Line Color for the Text Overlay.
Values: Color Hex Code in format #RGB, #RGBA, #RRGGBB or #RRGGBBAA``AA is transparency; 00 [transparent] to FF [opaque]
back_line_width Description: Controls the Backdrop Line Width for the Text Overlay.
Values: Any number greater than 0
  1. Each default overlay has a key that when calling to effect a specific collection you must replace <<key>> with when calling.