mirror of
https://github.com/meisnate12/Plex-Meta-Manager
synced 2024-11-10 06:54:21 +00:00
create "Text Overlay Template Variables" and fix ratings default values.
This commit is contained in:
parent
0c33e346c6
commit
c7a0f03d53
12 changed files with 48 additions and 86 deletions
|
@ -1,6 +1,8 @@
|
|||
# Shared Overlay Template Variables
|
||||
|
||||
IMPORTANT: The variables in this table are only valid in the context of the [`PMM default metadata files`](guide.md.
|
||||
???+ important
|
||||
|
||||
The variables in this table are only valid in the context of the PMM Defaults Overlay files and will not work with non-Defaults files that have been manually created using builders.
|
||||
|
||||
There are some `template_variables` that all the PMM Defaults except `franchise` can use to manipulate the file from the default settings which are provided. This page is not an exhaustive list of all such template variables.
|
||||
|
||||
|
@ -37,3 +39,31 @@ Below are the common variables which can be used to customize the file.
|
|||
| `back_line_width` | **Description:** Controls the Backdrop Line Width for the Text Overlay.<br>**Values:** Any number greater than 0 |
|
||||
|
||||
1. Each default overlay has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
|
||||
# Text Overlay Template Variables
|
||||
|
||||
The below `template_variables` are also available for Overlays which have text written, allowing for further customization of the text that appears.
|
||||
|
||||
???+ note
|
||||
|
||||
This will not work for images of text such as the Resolution overlays, this is specifically for text which Plex Meta Manager writes such as the Direct Play overlay
|
||||
|
||||
Some of these template variables may have default values depending on the specific overlay. Those default values will also be listed on the individual overlay page.
|
||||
|
||||
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.
|
||||
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-----------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `font` | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Medium.ttf`<br>**Values:** Path to font file |
|
||||
| `font_style` | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style |
|
||||
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `55`<br>**Values:** Any number greater than 0 |
|
||||
| `font_color` | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `stroke_width` | **Description:** Font Stroke Width for the Overlay.<br>**Values:** Any number greater than 0 |
|
||||
| `stroke_color` | **Description:** Font Stroke Color for the Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `font_<<key>>` | **Description:** Choose the font for this key's Overlay.<br>**Default:** `fonts/Inter-Medium.ttf`<br>**Values:** Path to font file |
|
||||
| `font_style_<<key>>` | **Description:** Font style for this key's Variable Fonts.<br>**Values:** Variable Font Style |
|
||||
| `font_size_<<key>>` | **Description:** Choose the font size for this key's Overlay.<br>**Default:** `55`<br>**Values:** Any number greater than 0 |
|
||||
| `font_color_<<key>>` | **Description:** Choose the font color for this key's Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `stroke_width_<<key>>` | **Description:** Font Stroke Width for this key's Overlay.<br>**Values:** Any number greater than 0 |
|
||||
| `stroke_color_<<key>>` | **Description:** Font Stroke Color for this key's Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
|
|
|
@ -64,12 +64,6 @@ All [Shared Overlay Variables](../overlay_variables.md) are available with the d
|
|||
|:-----------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `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>`1.33`</td><td>`1.33`</td></tr><tr><td>`1.65`</td><td>`1.65`</td></tr><tr><td>`1.66`</td><td>`1.66`</td></tr><tr><td>`1.78`</td><td>`1.78`</td></tr><tr><td>`1.85`</td><td>`1.85`</td></tr><tr><td>`2.2`</td><td>`2.2`</td></tr><tr><td>`2.35`</td><td>`2.35`</td></tr><tr><td>`2.77`</td><td>`2.77`</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 |
|
||||
| `font` | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Medium.ttf`<br>**Values:** Path to font file |
|
||||
| `font_style` | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style |
|
||||
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `50`<br>**Values:** Any number greater than 0 |
|
||||
| `font_color` | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any number greater than 0 |
|
||||
| `stroke_color` | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
|
||||
1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` with when calling.
|
||||
|
||||
|
|
|
@ -75,12 +75,6 @@ All [Shared Overlay Variables](../overlay_variables.md) are available with the d
|
|||
|
||||
| Variable | Description & Values |
|
||||
|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `font` | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Medium.ttf`<br>**Values:** Path to font file |
|
||||
| `font_style` | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style |
|
||||
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `55`<br>**Values:** Any number greater than 0 |
|
||||
| `font_color` | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any number greater than 0 |
|
||||
| `stroke_color` | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any number greater than 0 |
|
||||
| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `left`<br>**Values:** `left`, `right`, `top`, `bottom` |
|
||||
| `pre_text` | **Description:** Choose the text before the key for the Overlay.<br>**Values:** Any String |
|
||||
|
|
|
@ -66,12 +66,6 @@ All [Shared Overlay Variables](../overlay_variables.md) are available with the d
|
|||
| `back_radius` | **Description:** Choose the back radius for the overlay lozenge.<br>**Default:**`30` |
|
||||
| `back_width` | **Description:** Choose the back width for the overlay lozenge.<br>**Default:**`305` |
|
||||
| `back_height` | **Description:** Choose the back height for the overlay lozenge.<br>**Default:**`105` |
|
||||
| `font` | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Medium.ttf`<br>**Values:** Path to font file |
|
||||
| `font_style` | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style |
|
||||
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `55`<br>**Values:** Any number greater than 0 |
|
||||
| `font_color` | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any number greater than 0 |
|
||||
| `stroke_color` | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any number greater than 0 |
|
||||
| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `left`<br>**Values:** `left`, `right`, `top`, `bottom` |
|
||||
| `builder_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` |
|
||||
|
|
|
@ -55,12 +55,6 @@ All [Shared Overlay Variables](../overlay_variables.md) are available with the d
|
|||
| `back_radius` | **Description:** Choose the back radius for the overlay lozenge.<br>**Default:**`30` |
|
||||
| `back_width` | **Description:** Choose the back width for the overlay lozenge.<br>**Default:**`305` |
|
||||
| `back_height` | **Description:** Choose the back height for the overlay lozenge.<br>**Default:**`105` |
|
||||
| `font` | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Medium.ttf`<br>**Values:** Path to font file |
|
||||
| `font_style` | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style |
|
||||
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `55`<br>**Values:** Any number greater than 0 |
|
||||
| `font_color` | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any number greater than 0 |
|
||||
| `stroke_color` | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any number greater than 0 |
|
||||
| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `left`<br>**Values:** `left`, `right`, `top`, `bottom` |
|
||||
|
||||
|
|
|
@ -61,12 +61,6 @@ All [Shared Overlay Variables](../overlay_variables.md) are available with the d
|
|||
| `back_radius` | **Description:** Choose the back radius for the overlay lozenge.<br>**Default:**`30` |
|
||||
| `back_width` | **Description:** Choose the back width for the overlay lozenge.<br>**Default:**`305` |
|
||||
| `back_height` | **Description:** Choose the back height for the overlay lozenge.<br>**Default:**`105` |
|
||||
| `font` | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Medium.ttf`<br>**Values:** Path to font file |
|
||||
| `font_style` | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style |
|
||||
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `55`<br>**Values:** Any number greater than 0 |
|
||||
| `font_color` | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any number greater than 0 |
|
||||
| `stroke_color` | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any number greater than 0 |
|
||||
| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `left`<br>**Values:** `left`, `right`, `top`, `bottom` |
|
||||
|
||||
|
|
|
@ -38,15 +38,6 @@ All [Shared Overlay Variables](../overlay_variables.md) are available with the d
|
|||
| `back_width` | `305` |
|
||||
| `back_height` | `105` |
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:---------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `font` | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Medium.ttf`<br>**Values:** Path to font file |
|
||||
| `font_style` | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style |
|
||||
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `55`<br>**Values:** Any number greater than 0 |
|
||||
| `font_color` | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any number greater than 0 |
|
||||
| `stroke_color` | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
```yaml
|
||||
|
|
|
@ -64,12 +64,6 @@ All [Shared Overlay Variables](../overlay_variables.md) except `horizontal_offse
|
|||
| `location` | **Description:** Changes the Builder Location for all overlays in a Defaults file.<br>**Default:** `world`<br>**Values:** [`location` Attribute Options](../../builders/flixpatrol.md#top-platform-attributes) |
|
||||
| `location_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Location of the specified key's overlay.<br>**Default:** `location`<br>**Values:** [`location` Attribute Options](../../builders/flixpatrol.md#top-platform-attributes) |
|
||||
| `weight_<<key>>`<sup>1</sup> | **Description:** Controls the weight of the Overlay. Higher numbers have priority.<br>**Values:** Any Number |
|
||||
| `font` | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Medium.ttf`<br>**Values:** Path to font file |
|
||||
| `font_style` | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style |
|
||||
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `50`<br>**Values:** Any Number greater then 0 |
|
||||
| `font_color` | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any Number greater then 0 |
|
||||
| `stroke_color` | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `30`<br>**Values:** Any Number greater then 0 |
|
||||
| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `top`<br>**Values:** `left`, `right`, `top`, `bottom` |
|
||||
|
||||
|
|
|
@ -66,23 +66,24 @@ Template Variables can be used to manipulate the file in various ways to slightl
|
|||
|
||||
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 is its default value if it has one if not it's just ignored.
|
||||
|
||||
All [Shared Overlay Variables](../overlay_variables.md) are available with the default values below as well as the additional Variables below which can be used to customize the file.
|
||||
All [Shared Overlay Variables](../overlay_variables.md) are available with the default values below as well as the additional Variables below which can be used to customize the file. These can be prepended with `rating1_`, `rating2_`, or `rating3_` to change that attribute on each rating individually.
|
||||
|
||||
All [Shared Overlay Variables](../overlay_variables.md) can be prepended with `rating1_`, `rating2_`, or `rating3_` to change that attribute on each rating individually.
|
||||
???+ warning
|
||||
|
||||
| Variable | Default |
|
||||
|:--------------------|:------------|
|
||||
| `horizontal_offset` | `200` |
|
||||
| `horizontal_align` | `right` |
|
||||
| `vertical_offset` | `15` |
|
||||
| `vertical_align` | `top` |
|
||||
| `back_color` | `#00000099` |
|
||||
| `back_radius` | `30` |
|
||||
| `back_width` | `105` |
|
||||
| `back_height` | `105` |
|
||||
| `back_padding` | `15` |
|
||||
| `back_radius` | `30` |
|
||||
| `back_height` | `105` |
|
||||
To amend `horizontal_offset` and `vertical_offset` you **must** prepend the variable with `rating1_`, `rating2_`, or `rating3_`
|
||||
|
||||
| Variable | Default |
|
||||
|:---------------------|:------------|
|
||||
| `horizontal_offset` | `30` |
|
||||
| `horizontal_align` | `left` |
|
||||
| `vertical_offset` | `30` |
|
||||
| `vertical_align` | `center` |
|
||||
| `back_color` | `#00000099` |
|
||||
| `back_radius` | `30` |
|
||||
| `back_width` | `160` |
|
||||
| `back_height` | `160` |
|
||||
| `back_padding` | `15` |
|
||||
| `back_radius` | `30` |
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-----------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
|
@ -104,14 +105,8 @@ All [Shared Overlay Variables](../overlay_variables.md) can be prepended with `r
|
|||
| `minimum_rating` | **Description:** Minimum Rating to display<br>**Default:** 0.0<br>**Values:** Any Number |
|
||||
| `fresh_rating` | **Description:** Determines when ratings are considered Fresh<br>**Default:** 6.0<br>**Values:** Any Number |
|
||||
| `maximum_rating` | **Description:** Maximum Rating to display<br>**Default:** 10.0<br>**Values:** Any Number |
|
||||
| `font`<sup>1</sup> | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Bold.ttf`<br>**Values:** Path to font file |
|
||||
| `font_style`<sup>1</sup> | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style |
|
||||
| `font_size`<sup>1</sup> | **Description:** Choose the font size for the Overlay.<br>**Default:** `63`<br>**Values:** Any number greater than 0 |
|
||||
| `font_color`<sup>1</sup> | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `stroke_width`<sup>1</sup> | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any number greater than 0 |
|
||||
| `stroke_color`<sup>1</sup> | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `addon_offset`<sup>1</sup> | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any number greater than 0 |
|
||||
| `addon_position`<sup>1</sup> | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `left`<br>**Values:** `left`, `right`, `top`, `bottom` |
|
||||
| `addon_position`<sup>1</sup> | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `top`<br>**Values:** `left`, `right`, `top`, `bottom` |
|
||||
| `builder_level` | **Description:** Choose the Overlay Level.<br>**Values:** `episode` |
|
||||
|
||||
1. These Variables can be prepended with `rating1_`, `rating2_`, or `rating3_` to change that attribute on each rating individually.
|
||||
|
|
|
@ -47,12 +47,6 @@ All [Shared Overlay Variables](../overlay_variables.md) are available with the d
|
|||
| Variable | Description & Values |
|
||||
|:---------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `text` | **Description:** Choose the text for the Overlay.<br>**Default:** `Runtime: `<br>**Values:** Any String |
|
||||
| `font` | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Medium.ttf`<br>**Values:** Path to font file |
|
||||
| `font_style` | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style |
|
||||
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `55`<br>**Values:** Any number greater than 0 |
|
||||
| `font_color` | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any number greater than 0 |
|
||||
| `stroke_color` | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
|
|
@ -52,12 +52,6 @@ All [Shared Overlay Variables](../overlay_variables.md) are available with the d
|
|||
| `last` | **Description:** Episode Air Date in the last number of days for the AIRING Overlay.<br>**Default:** `14`<br>**Values:** Any number greater than 0 |
|
||||
| `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>`airing`</td><td>`AIRING`</td></tr><tr><td>`returning`</td><td>`RETURNING`</td></tr><tr><td>`canceled`</td><td>`CANCELED`</td></tr><tr><td>`ended`</td><td>`ENDED`</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 |
|
||||
| `font` | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Medium.ttf`<br>**Values:** Path to font file |
|
||||
| `font_style` | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style |
|
||||
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `50`<br>**Values:** Any number greater than 0 |
|
||||
| `font_color` | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any number greater than 0 |
|
||||
| `stroke_color` | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
|
||||
1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` with when calling.
|
||||
|
||||
|
|
|
@ -63,12 +63,6 @@ All [Shared Overlay Variables](../overlay_variables.md) are available with the d
|
|||
| Variable | Description & Values |
|
||||
|:-----------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `builder_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` |
|
||||
| `font` | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Medium.ttf`<br>**Values:** Path to font file |
|
||||
| `font_style` | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style |
|
||||
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `55`<br>**Values:** Any number greater than 0 |
|
||||
| `font_color` | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any number greater than 0 |
|
||||
| `stroke_color` | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
|
||||
| `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 |
|
||||
|
|
Loading…
Reference in a new issue