2022-10-17 06:48:08 +00:00
# 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.
2023-01-21 00:20:33 +00:00
2022-10-17 06:48:08 +00:00
2023-01-21 00:20:33 +00:00
## Requirements & Recommendations
2022-10-17 06:48:08 +00:00
2023-01-21 00:20:33 +00:00
Supported Overlay Level: Movie, Show, Season, Episode
Recommendations: Designed for [TRaSH Guides ](https://trash-guides.info/ ) filename naming scheme
2022-10-17 06:48:08 +00:00
## Supported Video Formats
2022-11-16 14:30:04 +00:00
| Video Format | Key | Weight |
|:-------------|:---------|:-------|
| REMUX | `remux` | `60` |
| BLU-RAY | `bluray` | `50` |
| WEB | `web` | `40` |
| HDTV | `hdtv` | `30` |
| DVD | `dvd` | `20` |
| SDTV | `sdtv` | `10` |
2022-10-17 06:48:08 +00:00
## Config
The below YAML in your config.yml will create the overlays:
```yaml
libraries:
Movies:
2023-12-12 22:03:15 +00:00
overlay_files:
2023-01-27 13:40:34 +00:00
- pmm: video_format
2022-10-17 06:48:08 +00:00
TV Shows:
2023-12-12 22:03:15 +00:00
overlay_files:
2022-10-17 06:48:08 +00:00
- pmm: video_format
- pmm: video_format
template_variables:
2023-05-18 14:18:30 +00:00
builder_level: season
2022-10-17 06:48:08 +00:00
- pmm: video_format
template_variables:
2023-05-18 14:18:30 +00:00
builder_level: episode
2022-10-17 06:48:08 +00:00
```
2023-12-31 16:45:00 +00:00
## Template Variables
2022-10-17 06:48:08 +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.
2023-12-31 16:45:00 +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.
2022-10-17 12:13:48 +00:00
2023-12-31 16:45:00 +00:00
??? info "Click to expand"
2022-10-17 06:48:08 +00:00
2024-01-05 21:06:39 +00:00
??? example "Default Templatye Variable Values (click to expand)"
| Variable | Default |
|:--------------------|:------------|
| `horizontal_offset` | `15` |
| `horizontal_align` | `left` |
| `vertical_offset` | `30` |
| `vertical_align` | `bottom` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_height` | `105` |
2023-12-31 16:45:00 +00:00
=== "File-Specific Template Variables"
2023-11-29 15:23:04 +00:00
2023-12-31 16:45:00 +00:00
The below template variables are available specifically for this PMM Defaults file.
2023-11-29 15:23:04 +00:00
2023-12-31 16:45:00 +00:00
Be sure to also check out the "Overlay Template Variables" tab for additional variables.
2023-11-29 15:23:04 +00:00
2024-01-05 21:06:39 +00:00
| Variable | Description & Values |
2023-12-31 16:45:00 +00:00
|:-----------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `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 |
2022-10-17 06:48:08 +00:00
2023-12-31 16:45:00 +00:00
1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` with when calling.
=== "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:
Movies:
overlay_files:
- pmm: video_format
template_variables:
text_bluray: BLURAY
use_sdtv: false
use_dvd: false
```
