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

50 lines
1.6 KiB
Markdown

# MediaStinger Overlay
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_path:
- pmm: mediastinger
```
## 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](../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 |
|:--------------------|:------------|
| `horizontal_offset` | `200` |
| `horizontal_align` | `right` |
| `vertical_offset` | `15` |
| `vertical_align` | `top` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `105` |
| `back_height` | `105` |
The below is an example config.yml extract with some Template Variables added in to change how the file works.
```yaml
libraries:
Movies:
overlay_path:
- pmm: mediastinger
template_variables:
font_color: "#FFFFFF99"
```