Plex-Meta-Manager/docs/defaults/overlays/mediastinger.md

66 lines
1.9 KiB
Markdown
Raw Normal View History

# 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.
![](images/mediastinger.png)
## Requirements & Recommendations
Supported Overlay Level: Movie
## Config
The below YAML in your config.yml will create the overlays:
```yaml
libraries:
Movies:
overlay_files:
- pmm: mediastinger
```
2023-12-31 16:45:00 +00:00
## Template Variables
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.
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.
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.
??? 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"
```