Mirrors/Plex-Meta-Manager
2
0
Fork 0
mirror of https://github.com/meisnate12/Plex-Meta-Manager synced 2024-11-14 00:37:22 +00:00
Code Issues Projects Releases Packages Wiki Activity
Plex-Meta-Manager/docs/defaults/overlays/aspect.md
bullmoose20 70e2ac071b added aspect ratio wiki documentation
2023-06-25 22:29:05 -04:00

7.5 KiB
Raw Blame History

Status Overlay

The aspect Default Overlay File is used to create an overlay on a show detailing its Current Airing Status for all shows in your library.

Requirements & Recommendations

Supported Overlay Level: Movie, Show

Supported Status

Status 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:
          overlay_level: episode
      - pmm: aspect
        template_variables:
          overlay_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:
KeyDefault
1.331.33
1.651.65
1.661.66
1.781.78
1.851.85
2.22.2
2.352.35
2.772.77
Values: Any String
weight_<<key>>1 Description: Controls the weight of the Overlay. Higher numbers have priority.
Values: Any Number
font Description: Choose the font for the Overlay.
Default: fonts/Inter-Medium.ttf
Values: Path to font file
font_style Description: Font style for Variable Fonts.
Values: Variable Font Style
font_size Description: Choose the font size for the Overlay.
Default: 50
Values: Any Number greater then 0
font_color Description: Choose the font color for the Overlay.
Default: #FFFFFF
Values: Color Hex Code in format #RGB, #RGBA, #RRGGBB or #RRGGBBAA
stroke_width Description: Font Stroke Width for the Text Overlay.
Values: Any Number greater then 0
stroke_color Description: Font Stroke Color for the Text Overlay.
Values: Color Hex Code in format #RGB, #RGBA, #RRGGBB or #RRGGBBAA
  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"