2022-10-17 06:48:08 +00:00
|
|
|
# MediaStinger Overlay
|
|
|
|
|
2024-01-07 08:07:13 +00:00
|
|
|
The `mediastinger` Default Overlay File is used to create an overlay based on if there's an after/during credit scene on
|
|
|
|
each movie within your library.
|
2022-10-17 06:48:08 +00:00
|
|
|
|
|
|
|
![](images/mediastinger.png)
|
|
|
|
|
2023-01-21 00:20:33 +00:00
|
|
|
## Requirements & Recommendations
|
|
|
|
|
|
|
|
Supported Overlay Level: Movie
|
|
|
|
|
2022-10-17 06:48:08 +00:00
|
|
|
## Config
|
|
|
|
|
|
|
|
The below YAML in your config.yml will create the overlays:
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
libraries:
|
|
|
|
Movies:
|
2023-12-12 22:03:15 +00:00
|
|
|
overlay_files:
|
2022-10-17 06:48:08 +00:00
|
|
|
- pmm: mediastinger
|
|
|
|
```
|
|
|
|
|
2023-12-31 16:45:00 +00:00
|
|
|
## Template Variables
|
2022-10-17 06:48:08 +00:00
|
|
|
|
2024-01-07 08:07:13 +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.
|
2022-10-17 06:48:08 +00:00
|
|
|
|
2024-01-07 08:07:13 +00:00
|
|
|
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.
|
2023-11-29 15:23:04 +00:00
|
|
|
|
2024-01-07 08:07:13 +00:00
|
|
|
??? abstract "Variable Lists (click to expand)"
|
|
|
|
|
|
|
|
* **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults.
|
2023-11-29 15:23:04 +00:00
|
|
|
|
2024-01-05 21:55:28 +00:00
|
|
|
??? example "Default Template Variable Values (click to expand)"
|
2024-01-05 21:06:39 +00:00
|
|
|
|
|
|
|
| Variable | Default |
|
|
|
|
|:--------------------|:------------|
|
|
|
|
| `horizontal_offset` | `200` |
|
|
|
|
| `horizontal_align` | `right` |
|
|
|
|
| `vertical_offset` | `15` |
|
|
|
|
| `vertical_align` | `top` |
|
|
|
|
| `back_color` | `#00000099` |
|
|
|
|
| `back_radius` | `30` |
|
|
|
|
| `back_width` | `105` |
|
|
|
|
| `back_height` | `105` |
|
|
|
|
|
2024-01-07 08:07:13 +00:00
|
|
|
=== "Overlay Template Variables"
|
2023-12-31 16:45:00 +00:00
|
|
|
|
2024-01-07 08:07:13 +00:00
|
|
|
{%
|
|
|
|
include-markdown "../overlay_variables.md"
|
|
|
|
%}
|
|
|
|
|
|
|
|
???+ example "Example Template Variable Amendments"
|
2023-12-31 16:45:00 +00:00
|
|
|
|
|
|
|
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
2024-01-07 08:07:13 +00:00
|
|
|
|
2023-12-31 16:45:00 +00:00
|
|
|
```yaml
|
|
|
|
libraries:
|
|
|
|
Movies:
|
|
|
|
overlay_files:
|
|
|
|
- pmm: mediastinger
|
|
|
|
template_variables:
|
|
|
|
font_color: "#FFFFFF99"
|
|
|
|
```
|