7.8 KiB

Raw Blame History

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 Variable Default Values

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.

Variable( ) Default / Values( / Values )

horizontal_offset 150

horizontal_align center

vertical_offset 0

vertical_align bottom

back_color #00000099

back_radius 30

back_width 305

back_height 105

text_<<key>>¹

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>>¹ Description: Controls the weight of the Overlay. Higher numbers have priority.
Values: Any Number

{% include-markdown "../overlay_variables.md" %}

{% include-markdown "../overlay_text_variables.md" %}

Example Template Variable Amendments

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"

7.8 KiB Raw Blame History