You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
6.1 KiB
6.1 KiB
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 | 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:
- pmm: status
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 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
horizontal_offset |
15 |
||||||||||
horizontal_align |
left |
||||||||||
vertical_offset |
330 |
||||||||||
vertical_align |
top |
||||||||||
back_color |
#00000099 |
||||||||||
back_radius |
30 |
||||||||||
back_width |
305 |
||||||||||
back_height |
105 |
||||||||||
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>> 1 |
Description: Choose the text for the Overlay. Default:
|
||||||||||
weight_<<key>> 1 |
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.
{% 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:
TV Shows:
overlay_files:
- pmm: status
template_variables:
text_canceled: "C A N C E L L E D"