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.
Requirements & Recommendations¶
Supported Overlay Level: Show
Supported Status¶
Status |
Key |
Weight |
---|---|---|
AIRING |
|
|
RETURNING |
|
|
CANCELED |
|
|
ENDED |
|
|
Config¶
The below YAML in your config.yml will create the overlays:
libraries:
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 |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Variable |
Description & Values |
||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
Description: Episode Air Date in the last number of days for the AIRING Overlay. |
||||||||||
|
Description: Choose the text for the Overlay.
|
||||||||||
|
Description: Controls the weight of the Overlay. Higher numbers have priority. |
||||||||||
|
Description: Choose the font for the Overlay. |
||||||||||
|
Description: Font style for Variable Fonts. |
||||||||||
|
Description: Choose the font size for the Overlay. |
||||||||||
|
Description: Choose the font color for the Overlay. |
||||||||||
|
Description: Font Stroke Width for the Text Overlay. |
||||||||||
|
Description: Font Stroke Color for the Text Overlay. |
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:
TV Shows:
overlay_path:
- pmm: status
template_variables:
text_canceled: "C A N C E L L E D"