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.
3.1 KiB
3.1 KiB
Studio Overlay
The studio Default Overlay File is used to create an overlay based on the show studio on each item within your library.
Requirements & Recommendations
Supported library types: Movie / Show
Config
The below YAML in your config.yml will create the overlays:
libraries:
Movies:
overlay_files:
- pmm: studio
TV Shows:
overlay_files:
- pmm: studio
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 will use its default value if it has one if not it's just ignored.
??? info "Click to expand"
??? example "Default Template Variable Values (click to expand)"
| Variable | Default |
|:--------------------|:------------|
| `horizontal_offset` | `15` |
| `horizontal_align` | `left` |
| `vertical_offset` | `150` |
| `vertical_align` | `bottom` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_height` | `105` |
=== "File-Specific Template Variables"
The below template variables are available specifically for this PMM Defaults file.
Be sure to also check out the "Overlay Template Variables" tab for additional variables.
| Variable | Description & Values |
|:----------------|:-------------------------------------------------------------------------------------------------|
| `builder_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` |
| `style` | **Description:** Choose between the standard size or the **bigger** one.<br>**Values:** `bigger` |
Preview of the bigger style
=== "Overlay Template Variables"
{%
include-markdown "../overlay_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.
```yaml
libraries:
Movies:
overlay_files:
- pmm: studio
template_variables:
vertical_offset: 390
TV Shows:
overlay_files:
- pmm: studio
- pmm: studio
template_variables:
builder_level: season
vertical_align: bottom
vertical_offset: 15
horizontal_align: left
horizontal_offset: 15
style: bigger
- pmm: studio
template_variables:
builder_level: episode
vertical_align: top
vertical_offset: 15
```