Update overlay_variables.md

pull/1360/head
johnfawkes 2 years ago committed by GitHub
parent 7a25d3cd31
commit 2873a0a09b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -6,6 +6,9 @@ Note that the `template_variables:` section only needs to be used if you do want
Below are the available variables which can be used to customize the file. Below are the available variables which can be used to customize the file.
**NOTE:** `file`, `url`, `git`, `repo`, and `pmm` can all be used with `_<<key>>`
<br>For example, with the audio_codec overlay `file_dtsx: config/overlays/dtsx.png`
| Variable | Description & Values | | Variable | Description & Values |
|:--------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |:--------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `use_<<key>>`<sup>1</sup> | **Description:** Turns off individual Overlays in a Defaults file.<br>**Values:** `false` to turn off the overlay | | `use_<<key>>`<sup>1</sup> | **Description:** Turns off individual Overlays in a Defaults file.<br>**Values:** `false` to turn off the overlay |
@ -26,4 +29,4 @@ Below are the available variables which can be used to customize the file.
| `back_line_color` | **Description:** Controls the Backdrop Line Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` | | `back_line_color` | **Description:** Controls the Backdrop Line Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
| `back_line_width` | **Description:** Controls the Backdrop Line Width for the Text Overlay.<br>**Values:** Any Number greater then 0 | | `back_line_width` | **Description:** Controls the Backdrop Line Width for the Text Overlay.<br>**Values:** Any Number greater then 0 |
1. Each default overlay has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling. 1. Each default overlay has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.

Loading…
Cancel
Save