diff --git a/docs/defaults/collection_variables.md b/docs/defaults/collection_variables.md index 5926314b..c823f804 100644 --- a/docs/defaults/collection_variables.md +++ b/docs/defaults/collection_variables.md @@ -1,3 +1,4 @@ +File paths need to be valid in the context where Kometa is running; this is primarily an issue when running in docker, as Kometa inside the container cannot see host paths. | Variable | Description & Values | |:----------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| diff --git a/docs/defaults/overlay_text_variables.md b/docs/defaults/overlay_text_variables.md index b8cf7aee..5b3f77da 100644 --- a/docs/defaults/overlay_text_variables.md +++ b/docs/defaults/overlay_text_variables.md @@ -1,15 +1,20 @@ +When something in this table is noted as expecting a number, typically that number is expressed in pixels, assuming an image 1000x1500 in size. + +Color values should be wrapped in quotes in the YAML, as the `#` denotes a comment in YAML and if left unquoted will prevent the value from being seen by Kometa. + +File paths need to be valid in the context where Kometa is running; this is primarily an issue when running in docker, as Kometa inside the container cannot see host paths. | Variable | Description & Values | |:-----------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `font` | **Description:** Choose the font for the Overlay.
**Default:** `fonts/Inter-Medium.ttf`
**Values:** Path to font file | | `font_style` | **Description:** Font style for Variable Fonts.
**Values:** Variable Font Style | -| `font_size` | **Description:** Choose the font size for the Overlay.
**Default:** `55`
**Values:** Any number greater than 0 | +| `font_size` | **Description:** Choose the font size for the Overlay.
**Default:** `55`
**Values:** Any number greater than 0 [pixels assuming a 1000x1500 image] | | `font_color` | **Description:** Choose the font color for the Overlay.
**Default:** `#FFFFFF`
**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` | -| `stroke_width` | **Description:** Font Stroke Width for the Overlay.
**Values:** Any number greater than 0 | +| `stroke_width` | **Description:** Font Stroke Width for the Overlay.
**Values:** Any number greater than 0 [pixels assuming a 1000x1500 image] | | `stroke_color` | **Description:** Font Stroke Color for the Overlay.
**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` | | `font_<>` | **Description:** Choose the font for this key's Overlay.
**Default:** `fonts/Inter-Medium.ttf`
**Values:** Path to font file | | `font_style_<>` | **Description:** Font style for this key's Variable Fonts.
**Values:** Variable Font Style | -| `font_size_<>` | **Description:** Choose the font size for this key's Overlay.
**Default:** `55`
**Values:** Any number greater than 0 | +| `font_size_<>` | **Description:** Choose the font size for this key's Overlay.
**Default:** `55`
**Values:** Any number greater than 0 [pixels assuming a 1000x1500 image] | | `font_color_<>` | **Description:** Choose the font color for this key's Overlay.
**Default:** `#FFFFFF`
**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` | -| `stroke_width_<>` | **Description:** Font Stroke Width for this key's Overlay.
**Values:** Any number greater than 0 | +| `stroke_width_<>` | **Description:** Font Stroke Width for this key's Overlay.
**Values:** Any number greater than 0 [pixels assuming a 1000x1500 image] | | `stroke_color_<>` | **Description:** Font Stroke Color for this key's Overlay.
**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` | \ No newline at end of file diff --git a/docs/defaults/overlay_variables.md b/docs/defaults/overlay_variables.md index 9a49a792..8e4b9bc6 100644 --- a/docs/defaults/overlay_variables.md +++ b/docs/defaults/overlay_variables.md @@ -1,3 +1,33 @@ +When something in this table is noted as expecting a number, that number is expressed in pixels, assuming an image 1000x1500 in size. If the number is an `offset`, the value is relative to the corresponding `alignment`. Percentages are also relative to the `alignment`. + +For example: +```yaml +libraries: + Movies: + overlay_files: + - default: resolution + template_variables: + horizontal_align: left + horizontal_offset: 247 + vertical_align: bottom + vertical_offset: 40% +``` +That would place the resolution overlay 247 pixels in from the left edge of the poster, and 40% of the way up from the bottom. + +```yaml +libraries: + Movies: + overlay_files: + - default: resolution + template_variables: + back_width: 198 + back_height: 47 +``` +That would set the resolution overlay background to 198 pixels wide by 47 pixels high. + +Color values should be wrapped in quotes in the YAML, as the `#` denotes a comment in YAML and if left unquoted will prevent the value from being seen by Kometa. + +File paths need to be valid in the context where Kometa is running; this is primarily an issue when running in docker, as Kometa inside the container cannot see host paths. | Variable | Description & Values | |:---------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -10,18 +40,18 @@ | `git_<>`1 | **Description:** Controls the image associated with this key's Overlay to the git repo.
**Values:** Git Path to Overlay Image | | `repo` | **Description:** Controls the images associated with all the Overlays to a custom repo.
**Values:** Repo Path to Overlay Image | | `repo_<>`1 | **Description:** Controls the image associated with this key's Overlay to a custom repo.
**Values:** Repo Path to Overlay Image | -| `horizontal_offset` | **Description:** Controls the Horizontal Offset of this overlay. Can be a %.
**Values:** Number 0 or greater or 0%-100% | +| `horizontal_offset` | **Description:** Controls the Horizontal Offset of this overlay. Can be a %.
**Values:** Number 0 or greater or 0%-100% [pixels assuming a 1000x1500 image] | | `horizontal_align` | **Description:** Controls the Horizontal Alignment of the overlay.
**Values:** `left`, `center`, or `right` | -| `vertical_offset` | **Description:** Controls the Vertical Offset of this overlay. Can be a %.
**Values:** Number 0 or greater or 0%-100% | +| `vertical_offset` | **Description:** Controls the Vertical Offset of this overlay. Can be a %.
**Values:** Number 0 or greater or 0%-100% [pixels assuming a 1000x1500 image] | | `vertical_align` | **Description:** Controls the Vertical Alignment of the overlay.
**Values:** `top`, `center`, or `bottom` | | `back_color` | **Description:** Controls the Backdrop Color for the Text Overlay.
**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA`
`AA` is transparency; 00 [transparent] to FF [opaque] | -| `back_width` | **Description:** Controls the Backdrop Width for the Text Overlay. If `back_width` is not specified the Backdrop Sizes to the text
**Values:** Any number greater than 0 | -| `back_height` | **Description:** Controls the Backdrop Height for the Text Overlay. If `back_height` is not specified the Backdrop Sizes to the text
**Values:** Any number greater than 0 | +| `back_width` | **Description:** Controls the Backdrop Width for the Text Overlay. If `back_width` is not specified the Backdrop Sizes to the text
**Values:** Any number greater than 0 [pixels assuming a 1000x1500 image] | +| `back_height` | **Description:** Controls the Backdrop Height for the Text Overlay. If `back_height` is not specified the Backdrop Sizes to the text
**Values:** Any number greater than 0 [pixels assuming a 1000x1500 image] | | `back_align` | **Description:** Controls the Alignment for the Text Overlay inside the backdrop. If `back_align` is not specified the Backdrop Centers the text.
**Values:** `left`, `right`, `center`, `top`, or `bottom` | -| `back_padding` | **Description:** Controls the Backdrop Padding for the Text Overlay.
**Values:** Any number greater than 0 | -| `back_radius` | **Description:** Controls the Backdrop Radius for the Text Overlay.
**Values:** Any number greater than 0 | +| `back_padding` | **Description:** Controls the Backdrop Padding for the Text Overlay.
**Values:** Any number greater than 0 [pixels assuming a 1000x1500 image] | +| `back_radius` | **Description:** Controls the Backdrop Radius for the Text Overlay.
**Values:** Any number greater than 0 [pixels assuming a 1000x1500 image] | | `back_line_color` | **Description:** Controls the Backdrop Line Color for the Text Overlay.
**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA``AA` is transparency; 00 [transparent] to FF [opaque] | -| `back_line_width` | **Description:** Controls the Backdrop Line Width for the Text Overlay.
**Values:** Any number greater than 0 | +| `back_line_width` | **Description:** Controls the Backdrop Line Width for the Text Overlay.
**Values:** Any number greater than 0 [pixels assuming a 1000x1500 image] | 1. Each default overlay has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. \ No newline at end of file