From af52bc5926a6cc280c68d9045645ee7aace27e75 Mon Sep 17 00:00:00 2001 From: YozoraXCII <96386153+YozoraXCII@users.noreply.github.com> Date: Thu, 27 Apr 2023 14:51:24 +0100 Subject: [PATCH] add `originals_only` to Streaming overlays --- docs/defaults/both/streaming.md | 26 +++++++++++------------ docs/defaults/overlays/streaming.md | 32 ++++++++++++++--------------- 2 files changed, 28 insertions(+), 30 deletions(-) diff --git a/docs/defaults/both/streaming.md b/docs/defaults/both/streaming.md index fbc1b660..155e6726 100644 --- a/docs/defaults/both/streaming.md +++ b/docs/defaults/both/streaming.md @@ -55,19 +55,19 @@ All [Shared Collection Variables](../collection_variables) are available as well This file contains a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well. -| Variable | Description & Values | -|:--------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | -| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | -| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | -| `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | -| `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
| -| `exclude` | **Description:** Exclude these Streaming Services from creating a Dynamic Collection.
**Values:** List of Streaming Service Keys | -| `region` | **Description:** Changes some Streaming Service lists to regional variants (see below table for more information.
**Default:** `us`
**Values:** `us`,`uk`,`ca`, `da`, `de`, `es`, `fr`, `it`, `pt-br` | -| `originals_only` | **Description:** Changes Streaming Service lists to only show original content produced by the service.
**Note**: Cannot be used with `region`, and only produces collections for `appletv`, `disney`, `hbomax`, `hulu`, `netflix`, `paramount`, `peacock` and `amazon`
**Default:** `false`
**Values:** `true`, `false` | -| `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | -| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s streaming on <>.`
**Values:** Any string. | +| Variable | Description & Values | +|:--------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | +| `limit_<>`1 | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | +| `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | +| `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
| +| `exclude` | **Description:** Exclude these Streaming Services from creating a Dynamic Collection.
**Values:** List of Streaming Service Keys | +| `region` | **Description:** Changes some Streaming Service lists to regional variants (see below table for more information.
**Default:** `us`
**Values:** `us`,`uk`,`ca`, `da`, `de`, `es`, `fr`, `it`, `pt-br` | +| `originals_only` | **Description:** Changes Streaming Service lists to only show original content produced by the service.
**Note**: Cannot be used with `region`, and only produces collections for `amazon`, `appletv`, `disney`, `hbomax`, `hulu`, `netflix`, `paramount`, `peacock`
**Default:** `false`
**Values:** `true`, `false` | +| `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | +| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s streaming on <>.`
**Values:** Any string. | 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/streaming.md b/docs/defaults/overlays/streaming.md index 0acc2f59..5d157c32 100644 --- a/docs/defaults/overlays/streaming.md +++ b/docs/defaults/overlays/streaming.md @@ -55,20 +55,19 @@ Note that the `template_variables:` section only needs to be used if you do want All [Shared Overlay Variables](../overlay_variables) are available with the default values below as well as the additional Variables below which can be used to customize the file. -| Variable | Default | -|:--------------------|:------------| -| `horizontal_offset` | `15` | -| `horizontal_align` | `left` | -| `vertical_offset` | `150` | -| `vertical_align` | `bottom` | -| `back_color` | `#00000099` | -| `back_radius` | `30` | -| `back_width` | `305` | -| `back_height` | `105` | - -| Variable | Description & Values | -|:-----------------------------|:-------------------------------------------------------------------------------------------------------------| -| `weight_<>`1 | **Description:** Controls the weight of the Overlay. Higher numbers have priority.
**Values:** Any Number | +| Variable | Description & Values | +|:-----------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `horizontal_offset` | **Description:** Change the horizontal offset.
**Default Value:** `15` | +| `horizontal_align` | **Description:** Change the horizontal alignment.
**Default Value:** `left` | +| `vertical_offset` | **Description:** Change the vertical offset.
**Default Value:** `150` | +| `vertical_align` | **Description:** Change the vertical alignment.
**Default Value:** `bottom` | +| `back_color` | **Description:** Change the back color.
**Default Value:** `#00000099` | +| `back_radius` | **Description:** Change the back (lozenge) radius .
**Default Value:** `30` | +| `back_width` | **Description:** Change the back (lozenge) width.
**Default Value:** `305` | +| `back_height` | **Description:** Change the back (lozenge) height.
**Default Value:** `105` | +| `region` | **Description:** Changes some Streaming Service lists to regional variants (see below table for more information.
**Default:** `us`
**Values:** `us`,`uk`,`ca`, `da`, `de`, `es`, `fr`, `it`, `pt-br` | +| `originals_only` | **Description:** Changes Streaming Service overlays to only apply to original content produced by the service.
**Note**: Cannot be used with `region`, and only produces overlays for `amazon`, `appletv`, `disney`, `hbomax`, `hulu`, `netflix`, `paramount`, `peacock`
**Default:** `false`
**Values:** `true`, `false` | +| `weight_<>`1 | **Description:** Controls the weight of the Overlay. Higher numbers have priority.
**Values:** Any Number | 1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<>` with when calling. @@ -91,8 +90,7 @@ libraries: overlay_path: - pmm: streaming template_variables: - region: ca + originals_only: true use_peacock: false - use_youtube: false - weight_youtube: 5 + weight_netflix: 100 ```