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:
overlay_path:
2023-01-27 13:40:34 +00:00
- pmm: video_format
2022-10-17 06:48:08 +00:00
TV Shows:
overlay_path:
- 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-11-29 15:23:04 +00:00
## Template Variable Default Values
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-11-29 15:23:04 +00:00
| Variable | Default / Values |
2022-10-17 12:13:48 +00:00
|:-----------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
2023-11-29 15:23:04 +00:00
| `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-05-18 14:18:30 +00:00
| `builder_level` | **Description:** Choose the Overlay Level.< br > **Values:** `season` or `episode` |
2022-11-09 20:12:47 +00:00
| `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 12:13:48 +00:00
2023-04-05 15:58:46 +00:00
1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` with when calling.
2022-10-17 06:48:08 +00:00
2023-11-29 15:23:04 +00:00
{%
include-markdown "../overlay_variables.md"
%}
{%
include-markdown "../overlay_text_variables.md"
%}
## Example Template Variable Amendments
2022-10-17 06:48:08 +00:00
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:
2023-01-27 13:40:34 +00:00
- pmm: video_format
2022-10-17 06:48:08 +00:00
template_variables:
text_bluray: BLURAY
use_sdtv: false
use_dvd: false
```
