2022-10-17 06:48:08 +00:00
# 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.
2023-01-21 00:20:33 +00:00
## Requirements & Recommendations
Supported Overlay Level: Show
2022-10-17 06:48:08 +00:00
## Supported Status
2023-01-17 11:36:18 +00:00
| Status | Key | Weight |
|:----------|:------------|:-------|
| AIRING | `airing` | `40` |
| RETURNING | `returning` | `30` |
| CANCELED | `canceled` | `20` |
| ENDED | `ended` | `10` |
2022-10-17 06:48:08 +00:00
## Config
The below YAML in your config.yml will create the overlays:
```yaml
libraries:
TV Shows:
2023-12-12 22:03:15 +00:00
overlay_files:
2022-10-17 06:48:08 +00:00
- pmm: status
```
2023-11-29 15:23:04 +00:00
## Template Variable Default Values
2022-10-17 06:48:08 +00:00
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.
2023-11-29 15:23:04 +00:00
| Variable | Default / Values |
2022-10-17 12:13:48 +00:00
|:-----------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
2023-11-29 15:23:04 +00:00
| `horizontal_offset` | `15` |
| `horizontal_align` | `left` |
| `vertical_offset` | `330` |
| `vertical_align` | `top` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_height` | `105` |
2023-09-25 23:10:21 +00:00
| `last` | **Description:** Episode Air Date in the last number of days for the AIRING Overlay.< br > **Default:** `14` < br > **Values:** Any number greater than 0 |
2022-10-17 12:13:48 +00:00
| `text_<<key>>` < sup > 1</ sup > | **Description:** Choose the text for the Overlay.< br > **Default:** < table class = "clearTable" >< tr >< th > Key</ th >< th > Default</ th ></ tr >< tr >< td > `airing`</ td >< td > `AIRING`</ td ></ tr >< tr >< td > `returning`</ td >< td > `RETURNING`</ td ></ tr >< tr >< td > `canceled`</ td >< td > `CANCELED`</ td ></ tr >< tr >< td > `ended`</ td >< td > `ENDED`</ td ></ tr ></ table > **Values:** Any String |
| `weight_<<key>>` < sup > 1</ sup > | **Description:** Controls the weight of the Overlay. Higher numbers have priority.< br > **Values:** Any Number |
2023-04-05 15:58:46 +00:00
1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` with when calling.
2022-10-17 06:48:08 +00:00
2023-11-29 15:23:04 +00:00
{%
include-markdown "../overlay_variables.md"
%}
{%
include-markdown "../overlay_text_variables.md"
%}
## Example Template Variable Amendments
2022-10-17 06:48:08 +00:00
The below is an example config.yml extract with some Template Variables added in to change how the file works.
```yaml
libraries:
2023-01-17 11:36:18 +00:00
TV Shows:
2023-12-12 22:03:15 +00:00
overlay_files:
2022-10-17 06:48:08 +00:00
- pmm: status
2023-01-06 17:53:05 +00:00
template_variables:
2023-01-27 13:40:34 +00:00
text_canceled: "C A N C E L L E D"
2022-10-17 06:48:08 +00:00
```
