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.
87 lines
7.7 KiB
87 lines
7.7 KiB
# Video Format Overlay
|
|
|
|
The `video_format` Default Overlay File is used to create an overlay based on the video format available on each item within your library.
|
|
|
|
|
|
|
|
## Requirements & Recommendations
|
|
|
|
Supported Overlay Level: Movie, Show, Season, Episode
|
|
|
|
Recommendations: Designed for [TRaSH Guides](https://trash-guides.info/) filename naming scheme
|
|
|
|
## Supported Video Formats
|
|
|
|
| Video Format | Key | Weight |
|
|
|:-------------|:---------|:-------|
|
|
| REMUX | `remux` | `60` |
|
|
| BLU-RAY | `bluray` | `50` |
|
|
| WEB | `web` | `40` |
|
|
| HDTV | `hdtv` | `30` |
|
|
| DVD | `dvd` | `20` |
|
|
| SDTV | `sdtv` | `10` |
|
|
|
|
## Config
|
|
|
|
The below YAML in your config.yml will create the overlays:
|
|
|
|
```yaml
|
|
libraries:
|
|
Movies:
|
|
overlay_path:
|
|
- pmm: video_format
|
|
TV Shows:
|
|
overlay_path:
|
|
- pmm: video_format
|
|
- pmm: video_format
|
|
template_variables:
|
|
builder_level: season
|
|
- pmm: video_format
|
|
template_variables:
|
|
builder_level: episode
|
|
```
|
|
|
|
## Template Variable Default Values
|
|
|
|
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.
|
|
|
|
| Variable | Default / Values |
|
|
|:-----------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| `horizontal_offset` | `15` |
|
|
| `horizontal_align` | `left` |
|
|
| `vertical_offset` | `30` |
|
|
| `vertical_align` | `bottom` |
|
|
| `back_color` | `#00000099` |
|
|
| `back_radius` | `30` |
|
|
| `back_width` | `305` |
|
|
| `back_height` | `105` |
|
|
| `builder_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` |
|
|
| `text_<<key>>`<sup>1</sup> | **Description:** Choose the text for the Overlay.<br>**Default:** <table class="clearTable"><tr><th>Key</th><th>Default</th></tr><tr><td>`remux`</td><td>`REMUX`</td></tr><tr><td>`bluray`</td><td>`BLU-RAY`</td></tr><tr><td>`web`</td><td>`WEB`</td></tr><tr><td>`hdtv`</td><td>`HDTV`</td></tr><tr><td>`dvd`</td><td>`DVD`</td></tr><tr><td>`sdtv`</td><td>`SDTV`</td></tr></table>**Values:** Any String |
|
|
| `weight_<<key>>`<sup>1</sup> | **Description:** Controls the weight of the Overlay. Higher numbers have priority.<br>**Values:** Any Number |
|
|
| `regex_<<key>>`<sup>1</sup> | **Description:** Controls the regex of the Overlay Search.<br>**Values:** Any Proper Regex |
|
|
|
|
1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` with when calling.
|
|
|
|
{%
|
|
include-markdown "../overlay_variables.md"
|
|
%}
|
|
|
|
{%
|
|
include-markdown "../overlay_text_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_path:
|
|
- pmm: video_format
|
|
template_variables:
|
|
text_bluray: BLURAY
|
|
use_sdtv: false
|
|
use_dvd: false
|
|
```
|