7.7 KiB

Raw Blame History

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 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:

libraries:
  Movies:
    overlay_files:
      - pmm: video_format
  TV Shows:
    overlay_files:
      - 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.
Values: season or episode

text_<<key>>¹

Description: Choose the text for the Overlay.
Default:

Key	Default
`remux`	`REMUX`
`bluray`	`BLU-RAY`
`web`	`WEB`
`hdtv`	`HDTV`
`dvd`	`DVD`
`sdtv`	`SDTV`

Values: Any String

weight_<<key>>¹ Description: Controls the weight of the Overlay. Higher numbers have priority.
Values: Any Number

regex_<<key>>¹ Description: Controls the regex of the Overlay Search.
Values: Any Proper Regex

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.

libraries:
  Movies:
    overlay_files:
      - pmm: video_format
        template_variables:
          text_bluray: BLURAY
          use_sdtv: false
          use_dvd: false

7.7 KiB Raw Blame History