Plex-Meta-Manager/docs/defaults/overlays/aspect.md

Aspect Overlay

The aspect Default Overlay File is used to create an overlay on a show/movie detailing its aspect ratio.

Requirements & Recommendations

Supported Overlay Level: Movie, Show

Supported Status

Aspect	Key	Weight
1.33	1.33	80
1.65	1.65	70
1.66	1.66	60
1.78	1.78	50
1.85	1.85	40
2.2	2.2	30
2.35	2.35	20
2.77	2.77	10

Config

The below YAML in your config.yml will create the overlays:

libraries:
  Movies:
    overlay_path:
      - pmm: aspect
  TV Shows:
    overlay_path:
      - pmm: aspect
      - pmm: aspect
        template_variables:
          builder_level: episode
      - pmm: aspect
        template_variables:
          builder_level: season

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 template_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 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	150
horizontal_align	center
vertical_offset	0
vertical_align	bottom
back_color	#00000099
back_radius	30
back_width	305
back_height	105

Variable	Description & Values
text_<<key>>1	Description: Choose the text for the Overlay. Default: Key Default 1.33 1.33 1.65 1.65 1.66 1.66 1.78 1.78 1.85 1.85 2.2 2.2 2.35 2.35 2.77 2.77 Values: Any String
weight_<<key>>1	Description: Controls the weight of the Overlay. Higher numbers have priority. Values: Any Number

1. Each default overlay has a key that when calling to effect a specific overlay you must replace <<key>> with when calling.

The below is an example config.yml extract with some Template Variables added in to change how the file works.

libraries:
  Movies:
    overlay_path:
      - pmm: aspect
        template_variables:
          text_1.33: "4:9"
          text_1.77: "16:9"
  TV Shows:
    overlay_path:
      - pmm: aspect
        template_variables:
          text_1.33: "4:9"
          text_1.77: "16:9"
      - pmm: aspect
        template_variables:
          overlay_level: episode
          text_1.33: "4:9"
          text_1.77: "16:9"
      - pmm: aspect
        template_variables:
          overlay_level: season
          text_1.33: "4:9"
          text_1.77: "16:9"