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 Show Libraries.

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:

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 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	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. Default: 14 Values: Any Number greater then 0
text_<<key>>1	Description: Choose the text for the Overlay. Default: Key Default airing AIRING returning RETURNING canceled CANCELED ended ENDED 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 collection 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: status
        template_variables:
          text_canceled: CANCELLED