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.

Show status is sourced from TMDB.

Requirements & Recommendations¶

Supported Overlay Level: Show

Supported Status¶

Status	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:
  TV Shows:
    overlay_files:
      - default: 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 will use its default value if it has one if not it's just ignored.

Variable Lists (click to expand)

File-Specific Template Variables are variables available specifically for this Kometa Defaults file.
Overlay Template Variables are additional variables shared across the Kometa Overlay Defaults.
Overlay Text Template Variables are additional variables shared across the Kometa Text Overlay Defaults.

Default Template Variable Values (click to expand)

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`

File-Specific Template VariablesOverlay Template VariablesOverlay Text Template Variables

Variable Description & Values

last Description: Episode Air Date in the last number of days for the AIRING Overlay.
Default: 14
Values: Any number greater than 0

text_<<key>>¹

Description: Choose the text for the Overlay.
Default:

Key	Default
`airing`	`AIRING`
`returning`	`RETURNING`
`canceled`	`CANCELED`
`ended`	`ENDED`

Values: Any String

weight_<<key>>¹ Description: Controls the weight of the Overlay. Higher numbers have priority.
Values: Any Number

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

Variable	Description & Values
`use_<<key>>`¹	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>>`¹	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>>`¹	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>>`¹	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>>`¹	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

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

Variable	Description & Values
`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: `55` Values: Any number greater than 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 Overlay. Values: Any number greater than 0
`stroke_color`	Description: Font Stroke Color for the Overlay. Values: Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA`
`font_<<key>>`	Description: Choose the font for this key's Overlay. Default: `fonts/Inter-Medium.ttf` Values: Path to font file
`font_style_<<key>>`	Description: Font style for this key's Variable Fonts. Values: Variable Font Style
`font_size_<<key>>`	Description: Choose the font size for this key's Overlay. Default: `55` Values: Any number greater than 0
`font_color_<<key>>`	Description: Choose the font color for this key's Overlay. Default: `#FFFFFF` Values: Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA`
`stroke_width_<<key>>`	Description: Font Stroke Width for this key's Overlay. Values: Any number greater than 0
`stroke_color_<<key>>`	Description: Font Stroke Color for this key's Overlay. Values: Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA`

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:
  TV Shows:
    overlay_files:
      - default: status
        template_variables:
          text_canceled: "C A N C E L L E D"