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.
2.8 KiB
2.8 KiB
Runtimes Overlay
The runtimes Default Overlay File is used to create an overlay of the movie runtime, episode runtime, or average episode runtime for all items in your library.
Requirements & Recommendations
Supported Overlay Level: Movie, Show, Season, Episode
Config
The below YAML in your config.yml will create the overlays:
libraries:
Movies:
overlay_files:
- pmm: runtimes
TV Shows:
overlay_files:
- pmm: runtimes
- pmm: runtimes
template_variables:
builder_level: episode
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` | `right` |
| `vertical_offset` | `30` |
| `vertical_align` | `bottom` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `600` |
| `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 |
|:----------|:-----------------------------------------------------------------------------------------------------------------------------------------|
| `text` | **Description:** Choose the text that appears prior to the runtime on the Overlay.<br>**Default:** `Runtime: `<br>**Values:** Any String |
=== "Overlay Template Variables"
{%
include-markdown "../overlay_text_variables.md"
%}
{%
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:
TV Shows:
overlay_files:
- pmm: runtimes
template_variables:
builder_level: episode
font: fonts/Inter-Bold.ttf
```