diff --git a/docs/defaults/chart/flixpatrol.md b/docs/defaults/chart/flixpatrol.md index 6404d9e0..24e62e5f 100644 --- a/docs/defaults/chart/flixpatrol.md +++ b/docs/defaults/chart/flixpatrol.md @@ -40,18 +40,18 @@ 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 Collection Variables](../collection_variables) are available as well as the additional Variables below which can be used to customize the file. +All [Shared Collection Variables](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. | Variable | Description & Values | |:---------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `10`
**Values:** Any Number 1-10 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Any Number 1-10 | -| `location` | **Description:** Changes the Builder Location for all collections in a Defaults file.
**Default:** `world`
**Values:** [`location` Attribute Options](../../metadata/builders/flixpatrol.md#top-platform-attributes) | -| `location_<>`1 | **Description:** Changes the Builder Location of the specified key's collection.
**Default:** `location`
**Values:** [`location` Attribute Options](../../metadata/builders/flixpatrol.md#top-platform-attributes) | +| `location` | **Description:** Changes the Builder Location for all collections in a Defaults file.
**Default:** `world`
**Values:** [`location` Attribute Options](../../builders/flixpatrol.md#top-platform-attributes) | +| `location_<>`1 | **Description:** Changes the Builder Location of the specified key's collection.
**Default:** `location`
**Values:** [`location` Attribute Options](../../builders/flixpatrol.md#top-platform-attributes) | | `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.
**Default:** `sync`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| -| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/chart/trakt.md b/docs/defaults/chart/trakt.md index 275a76cf..2bf3c085 100644 --- a/docs/defaults/chart/trakt.md +++ b/docs/defaults/chart/trakt.md @@ -41,16 +41,16 @@ 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 Collection Variables](../collection_variables) are available as well as the additional Variables below which can be used to customize the file. - -| Variable | Description & Values | -|:---------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `100`
**Values:** Number Greater than 0 | -| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | -| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.
**Default:** `sync`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| -| `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| -| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +All [Shared Collection Variables](../collection_variables.md) are available as well as the additional Variables below which can be used to customize the file. + +| Variable | Description & Values | +|:---------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `100`
**Values:** Number Greater than 0 | +| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater than 0 | +| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.
**Default:** `sync`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| +| `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the specified key's collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| +| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order_<>`1 | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. diff --git a/docs/defaults/overlays/flixpatrol.md b/docs/defaults/overlays/flixpatrol.md index ae4350be..1007fe91 100644 --- a/docs/defaults/overlays/flixpatrol.md +++ b/docs/defaults/overlays/flixpatrol.md @@ -40,7 +40,7 @@ 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) except `horizontal_offset`, `horizontal_align`, `vertical_offset`, and `vertical_align` 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) except `horizontal_offset`, `horizontal_align`, `vertical_offset`, and `vertical_align` are available with the default values below as well as the additional Variables below which can be used to customize the file. | Variable | Default | |:--------------------|:------------------| @@ -54,24 +54,24 @@ All [Shared Overlay Variables](../overlay_variables) except `horizontal_offset`, | `back_height` | `160` | | `back_padding` | `15` | -| Variable | Description & Values | -|:----------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `position` | **Description:** Changes the position of the Overlays.
**Default:** `right`
**Values:** `right`, `left`, or List of Coordinates | -| `style` | **Description:** Changes the style of the Logo Image.
**Default:** `round`
**Values:** `round` or `square` | -| `pre_text` | **Description:** Changes the text before the number.
**Default:** `TOP`
**Values:** Any String | -| `limit` | **Description:** Changes the Builder Limit for all overlays in a Defaults file.
**Default:** `10`
**Values:** Any Number 1-10 | -| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's overlay.
**Default:** `limit`
**Values:** Any Number 1-10 | -| `location` | **Description:** Changes the Builder Location for all overlays in a Defaults file.
**Default:** `world`
**Values:** [`location` Attribute Options](../../metadata/builders/flixpatrol.md#top-platform-attributes) | -| `location_<>`1 | **Description:** Changes the Builder Location of the specified key's overlay.
**Default:** `location`
**Values:** [`location` Attribute Options](../../metadata/builders/flixpatrol.md#top-platform-attributes) | -| `weight_<>`1 | **Description:** Controls the weight of the Overlay. Higher numbers have priority.
**Values:** Any Number | -| `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:** `50`
**Values:** Any Number greater then 0 | -| `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 Text Overlay.
**Values:** Any Number greater then 0 | -| `stroke_color` | **Description:** Font Stroke Color for the Text Overlay.
**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` | -| `addon_offset` | **Description:** Text Addon Image Offset from the text.
**Default:** `30`
**Values:** Any Number greater then 0 | -| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.
**Default:** `top`
**Values:** `left`, `right`, `top`, `bottom` | +| Variable | Description & Values | +|:----------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `position` | **Description:** Changes the position of the Overlays.
**Default:** `right`
**Values:** `right`, `left`, or List of Coordinates | +| `style` | **Description:** Changes the style of the Logo Image.
**Default:** `round`
**Values:** `round` or `square` | +| `pre_text` | **Description:** Changes the text before the number.
**Default:** `TOP`
**Values:** Any String | +| `limit` | **Description:** Changes the Builder Limit for all overlays in a Defaults file.
**Default:** `10`
**Values:** Any Number 1-10 | +| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's overlay.
**Default:** `limit`
**Values:** Any Number 1-10 | +| `location` | **Description:** Changes the Builder Location for all overlays in a Defaults file.
**Default:** `world`
**Values:** [`location` Attribute Options](../../builders/flixpatrol.md#top-platform-attributes) | +| `location_<>`1 | **Description:** Changes the Builder Location of the specified key's overlay.
**Default:** `location`
**Values:** [`location` Attribute Options](../../builders/flixpatrol.md#top-platform-attributes) | +| `weight_<>`1 | **Description:** Controls the weight of the Overlay. Higher numbers have priority.
**Values:** Any Number | +| `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:** `50`
**Values:** Any Number greater then 0 | +| `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 Text Overlay.
**Values:** Any Number greater then 0 | +| `stroke_color` | **Description:** Font Stroke Color for the Text Overlay.
**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` | +| `addon_offset` | **Description:** Text Addon Image Offset from the text.
**Default:** `30`
**Values:** Any Number greater then 0 | +| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.
**Default:** `top`
**Values:** `left`, `right`, `top`, `bottom` | 1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<>` with when calling.