diff --git a/docs/config/settings.md b/docs/config/settings.md index 6c67633ce..2e2b2870e 100644 --- a/docs/config/settings.md +++ b/docs/config/settings.md @@ -443,7 +443,7 @@ The available setting attributes which can be set at each level are outlined bel `release`Order Collection by Release Dates `alpha`Order Collection Alphabetically `custom`Order Collection Via the Builder Order - [Any `plex_search` sort option](../files/builders/plex.md#sort-options) + [Any `plex_search` sort option](../files/builders/plex.md#__tabbed_1_4) **Default Value:** `None` diff --git a/docs/config/tmdb.md b/docs/config/tmdb.md index 3c57861db..64571f6d4 100644 --- a/docs/config/tmdb.md +++ b/docs/config/tmdb.md @@ -17,12 +17,12 @@ tmdb: cache_expiration: 60 ``` -| Attribute | Allowed Values | Default | Required | -|:-------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------|:------------------------------------------:| -| `apikey` | User TMDb V3 API Key | N/A | :fontawesome-solid-circle-check:{ .green } | -| `language` | [ISO 639-1 Code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) of the User Language | en | :fontawesome-solid-circle-xmark:{ .red } | -| `region` | [ISO 3166-1 Code](https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) of the User Region for use with [Other TMDb Builders](../files/builders/tmdb.md#other-tmdb-builders) | None | :fontawesome-solid-circle-xmark:{ .red } | -| `cache_expiration` | Number of days before each cache mapping expires and has to be re-cached. | 60 | :fontawesome-solid-circle-xmark:{ .red } | +| Attribute | Allowed Values | Default | Required | +|:-------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------|:------------------------------------------:| +| `apikey` | User TMDb V3 API Key | N/A | :fontawesome-solid-circle-check:{ .green } | +| `language` | [ISO 639-1 Code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) of the User Language | en | :fontawesome-solid-circle-xmark:{ .red } | +| `region` | [ISO 3166-1 Code](https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) of the User Region for use with [TMDb Chart Builders](../files/builders/tmdb.md#tmdb-chart-builders) | None | :fontawesome-solid-circle-xmark:{ .red } | +| `cache_expiration` | Number of days before each cache mapping expires and has to be re-cached. | 60 | :fontawesome-solid-circle-xmark:{ .red } | ## Important Notes diff --git a/docs/defaults/award/bafta.md b/docs/defaults/award/bafta.md index 77b7258d6..c3213c63a 100644 --- a/docs/defaults/award/bafta.md +++ b/docs/defaults/award/bafta.md @@ -49,8 +49,8 @@ work. Any value not specified will use its default value if it has one if not it | `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)
**Values:** Any number | | `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 [key's](#collection_section) 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](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: latest-5
Values: Number greater than 0
endingControls the ending year for collections
Default: latest
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value latest
  • You can also use a value relative to the latest by doing latest-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `BAFTA <>`
**Values:** Any string with `<>` in it. | diff --git a/docs/defaults/award/berlinale.md b/docs/defaults/award/berlinale.md index 488685c08..eb6c0ed5b 100644 --- a/docs/defaults/award/berlinale.md +++ b/docs/defaults/award/berlinale.md @@ -48,8 +48,8 @@ work. Any value not specified will use its default value if it has one if not it | `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)
**Values:** Any number | | `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 [key's](#collection_section) 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](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: latest-5
Values: Number greater than 0
endingControls the ending year for collections
Default: latest
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value latest
  • You can also use a value relative to the latest by doing latest-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Berlinale <>`
**Values:** Any string with `<>` in it. | diff --git a/docs/defaults/award/cannes.md b/docs/defaults/award/cannes.md index 15671e549..3e9db57df 100644 --- a/docs/defaults/award/cannes.md +++ b/docs/defaults/award/cannes.md @@ -48,8 +48,8 @@ work. Any value not specified will use its default value if it has one if not it | `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)
**Values:** Any number | | `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 [key's](#collection_section) 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](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: latest-5
Values: Number greater than 0
endingControls the ending year for collections
Default: latest
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value latest
  • You can also use a value relative to the latest by doing latest-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Cannes <>`
**Values:** Any string with `<>` in it. | diff --git a/docs/defaults/award/cesar.md b/docs/defaults/award/cesar.md index b853b4f37..f0063a869 100644 --- a/docs/defaults/award/cesar.md +++ b/docs/defaults/award/cesar.md @@ -48,8 +48,8 @@ work. Any value not specified will use its default value if it has one if not it | `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)
**Values:** Any number | | `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 [key's](#collection_section) 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](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: latest-5
Values: Number greater than 0
endingControls the ending year for collections
Default: latest
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value latest
  • You can also use a value relative to the latest by doing latest-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `César <>`
**Values:** Any string with `<>` in it. | diff --git a/docs/defaults/award/choice.md b/docs/defaults/award/choice.md index 028e595ac..5cc445106 100644 --- a/docs/defaults/award/choice.md +++ b/docs/defaults/award/choice.md @@ -49,8 +49,8 @@ Note that the `template_variables:` section only needs to be used if you do want | `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)
**Values:** Any number | | `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 [key's](#collection_section) 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](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: latest-5
Values: Number greater than 0
endingControls the ending year for collections
Default: latest
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value latest
  • You can also use a value relative to the latest by doing latest-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Critics Choice <>`
**Values:** Any string with `<>` in it. | diff --git a/docs/defaults/award/emmy.md b/docs/defaults/award/emmy.md index aee0bfa7a..b69681d07 100644 --- a/docs/defaults/award/emmy.md +++ b/docs/defaults/award/emmy.md @@ -49,8 +49,8 @@ Note that the `template_variables:` section only needs to be used if you do want | `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)
**Values:** Any number | | `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 [key's](#collection_section) 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](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: latest-5
Values: Number greater than 0
endingControls the ending year for collections
Default: latest
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value latest
  • You can also use a value relative to the latest by doing latest-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Emmys <>`
**Values:** Any string with `<>` in it. | diff --git a/docs/defaults/award/golden.md b/docs/defaults/award/golden.md index 172097d8d..b51f58d01 100644 --- a/docs/defaults/award/golden.md +++ b/docs/defaults/award/golden.md @@ -55,8 +55,8 @@ work. Any value not specified will use its default value if it has one if not it | `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)
**Values:** Any number | | `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 [key's](#collection_section) 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](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: latest-5
Values: Number greater than 0
endingControls the ending year for collections
Default: latest
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value latest
  • You can also use a value relative to the latest by doing latest-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Golden Globe <>`
**Values:** Any string with `<>` in it. | diff --git a/docs/defaults/award/nfr.md b/docs/defaults/award/nfr.md index 2884bc4a9..10de156d7 100644 --- a/docs/defaults/award/nfr.md +++ b/docs/defaults/award/nfr.md @@ -48,8 +48,8 @@ work. Any value not specified will use its default value if it has one if not it | `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)
**Values:** Any number | | `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 [key's](#collection_section) 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](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: latest-5
Values: Number greater than 0
endingControls the ending year for collections
Default: latest
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value latest
  • You can also use a value relative to the latest by doing latest-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `National Film Registry <>`
**Values:** Any string with `<>` in it. | diff --git a/docs/defaults/award/oscars.md b/docs/defaults/award/oscars.md index c11db3642..542749faf 100644 --- a/docs/defaults/award/oscars.md +++ b/docs/defaults/award/oscars.md @@ -49,8 +49,8 @@ work. Any value not specified will use its default value if it has one if not it | `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)
**Values:** Any number | | `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 [key's](#collection_section) 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](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: latest-6
Values: Number greater than 0
endingControls the ending year for collections
Default: latest-1
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value latest
  • You can also use a value relative to the latest by doing latest-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Oscars Winners <>`
**Values:** Any string with `<>` in it. | diff --git a/docs/defaults/award/pca.md b/docs/defaults/award/pca.md index 47445c0ae..f49d6fed6 100644 --- a/docs/defaults/award/pca.md +++ b/docs/defaults/award/pca.md @@ -48,8 +48,8 @@ work. Any value not specified will use its default value if it has one if not it | `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)
**Values:** Any number | | `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 [key's](#collection_section) 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](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: latest-5
Values: Number greater than 0
endingControls the ending year for collections
Default: latest
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value latest
  • You can also use a value relative to the latest by doing latest-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `People's Choice Awards <>`
**Values:** Any string with `<>` in it. | diff --git a/docs/defaults/award/razzie.md b/docs/defaults/award/razzie.md index 01e4a8d75..9fdd401d1 100644 --- a/docs/defaults/award/razzie.md +++ b/docs/defaults/award/razzie.md @@ -48,8 +48,8 @@ work. Any value not specified will use its default value if it has one if not it | `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)
**Values:** Any number | | `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 [key's](#collection_section) 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](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: latest-5
Values: Number greater than 0
endingControls the ending year for collections
Default: latest
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value latest
  • You can also use a value relative to the latest by doing latest-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Razzie <>`
**Values:** Any string with `<>` in it. | diff --git a/docs/defaults/award/sag.md b/docs/defaults/award/sag.md index 020451cf5..27724f2b7 100644 --- a/docs/defaults/award/sag.md +++ b/docs/defaults/award/sag.md @@ -48,8 +48,8 @@ work. Any value not specified will use its default value if it has one if not it | `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)
**Values:** Any number | | `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 [key's](#collection_section) 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](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: latest-5
Values: Number greater than 0
endingControls the ending year for collections
Default: latest
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value latest
  • You can also use a value relative to the latest by doing latest-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Screen Actors Guild <>`
**Values:** Any string with `<>` in it. | diff --git a/docs/defaults/award/spirit.md b/docs/defaults/award/spirit.md index 42065ac8b..7d5debab6 100644 --- a/docs/defaults/award/spirit.md +++ b/docs/defaults/award/spirit.md @@ -48,8 +48,8 @@ work. Any value not specified will use its default value if it has one if not it | `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)
**Values:** Any number | | `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 [key's](#collection_section) 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](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: latest-5
Values: Number greater than 0
endingControls the ending year for collections
Default: latest
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value latest
  • You can also use a value relative to the latest by doing latest-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Independent Spirit Awards <>`
**Values:** Any string with `<>` in it. | diff --git a/docs/defaults/award/sundance.md b/docs/defaults/award/sundance.md index 38c623718..1ed62b8c3 100644 --- a/docs/defaults/award/sundance.md +++ b/docs/defaults/award/sundance.md @@ -48,8 +48,8 @@ work. Any value not specified will use its default value if it has one if not it | `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)
**Values:** Any number | | `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 [key's](#collection_section) 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](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: latest-5
Values: Number greater than 0
endingControls the ending year for collections
Default: latest
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value latest
  • You can also use a value relative to the latest by doing latest-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Sundance Film Festival <>`
**Values:** Any string with `<>` in it. | diff --git a/docs/defaults/award/tiff.md b/docs/defaults/award/tiff.md index 1a4b6e5a5..dcac14609 100644 --- a/docs/defaults/award/tiff.md +++ b/docs/defaults/award/tiff.md @@ -49,8 +49,8 @@ work. Any value not specified will use its default value if it has one if not it | `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)
**Values:** Any number | | `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 [key's](#collection_section) 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](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: latest-5
Values: Number greater than 0
endingControls the ending year for collections
Default: latest
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value latest
  • You can also use a value relative to the latest by doing latest-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Toronto International Film Festival <>`
**Values:** Any string with `<>` in it. | diff --git a/docs/defaults/award/venice.md b/docs/defaults/award/venice.md index 165b72925..371d4a04c 100644 --- a/docs/defaults/award/venice.md +++ b/docs/defaults/award/venice.md @@ -48,8 +48,8 @@ work. Any value not specified will use its default value if it has one if not it | `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)
**Values:** Any number | | `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 [key's](#collection_section) 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](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: latest-5
Values: Number greater than 0
endingControls the ending year for collections
Default: latest
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value latest
  • You can also use a value relative to the latest by doing latest-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Venice <>`
**Values:** Any string with `<>` in it. | diff --git a/docs/defaults/both/actor.md b/docs/defaults/both/actor.md index ea865a8b6..88d255220 100644 --- a/docs/defaults/both/actor.md +++ b/docs/defaults/both/actor.md @@ -56,8 +56,8 @@ work. Any value not specified will use its default value if it has one if not it | `style` | **Description:** Controls the visual theme of the collections created.
**Default:** `bw`
**Values:** `bw`, `rainier`, `signature`, `diiivoy`, or `diiivoycolor` | | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.
**Default:** `limit`
**Values:** Number Greater than 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](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
depthControls the depth within the casting credits to search for common actors
Default: 5
Values: Number greater than 0
limitControls the maximum number of collections to create
Default: 25
Values: Number greater than 0
| | `include` | **Description:** Force these Actors to be included to create a Dynamic Collection.
**Values:** List of Actor Names | | `exclude` | **Description:** Exclude these Actors from creating a Dynamic Collection.
**Values:** List of Actor Names | diff --git a/docs/defaults/both/aspect.md b/docs/defaults/both/aspect.md index 369aa215d..22ad25d76 100644 --- a/docs/defaults/both/aspect.md +++ b/docs/defaults/both/aspect.md @@ -59,8 +59,8 @@ work. Any value not specified will use its default value if it has one if not it |:--------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.
**Default:** `limit`
**Values:** Number Greater than 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](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `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 [key's](#collection_section) collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| | `exclude` | **Description:** Exclude these Media Outlets from creating a Dynamic Collection.
**Values:** List of Media Outlet Keys | diff --git a/docs/defaults/both/audio_language.md b/docs/defaults/both/audio_language.md index 676849e2d..1d886d7f7 100644 --- a/docs/defaults/both/audio_language.md +++ b/docs/defaults/both/audio_language.md @@ -54,8 +54,8 @@ work. Any value not specified will use its default value if it has one if not it |:------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.
**Default:** `limit`
**Values:** Number Greater than 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](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `include` | **Description:** Overrides the [default include list](#default-values)
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) | | `append_include` | **Description:** Appends to the [default include list](#default-values)
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) | | `remove_include` | **Description:** Removes from the [default include list](#default-values)
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) | diff --git a/docs/defaults/both/based.md b/docs/defaults/both/based.md index cc0336e7e..964a6c80e 100644 --- a/docs/defaults/both/based.md +++ b/docs/defaults/both/based.md @@ -56,8 +56,8 @@ work. Any value not specified will use its default value if it has one if not it |:--------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.
**Default:** `limit`
**Values:** Number Greater than 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](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `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 [key's](#collection_section) collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| | `exclude` | **Description:** Exclude these Media Outlets from creating a Dynamic Collection.
**Values:** List of Media Outlet Keys | diff --git a/docs/defaults/both/collectionless.md b/docs/defaults/both/collectionless.md index 1879fd82e..970b5404c 100644 --- a/docs/defaults/both/collectionless.md +++ b/docs/defaults/both/collectionless.md @@ -1,7 +1,7 @@ # Collectionless Collection The `collectionless` Default Collection File is used to create a -[Collectionless collection](../../files/builders/plex.md#plex-collectionless) to help Show/Hide Movies/Shows properly in +[Collectionless collection](../../files/builders/plex.md#__tabbed_3_5) to help Show/Hide Movies/Shows properly in your library. ![](../images/collectionless.png) @@ -23,7 +23,7 @@ Requirements: | Collection | Description | |:-----------------|:---------------------------------------------------------------------------------------------------------------------------------------| -| `Collectionless` | [Collectionless collection](../../files/builders/plex.md#plex-collectionless) to help Show/Hide Movies/Shows properly in your library. | +| `Collectionless` | [Collectionless collection](../../files/builders/plex.md#__tabbed_3_5) to help Show/Hide Movies/Shows properly in your library. | ## Config @@ -66,10 +66,10 @@ work. Any value not specified will use its default value if it has one if not it | `name_collectionless` | **Description:** Changes the name of the collection.
**Values:** New Collection Name | | `summary_collectionless` | **Description:** Changes the summary of the collection.
**Values:** New Collection Summary | | `sort_title` | **Description:** Sets the sort title for the collection.
**Default:** `~_Collectionless`
**Values:** Any String | - | `collection_order` | **Description:** Changes the Collection Order for all collections in this file.
**Default:** `alpha`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `collection_order` | **Description:** Changes the Collection Order for all collections in this file.
**Default:** `alpha`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| | `url_poster` | **Description:** Changes the poster url of the collection.
**Values:** URL directly to the Image | | `exclude` | **Description:** Exclude these Collections from being considered for collectionless.
**Values:** List of Collections | - | `exclude_prefix` | **Description:** Overrides the [default exclude_prefix list](#default-values). Exclude Collections with one of these prefixes from being considered for collectionless.
**Default:** [default exclude_prefix list](#exclude-prefix)
**Values:** List of Prefixes | | + | `exclude_prefix` | **Description:** Overrides the default exclude_prefix list. Exclude Collections with one of these prefixes from being considered for collectionless.
**Default:** default exclude_prefix list
**Values:** List of Prefixes | | ???+ example "Example Template Variable Amendments" diff --git a/docs/defaults/both/content_rating_au.md b/docs/defaults/both/content_rating_au.md index f9961ad73..be6799f9a 100644 --- a/docs/defaults/both/content_rating_au.md +++ b/docs/defaults/both/content_rating_au.md @@ -59,8 +59,8 @@ work. Any value not specified will use its default value if it has one if not it |:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.
**Default:** `limit`
**Values:** Number Greater than 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](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `include` | **Description:** Overrides the [default include list](#default-values).
**Values:** List of Content Ratings found in your library | | `append_include` | **Description:** Appends to the [default include list](#default-values).
**Values:** List of Content Ratings found in your library | | `remove_include` | **Description:** Removes from the [default include list](#default-values).
**Values:** List of Content Ratings found in your library | diff --git a/docs/defaults/both/content_rating_cs.md b/docs/defaults/both/content_rating_cs.md index a1453c668..af4ccedab 100644 --- a/docs/defaults/both/content_rating_cs.md +++ b/docs/defaults/both/content_rating_cs.md @@ -61,8 +61,8 @@ work. Any value not specified will use its default value if it has one if not it |:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.
**Default:** `limit`
**Values:** Number Greater than 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](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `include` | **Description:** Overrides the [default include list](#default-values).
**Values:** List of Content Ratings found in your library | | `append_include` | **Description:** Appends to the [default include list](#default-values).
**Values:** List of Content Ratings found in your library | | `remove_include` | **Description:** Removes from the [default include list](#default-values).
**Values:** List of Content Ratings found in your library | diff --git a/docs/defaults/both/content_rating_de.md b/docs/defaults/both/content_rating_de.md index 04dba954f..56f1f2970 100644 --- a/docs/defaults/both/content_rating_de.md +++ b/docs/defaults/both/content_rating_de.md @@ -59,8 +59,8 @@ work. Any value not specified will use its default value if it has one if not it |:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.
**Default:** `limit`
**Values:** Number Greater than 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](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `include` | **Description:** Overrides the [default include list](#default-values).
**Values:** List of Content Ratings found in your library | | `append_include` | **Description:** Appends to the [default include list](#default-values).
**Values:** List of Content Ratings found in your library | | `remove_include` | **Description:** Removes from the [default include list](#default-values).
**Values:** List of Content Ratings found in your library | diff --git a/docs/defaults/both/content_rating_mal.md b/docs/defaults/both/content_rating_mal.md index b96c2d41e..6117b9d66 100644 --- a/docs/defaults/both/content_rating_mal.md +++ b/docs/defaults/both/content_rating_mal.md @@ -67,8 +67,8 @@ work. Any value not specified will use its default value if it has one if not it |:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.
**Default:** `limit`
**Values:** Number Greater than 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](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `include` | **Description:** Overrides the [default include list](#default-values).
**Values:** List of Content Ratings found in your library | | `append_include` | **Description:** Appends to the [default include list](#default-values).
**Values:** List of Content Ratings found in your library | | `remove_include` | **Description:** Removes from the [default include list](#default-values).
**Values:** List of Content Ratings found in your library | diff --git a/docs/defaults/both/content_rating_nz.md b/docs/defaults/both/content_rating_nz.md index 7eb6bcef6..600af8c8e 100644 --- a/docs/defaults/both/content_rating_nz.md +++ b/docs/defaults/both/content_rating_nz.md @@ -59,8 +59,8 @@ work. Any value not specified will use its default value if it has one if not it |:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.
**Default:** `limit`
**Values:** Number Greater than 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](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `include` | **Description:** Overrides the [default include list](#default-values).
**Values:** List of Content Ratings found in your library | | `append_include` | **Description:** Appends to the [default include list](#default-values).
**Values:** List of Content Ratings found in your library | | `remove_include` | **Description:** Removes from the [default include list](#default-values).
**Values:** List of Content Ratings found in your library | diff --git a/docs/defaults/both/content_rating_uk.md b/docs/defaults/both/content_rating_uk.md index 183de06ca..a2220e222 100644 --- a/docs/defaults/both/content_rating_uk.md +++ b/docs/defaults/both/content_rating_uk.md @@ -59,8 +59,8 @@ work. Any value not specified will use its default value if it has one if not it |:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.
**Default:** `limit`
**Values:** Number Greater than 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](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `include` | **Description:** Overrides the [default include list](#default-values).
**Values:** List of Content Ratings found in your library | | `append_include` | **Description:** Appends to the [default include list](#default-values).
**Values:** List of Content Ratings found in your library | | `remove_include` | **Description:** Removes from the [default include list](#default-values).
**Values:** List of Content Ratings found in your library | diff --git a/docs/defaults/both/genre.md b/docs/defaults/both/genre.md index 8eb434f91..ea9b23c26 100644 --- a/docs/defaults/both/genre.md +++ b/docs/defaults/both/genre.md @@ -54,8 +54,8 @@ work. Any value not specified will use its default value if it has one if not it |:------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.
**Default:** `limit`
**Values:** Number Greater than 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](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `exclude` | **Description:** Exclude these Genres from creating a Dynamic Collection.
**Values:** List of Genres found in your library | | `addons` | **Description:** Overrides the [default addons dictionary](#default-values). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Genres found in your library | | `append_addons` | **Description:** Appends to the [default addons dictionary](#default-values).
**Values:** Dictionary List of Genres found in your library | diff --git a/docs/defaults/both/resolution.md b/docs/defaults/both/resolution.md index 8a6238e96..af1b81f1f 100644 --- a/docs/defaults/both/resolution.md +++ b/docs/defaults/both/resolution.md @@ -64,8 +64,8 @@ work. Any value not specified will use its default value if it has one if not it | `style` | **Description:** Controls the visual theme of the collections created.
Values:
defaultDefault Theme
standardsStandards Theme
| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.
**Default:** `limit`
**Values:** Number Greater than 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](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `include` | **Description:** Overrides the [default include list](#default-values).
**Values:** Any Resolutions found in your library | | `append_include` | **Description:** Appends to the [default include list](#default-values).
**Values:** List of Resolutions found in your library | | `remove_include` | **Description:** Removes from the [default include list](#default-values).
**Values:** List of Resolutions found in your library | diff --git a/docs/defaults/both/streaming.md b/docs/defaults/both/streaming.md index 33c0fa57c..f656042f2 100644 --- a/docs/defaults/both/streaming.md +++ b/docs/defaults/both/streaming.md @@ -81,8 +81,8 @@ work. Any value not specified will use its default value if it has one if not it | `region` | **Description:** Changes some Streaming Service lists to regional variants (see below table for more information.
**Default:** `us`
**Values:** Any [ISO 3166-1 Code](https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) of the region where the streaming information should be based on. | | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `500`
**Values:** Number Greater than 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.
**Default:** `limit`
**Values:** Number Greater than 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](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `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 [key's](#collection_section) 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 | diff --git a/docs/defaults/both/studio.md b/docs/defaults/both/studio.md index 80d99c5b0..5d62306f0 100644 --- a/docs/defaults/both/studio.md +++ b/docs/defaults/both/studio.md @@ -56,8 +56,8 @@ work. Any value not specified will use its default value if it has one if not it |:------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.
**Default:** `limit`
**Values:** Number Greater than 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](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `include` | **Description:** Overrides the [default include list](#default-values).
**Values:** List of Studios found in your library | | `append_include` | **Description:** Appends to the [default include list](#default-values).
**Values:** List of Studios found in your library | | `remove_include` | **Description:** Removes from the [default include list](#default-values).
**Values:** List of Studios found in your library | diff --git a/docs/defaults/both/subtitle_language.md b/docs/defaults/both/subtitle_language.md index f73be02bb..3039ce61a 100644 --- a/docs/defaults/both/subtitle_language.md +++ b/docs/defaults/both/subtitle_language.md @@ -54,8 +54,8 @@ work. Any value not specified will use its default value if it has one if not it |:------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.
**Default:** `limit`
**Values:** Number Greater than 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](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `include` | **Description:** Overrides the [default include list](#default-values)
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) | | `exclude` | **Description:** Exclude these Audio Languages from creating a Dynamic Collection.
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) | | `append_include` | **Description:** Appends to the [default include list](#default-values)
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)
**Values:** List of [ISO 639-2 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-2_codes) | diff --git a/docs/defaults/both/universe.md b/docs/defaults/both/universe.md index 46abd9f8f..bf0fc5f05 100644 --- a/docs/defaults/both/universe.md +++ b/docs/defaults/both/universe.md @@ -67,8 +67,8 @@ work. Any value not specified will use its default value if it has one if not it |:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `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 [key's](#collection_section) 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](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| | `minimum_items` | **Description:** Controls the minimum items that the collection must have to be created.
**Default:** `2`
**Values:** Any number | | `name_mapping_<>`1 | **Description:** Sets the name mapping value for using assets of the [key's](#collection_section) collection.
**Values:** Any String | | `imdb_list_<>`1 | **Description:** Adds the Movies in the IMDb List to the [key's](#collection_section) collection.
**Values:** List of IMDb List URLs | | | diff --git a/docs/defaults/both/year.md b/docs/defaults/both/year.md index c446885e1..f796f7d4a 100644 --- a/docs/defaults/both/year.md +++ b/docs/defaults/both/year.md @@ -53,8 +53,8 @@ work. Any value not specified will use its default value if it has one if not it |:------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `10`
**Values:** Number Greater than 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.
**Default:** `limit`
**Values:** Number Greater than 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](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-10
Values: Number greater than 0
endingControls the ending year for collections
Default: current_year
Values: Number greater than 1
incrementControls the increment (i.e. every 5th year)
Default: 1
Values: Number greater than 0
  • starting and ending can also have the value current_year
  • You can also use a value relative to the current_year by doing current_year-5
| | `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.
**Values:** List of Years | diff --git a/docs/defaults/chart/anilist.md b/docs/defaults/chart/anilist.md index 7e087d29e..fe28185df 100644 --- a/docs/defaults/chart/anilist.md +++ b/docs/defaults/chart/anilist.md @@ -53,8 +53,8 @@ work. Any value not specified will use its default value if it has one if not it | `limit_<>`1 | **Description:** Changes the number of items in a collection of the [key's](#collection_section) 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 [key's](#collection_section) 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](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| | `style` | **Description:** Changes the color scheme of the collection posters.
**Default:** `color`
**Values:** `color` or `white` | 1. Each default collection has a `key` [see here]() that you must replace diff --git a/docs/defaults/chart/basic.md b/docs/defaults/chart/basic.md index 9c58e23a5..cb74355e6 100644 --- a/docs/defaults/chart/basic.md +++ b/docs/defaults/chart/basic.md @@ -49,8 +49,8 @@ work. Any value not specified will use its default value if it has one if not it |:----------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | **Description:** Changes the Smart Filter Limit for all collections in a Defaults file.
**Values:** Number greater than 0 | | `limit_<>`1 | **Description:** Changes the Smart Filter Limit of the [key's](#collection_section) collection.
**Default:** `limit`
**Values:** Number greater than 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](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `in_the_last_<>`1 | **Description:** Changes how far back the Smart Filter looks.
**Default:**
`released``90`
`episodes``7`
**Values:** Number greater than 0 | | `style` | **Description:** Changes the color scheme of the collection posters.
**Default:** `color`
**Values:** `color` or `white` | diff --git a/docs/defaults/chart/imdb.md b/docs/defaults/chart/imdb.md index 212ff728b..320fbbf58 100644 --- a/docs/defaults/chart/imdb.md +++ b/docs/defaults/chart/imdb.md @@ -52,8 +52,8 @@ work. Any value not specified will use its default value if it has one if not it |:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `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 [key's](#collection_section) 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](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| | `style` | **Description:** Changes the color scheme of the collection posters.
**Default:** `color`
**Values:** `color` or `white` | 1. Each default collection has a `key` [see here]() that you must replace diff --git a/docs/defaults/chart/letterboxd.md b/docs/defaults/chart/letterboxd.md index 1dadaefca..b6d37b5c9 100644 --- a/docs/defaults/chart/letterboxd.md +++ b/docs/defaults/chart/letterboxd.md @@ -64,8 +64,8 @@ work. Any value not specified will use its default value if it has one if not it |:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `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 [key's](#collection_section) 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](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| | `cache_builders` | **Description:** Changes the Builder Cache for all collections in a Defaults file.
**Default:** `1`
**Values:** number 0 or greater | | `cache_builders_<>` | **Description:** Changes the Builder Cache of the [key's](#collection_section) collection.
**Default:** `1`
**Values:** number 0 or greater | | `style` | **Description:** Changes the color scheme of the collection posters.
**Default:** `color`
**Values:** `color` or `white` | diff --git a/docs/defaults/chart/myanimelist.md b/docs/defaults/chart/myanimelist.md index a20e8da94..338bc5daa 100644 --- a/docs/defaults/chart/myanimelist.md +++ b/docs/defaults/chart/myanimelist.md @@ -55,8 +55,8 @@ work. Any value not specified will use its default value if it has one if not it | `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
| | `starting_only` | **Description:** Changes the season collection to only use anime listed under the new section on [MAL Seasons](https://myanimelist.net/anime/season/)
**Default:** `False`
**Values:** `True` or `False` | | `sync_mode_<>`1 | **Description:** Changes the Sync Mode of the [key's](#collection_section) 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](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| | `style` | **Description:** Changes the color scheme of the collection posters.
**Default:** `color`
**Values:** `color` or `white` | 1. Each default collection has a `key` [see here]() that you must replace diff --git a/docs/defaults/chart/other.md b/docs/defaults/chart/other.md index 83efde276..f172eac6e 100644 --- a/docs/defaults/chart/other.md +++ b/docs/defaults/chart/other.md @@ -54,8 +54,8 @@ work. Any value not specified will use its default value if it has one if not it | `limit_anidb` | **Description:** Changes the Builder Limit of the AniDB Popular Collection.
**Default:** `30`
**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 [key's](#collection_section) 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](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| | `style` | **Description:** Changes the color scheme of the collection posters.
**Default:** `color`
**Values:** `color` or `white` | 1. Each default collection has a `key` [see here]() that you must replace diff --git a/docs/defaults/chart/tautulli.md b/docs/defaults/chart/tautulli.md index c5496d923..d667b391d 100644 --- a/docs/defaults/chart/tautulli.md +++ b/docs/defaults/chart/tautulli.md @@ -56,8 +56,8 @@ work. Any value not specified will use its default value if it has one if not it | `list_size_<>`1 | **Description:** Changes the `list_size` attribute of the builder of the [key's](#collection_section) collection.
**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 [key's](#collection_section) 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](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| | `style` | **Description:** Changes the color scheme of the collection posters.
**Default:** `color`
**Values:** `color` or `white` | 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/tmdb.md b/docs/defaults/chart/tmdb.md index 00a02bd58..0936755e5 100644 --- a/docs/defaults/chart/tmdb.md +++ b/docs/defaults/chart/tmdb.md @@ -56,8 +56,8 @@ work. Any value not specified will use its default value if it has one if not it | `limit_<>`1 | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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 [key's](#collection_section) 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](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| | `style` | **Description:** Changes the color scheme of the collection posters.
**Default:** `color`
**Values:** `color` or `white` | 1. Each default collection has a `key` [see here]() that you must replace diff --git a/docs/defaults/chart/trakt.md b/docs/defaults/chart/trakt.md index 3ef73b675..dac4a7feb 100644 --- a/docs/defaults/chart/trakt.md +++ b/docs/defaults/chart/trakt.md @@ -56,8 +56,8 @@ work. Any value not specified will use its default value if it has one if not it | `limit_<>`1 | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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 [key's](#collection_section) 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](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| | `style` | **Description:** Changes the color scheme of the collection posters.
**Default:** `color`
**Values:** `color` or `white` | 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/movie/content_rating_us.md b/docs/defaults/movie/content_rating_us.md index d5a767d8e..2d77775ea 100644 --- a/docs/defaults/movie/content_rating_us.md +++ b/docs/defaults/movie/content_rating_us.md @@ -58,8 +58,8 @@ work. Any value not specified will use its default value if it has one if not it |:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.
**Default:** `limit`
**Values:** Number Greater than 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](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `include` | **Description:** Overrides the [default include list](#default-values).
**Values:** List of Content Ratings found in your library | | `append_include` | **Description:** Appends to the [default include list](#default-values).
**Values:** List of Content Ratings found in your library | | `remove_include` | **Description:** Removes from the [default include list](#default-values).
**Values:** List of Content Ratings found in your library | diff --git a/docs/defaults/movie/continent.md b/docs/defaults/movie/continent.md index 22d789270..5bfbb15dd 100644 --- a/docs/defaults/movie/continent.md +++ b/docs/defaults/movie/continent.md @@ -60,8 +60,8 @@ work. Any value not specified will use its default value if it has one if not it | `style` | **Description:** Controls the visual theme of the collections created
Values:
whiteWhite Theme
colorColor Theme
| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.
**Default:** `limit`
**Values:** Number Greater than 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](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `include` | **Description:** Overrides the [default include list](#default-values).
**Values:** List of Countries found in your library | | `append_include` | **Description:** Appends to the [default include list](#default-values).
**Values:** List of Countries found in your library | | `remove_include` | **Description:** Removes from the [default include list](#default-values).
**Values:** List of Countries found in your library | diff --git a/docs/defaults/movie/country.md b/docs/defaults/movie/country.md index 250f9bd22..9024f9fe0 100644 --- a/docs/defaults/movie/country.md +++ b/docs/defaults/movie/country.md @@ -60,8 +60,8 @@ work. Any value not specified will use its default value if it has one if not it | `style` | **Description:** Controls the visual theme of the collections created
Values:
whiteWhite Theme
colorColor Theme
| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.
**Default:** `limit`
**Values:** Number Greater than 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](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `include` | **Description:** Overrides the [default include list](#default-values).
**Values:** List of Countries found in your library | | `append_include` | **Description:** Appends to the [default include list](#default-values).
**Values:** List of Countries found in your library | | `remove_include` | **Description:** Removes from the [default include list](#default-values).
**Values:** List of Countries found in your library | diff --git a/docs/defaults/movie/decade.md b/docs/defaults/movie/decade.md index e49fac6a7..6cd555933 100644 --- a/docs/defaults/movie/decade.md +++ b/docs/defaults/movie/decade.md @@ -52,8 +52,8 @@ work. Any value not specified will use its default value if it has one if not it |:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `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 [key's](#collection_section) collection.
**Default:** `limit`
**Values:** Number Greater than 0 | - | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `critic_rating.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `critic_rating.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `exclude` | **Description:** Exclude these Decades from creating a Dynamic Collection.
**Values:** List of Decades found in your library | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Best of <>`
**Values:** Any string with `<>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `Top <> <>s of the <>.`
**Values:** Any string. | diff --git a/docs/defaults/movie/director.md b/docs/defaults/movie/director.md index 36423d026..44b0c33bf 100644 --- a/docs/defaults/movie/director.md +++ b/docs/defaults/movie/director.md @@ -53,8 +53,8 @@ work. Any value not specified will use its default value if it has one if not it | `style` | **Description:** Controls the visual theme of the collections created.
**Default:** `bw`
**Values:** `bw`, `rainier`, `signature`, `diiivoy`, or `diiivoycolor` | | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.
**Default:** `limit`
**Values:** Number Greater than 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](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
depthControls the depth within the casting credits to search for common actors
Default: 5
Values: Number greater than 0
limitControls the maximum number of collections to create
Default: 25
Values: Number greater than 0
| | `include` | **Description:** Force these Actors to be included to create a Dynamic Collection.
**Values:** List of Actor Names | | `exclude` | **Description:** Exclude these Directors from creating a Dynamic Collection.
**Values:** List of Director Names | diff --git a/docs/defaults/movie/franchise.md b/docs/defaults/movie/franchise.md index 1bc99862c..8cb915621 100644 --- a/docs/defaults/movie/franchise.md +++ b/docs/defaults/movie/franchise.md @@ -72,8 +72,8 @@ work. Any value not specified will use its default value if it has one if not it | `build_collection` | **Description:** Controls if you want the collection to actually be built. i.e. you may just want these movies sent to Radarr.
**Values:** `false` to not build the collection | | `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 [key's](#collection_section) 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 this file.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `collection_order` | **Description:** Changes the Collection Order for all collections in this file.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| | `title_override` | **Description:** Overrides the [default title_override dictionary](#default-values).
**Values:** Dictionary with `key: new_title` entries | | `exclude` | **Description:** Exclude these TMDb Collections from creating a Dynamic Collection.
**Values:** List of TMDb Collection IDs | | `addons` | **Description:** Overrides the [default addons dictionary](#default-values). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of TMDb Collection IDs | diff --git a/docs/defaults/movie/producer.md b/docs/defaults/movie/producer.md index fde87e706..f9cddd3f8 100644 --- a/docs/defaults/movie/producer.md +++ b/docs/defaults/movie/producer.md @@ -53,8 +53,8 @@ work. Any value not specified will use its default value if it has one if not it | `style` | **Description:** Controls the visual theme of the collections created.
**Default:** `bw`
**Values:** `bw`, `rainier`, `signature`, `diiivoy`, or `diiivoycolor` | | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.
**Default:** `limit`
**Values:** Number Greater than 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](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
depthControls the depth within the casting credits to search for common actors
Default: 5
Values: Number greater than 0
limitControls the maximum number of collections to create
Default: 25
Values: Number greater than 0
| | `include` | **Description:** Force these Actors to be included to create a Dynamic Collection.
**Values:** List of Actor Names | | `exclude` | **Description:** Exclude these Producers from creating a Dynamic Collection.
**Values:** List of Producer Names | diff --git a/docs/defaults/movie/region.md b/docs/defaults/movie/region.md index 1a5105269..9726f3816 100644 --- a/docs/defaults/movie/region.md +++ b/docs/defaults/movie/region.md @@ -64,8 +64,8 @@ work. Any value not specified will use its default value if it has one if not it | `style` | **Description:** Controls the visual theme of the collections created
Values:
whiteWhite Theme
colorColor Theme
| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.
**Default:** `limit`
**Values:** Number Greater than 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](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `include` | **Description:** Overrides the [default include list](#default-values).
**Values:** List of Countries found in your library | | `exclude` | **Description:** Exclude these Countries from creating a Dynamic Collection.
**Values:** List of Countries found in your library | | `addons` | **Description:** Overrides the [default addons dictionary](#default-values). Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
**Values:** Dictionary List of Countries found in your library | diff --git a/docs/defaults/movie/seasonal.md b/docs/defaults/movie/seasonal.md index 9e800648f..93b2db276 100644 --- a/docs/defaults/movie/seasonal.md +++ b/docs/defaults/movie/seasonal.md @@ -78,8 +78,8 @@ work. Any value not specified will use its default value if it has one if not it | `limit_<>`1 | **Description:** Changes the Builder Limit of the specified [key's](#collection_section) 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_section) collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| - | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in this file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in this file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the specified [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `schedule` | **Description:** Changes the Schedule for all collections in this file. Use `daily` to have all collections show.
**Values:** [Any Schedule Option](../../config/schedule.md) | | `schedule_<>`1 | **Description:** Changes the Schedule of the specified [key's](#collection_section) collection. Overrides the [default schedule](#default-values) for that collection if used.
**Values:** [Any Schedule Option](../../config/schedule.md) | | `data` | **Description:** Overrides the [default data dictionary](#default-values). Defines the data that the custom dynamic collection processes.
**Values:** Dictionary List of keys/names | diff --git a/docs/defaults/movie/writer.md b/docs/defaults/movie/writer.md index c7de09185..e6ad677a3 100644 --- a/docs/defaults/movie/writer.md +++ b/docs/defaults/movie/writer.md @@ -53,8 +53,8 @@ work. Any value not specified will use its default value if it has one if not it | `style` | **Description:** Controls the visual theme of the collections created.
**Default:** `bw`
**Values:** `bw`, `rainier`, `signature`, `diiivoy`, or `diiivoycolor` | | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.
**Default:** `limit`
**Values:** Number Greater than 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](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
depthControls the depth within the casting credits to search for common actors
Default: 5
Values: Number greater than 0
limitControls the maximum number of collections to create
Default: 25
Values: Number greater than 0
| | `include` | **Description:** Force these Actors to be included to create a Dynamic Collection.
**Values:** List of Actor Names | | `exclude` | **Description:** Exclude these Writers from creating a Dynamic Collection.
**Values:** List of Writer Names | diff --git a/docs/defaults/show/content_rating_us.md b/docs/defaults/show/content_rating_us.md index 7c38c40f7..ec419c648 100644 --- a/docs/defaults/show/content_rating_us.md +++ b/docs/defaults/show/content_rating_us.md @@ -56,8 +56,8 @@ work. Any value not specified will use its default value if it has one if not it |:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.
**Default:** `limit`
**Values:** Number Greater than 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](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `include` | **Description:** Overrides the [default include list](#default-values).
**Values:** List of Content Ratings found in your library | | `append_include` | **Description:** Appends to the [default include list](#default-values).
**Values:** List of Content Ratings found in your library | | `remove_include` | **Description:** Removes from the [default include list](#default-values).
**Values:** List of Content Ratings found in your library | diff --git a/docs/defaults/show/continent.md b/docs/defaults/show/continent.md index 41469ef1b..7ff00ec20 100644 --- a/docs/defaults/show/continent.md +++ b/docs/defaults/show/continent.md @@ -58,8 +58,8 @@ Note that the `template_variables:` section only needs to be used if you do want | `limit_<>`1 | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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 [key's](#collection_section) collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| - | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `include` | **Description:** Overrides the [default include list](#default-values).
**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) | | `append_include` | **Description:** Appends to the [default include list](#default-values).
**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) | | `remove_include` | **Description:** Removes from the [default include list](#default-values).
**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) | diff --git a/docs/defaults/show/country.md b/docs/defaults/show/country.md index 40880656c..cd2135026 100644 --- a/docs/defaults/show/country.md +++ b/docs/defaults/show/country.md @@ -58,8 +58,8 @@ Note that the `template_variables:` section only needs to be used if you do want | `limit_<>`1 | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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 [key's](#collection_section) collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| - | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `include` | **Description:** Overrides the [default include list](#default-values).
**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) | | `append_include` | **Description:** Appends to the [default include list](#default-values).
**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) | | `remove_include` | **Description:** Removes from the [default include list](#default-values).
**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) | diff --git a/docs/defaults/show/decade.md b/docs/defaults/show/decade.md index 4feb1ff26..a6063f649 100644 --- a/docs/defaults/show/decade.md +++ b/docs/defaults/show/decade.md @@ -52,8 +52,8 @@ work. Any value not specified will use its default value if it has one if not it |:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `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 [key's](#collection_section) collection.
**Default:** `limit`
**Values:** Number Greater than 0 | - | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `critic_rating.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `critic_rating.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `exclude` | **Description:** Exclude these Decades from creating a Dynamic Collection.
**Values:** List of Decades found in your library | | `name_format` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Best of <>`
**Values:** Any string with `<>` in it. | | `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `Top <> <>s of the <>.`
**Values:** Any string. | diff --git a/docs/defaults/show/franchise.md b/docs/defaults/show/franchise.md index e5d587991..06c33e398 100644 --- a/docs/defaults/show/franchise.md +++ b/docs/defaults/show/franchise.md @@ -63,8 +63,8 @@ work. Any value not specified will use its default value if it has one if not it | `build_collection` | **Description:** Controls if you want the collection to actually be built. i.e. you may just want these shows sent to Sonarr.
**Values:** `false` to not build the collection | | `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 [key's](#collection_section) 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 this file.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| - | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| + | `collection_order` | **Description:** Changes the Collection Order for all collections in this file.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| + | `collection_order_<>`1 | **Description:** Changes the Collection Order of the [key's](#collection_section) 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](../../files/builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| | `exclude` | **Description:** Exclude these Collections from creating a Dynamic Collection.
**Values:** List of Collection IDs | | `data` | **Description:** Overrides the [default data dictionary](#default-values ). Defines the data that the custom dynamic collection processes.
**Values:** Dictionary List of TMDb Main Show ID | | `append_data` | **Description:** Appends to the [default data dictionary](#default-values).
**Values:** Dictionary List of TMDb Main Show ID | diff --git a/docs/defaults/show/network.md b/docs/defaults/show/network.md index eb43c099e..fc8221461 100644 --- a/docs/defaults/show/network.md +++ b/docs/defaults/show/network.md @@ -66,8 +66,8 @@ work. Any value not specified will use its default value if it has one if not it |:------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater than 0 | | `limit_<>`1 | **Description:** Changes the Builder Limit of the [key's](#collection_section) collection.
**Default:** `limit`
**Values:** Number Greater than 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](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `style` | **Description:** Choose between the default color version or the **white** one.
**Values:** `color` or `white` | | `include` | **Description:** Overrides the [default include list](#default-values).
**Values:** List of Networks found in your library | | `append_include` | **Description:** Appends to the [default include list](#default-values).
**Values:** List of Networks found in your library | diff --git a/docs/defaults/show/region.md b/docs/defaults/show/region.md index 8f3fdbcc7..446159d4e 100644 --- a/docs/defaults/show/region.md +++ b/docs/defaults/show/region.md @@ -66,8 +66,8 @@ work. Any value not specified will use its default value if it has one if not it | `limit_<>`1 | **Description:** Changes the Builder Limit of the [key's](#collection_section) 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 [key's](#collection_section) collection.
**Default:** `sync_mode`
**Values:**
`sync`Add and Remove Items based on Builders
`append`Only Add Items based on Builders
| - | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | - | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) | + | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | + | `sort_by_<>`1 | **Description:** Changes the Smart Filter Sort of the [key's](#collection_section) collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../files/builders/plex.md#__tabbed_1_4) | | `include` | **Description:** Overrides the [default include list](#default-values).
**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) | | `append_include` | **Description:** Appends to the [default include list](#default-values).
**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) | | `remove_include` | **Description:** Removes from the [default include list](#default-values).
**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) | diff --git a/docs/files/builders/icheckmovies.md b/docs/files/builders/icheckmovies.md index 9161ffea0..64353879d 100644 --- a/docs/files/builders/icheckmovies.md +++ b/docs/files/builders/icheckmovies.md @@ -9,7 +9,6 @@ You can find items using the lists on [ICheckMovies.com](https://www.icheckmovie | Attribute | Description | Works with Movies | Works with Shows | Works with Playlists and Custom Sort | |:-----------------------------------------------|:--------------------------------------------------------------------------------------------------------------------|:------------------------------------------:|:----------------------------------------:|:------------------------------------------:| | [`icheckmovies_list`](#__tabbed_1_1) | Finds every movie in the ICheckMovies List | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| [`icheckmovies_list_details`](#__tabbed_1_1) | Finds every movie in the ICheckMovies List and updates the collection with the description of the ICheckMovies list | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | === "ICheckMovies List" diff --git a/docs/files/builders/imdb.md b/docs/files/builders/imdb.md index 595581bdd..19013952d 100644 --- a/docs/files/builders/imdb.md +++ b/docs/files/builders/imdb.md @@ -422,7 +422,7 @@ You can find items using the features of [IMDb.com](https://www.imdb.com/) (IMDb Due to recent changes in IMDb's code, `imdb_list` can no longer be used for any url which starts with `https://www.imdb.com/search/` or `https://www.imdb.com/filmosearch/`. - These must instead use the [IMDb Search Builder](#imdb-search) + These must instead use the [IMDb Search Builder](#__tabbed_1_3) Finds every item in an IMDb List. diff --git a/docs/files/builders/letterboxd.md b/docs/files/builders/letterboxd.md index efc0be2e1..14f224d33 100644 --- a/docs/files/builders/letterboxd.md +++ b/docs/files/builders/letterboxd.md @@ -9,7 +9,6 @@ You can find items using the lists on [Letterboxd.com](https://letterboxd.com/) | Attribute | Description | Works with Movies | Works with Shows | Works with Playlists and Custom Sort | |:-------------------------------------------|:----------------------------------------------------------------------------------------------------------------|:------------------------------------------:|:----------------------------------------:|:------------------------------------------:| | [`letterboxd_list`](#__tabbed_1_1) | Finds every movie in the Letterboxd List | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| [`letterboxd_list_details`](#__tabbed_1_2) | Finds every movie in the Letterboxd List and updates the collection with the description of the Letterboxd list | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | === "Letterboxd List" diff --git a/docs/files/builders/overview.md b/docs/files/builders/overview.md index c4f376035..00c7ef361 100644 --- a/docs/files/builders/overview.md +++ b/docs/files/builders/overview.md @@ -4,31 +4,17 @@ Builders use third-party services to source items to be added to the collection. !!! builder - ![Smart Plex logo](../../assets/icons/plex.png){ align=right } + ![Plex logo](../../assets/icons/plex.png){ align=right } - **[Plex (Smart)](smart.md)** builders create Smart Collections based on the metadata inside your Plex Server. Results are dynamic and will update as your library updates without the need to re-run Kometa. - - [:octicons-home-16: View Builder](smart.md){ .md-button .md-button--primary } - [:octicons-alert-24:](""){ .card-link title="Cannot be used for Overlays unless utilizing Smart Labels" } - - ??? quicklink "Popular Builders" - - - [:simple-plex: Smart Label](smart.md#smart-label) - Create a Smart Collection based on a specific label. The label can be generated by Kometa based on criteria. - - [:simple-plex: Smart Filter](smart.md#smart-filter) - Create a Smart Collection based on the filter parameters provided. - -!!! builder - - ![Dumb Plex logo](../../assets/icons/plex_dumb.png){ align=right } - - **[Plex (Dumb)](smart.md)** builders grab items based on the metadata inside your Plex Server. Results are static and require Kometa to re-run to update. + **[Plex](plex.md)** builders create Smart Collections based on the metadata inside your Plex Server. Results are dynamic and will update as your library updates without the need to re-run Kometa. [:octicons-home-16: View Builder](plex.md){ .md-button .md-button--primary } + [:octicons-alert-24:](""){ .card-link title="Cannot be used for Overlays unless utilizing Smart Labels" } ??? quicklink "Popular Builders" - - [:simple-plex: Plex All](plex.md#plex-all) - Gets every movie/show in your library. - - [:simple-plex: Plex Search](plex.md#plex-search) - Gets every movie/show based on the search parameters provided. - - [:simple-plex: Plex Collectionless](plex.md#plex-collectionless) - Gets every movie/show that is not in a collection. + - [:simple-plex: Smart Label](plex.md#__tabbed_2_2) - Create a Smart Collection based on a specific label. The label can be generated by Kometa based on criteria. + - [:simple-plex: Smart Filter](plex.md#__tabbed_2_1) - Create a Smart Collection based on the filter parameters provided. !!! builder @@ -40,10 +26,10 @@ Builders use third-party services to source items to be added to the collection. ??? quicklink "Popular Builders" - - [:simple-themoviedatabase: TMDb Collection](tmdb.md#tmdb-collection) - Gets every movie/show in your library. - - [:simple-themoviedatabase: TMDb List](tmdb.md#tmdb-list) - Gets every movie/show in your Watchlist. - - [:simple-themoviedatabase: TMDb Company](tmdb.md#tmdb-company) - Gets the first episode of every show in your library. - - [:simple-themoviedatabase: TMDb Network](tmdb.md#tmdb-network) - Gets the first episode of every show in your library. + - [:simple-themoviedatabase: TMDb Collection](tmdb.md#__tabbed_2_2) - Gets every movie/show in your library. + - [:simple-themoviedatabase: TMDb List](tmdb.md#__tabbed_2_3) - Gets every movie/show in your Watchlist. + - [:simple-themoviedatabase: TMDb Company](tmdb.md#__tabbed_2_6) - Gets the first episode of every show in your library. + - [:simple-themoviedatabase: TMDb Network](tmdb.md#__tabbed_2_7) - Gets the first episode of every show in your library. !!! builder @@ -55,9 +41,9 @@ Builders use third-party services to source items to be added to the collection. ??? quicklink "Popular Builders" - - [:simple-trakt: Trakt List](trakt.md#trakt-list) - Gets every movie/show in the Trakt List - - [:simple-trakt: Trakt Chart](trakt.md#trakt-chart) - Gets every movie/show in the Trakt Chart - - [:simple-trakt: Trakt Recommendations](trakt.md#trakt-recommendations) - Gets every movie/show in Trakt's Personal Recommendations for your User + - [:simple-trakt: Trakt List](trakt.md#__tabbed_1_1) - Gets every movie/show in the Trakt List + - [:simple-trakt: Trakt Chart](trakt.md#__tabbed_1_2) - Gets every movie/show in the Trakt Chart + - [:simple-trakt: Trakt Recommendations](trakt.md#__tabbed_1_4) - Gets every movie/show in Trakt's Personal Recommendations for your User !!! builder @@ -69,7 +55,7 @@ Builders use third-party services to source items to be added to the collection. ??? quicklink "Popular Builders" - - [:octicons-list-ordered-16: MDBList List](mdblist.md#mdblist-list) - Gets every movie/show in a MDBList List. + - [:octicons-list-ordered-16: MDBList List](mdblist.md#__tabbed_1_1) - Gets every movie/show in a MDBList List. !!! builder @@ -81,10 +67,10 @@ Builders use third-party services to source items to be added to the collection. ??? quicklink "Popular Builders" - - [:simple-imdb: IMDb Chart](imdb.md#imdb-chart) - Gets every movie/show in an IMDb Chart like IMDb Top 250 Movies. - - [:simple-imdb: IMDb List](imdb.md#imdb-list) - Gets every movie/show in an IMDb List. - - [:simple-imdb: IMDb Award](imdb.md#imdb-award) - Gets every movie/show in an IMDb Event. - - [:simple-imdb: IMDb Search](imdb.md#imdb-award) - Gets every movie/show in an IMDb Search. Can also be used for Keyword searches. + - [:simple-imdb: IMDb Search](imdb.md#__tabbed_1_1) - Gets every movie/show in an IMDb Search. Can also be used for Keyword searches. + - [:simple-imdb: IMDb Chart](imdb.md#__tabbed_1_2) - Gets every movie/show in an IMDb Chart like IMDb Top 250 Movies. + - [:simple-imdb: IMDb List](imdb.md#__tabbed_1_4) - Gets every movie/show in an IMDb List. + - [:simple-imdb: IMDb Award](imdb.md#__tabbed_1_6) - Gets every movie/show in an IMDb Event. !!! builder @@ -96,9 +82,9 @@ Builders use third-party services to source items to be added to the collection. ??? quicklink "Popular Builders" - - [:material-television-guide: TVDb Show](tvdb.md#tvdb-show) - Grabs the specified series. - - [:material-television-guide: TVDb Movie](tvdb.md#tvdb-movie) - Gets the specified movies. - - [:material-television-guide: TVDb List](tvdb.md#tvdb-list) - Gets every item in a TVDb List or TVDb UserList. + - [:material-television-guide: TVDb Show](tvdb.md#__tabbed_1_2) - Grabs the specified series. + - [:material-television-guide: TVDb Movie](tvdb.md#__tabbed_1_3) - Gets the specified movies. + - [:material-television-guide: TVDb List](tvdb.md#__tabbed_1_1) - Gets every item in a TVDb List or TVDb UserList. !!! builder @@ -125,8 +111,8 @@ Builders use third-party services to source items to be added to the collection. ??? quicklink "Popular Builders" - - [:material-movie-search: Tautulli Popular](tautulli.md#tautulli-popularwatched) - Gets every movie/show in the Tautulli Most Popular List - - [:material-movie-search: Tautulli Watched](tautulli.md#tautulli-popularwatched) - Gets every movie/show in the Tautulli Most Watched List + - [:material-movie-search: Tautulli Popular](tautulli.md#__tabbed_1_1) - Gets every movie/show in the Tautulli Most Popular List + - [:material-movie-search: Tautulli Watched](tautulli.md#__tabbed_1_1) - Gets every movie/show in the Tautulli Most Watched List !!! builder @@ -139,8 +125,8 @@ Builders use third-party services to source items to be added to the collection. ??? quicklink "Popular Builders" - - [:octicons-tag-16: Radarr All](radarr.md#radarr-all) - Gets every movie in Radarr - - [:octicons-tag-16: Radarr Taglist](radarr.md#radarr-taglist) - Gets every movie with the specified tags + - [:octicons-tag-16: Radarr All](radarr.md#__tabbed_1_1) - Gets every movie in Radarr + - [:octicons-tag-16: Radarr Taglist](radarr.md#__tabbed_1_2) - Gets every movie with the specified tags !!! builder @@ -153,8 +139,8 @@ Builders use third-party services to source items to be added to the collection. ??? quicklink "Popular Builders" - - [:octicons-tag-16: Sonarr All](sonarr.md#sonarr-all) - Gets every show in Sonarr - - [:octicons-tag-16: Sonarr Taglist](sonarr.md#sonarr-taglist) - Gets every show with the specified tags + - [:octicons-tag-16: Sonarr All](sonarr.md#__tabbed_1_1) - Gets every show in Sonarr + - [:octicons-tag-16: Sonarr Taglist](sonarr.md#__tabbed_1_2) - Gets every show with the specified tags !!! builder @@ -167,7 +153,7 @@ Builders use third-party services to source items to be added to the collection. ??? quicklink "Popular Builders" - - [:simple-letterboxd: Letterboxd List](letterboxd.md#letterboxd-list) - Gets every movie in the Letterboxd list + - [:simple-letterboxd: Letterboxd List](letterboxd.md#__tabbed_1_1) - Gets every movie in the Letterboxd list !!! builder @@ -180,7 +166,7 @@ Builders use third-party services to source items to be added to the collection. ??? quicklink "Popular Builders" - - [:material-check: ICheckMovies List](icheckmovies.md#icheckmovies-list) - Gets every show in the ICheckMovies list + - [:material-check: ICheckMovies List](icheckmovies.md#__tabbed_1_1) - Gets every show in the ICheckMovies list !!! builder @@ -192,9 +178,9 @@ Builders use third-party services to source items to be added to the collection. ??? quicklink "Popular Builders" - - [:octicons-database-16: AniDB ID](anidb.md#anidb-id) - Finds the anime specified by the AniDB ID - - [:octicons-database-16: AniDB Popular](anidb.md#anidb-popular) - Finds every anime in AniDB's Popular Anime list - - [:octicons-database-16: AniDB Tags](anidb.md#anidb-tag) - Finds every anime with the specified AniDB Tag + - [:octicons-database-16: AniDB ID](anidb.md#__tabbed_1_1) - Finds the anime specified by the AniDB ID + - [:octicons-database-16: AniDB Popular](anidb.md#__tabbed_1_3) - Finds every anime in AniDB's Popular Anime list + - [:octicons-database-16: AniDB Tags](anidb.md#__tabbed_1_4) - Finds every anime with the specified AniDB Tag !!! builder @@ -206,10 +192,10 @@ Builders use third-party services to source items to be added to the collection. ??? quicklink "Popular Builders" - - [:simple-anilist: AniList Top Rated](anilist.md#anilist-top-rated) - Gets every anime in AniList's Top Rated Anime list - - [:simple-anilist: AniList Popular](anilist.md#anilist-popular) - Gets every anime in AniList's Popular Anime list - - [:simple-anilist: AniList Trending](anilist.md#anilist-trending) - Gets every anime in AniList's Trending Anime list - - [:simple-anilist: AniList Search](anilist.md#anilist-search) - Gets every anime specified by the AniList search parameters provided + - [:simple-anilist: AniList Top Rated](anilist.md#__tabbed_1_2) - Gets every anime in AniList's Top Rated Anime list + - [:simple-anilist: AniList Popular](anilist.md#__tabbed_1_3) - Gets every anime in AniList's Popular Anime list + - [:simple-anilist: AniList Trending](anilist.md#__tabbed_1_4) - Gets every anime in AniList's Trending Anime list + - [:simple-anilist: AniList Search](anilist.md#__tabbed_1_1) - Gets every anime specified by the AniList search parameters provided !!! builder @@ -221,10 +207,10 @@ Builders use third-party services to source items to be added to the collection. ??? quicklink "Popular Builders" - - [:simple-myanimelist: MyAnimeList Popular](myanimelist.md#myanimelist-most-popular) - Gets every anime in MyAnimeList's Most Popular Anime list - - [:simple-myanimelist: MyAnimeList Top All](myanimelist.md#myanimelist-top-all) - Gets every anime in MyAnimeList's Top All Anime list - - [:simple-myanimelist: MyAnimeList Top Airing](myanimelist.md#myanimelist-top-airing) - Gets every anime in MyAnimeList's Top Airing Anime list - - [:simple-myanimelist: MyAnimeList Suggested](myanimelist.md#myanimelist-suggested) - Gets every suggested anime in by MyAnimeList for the authorized user + - [:simple-myanimelist: MyAnimeList Popular](myanimelist.md#__tabbed_1_9) - Gets every anime in MyAnimeList's Most Popular Anime list + - [:simple-myanimelist: MyAnimeList Top All](myanimelist.md#__tabbed_1_2) - Gets every anime in MyAnimeList's Top All Anime list + - [:simple-myanimelist: MyAnimeList Top Airing](myanimelist.md#__tabbed_1_3) - Gets every anime in MyAnimeList's Top Airing Anime list + - [:simple-myanimelist: MyAnimeList Suggested](myanimelist.md#__tabbed_1_11) - Gets every suggested anime in by MyAnimeList for the authorized user !!! builder @@ -237,7 +223,7 @@ Builders use third-party services to source items to be added to the collection. ??? quicklink "Popular Builders" - - [:material-chef-hat: Reciperr List](reciperr.md#reciperr-list) - Gets every movie returned by the Reciperr JSON data URL. + - [:material-chef-hat: Reciperr List](reciperr.md#__tabbed_1_1) - Gets every movie returned by the Reciperr JSON data URL. !!! builder @@ -250,4 +236,4 @@ Builders use third-party services to source items to be added to the collection. ??? quicklink "Popular Builders" - - [:material-pirate: StevenLu Popular](stevenlu.md#stevenlus-popular-movies-list) - Gets every movie on StevenLu's Popular Movies List. \ No newline at end of file + - [:material-pirate: StevenLu Popular](stevenlu.md#__tabbed_1_1) - Gets every movie on StevenLu's Popular Movies List. \ No newline at end of file diff --git a/docs/files/builders/plex.md b/docs/files/builders/plex.md index a9eeedf74..ed85581e7 100644 --- a/docs/files/builders/plex.md +++ b/docs/files/builders/plex.md @@ -137,7 +137,7 @@ Smart Builders are usually the recommended approach as they are lightweight and To make a collection a Smart Label Collection, the `smart_label` attribute must be added to the collection definition. It functions in two different ways: - 1. Define the sort using the Movies/Shows column of the [Sorts Table](#sort-options) below along with any other builder + 1. Define the sort using the Movies/Shows column of the [Sorts Table](#__tabbed_1_4) below along with any other builder to make that collection a Smart Label Collection. ```yaml collections: @@ -159,8 +159,8 @@ Smart Builders are usually the recommended approach as they are lightweight and ``` This is extremely useful because smart collections don't follow normal show/hide rules and can eliminate the need to - have [Plex Collectionless](plex.md#plex-collectionless) when used correctly. To fix the issue described in - [Plex Collectionless](plex.md#plex-collectionless) you would make `Marvel Cinematic Universe` a Smart Label Collection + have [Plex Collectionless](#__tabbed_3_5) when used correctly. To fix the issue described in + [Plex Collectionless](#__tabbed_3_5) you would make `Marvel Cinematic Universe` a Smart Label Collection and all other Marvel collection just normal collections, and they will show/hide all the movie properly. To have the Smart Label Collections to eliminate Plex Collectionless you have to go all in on using them. A good rule of @@ -369,7 +369,7 @@ Smart Builders are usually the recommended approach as they are lightweight and === "Plex Collectionless" - **This is not needed if you're using [Smart Label Collections](smart.md#smart-label).** + **This is not needed if you're using [Smart Label Collections](#__tabbed_2_2).** Finds every item that is not in a collection unless the collection is in the exclusion list. This is a special collection type to help keep your library looking correct. When items in your library are in multiple collections it @@ -687,5 +687,5 @@ Smart Builders are usually the recommended approach as they are lightweight and | Attribute | Description & Values | |:-----------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | **Description:** The max number of item for the filter.
**Default:** `all`
**Values:** `all` or a number greater than 0 | - | `sort_by` | **Description:** This will control how the filter is sorted in your library. You can do a multi-level sort using a list.
**Default:** `random`
**Values:** Any sort options for your filter type in the [Sorts Options Table](#sort-options) | + | `sort_by` | **Description:** This will control how the filter is sorted in your library. You can do a multi-level sort using a list.
**Default:** `random`
**Values:** Any sort options for your filter type in the [Sorts Options Table](#__tabbed_1_4) | | `validate` | **Description:** Determines if a collection will fail on a validation error
**Default:** `true`
**Values**: `true` or `false` | diff --git a/docs/files/builders/plexnew.md b/docs/files/builders/plexnew.md deleted file mode 100644 index a9eeedf74..000000000 --- a/docs/files/builders/plexnew.md +++ /dev/null @@ -1,691 +0,0 @@ ---- -hide: - - toc ---- - -# Plex Builders - -Plex has two categories of builders - Smart and Dumb (non-smart). - -Smart Builders use rules (filters) to automatically include items that match the criteria of the builder. When new media is added to your library, or if metadata of any item in your library changes to match the builder's rules, the media is automatically included in the collection without the need to run Kometa again. - -Dumb (non-Smart) Builders are static in nature and will not dynamically update as new media is added/metadata criteria changes across your library - you will have to run Kometa any time you want the builder to re-run. - -Smart Builders are usually the recommended approach as they are lightweight and faster to process than Dumb Builders. - -???+ important - - The `Smart Builders` and `Dumb Builders` tabs below will give examples of how to use the Builders, whilst the `Search Options`, `Sort Options` and `Builder Attributes` will give the full list of attributes and customizations available for use with the Builders. - -=== "Smart Builders" - - Smart Builders allow Kometa to create Smart Collections in two different ways. - - The results of these builders are dynamic and do not require Kometa to re-run in order to update, instead they will - update automatically as the data within your Plex Library updates (i.e. if new media is added) - - Smart Filter and Smart Label are the two methods available for Smart Builders. - - Smart Filter Bulders use Plex's [Advanced Filters](https://support.plex.tv/articles/201273953-collections/) to create a smart collection based on the filter parameters provided. Any Advanced Filter made using the Plex UI should be able to be recreated using `smart_filter`. This is the normal approach used when your Builder criteria is held solely within Plex, and no third-party service involvement is required. - - Smart Label Builders attaches a label to every item that meets the criteria, and then creates a Smart Filter to search for that label. This is the normal approach used when you want to use a third-party list (such as Trakt or TMDb) with a Smart Builder. - - ???+ important - - Smart Builders do not work with Playlists - - === "Smart Filter Builder" - - Like Plex's [Advanced Filters](https://support.plex.tv/articles/201273953-collections/), you have to start each filter with either `any` or `all` as a base. You can only - have one base attribute and all filter attributes must be under the base. - - Inside the base attribute you can use any filter below or nest more `any` or `all`. You can have as many nested `any` - or `all` next to each other as you want. If using multiple `any` or `all` you will have to do so in the form of a list. - - **Note: To search by `season`, `episode`, `album`, or `track` you must use the `builder_level` [Setting](../settings.md) - to change the type of items the collection holds.** - - ## Smart Filter Examples - - A few examples are listed below: - - ```yaml - collections: - Documentaries: - smart_filter: - all: - genre: Documentary - ``` - ```yaml - collections: - Dave Chappelle Comedy: - smart_filter: - all: - actor: Dave Chappelle - genre: Comedy - ``` - ```yaml - collections: - Top Action Movies: - smart_filter: - all: - genre: Action - sort_by: audience_rating.desc - limit: 20 - ``` - ```yaml - collections: - 90s Movies: - smart_filter: - any: - year: - - 1990 - - 1991 - - 1992 - - 1993 - - 1994 - - 1995 - - 1996 - - 1997 - - 1998 - - 1999 - ``` - ```yaml - collections: - 90s Movies: - smart_filter: - any: - decade: 1990 - ``` - - If you specify TMDb Person ID's using the Setting `tmdb_person` and then tell either `actor`, `director`, `producer`, or - `writer` to add `tmdb`, the script will translate the TMDb Person IDs into their names and run the filter on those names. - - ```yaml - collections: - Robin Williams: - smart_filter: - all: - actor: tmdb - tmdb_person: 2157 - ``` - ```yaml - collections: - Steven Spielberg: - smart_filter: - all: - director: tmdb - tmdb_person: https://www.themoviedb.org/person/488-steven-spielberg - ``` - ```yaml - collections: - Quentin Tarantino: - smart_filter: - any: - actor: tmdb - director: tmdb - producer: tmdb - writer: tmdb - tmdb_person: 138 - ``` - - === "Smart Label Builder" - - A Smart Label Collection is a smart collection that grabs every item with a specific label generated by the program. - That label is added to all the items the Collection Builders find instead of being added to a normal collection. - - To make a collection a Smart Label Collection, the `smart_label` attribute must be added to the collection definition. - It functions in two different ways: - - 1. Define the sort using the Movies/Shows column of the [Sorts Table](#sort-options) below along with any other builder - to make that collection a Smart Label Collection. - ```yaml - collections: - Marvel Cinematic Universe: - trakt_list: https://trakt.tv/users/jawann2002/lists/marvel-cinematic-universe-movies?sort=rank,asc - smart_label: release.desc - ``` - - 2. Provide a whole `smart_filter` to determine exactly how the smart collection should be built, ensuring to include `label: <>`, which will link it to the collection labels. - ```yaml - collections: - Unplayed Marvel Cinematic Universe: - trakt_list: https://trakt.tv/users/jawann2002/lists/marvel-cinematic-universe-movies?sort=rank,asc - smart_label: - sort_by: release.desc - all: - label: <> - unplayed: true - ``` - - This is extremely useful because smart collections don't follow normal show/hide rules and can eliminate the need to - have [Plex Collectionless](plex.md#plex-collectionless) when used correctly. To fix the issue described in - [Plex Collectionless](plex.md#plex-collectionless) you would make `Marvel Cinematic Universe` a Smart Label Collection - and all other Marvel collection just normal collections, and they will show/hide all the movie properly. - - To have the Smart Label Collections to eliminate Plex Collectionless you have to go all in on using them. A good rule of - thumb to make sure this works correctly is that every item in your library should have a max of one non-smart collection. - - Reach out on the [Kometa Discord](https://kometa.wiki/en/latest/discord/) or in the [GitHub Discussions](https://github.com/Kometa-Team/Kometa/discussions) for help if you're having any issues getting - this to work properly. - -=== "Dumb Builders" - - This builder finds items by using data held solely within Plex. - - The results of these builders are static and require Kometa to re-run in order to update. - - | Attribute | Description | Works with Movies | Works with Shows | Works with Playlists and Custom Sort | - |:----------------------------------------------|:----------------------------------------------------------------------------|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:| - | [`plex_all`](#__tabbed_3_1) | Gets every movie/show in your library. Useful with [Filters](../filters.md) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | [`plex_search`](#__tabbed_3_2) | Gets every movie/show based on the search parameters provided | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | - | [`plex_watchlist`](#__tabbed_3_3) | Gets every movie/show in your Watchlist. | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | - | [`plex_pilots`](#__tabbed_3_4) | Gets the first episode of every show in your library | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | - | [`plex_collectionless`](#__tabbed_3_5) | Gets every movie/show that is not in a collection | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - - === "Plex All" - - Finds every item in your library. Useful with [Filters](../filters.md). - - The expected input is either true or false. - - ```yaml - collections: - 9.0 Movies: - plex_all: true - filters: - user_rating.gte: 9 - ``` - - === "Plex Search" - - Uses Plex's [Advanced Filters](https://support.plex.tv/articles/201273953-collections/) to find all items based on the search parameters provided. - - Any Advanced Filter made using the Plex UI should be able to be recreated using `plex_search`. If you're having trouble - getting `plex_search` to work correctly, build the collection you want inside of Plex's Advanced Filters and take a - screenshot of the parameters in the Plex UI and post it in either the - [Discussions](https://github.com/Kometa-Team/Kometa/discussions) or on [Discord](https://kometa.wiki/en/latest/discord/), - and I'll do my best to help you. - - like Plex's [Advanced Filters](https://support.plex.tv/articles/201273953-collections/) you have to start each search with either `any` or `all` as a base. You can only - have one base attribute and all search attributes must be under the base. - - Inside the base attribute you can use any search below or nest more `any` or `all`. You can have as many nested `any` - or `all` next to each other as you want. If using multiple `any` or `all` you will have to do so in the form of a list. - - **Note: To search by `season`, `episode`, `album`, or `track` you must use the `builder_level` [Setting](../settings.md) to change - the type of items the collection holds.** - - There are a couple other attributes you can have at the top level only along with the base attribute are: - - ## Plex Search Examples - - A few examples are listed below: - - ```yaml - collections: - Documentaries: - plex_search: - all: - genre: Documentary - ``` - ```yaml - collections: - Dave Chappelle Comedy: - plex_search: - all: - actor: Dave Chappelle - genre: Comedy - ``` - ```yaml - collections: - Top Action Movies: - collection_order: custom - plex_search: - all: - genre: Action - sort_by: audience_rating.desc - limit: 20 - ``` - ```yaml - collections: - 90s Movies: - plex_search: - any: - year: - - 1990 - - 1991 - - 1992 - - 1993 - - 1994 - - 1995 - - 1996 - - 1997 - - 1998 - - 1999 - ``` - ```yaml - collections: - 90s Movies: - plex_search: - any: - decade: 1990 - ``` - ```yaml - collections: - Best 2010+ Movies: - collection_order: custom - plex_search: - all: - year.gte: 2010 - sort_by: - - year.desc - - audience_rating.desc - limit: 20 - ``` - - Here's an example of an episode collection using `plex_search`. - - ```yaml - collections: - Top 100 Simpsons Episodes: - collection_order: custom - builder_level: episode - plex_search: - type: episode - sort_by: audience_rating.desc - limit: 100 - all: - title.ends: "Simpsons" - summary: A collection of the highest rated simpsons episodes. - ``` - - If you specify TMDb Person ID's using the Setting `tmdb_person` and then tell either `actor`, `director`, `producer`, or - `writer` to add `tmdb`, the script will translate the TMDb Person IDs into their names and run the search on those names. - - ```yaml - collections: - Robin Williams: - plex_search: - all: - actor: tmdb - tmdb_person: 2157 - ``` - ```yaml - collections: - Steven Spielberg: - plex_search: - all: - director: tmdb - tmdb_person: https://www.themoviedb.org/person/488-steven-spielberg - ``` - ```yaml - collections: - Quentin Tarantino: - plex_search: - any: - actor: tmdb - director: tmdb - producer: tmdb - writer: tmdb - tmdb_person: 138 - ``` - - === "Plex Watchlist" - - Finds every item in your Watchlist. - - The expected input is the sort you want returned. It defaults to `added.asc`. - - ### Watchlist Sort Options - - | Sort Option | Description | - |:--------------------------------------------|:--------------------------------------------| - | `title.asc`
`title.desc` | Sort by Title | - | `release.asc`
`release.desc` | Sort by Release Date (Originally Available) | - | `critic_rating.asc`
`critic_rating.desc` | Sort by Critic Rating | - | `added.asc`
`added.desc` | Sort by Date Added to your Watchlist | - - The `sync_mode: sync` and `collection_order: custom` Setting are recommended. - - ```yaml - collections: - My Watchlist: - plex_watchlist: critic_rating.desc - collection_order: custom - sync_mode: sync - ``` - - === "Plex Pilots" - - Gets the first episode of every show in your library. This only works with `builder_level: episode` - - ```yaml - collections: - Pilots: - builder_level: episode - plex_pilots: true - ``` - - === "Plex Collectionless" - - **This is not needed if you're using [Smart Label Collections](smart.md#smart-label).** - - Finds every item that is not in a collection unless the collection is in the exclusion list. This is a special - collection type to help keep your library looking correct. When items in your library are in multiple collections it - can mess up how they're displayed in your library. - - For Example, if you have a `Marvel Cinematic Universe` Collection set to `Show this collection and its items` and an - `Iron Man` Collection set to `Hide items in this collection` what happens is the show overrides the hide, and you end - up with both the collections and the 3 Iron Man movies all displaying. - - Alternatively, if you set the `Marvel Cinematic Universe` Collection to `Hide items in this collection` then movies - without a collection like `The Incredible Hulk` will be hidden from the library view. - - To combat the problem above you set all collections to `Hide items in this collection` then create a collection set to - `Hide collection` and put every movie that you still want to display in that collection. - - With the variability of collections generated by the Kometa maintaining a collection like this becomes very difficult, - so in order to automate it, you can use `plex_collectionless`. You just have to tell it what collections to exclude or - what collection prefixes to exclude. - - There are two attributes for `plex_collectionless`: - - * `exclude`: Exclude these Collections from being considered for collectionless. - * `exclude_prefix` Exclude Collections whose title or sort title starts with a prefix from being considered for - collectionless. - - **At least one exclusion is required.** - - ```yaml - collections: - Collectionless: - plex_collectionless: - exclude_prefix: - - "!" - - "+" - - "~" - exclude: - - Marvel Cinematic Universe - sort_title: ~_Collectionless - collection_order: alpha - collection_mode: hide - ``` - - * Both `exclude` and `exclude_prefix` can take multiple values as a List. - * This is a known issue with Plex Collection and there is a [Feature Suggestion](https://forums.plex.tv/t/collection-display-issue/305406) detailing the issue more on their - forms. - -=== "Search Options" - - When using a Plex builder, there are three elements that correlate to Plex's Advanced Filters in the Web UI. - - - **Attribute:** What attribute you wish to filter. - - **Modifier:** Which modifier to use. - - **Value:** Actual value to filter. - - These three elements combined would look like `attribute.modifier: value`, in a Builder this may be something like `title.not: Harry Potter` or `episode_added: 7`. - - Attribute and Value elements are mandatory, whilst modifiers are optional. Typically speaking, Plex will have a default modifier of "is" or "contains" if you do not specify a modifier. - - The majority of Smart and Dumb Builders utilize the same Search Options, meaning that the criteria for the builders is largely interchangeable between the two. Any deviation from this will be highlighted against the specific builder. - - === "Boolean Filters" - - Boolean Filters take no modifier and can only be either `true` or `false`. - - #### Boolean Filter Attributes - - | Boolean Search | Description | Movie
Libraries | Show
Libraries | Music
Libraries | - |:--------------------|:-----------------------|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:| - | `hdr` | Is HDR | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `unmatched` | Is Unmatched | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | - | `duplicate` | Is Duplicate | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | - | `unplayed` | Is Unplayed | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | - | `progress` | Is In Progress | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | - | `trash` | Is Trashed | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `unplayed_episodes` | Has Unplayed Episodes | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `episode_unplayed` | Has Episodes Unplayed | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `episode_duplicate` | Has Duplicate Episodes | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `episode_progress` | Has Episode Progress | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `episode_unmatched` | Has Episodes Unmatched | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `show_unmatched` | Has Shows Unmatched | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `artist_unmatched` | Is Artist's Unmatched | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `album_unmatched` | Is Album's Unmatched | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `track_trash` | Is Track Trashed | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - - === "Date Filters" - - Date filters can be used with either no modifier or with `.not`, `.before`, or `.after`. - - No date filter can take multiple values. - - - #### Date Filter Attributes - - | Date Search | Description | Movie
Libraries | Show
Libraries | Music
Libraries | - |:----------------------|:-----------------------------------------------------------------------------------|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:| - | `added` | Uses the date added attribute to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `episode_added` | Uses the date added attribute of the show's episodes to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `release` | Uses the release date attribute (originally available) to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `episode_air_date` | Uses the air date attribute (originally available) of the show's episodes to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `last_played` | Uses the date last played attribute to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `episode_last_played` | Uses the date last played attribute of the show's episodes to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `artist_added` | Uses the Artist's date added attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `artist_last_played` | Uses the Artist's last played attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `album_last_played` | Uses the Album's last played attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `album_added` | Uses the Album's date added attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `album_released` | Uses the Album's release date attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `track_last_played` | Uses the Track's date last played attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `track_last_skipped` | Uses the Track's date last skipped attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `track_last_rated` | Uses the Track's date last rated attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `track_added` | Uses the Track's date added attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - - ???+ tip "Date Filter Modifiers" - - | Date Modifier | Description | Plex Web UI Display | - |:--------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------:| - | No Modifier | Matches every item where the date attribute is in the last X days
**Format:** number of days
**Example:** `30` | `is in the last` | - | `.not` | Matches every item where the date attribute is not in the last X days
**Format:** number of days
**Example:** `30` | `is not in the last` | - | `.before` | Matches every item where the date attribute is before the given date
**Format:** MM/DD/YYYY or `today` for the current day
**Example:** `01/01/2000` | `is before` | - | `.after` | Matches every item where the date attribute is after the given date
**Format:** MM/DD/YYYY or `today` for the current day
**Example:** `01/01/2000` | `is after` | - - === "Number Filters" - - Number filters must use `.gt`, `.gte`, `.lt`, or `.lte` as a modifier only the rating filters can use `.rated`. - - No number filter can take multiple values. - - #### Number Filter Attributes - - | Number Search | Description | Movie
Libraries | Show
Libraries | Music
Libraries | - |:---------------------------|:--------------------------------------------------------------------------------------------|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:| - | `duration` | Uses the duration attribute to match using minutes
**Minimum:** `0` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | - | `plays` | Uses the plays attribute to match
**Minimum:** `0` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `episode_plays` | Uses the Episode's plays attribute to match
**Minimum:** `0` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `critic_rating` | Uses the critic rating attribute to match
**Range:** `0.0` - `10.0` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `audience_rating` | Uses the audience rating attribute to match
**Range:** `0.0` - `10.0` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `user_rating` | Uses the user rating attribute to match
**Range:** `0.0` - `10.0` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `episode_user_rating` | Uses the user rating attribute of the show's episodes to match
**Range:** `0.0` - `10.0` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `year`1 | Uses the year attribute to match
**Minimum:** `0` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `episode_year`1 | Uses the Episode's year attribute to match
**Minimum:** `0` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `album_year`1 | Uses the Album's year attribute to match
**Minimum:** `0` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `album_decade`1 | Uses the Album's decade attribute to match
**Minimum:** `0` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `album_plays` | Uses the Album's plays attribute to match
**Minimum:** `0` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `track_plays` | Uses the Track's plays attribute to match
**Minimum:** `0` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `track_skips` | Uses the Track's skips attribute to match
**Minimum:** `0` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `artist_user_rating` | Uses the Artist's user rating attribute to match
**Range:** `0.0` - `10.0` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `album_user_rating` | Uses the Album's user rating attribute to match
**Range:** `0.0` - `10.0` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `album_critic_rating` | Uses the Album's critic rating attribute to match
**Range:** `0.0` - `10.0` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `track_user_rating` | Uses the Track's user rating attribute to match
**Range:** `0.0` - `10.0` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - - 1 You can use `current_year` to have Kometa use the current years value. This can be combined with a - `-#` at the end to subtract that number of years. i.e. `current_year-2` - - ???+ tip "Number Filter Modifiers" - - | Number Modifier | Description | Plex Web UI Display | - |:----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------:| - | `.gt` | Matches every item where the number attribute is greater than the given number
**Format:** number
**Example:** `30`, `1995`, or `7.5` | `is greater than` | - | `.gte` | Matches every item where the number attribute is greater than or equal to the given number
**Format:** number
**Example:** `30`, `1995`, or `7.5` | N/A | - | `.lt` | Matches every item where the number attribute is less than the given number
**Format:** number
**Example:** `30`, `1995`, or `7.5` | `is less than` | - | `.lte` | Matches every item where the number attribute is less than or equal to the given number
**Format:** number
**Example:** `30`, `1995`, or `7.5` | N/A | - | `.rated` | Matches every item either rated or not rated
**Format:** `true` or `false` | N/A | - - * `.rated` only works for rating filters - - === "String Filters" - - String filters can be used with either no modifier or with `.not`, `.is`, `.isnot`, `.begins`, or `.ends`. - - String filter can take multiple values **only as a list**. - - #### String Filter Attributes - - | String Search | Description | Movie
Libraries | Show
Libraries | Music
Libraries | - |:---------------------|:---------------------------------------------------------|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:| - | `title` | Uses the title attribute to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `episode_title` | Uses the title attribute of the show's episodes to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `studio` | Uses the studio attribute to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `edition` | Uses the edition attribute to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | - | `artist_title` | Uses the Artist's Title attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `album_title` | Uses the Album's Title attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `track_title` | Uses the Track's Title attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `album_record_label` | Uses the Album's Record Label attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - - ???+ tip "String Filter Modifiers" - - | String Modifier | Description | Plex Web UI Display | - |:----------------|:-------------------------------------------------------------------------------|:-------------------:| - | No Modifier | Matches every item where the attribute contains the given string | `contains` | - | `.not` | Matches every item where the attribute does not contain the given string | `does not contain` | - | `.is` | Matches every item where the attribute exactly matches the given string | `is` | - | `.isnot` | Matches every item where the attribute does not exactly match the given string | `is not` | - | `.begins` | Matches every item where the attribute begins with the given string | `begins with` | - | `.ends` | Matches every item where the attribute ends with the given string | `ends with` | - - === "Tag Filters" - - Tag filters can be used with either no modifier or with `.not` except for `decade` and `resolution` which can only be - used with no modifier. - - Tag filter can take multiple values as a **list or a comma-separated string**. - - #### Tag Filter Attributes - - | Tag Search | Description | Movie
Libraries | Show
Libraries | Music
Libraries | - |:---------------------------|:----------------------------------------------------------------------------|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:| - | `actor` | Uses the actor tags to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `episode_actor` | Uses the episode actor tags to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `audio_language` | Uses the audio language tags to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `collection` | Uses the collection tags to match for top level collections | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `season_collection` | Uses the collection tags to match for season collections | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `episode_collection` | Uses the collection tags to match for episode collections | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `content_rating` | Uses the content rating tags to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `country` | Uses the country tags to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `decade`1 | Uses the year tag to match the decade | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | - | `director` | Uses the director tags to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | - | `genre` | Uses the genre tags to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `label` | Uses the label tags to match for top level collections | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `season_label` | Uses the label tags to match for season collections | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `episode_label` | Uses the label tags to match for episode collections | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `network` | Uses the network tags to match
**Only works with the New Plex TV Agent** | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `producer` | Uses the actor tags to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | - | `resolution` | Uses the resolution tags to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `subtitle_language` | Uses the subtitle language tags to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `writer` | Uses the writer tags to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | - | `year`1 | Uses the year tag to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `episode_year`1 | Uses the year tag to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `artist_genre` | Uses the Artist's Genre attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `artist_collection` | Uses the Artist's Collection attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `artist_country` | Uses the Artist's Country attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `artist_mood` | Uses the Artist's Mood attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `artist_style` | Uses the Artist's Style attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `artist_label` | Uses the Artist's Label attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `album_genre` | Uses the Album's Genre attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `album_mood` | Uses the Album's Mood attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `album_style` | Uses the Album's Style attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `album_format` | Uses the Album's Format attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `album_type` | Uses the Album's Type attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `album_collection` | Uses the Album's Collection attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `album_source` | Uses the Album's Source attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `album_label` | Uses the Album's Label attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `track_mood` | Uses the Track's Mood attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `track_source` | Uses the Track's Source attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `track_label` | Uses the Track's Label attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - - 1 You can use `current_year` to have Kometa use the current years value. This can be combined with a - `-#` at the end to subtract that number of years. i.e. `current_year-2` - - ???+ tip "Tag Filter Modifiers" - - | Tag Modifier | Description | Plex Web UI Display | - |:-------------|:-----------------------------------------------------------------------|:-------------------:| - | No Modifier | Matches every item where the attribute matches the given string | `is` | - | `.not` | Matches every item where the attribute does not match the given string | `is not` | - - -=== "Sort Options" - - The majority of Smart and Dumb Builders utilize the same Sort Options. Any deviation from this will be highlighted against the specific builder. - - | Sort Option | Description | Movies | Shows | Seasons | Episodes | Artists | Albums | Tracks | - |:------------------------------------------------|:----------------------------------------------------|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:| - | `title.asc`
`title.desc` | Sort by Title | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | - | `season.asc`
`season.desc` | Sort by Season | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | - | `show.asc`
`show.desc` | Sort by Show | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | - | `album_artist.asc`
`album_artist.desc` | Sort by Album Artist | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | - | `artist.asc`
`artist.desc` | Sort by Artist | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `album.asc`
`album.desc` | Sort by Album | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `year.asc`
`year.desc` | Sort by Year | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `release.asc`
`release.desc` | Sort by Release Date (Originally Available) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `episode_release.asc`
`episode_release.desc` | Sort by Episode Release Date (Originally Available) | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | - | `critic_rating.asc`
`critic_rating.desc` | Sort by Critic Rating | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - | `audience_rating.asc`
`audience_rating.desc` | Sort by Audience Rating | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | - | `user_rating.asc`
`user_rating.desc` | Sort by User Rating | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | - | `content_rating.asc`
`content_rating.desc` | Sort by Content Rating | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | - | `duration.asc`
`duration.desc` | Sort by Duration | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `progress.asc`
`progress.desc` | Sort by Progress | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | - | `played.asc`
`played.desc` | Sort by Date Last Played | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | - | `plays.asc`
`plays.desc` | Sort by Number of Plays | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | - | `unplayed.asc`
`unplayed.desc` | Sort by Unplayed | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | - | `episode_added.asc`
`episode_added.desc` | Sort by Last Episode Date Added | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | - | `added.asc`
`added.desc` | Sort by Date Added | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | - | `viewed.asc`
`viewed.desc` | Sort by Date Last Viewed | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | - | `rated.asc`
`rated.desc` | Sort by Date Last Rated | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `popularity.asc`
`popularity.desc` | Sort by Popularity | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `resolution.asc`
`resolution.desc` | Sort by Resolution | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | - | `bitrate.asc`
`bitrate.desc` | Sort by Bitrate | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - | `random` | Sort by Random | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | - - ## Sort Option Examples - - ```yaml - collections: - Best 2024 Movies: - smart_filter: - limit: 100 - all: - year: 2024 - sort_by: audience_rating.desc - ``` - - ```yaml - collections: - Newly Released Movies: - smart_filter: - limit: 100 - all: - release: 30 - sort_by: release.desc - ``` - -=== "Builder Attributes" - - The majority of Smart and Dumb Builders utilize the same Builder Attributes. Any deviation from this will be highlighted against the specific builder. - - | Attribute | Description & Values | - |:-----------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `limit` | **Description:** The max number of item for the filter.
**Default:** `all`
**Values:** `all` or a number greater than 0 | - | `sort_by` | **Description:** This will control how the filter is sorted in your library. You can do a multi-level sort using a list.
**Default:** `random`
**Values:** Any sort options for your filter type in the [Sorts Options Table](#sort-options) | - | `validate` | **Description:** Determines if a collection will fail on a validation error
**Default:** `true`
**Values**: `true` or `false` | diff --git a/docs/files/builders/smart.md b/docs/files/builders/smart.md deleted file mode 100644 index dab6efd4e..000000000 --- a/docs/files/builders/smart.md +++ /dev/null @@ -1,407 +0,0 @@ -# Smart Builders - -Smart Builders allow Kometa to create Smart Collections in two different ways. - -The results of these builders are dynamic and do not require Kometa to re-run in order to update, instead they will -update automatically as the data within your Plex Library updates (i.e. if new media is added) - -???+ note - - Smart Builders do not currently work with Playlists - -## Smart Label - -A Smart Label Collection is a smart collection that grabs every item with a specific label generated by the program. -That label is added to all the items the Collection Builders find instead of being added to a normal collection. - -To make a collection a Smart Label Collection, the `smart_label` attribute must be added to the collection definition. -It functions in two different ways: - -1. Define the sort using the Movies/Shows column of the [Sorts Table](#sort-options) below along with any other builder -to make that collection a Smart Label Collection. - ```yaml - collections: - Marvel Cinematic Universe: - trakt_list: https://trakt.tv/users/jawann2002/lists/marvel-cinematic-universe-movies?sort=rank,asc - smart_label: release.desc - ``` - -2. Provide a whole `smart_filter` to determine exactly how the smart collection should be built, ensuring to include -`label: <>`, which will link it to the collection labels. - ```yaml - collections: - Unplayed Marvel Cinematic Universe: - trakt_list: https://trakt.tv/users/jawann2002/lists/marvel-cinematic-universe-movies?sort=rank,asc - smart_label: - sort_by: release.desc - all: - label: <> - unplayed: true - ``` - -This is extremely useful because smart collections don't follow normal show/hide rules and can eliminate the need to -have [Plex Collectionless](plex.md#plex-collectionless) when used correctly. To fix the issue described in -[Plex Collectionless](plex.md#plex-collectionless) you would make `Marvel Cinematic Universe` a Smart Label Collection -and all other Marvel collection just normal collections, and they will show/hide all the movie properly. - -To have the Smart Label Collections to eliminate Plex Collectionless you have to go all in on using them. A good rule of -thumb to make sure this works correctly is that every item in your library should have a max of one non-smart collection. - -Reach out on the [Kometa Discord](https://kometa.wiki/en/latest/discord/) or in the [GitHub Discussions](https://github.com/Kometa-Team/Kometa/discussions) for help if you're having any issues getting -this to work properly. - -## Smart Filter - -Uses Plex's [Advanced Filters](https://support.plex.tv/articles/201273953-collections/) to create a smart collection based on the filter parameters provided. - -Any Advanced Filter made using the Plex UI should be able to be recreated using `smart_filter`. If you're having trouble -getting `smart_filter` to work correctly, build the collection you want inside of Plex's Advanced Filters and take a -screenshot of the parameters in the Plex UI and post it in either the -[Discussions](https://github.com/Kometa-Team/Kometa/discussions) or on [Discord](https://kometa.wiki/en/latest/discord/), -and I'll do my best to help you. - -like Plex's [Advanced Filters](https://support.plex.tv/articles/201273953-collections/) you have to start each filter with either `any` or `all` as a base. You can only -have one base attribute and all filter attributes must be under the base. - -Inside the base attribute you can use any filter below or nest more `any` or `all`. You can have as many nested `any` -or `all` next to each other as you want. If using multiple `any` or `all` you will have to do so in the form of a list. - -**Note: To search by `season`, `episode`, `album`, or `track` you must use the `builder_level` [Setting](../settings.md) -to change the type of items the collection holds.** - -There are a couple other attributes you can have at the top level only along with the base attribute are: - -## Special Attributes - -| Attribute | Description & Values | -|:-----------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `limit` | **Description:** The max number of item for the filter.
**Default:** `all`
**Values:** `all` or a number greater than 0 | -| `sort_by` | **Description:** This will control how the filter is sorted in your library. You can do a multi-level sort using a list.
**Default:** `random`
**Values:** Any sort options for your filter type in the [Sorts Options Table](#sort-options) | -| `validate` | **Description:** Determines if a collection will fail on a validation error
**Default:** `true`
**Values**: `true` or `false` | - -## Sort Options - -| Sort Option | Description | Movies | Shows | Seasons | Episodes | Artists | Albums | Tracks | -|:------------------------------------------------|:----------------------------------------------------|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:| -| `title.asc`
`title.desc` | Sort by Title | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| `season.asc`
`season.desc` | Sort by Season | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | -| `show.asc`
`show.desc` | Sort by Show | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | -| `album_artist.asc`
`album_artist.desc` | Sort by Album Artist | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| `artist.asc`
`artist.desc` | Sort by Artist | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `album.asc`
`album.desc` | Sort by Album | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `year.asc`
`year.desc` | Sort by Year | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `release.asc`
`release.desc` | Sort by Release Date (Originally Available) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `episode_release.asc`
`episode_release.desc` | Sort by Episode Release Date (Originally Available) | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | -| `critic_rating.asc`
`critic_rating.desc` | Sort by Critic Rating | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `audience_rating.asc`
`audience_rating.desc` | Sort by Audience Rating | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | -| `user_rating.asc`
`user_rating.desc` | Sort by User Rating | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| `content_rating.asc`
`content_rating.desc` | Sort by Content Rating | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | -| `duration.asc`
`duration.desc` | Sort by Duration | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `progress.asc`
`progress.desc` | Sort by Progress | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | -| `played.asc`
`played.desc` | Sort by Date Last Played | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| `plays.asc`
`plays.desc` | Sort by Number of Plays | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| `unplayed.asc`
`unplayed.desc` | Sort by Unplayed | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | -| `episode_added.asc`
`episode_added.desc` | Sort by Last Episode Date Added | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | -| `added.asc`
`added.desc` | Sort by Date Added | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| `viewed.asc`
`viewed.desc` | Sort by Date Last Viewed | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | -| `rated.asc`
`rated.desc` | Sort by Date Last Rated | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `popularity.asc`
`popularity.desc` | Sort by Popularity | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `resolution.asc`
`resolution.desc` | Sort by Resolution | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | -| `bitrate.asc`
`bitrate.desc` | Sort by Bitrate | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `random` | Sort by Random | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | - -## Filters - -There are three fields per filter option when using Plex's Advanced Filters in the Web UI. - -1. **Attribute:** What attribute you wish to filter. -2. **Modifier:** Which modifier to use. -3. **Value:** Actual value to filter. - -**Example:** `Attribute.Modifier: Value` - -## String Filters - -String filters can be used with either no modifier or with `.not`, `.is`, `.isnot`, `.begins`, or `.ends`. - -String filter can take multiple values **only as a list**. - -### String Modifiers - -| String Modifier | Description | Plex Web UI Display | -|:----------------|:-------------------------------------------------------------------------------|:-------------------:| -| No Modifier | Matches every item where the attribute contains the given string | `contains` | -| `.not` | Matches every item where the attribute does not contain the given string | `does not contain` | -| `.is` | Matches every item where the attribute exactly matches the given string | `is` | -| `.isnot` | Matches every item where the attribute does not exactly match the given string | `is not` | -| `.begins` | Matches every item where the attribute begins with the given string | `begins with` | -| `.ends` | Matches every item where the attribute ends with the given string | `ends with` | - -### String Attributes - -| String Search | Description | Movie
Libraries | Show
Libraries | Music
Libraries | -|:---------------------|:---------------------------------------------------------|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:| -| `title` | Uses the title attribute to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `episode_title` | Uses the title attribute of the show's episodes to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `studio` | Uses the studio attribute to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `edition` | Uses the edition attribute to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | -| `artist_title` | Uses the Artist's Title attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `album_title` | Uses the Album's Title attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `track_title` | Uses the Track's Title attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `album_record_label` | Uses the Album's Record Label attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - -## Tag Filters - -Tag filters can be used with either no modifier or with `.not` except for `decade` and `resolution` which can only be -used with no modifier. - -Tag filter can take multiple values as a **list or a comma-separated string**. - -### Tag Modifiers - -| Tag Modifier | Description | Plex Web UI Display | -|:-------------|:-----------------------------------------------------------------------|:-------------------:| -| No Modifier | Matches every item where the attribute matches the given string | `is` | -| `.not` | Matches every item where the attribute does not match the given string | `is not` | - -### Tag Attributes - -| Tag Search | Description | Movie
Libraries | Show
Libraries | Music
Libraries | -|:---------------------------|:----------------------------------------------------------------------------|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:| -| `actor` | Uses the actor tags to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `episode_actor` | Uses the episode actor tags to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `audio_language` | Uses the audio language tags to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `collection` | Uses the collection tags to match for top level collections | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `season_collection` | Uses the collection tags to match for season collections | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `episode_collection` | Uses the collection tags to match for episode collections | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `content_rating` | Uses the content rating tags to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `country` | Uses the country tags to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `decade`1 | Uses the year tag to match the decade | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | -| `director` | Uses the director tags to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | -| `genre` | Uses the genre tags to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `label` | Uses the label tags to match for top level collections | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `season_label` | Uses the label tags to match for season collections | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `episode_label` | Uses the label tags to match for episode collections | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `network` | Uses the network tags to match
**Only works with the New Plex TV Agent** | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `producer` | Uses the actor tags to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | -| `resolution` | Uses the resolution tags to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `subtitle_language` | Uses the subtitle language tags to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `writer` | Uses the writer tags to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | -| `year`1 | Uses the year tag to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `episode_year`1 | Uses the year tag to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `artist_genre` | Uses the Artist's Genre attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `artist_collection` | Uses the Artist's Collection attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `artist_country` | Uses the Artist's Country attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `artist_mood` | Uses the Artist's Mood attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `artist_style` | Uses the Artist's Style attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `artist_label` | Uses the Artist's Label attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `album_genre` | Uses the Album's Genre attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `album_mood` | Uses the Album's Mood attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `album_style` | Uses the Album's Style attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `album_format` | Uses the Album's Format attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `album_type` | Uses the Album's Type attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `album_collection` | Uses the Album's Collection attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `album_source` | Uses the Album's Source attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `album_label` | Uses the Album's Label attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `track_mood` | Uses the Track's Mood attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `track_source` | Uses the Track's Source attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `track_label` | Uses the Track's Label attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - -1 You can use `current_year` to have Kometa use the current years value. This can be combined with a -`-#` at the end to subtract that number of years. i.e. `current_year-2` - -## Date Filters - -Date filters can be used with either no modifier or with `.not`, `.before`, or `.after`. - -No date filter can take multiple values. - -### Date Modifiers - -| Date Modifier | Description | Plex Web UI Display | -|:--------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------:| -| No Modifier | Matches every item where the date attribute is in the last X days
**Format:** number of days
**Example:** `30` | `is in the last` | -| `.not` | Matches every item where the date attribute is not in the last X days
**Format:** number of days
**Example:** `30` | `is not in the last` | -| `.before` | Matches every item where the date attribute is before the given date
**Format:** MM/DD/YYYY or `today` for the current day
**Example:** `01/01/2000` | `is before` | -| `.after` | Matches every item where the date attribute is after the given date
**Format:** MM/DD/YYYY or `today` for the current day
**Example:** `01/01/2000` | `is after` | - -### Date Attributes - -| Date Search | Description | Movie
Libraries | Show
Libraries | Music
Libraries | -|:----------------------|:-----------------------------------------------------------------------------------|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:| -| `added` | Uses the date added attribute to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `episode_added` | Uses the date added attribute of the show's episodes to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `release` | Uses the release date attribute (originally available) to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `episode_air_date` | Uses the air date attribute (originally available) of the show's episodes to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `last_played` | Uses the date last played attribute to match | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `episode_last_played` | Uses the date last played attribute of the show's episodes to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `artist_added` | Uses the Artist's date added attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `artist_last_played` | Uses the Artist's last played attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `album_last_played` | Uses the Album's last played attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `album_added` | Uses the Album's date added attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `album_released` | Uses the Album's release date attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `track_last_played` | Uses the Track's date last played attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `track_last_skipped` | Uses the Track's date last skipped attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `track_last_rated` | Uses the Track's date last rated attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `track_added` | Uses the Track's date added attribute to match | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - -## Number Filters - -Number filters must use `.gt`, `.gte`, `.lt`, or `.lte` as a modifier only the rating filters can use `.rated`. - -No number filter can take multiple values. - -### Number Modifiers - -| Number Modifier | Description | Plex Web UI Display | -|:----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------:| -| `.gt` | Matches every item where the number attribute is greater than the given number
**Format:** number
**Example:** `30`, `1995`, or `7.5` | `is greater than` | -| `.gte` | Matches every item where the number attribute is greater than or equal to the given number
**Format:** number
**Example:** `30`, `1995`, or `7.5` | N/A | -| `.lt` | Matches every item where the number attribute is less than the given number
**Format:** number
**Example:** `30`, `1995`, or `7.5` | `is less than` | -| `.lte` | Matches every item where the number attribute is less than or equal to the given number
**Format:** number
**Example:** `30`, `1995`, or `7.5` | N/A | -| `.rated` | Matches every item either rated or not rated
**Format:** `true` or `false` | N/A | - -* `.rated` only works for rating filters - -### Number Attributes - -| Number Search | Description | Movie
Libraries | Show
Libraries | Music
Libraries | -|:---------------------------|:--------------------------------------------------------------------------------------------|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:| -| `duration` | Uses the duration attribute to match using minutes
**Minimum:** `0` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | -| `plays` | Uses the plays attribute to match
**Minimum:** `0` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `episode_plays` | Uses the Episode's plays attribute to match
**Minimum:** `0` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `critic_rating` | Uses the critic rating attribute to match
**Range:** `0.0` - `10.0` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `audience_rating` | Uses the audience rating attribute to match
**Range:** `0.0` - `10.0` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `user_rating` | Uses the user rating attribute to match
**Range:** `0.0` - `10.0` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `episode_user_rating` | Uses the user rating attribute of the show's episodes to match
**Range:** `0.0` - `10.0` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `year`1 | Uses the year attribute to match
**Minimum:** `0` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `episode_year`1 | Uses the Episode's year attribute to match
**Minimum:** `0` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `album_year`1 | Uses the Album's year attribute to match
**Minimum:** `0` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `album_decade`1 | Uses the Album's decade attribute to match
**Minimum:** `0` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `album_plays` | Uses the Album's plays attribute to match
**Minimum:** `0` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `track_plays` | Uses the Track's plays attribute to match
**Minimum:** `0` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `track_skips` | Uses the Track's skips attribute to match
**Minimum:** `0` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `artist_user_rating` | Uses the Artist's user rating attribute to match
**Range:** `0.0` - `10.0` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `album_user_rating` | Uses the Album's user rating attribute to match
**Range:** `0.0` - `10.0` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `album_critic_rating` | Uses the Album's critic rating attribute to match
**Range:** `0.0` - `10.0` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `track_user_rating` | Uses the Track's user rating attribute to match
**Range:** `0.0` - `10.0` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - -1 You can use `current_year` to have Kometa use the current years value. This can be combined with a -`-#` at the end to subtract that number of years. i.e. `current_year-2` - -## Boolean Filters - -Boolean Filters take no modifier and can only be either `true` or `false`. - -### Boolean Attributes - -| Boolean Search | Description | Movie
Libraries | Show
Libraries | Music
Libraries | -|:--------------------|:-----------------------|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:| -| `hdr` | Is HDR | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `unmatched` | Is Unmatched | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | -| `duplicate` | Is Duplicate | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | -| `unplayed` | Is Unplayed | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | -| `progress` | Is In Progress | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | -| `trash` | Is Trashed | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `unplayed_episodes` | Has Unplayed Episodes | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `episode_unplayed` | Has Episodes Unplayed | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `episode_duplicate` | Has Duplicate Episodes | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `episode_progress` | Has Episode Progress | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `episode_unmatched` | Has Episodes Unmatched | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `show_unmatched` | Has Shows Unmatched | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `artist_unmatched` | Is Artist's Unmatched | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `album_unmatched` | Is Album's Unmatched | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `track_trash` | Is Track Trashed | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | - -## Smart Filter Examples - -A few examples are listed below: - -```yaml -collections: - Documentaries: - smart_filter: - all: - genre: Documentary -``` -```yaml -collections: - Dave Chappelle Comedy: - smart_filter: - all: - actor: Dave Chappelle - genre: Comedy -``` -```yaml -collections: - Top Action Movies: - smart_filter: - all: - genre: Action - sort_by: audience_rating.desc - limit: 20 -``` -```yaml -collections: - 90s Movies: - smart_filter: - any: - year: - - 1990 - - 1991 - - 1992 - - 1993 - - 1994 - - 1995 - - 1996 - - 1997 - - 1998 - - 1999 -``` -```yaml -collections: - 90s Movies: - smart_filter: - any: - decade: 1990 -``` -```yaml -collections: - Best 2010+ Movies: - smart_filter: - all: - year.gte: 2010 - sort_by: audience_rating.desc - limit: 20 -``` - -If you specify TMDb Person ID's using the Setting `tmdb_person` and then tell either `actor`, `director`, `producer`, or -`writer` to add `tmdb`, the script will translate the TMDb Person IDs into their names and run the filter on those names. - -```yaml -collections: - Robin Williams: - smart_filter: - all: - actor: tmdb - tmdb_person: 2157 -``` -```yaml -collections: - Steven Spielberg: - smart_filter: - all: - director: tmdb - tmdb_person: https://www.themoviedb.org/person/488-steven-spielberg -``` -```yaml -collections: - Quentin Tarantino: - smart_filter: - any: - actor: tmdb - director: tmdb - producer: tmdb - writer: tmdb - tmdb_person: 138 -``` diff --git a/docs/files/builders/tmdb.md b/docs/files/builders/tmdb.md index 5055df4bc..3e23fd500 100644 --- a/docs/files/builders/tmdb.md +++ b/docs/files/builders/tmdb.md @@ -5,721 +5,689 @@ hide: # TMDb Builders You can find items using the features of [TheMovieDb.org](https://www.themoviedb.org/) (TMDb). -## Standard TMDb Builders - -| Attribute | Description | Works with Movies | Works with Shows | Works with Playlists and Custom Sort | -|:--------------------------------------|:---------------------------------------------------------|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:| -| [`tmdb_collection`](#tmdb-collection) | Finds every item in the TMDb collection | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | -| [`tmdb_list`](#tmdb-list) | Finds every item in the TMDb List | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [`tmdb_actor`](#tmdb-actor) | Finds every item in the TMDb Person's Actor Credits | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| [`tmdb_crew`](#tmdb-crew) | Finds every item in the TMDb Person's Crew Credits | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| [`tmdb_director`](#tmdb-director) | Finds every item in the TMDb Person's Director Credits | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| [`tmdb_producer`](#tmdb-producer) | Finds every item in the TMDb Person's Producer Credits | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| [`tmdb_writer`](#tmdb-writer) | Finds every item in the TMDb Person's Writer Credits | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| [`tmdb_movie`](#tmdb-movie) | Finds the movie specified | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | -| [`tmdb_show`](#tmdb-show) | Finds the show specified | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| [`tmdb_company`](#tmdb-company) | Finds every item from the TMDb company's movie/show list | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| [`tmdb_network`](#tmdb-network) | Finds every item from the TMDb network's show list | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| [`tmdb_keyword`](#tmdb-keyword) | Finds every item from the TMDb keyword's movie/show list | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | - - -## Other TMDb Builders - -| Attribute | Description | Works with Movies | Works with Shows | Works with Playlists and Custom Sort | -|:------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:| -| [`tmdb_popular`](#tmdb-popular) | Finds the movies/shows in TMDb's [Popular Movies](https://www.themoviedb.org/movie)/[Popular Shows](https://www.themoviedb.org/tv) list | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [`tmdb_now_playing`](#tmdb-now-playing) | Finds the movies in TMDb's [Now Playing](https://www.themoviedb.org/movie/now-playing) list | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| [`tmdb_top_rated`](#tmdb-top-rated) | Finds the movies/shows in TMDb's [Top Rated Movies](https://www.themoviedb.org/movie/top-rated)/[Top Rated Shows](https://www.themoviedb.org/tv/top-rated) list | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [`tmdb_upcoming`](#tmdb-upcoming) | Finds the movies in TMDb's [Upcoming Movies](https://www.themoviedb.org/movie/upcoming) list | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| [`tmdb_airing_today`](#tmdb-airing-today) | Finds the shows in TMDb's [Airing Today Shows](https://www.themoviedb.org/tv/airing-today) list | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [`tmdb_on_the_air`](#tmdb-on-the-air) | Finds the shows in TMDb's [On TV Shows](https://www.themoviedb.org/tv/on-the-air) list | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [`tmdb_trending_daily`](#tmdb-trending-daily) | Finds the movies/shows in TMDb's Trending Daily list | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [`tmdb_trending_weekly`](#tmdb-trending-weekly) | Finds the movies/shows in TMDb's Trending Weekly list | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| [`tmdb_discover`](#tmdb-discover) | Uses [TMDb's Discover Search](https://developer.themoviedb.org/docs/search-and-query-for-details) to find every movie/show based on the [movie search parameters](https://developers.themoviedb.org/3/discover/movie-discover) or [show search parameters](https://developers.themoviedb.org/3/discover/tv-discover) provided | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | - -## Expected Input - -The builders below are expected to have the full URL to the item or the TMDb ID of the item. Multiple values are -supported as either a list or a comma-separated string. - -* [TMDb Collection](#tmdb-collection) and [TMDb Collection Details](#tmdb-collection) -* [TMDb List](#tmdb-list) and [TMDb List Details](#tmdb-list) -* [TMDb Actor](#tmdb-actor) and [TMDb Actor Details](#tmdb-actor) -* [TMDb Crew](#tmdb-crew) and [TMDb Crew Details](#tmdb-crew) -* [TMDb Director](#tmdb-director) and [TMDb Director Details](#tmdb-director) -* [TMDb Producer](#tmdb-producer) and [TMDb Producer Details](#tmdb-producer) -* [TMDb Writer](#tmdb-writer) and [TMDb Writer Details](#tmdb-writer) -* [TMDb Movie](#tmdb-movie) and [TMDb Movie Details](#tmdb-movie) -* [TMDb Show](#tmdb-show) and [TMDb Show Details](#tmdb-show) -* [TMDb Company](#tmdb-company) -* [TMDb Network](#tmdb-network) - -The builders below are expected to have a single integer value of how many movies/shows to query. - -* [TMDb Popular](#tmdb-popular) -* [TMDb Now Playing](#tmdb-now-playing) -* [TMDb Top Rated](#tmdb-top-rated) -* [TMDb Trending Daily](#tmdb-trending-daily) -* [TMDb Trending Weekly](#tmdb-trending-weekly) - -[TMDb Discover](#tmdb-discover)'s attributes are detailed [below](#tmdb-discover). - -## TMDb Collection - -Finds every item in the TMDb collection. - - ???+ tip "Details Builder" - - You can replace `tmdb_collection` with `tmdb_collection_details` if you would like to fetch and use the TMDb collection's summary, poster, and background from the list - -```yaml -collections: - The Lord of the Rings: - tmdb_collection: https://www.themoviedb.org/collection/119 - The Hobbit: - tmdb_collection: 121938 - Middle Earth: - tmdb_collection: - - 119 - - https://www.themoviedb.org/collection/121938 -``` -* You can specify multiple collections in `tmdb_collection_details` but it will only use the first one to update the -collection details. -* Posters and background in the library's asset directory will be used over the collection details unless -`tmdb_poster`/`tmdb_background` is also specified. - -```yaml -collections: - Harry Potter: - tmdb_collection_details: 1241 #https://www.themoviedb.org/collection/1241 also accepted - Fantastic Beasts: - tmdb_collection_details: 435259 #https://www.themoviedb.org/collection/435259 also accepted - Wizarding World: - tmdb_collection_details: - - 1241 - - https://www.themoviedb.org/collection/435259 -``` - -## TMDb List - -Finds every item in the TMDb List. - -The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated -and in a specific order. - - ???+ tip "Details Builder" - - You can replace `tmdb_list` with `tmdb_list_details` if you would like to fetch and use the description and poster from the list - -```yaml -collections: - Top 50 Grossing Films of All Time (Worldwide): - tmdb_list: 10 #https://www.themoviedb.org/list/10 also accepted - collection_order: custom - sync_mode: sync -``` - -* You can specify multiple lists in `tmdb_list_details` but it will only use the first one to update the collection -details. - -```yaml -collections: - Rotten Tomatoes Top 100 Movies of All Time: - tmdb_list_details: 3697 #themoviedb.org/list/3697 also accepted -``` - -## TMDb Actor - -Finds every item in the TMDb Person's Actor Credits. - - ???+ tip "Details Builder" - - You can replace `tmdb_actor` with `tmdb_actor_details` if you would like to fetch and use the TMDb Person's biography and profile from the list - -```yaml -collections: - Robin Williams: - tmdb_actor: 2157 #https://www.themoviedb.org/person/2157-robin-williams also accepted -``` - -* You can specify multiple people in `tmdb_actor_details` but it will only use the first one to update the collection -details. - -```yaml -collections: - Meryl Streep: - tmdb_actor_details: 5064 -``` - -## TMDb Crew - -Finds every item in the TMDb Person's Crew Credits. - - ???+ tip "Details Builder" - - You can replace `tmdb_crew` with `tmdb_crew_details` if you would like to fetch and use the TMDb Person's biography and profile from the list - -```yaml -collections: - Quentin Tarantino: - tmdb_crew: 138 #https://www.themoviedb.org/person/138-quentin-tarantino also accepted -``` - -* You can specify multiple people in `tmdb_crew_details` but it will only use the first one to update the collection -details. - -```yaml -collections: - James Cameron: - tmdb_crew_details: 2710 -``` - -## TMDb Director - -Finds every item in the TMDb Person's Director Credits. - - ???+ tip "Details Builder" - - You can replace `tmdb_director` with `tmdb_director_details` if you would like to fetch and use the TMDb Person's biography and profile from the list - -```yaml -collections: - Steven Spielberg: - tmdb_director: 488 #https://www.themoviedb.org/person/488-steven-spielberg also accepted -``` - -* You can specify multiple people in `tmdb_director_details` but it will only use the first one to update the collection -details. - -```yaml -collections: - Sofia Coppola: - tmdb_director_details: 1769 -``` - -## TMDb Producer - -Finds every item in the TMDb Person's Producer Credits. - - ???+ tip "Details Builder" - - You can replace `tmdb_producer` with `tmdb_producer_details` if you would like to fetch and use the TMDb Person's biography and profile from the list - -```yaml -collections: - Adam Sandler: - tmdb_producer: 19292 #https://www.themoviedb.org/person/19292-adam-sandler also accepted -``` - -* You can specify multiple people in `tmdb_producer_details` but it will only use the first one to update the collection -details. - -```yaml -collections: - Kathleen Kennedy: - tmdb_producer_details: 489 -``` - -## TMDb Writer - -Finds every item in the TMDb Person's Writer Credits. - - ???+ tip "Details Builder" - - You can replace `tmdb_writer` with `tmdb_writer_details` if you would like to fetch and use the TMDb Person's biography and profile from the list - -```yaml -collections: - Woody Allen: - tmdb_writer: 1243 #https://www.themoviedb.org/person/1243-woody-allen also accepted -``` - -* You can specify multiple people in `tmdb_writer_details` but it will only use the first one to update the collection -details. - -```yaml -collections: - Tina Fey: - tmdb_writer_details: 56323 -``` - -## TMDb Movie - -Finds the movie specified. - - ???+ tip "Details Builder" - - You can replace `tmdb_movie` with `tmdb_movie_details` if you would like to fetch and use the TMDb movie's summary, poster, and background from the list - -```yaml -collections: - Anaconda: - tmdb_movie: 336560 #https://www.themoviedb.org/movie/336560 also accepted -``` - -* You can specify multiple movies in `tmdb_movie_details` but it will only use the first one to update the collection -details. -* Posters and background in the library's asset directory will be used over the collection details unless -`tmdb_poster`/`tmdb_background` is also specified. - -```yaml -collections: - Deadpool Specials: - tmdb_movie_details: 558144 -``` - -## TMDb Show - -Finds the show specified. - - ???+ tip "Details Builder" - - You can replace `tmdb_show` with `tmdb_show_details` if you would like to fetch and use the TMDb show's summary, poster, and background from the list - -```yaml -collections: - Star Wars (Animated Shows): - tmdb_show: - - 4194 #https://www.themoviedb.org/tv/4194-star-wars-the-clone-wars also accepted - - 60554 #https://www.themoviedb.org/tv/60554-star-wars-rebels also accepted -``` - -* You can specify multiple shows in `tmdb_show_details` but it will only use the first one to update the collection -details. -* Posters and background in the library's asset directory will be used over the collection details unless -`tmdb_poster`/`tmdb_background` is also specified. - -```yaml -collections: - Pokémon Evolutions & Chronicles: - tmdb_show_details: - - 132636 - - 13230 -``` - -## TMDb Company - -Finds every movie from the TMDb company's movie list. - -```yaml -collections: - Studio Ghibli: - tmdb_company: 10342 #https://www.themoviedb.org/company/10342 also accepted -``` -## TMDb Network - -Finds every item from the TMDb network's movie/show list. - -```yaml -collections: - CBS: - tmdb_network: 16 #https://www.themoviedb.org/network/16 also accepted -``` -## TMDb Keyword - -Finds every item from the TMDb keyword's movie/show list. - -```yaml -collections: - Marvel Cinematic Universe: - tmdb_keyword: 180547 #https://www.themoviedb.org/keyword/180547 also accepted -``` - -## TMDb Popular - -Finds the movies/shows in TMDb's [Popular Movies](https://www.themoviedb.org/movie)/[Popular Shows](https://www.themoviedb.org/tv) list. - -Use `tmdb_region` with this builder to set the region. - -The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated -and in a specific order. - -```yaml -collections: - TMDb Popular: - tmdb_popular: 30 - collection_order: custom - sync_mode: sync -``` - -## TMDb Now Playing - -Finds the movies in TMDb's [Now Playing](https://www.themoviedb.org/movie/now-playing) list. - -Use `tmdb_region` with this builder to set the region. - -The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated -and in a specific order. - -```yaml -collections: - TMDb Now Playing: - tmdb_now_playing: 30 - collection_order: custom - sync_mode: sync -``` - -## TMDb Top Rated - -Finds the movies/shows in TMDb's [Top Rated Movies](https://www.themoviedb.org/movie/top-rated)/[Top Rated Shows](https://www.themoviedb.org/tv/top-rated) list. - -Use `tmdb_region` with this builder to set the region. - -The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated -and in a specific order. - -```yaml -collections: - TMDb Top Rated: - tmdb_top_rated: 30 - collection_order: custom - sync_mode: sync -``` - -## TMDb Upcoming - -Finds the movies in TMDb's [Upcoming Movies](https://www.themoviedb.org/movie/upcoming) list. - -Use `tmdb_region` with this builder to set the region. - -The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated -and in a specific order. - -```yaml -collections: - TMDb Upcoming: - tmdb_upcoming: 30 - collection_order: custom - sync_mode: sync -``` - -## TMDb Airing Today - -Finds the shows in TMDb's [Airing Today Shows](https://www.themoviedb.org/tv/airing-today) list. - -The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated -and in a specific order. - -```yaml -collections: - TMDb Airing Today: - tmdb_airing_today: 30 - collection_order: custom - sync_mode: sync -``` - -## TMDb On the Air - -Finds the shows in TMDb's [On TV Shows](https://www.themoviedb.org/tv/on-the-air) list. - -The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated -and in a specific order. - -```yaml -collections: - TMDb On the Air: - tmdb_on_the_air: 30 - collection_order: custom - sync_mode: sync -``` - -## TMDb Trending Daily - -Finds the movies/shows in TMDb's Trending Daily list. - -The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated -and in a specific order. - -```yaml -collections: - TMDb Daily Trending: - tmdb_trending_daily: 30 - collection_order: custom - sync_mode: sync -``` - -## TMDb Trending Weekly - -Finds the movies/shows in TMDb's Trending Weekly list. - -The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated -and in a specific order. - -```yaml -collections: - TMDb Weekly Trending: - tmdb_trending_weekly: 30 - collection_order: custom - sync_mode: sync -``` - -## TMDb Discover - -Uses [TMDb's Discover Search](https://developer.themoviedb.org/docs/search-and-query-for-details) to find every -movie/show based on the [movie search parameters](https://developers.themoviedb.org/3/discover/movie-discover) or -[show search parameters](https://developers.themoviedb.org/3/discover/tv-discover) provided. - -The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated -and in a specific order. - -| Type | Description | -|:-------------------|:--------------------------------------------------| -| String | Any number of alphanumeric characters | -| Integer | Any whole number greater than zero i.e. 2, 10, 50 | -| Number | Any number greater than zero i.e. 2.5, 7.4, 9 | -| Boolean | Must be `true` or `false` | -| Date: `MM/DD/YYYY` | Date that fits the specified format | -| Year: `YYYY` | Year must be a 4 digit integer i.e. 1990 | - -### Discover Movies Parameters - -!!!important - - Note that a number of filters support being comma (,) or pipe (|) separated. Comma's are treated like an AND query - while pipe's are treated like an OR. This allows for quite complex filtering depending on your desired results. - -!!!bug - - We have noticed inconsistent responses from TMDb when using `popularity.asc` and `popularity.desc` as the sort order. This can result in movies/shows disappearing from and reapparing in collections/overlays sporadically. **We suggest users do not use the popularity sort options with `tmdb_discover`**. - - This bug is on TMDb's side and we are awaiting a fix from them. - -| Movie Parameters | Description | -|:--------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `limit` | Specify how many movies you want returned by the query.
**Type:** Integer
**Default:** 100 | -| `region` | Specify a [ISO 3166-1 code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) to filter release dates. Must be uppercase. Will use the `region` specified in the [TMDb Config](../../config/tmdb.md) by default.
**Type:** `^[A-Z]{2}$` | -| `sort_by` | Choose from one of the many available sort options.
**Type:** Any [sort options](#sort-options) below
**Default:** `popularity.desc` | -| `certification_country` | Used in conjunction with the certification parameter, use this to specify a country with a valid certification.
**Type:** String | -| `certification` | Filter results with a valid certification from the `certification_country` parameter.
**Type:** String | -| `certification.lte` | Filter and only include movies that have a certification that is less than or equal to the specified value.
**Type:** String | -| `certification.gte` | Filter and only include movies that have a certification that is greater than or equal to the specified value.
**Type:** String | -| `include_adult` | A filter and include or exclude adult movies.
**Type:** Boolean | -| `include_video` | A filter and include or exclude videos.
**Type:** Boolean | -| `primary_release_year` | A filter to limit the results to a specific primary release year.
**Type:** Year: YYYY | -| `primary_release_date.gte` | Filter and only include movies that have a primary release date that is greater or equal to the specified value.
**Type:** Date: `MM/DD/YYYY` | -| `primary_release_date.lte` | Filter and only include movies that have a primary release date that is less than or equal to the specified value.
**Type:** Date: `MM/DD/YYYY` | -| `release_date.gte` | Filter and only include movies that have a release date (looking at all release dates) that is greater or equal to the specified value.
**Type:** Date: `MM/DD/YYYY` | -| `release_date.lte` | Filter and only include movies that have a release date (looking at all release dates) that is less than or equal to the specified value.
**Type:** Date: `MM/DD/YYYY` | -| `with_release_type` | Specify a comma (AND) or pipe (OR) separated value to filter release types by.
**Type:** String
**Values:** `1`: Premiere, `2`: Theatrical (limited), `3`: Theatrical, `4`: Digital, `5`: Physical, `6`: TV | -| `year` | A filter to limit the results to a specific year (looking at all release dates).
**Type:** Year: `YYYY` | -| `vote_count.gte` | Filter and only include movies that have a vote count that is greater or equal to the specified value.
**Type:** Integer | -| `vote_count.lte` | Filter and only include movies that have a vote count that is less than or equal to the specified value.
**Type:** Integer | -| `vote_average.gte` | Filter and only include movies that have a rating that is greater or equal to the specified value.
**Type:** Number | -| `vote_average.lte` | Filter and only include movies that have a rating that is less than or equal to the specified value.
**Type:** Number | -| `with_cast` | A comma-separated list of person ID's. Only include movies that have one of the ID's added as an actor.
Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query
**Type:** String | -| `with_crew` | A comma-separated list of person ID's. Only include movies that have one of the ID's added as a crew member.
Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query
**Type:** String | -| `with_people` | A comma-separated list of person ID's. Only include movies that have one of the ID's added as either an actor or a crew member.
Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query
**Type:** String | -| `with_companies` | A comma-separated list of production company ID's. Only include movies that have one of the ID's added as a production company.
Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query
**Type:** String | -| `without_companies` | Filter the results to exclude the specific production companies you specify here. AND / OR filters are supported.
**Type:** String | -| `with_genres` | Comma-separated value of genre ids that you want to include in the results.
Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query
**Type:** String | -| `without_genres` | Comma-separated value of genre ids that you want to exclude from the results.
**Type:** String | -| `with_keywords` | A comma-separated list of keyword ID's. Only includes movies that have one of the ID's added as a keyword.
Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query
**Type:** String | -| `without_keywords` | Exclude items with certain keywords. You can comma and pipe separate these values to create an 'AND' or 'OR' logic.
**Type:** String | -| `with_runtime.gte` | Filter and only include movies that have a runtime that is greater or equal to a value.
**Type:** Integer | -| `with_runtime.lte` | Filter and only include movies that have a runtime that is less than or equal to a value.
**Type:** Integer | -| `with_origin_country` | Specify an origin country string to filter results by their original country value.
**Type:** String | -| `with_original_language` | Specify an ISO 639-1 string to filter results by their original language value.
**Type:** String | -| `with_watch_providers` | A comma or pipe separated list of watch provider ID's.
use in conjunction with watch_region, can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query
**Type:** String | -| `without_watch_providers` | Filter the results to exclude certain watch providers.
**Type:** String | -| `watch_region` | An [ISO 3166-1 code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes). Combine this filter with `with_watch_providers` in order to filter your results by a specific watch provider in a specific region.
**Type:** String
**Values:** [ISO 3166-1 code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) | -| `with_watch_monetization_types` | In combination with `watch_region`, you can filter by monetization type.
Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query
**Type:** String
**Values:** `flatrate`, `free`, `ads`, `rent`, `buy` | - - -### Discover Shows Parameters - -!!!important - - Note that a number of filters support being comma (,) or pipe (|) separated. Comma's are treated like an AND query - while pipe's are treated like an OR. This allows for quite complex filtering depending on your desired results. - -!!!bug - - We have noticed inconsistent responses from TMDb when using `popularity.desc` as the sort order. This can result in movies disappearing from and reapparing in collections/overlays sporadically. **We suggest users do not use the popularity.desc sort options with `tmdb_discover`**. - - This bug is on TMDb's side and we are awaiting a fix from them. - -| Show Parameters | Description | -|:--------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `limit` | Specify how many movies you want to be returned by the query.
**Type:** Integer
**Default:** 100 | -| `sort_by` | Choose from one of the many available sort options.
**Type:** Any [sort options](#sort-options) below
**Default:** `popularity.desc` | -| `air_date.gte` | Filter and only include TV shows that have an air date (by looking at all episodes) that is greater or equal to the specified value.
**Type:** Date: `MM/DD/YYYY` | -| `air_date.lte` | Filter and only include TV shows that have an air date (by looking at all episodes) that is less than or equal to the specified value.
**Type:** Date: `MM/DD/YYYY` | -| `first_air_date.gte` | Filter and only include TV shows that have a original air date that is greater or equal to the specified value. Can be used in conjunction with the `include_null_first_air_dates` filter if you want to include items with no air date.
**Type:** Date: `MM/DD/YYYY` | -| `first_air_date.lte` | Filter and only include TV shows that have a original air date that is less than or equal to the specified value. Can be used in conjunction with the `include_null_first_air_dates` filter if you want to include items with no air date.
**Type:** Date: `MM/DD/YYYY` | -| `first_air_date_year` | Filter and only include TV shows that have an original air date year that equal to the specified value. Can be used in conjunction with the `include_null_first_air_dates` filter if you want to include items with no air date.
**Type:** Year: `YYYY` | -| `include_adult` | A filter and include or exclude adult movies.
**Type:** Boolean | -| `include_null_first_air_dates` | Use this filter to include TV shows that don't have an air date while using any of the `first_air_date` filters.
**Type:** Boolean | -| `timezone` | Used in conjunction with the `air_date.gte/lte` filter to calculate the proper UTC offset.
**Type:** String
**Default:** `America/New_York` | -| `vote_count.gte` | Filter and only include TV that have a vote count that is greater or equal to the specified value.
**Type:** Integer | -| `vote_count.lte` | Filter and only include TV that have a vote count that is less than or equal to the specified value.
**Type:** Integer | -| `vote_average.gte` | Filter and only include TV that have a rating that is greater or equal to the specified value.
**Type:** Number | -| `vote_average.lte` | Filter and only include TV that have a rating that is less than or equal to the specified value.
**Type:** Number | -| `with_networks` | Comma-separated value of network ids that you want to include in the results.
**Type:** String | -| `with_companies` | A comma-separated list of production company ID's. Only include movies that have one of the ID's added as a production company.
Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query
**Type:** String | -| `without_companies` | Filter the results to exclude the specific production companies you specify here. AND / OR filters are supported.
**Type:** String | -| `with_genres` | Comma-separated value of genre ids that you want to include in the results.
Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query
**Type:** String | -| `without_genres` | Comma-separated value of genre ids that you want to exclude from the results.
**Type:** String | -| `with_keywords` | A comma-separated list of keyword ID's. Only includes TV shows that have one of the ID's added as a keyword.
Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query
**Type:** String | -| `without_keywords` | Exclude items with certain keywords. You can comma and pipe separate these values to create an 'AND' or 'OR' logic.
**Type:** String | -| `with_runtime.gte` | Filter and only include TV shows with an episode runtime that is greater than or equal to a value.
**Type:** Integer | -| `with_runtime.lte` | Filter and only include TV shows with an episode runtime that is less than or equal to a value.
**Type:** Integer | -| `with_original_language` | Specify an ISO 639-1 string to filter results by their original language value.
**Type:** String | -| `with_name_translation` | Specify a language/country string to filter the results by if the item has a type of name translation.
**Type:** String
**Values:** `ar-AE`, `ar-SA`, `bg-BG`, `bn-BD`, `ca-ES`, `ch-GU`, `cs-CZ`, `da-DK`, `de-DE`, `el-GR`, `en-US`, `eo-EO`, `es-ES`, `es-MX`, `eu-ES`, `fa-IR`, `fi-FI`, `fr-CA`, `fr-FR`, `he-IL`, `hi-IN`, `hu-HU`, `id-ID`, `it-IT`, `ja-JP`, `ka-GE`, `kn-IN`, `ko-KR`, `lt-LT`, `ml-IN`, `nb-NO`, `nl-NL`, `no-NO`, `pl-PL`, `pt-BR`, `pt-PT`, `ro-RO`, `ru-RU`, `sk-SK`, `sl-SI`, `sr-RS`, `sv-SE`, `ta-IN`, `te-IN`, `th-TH`, `tr-TR`, `uk-UA`, `vi-VN`, `zh-CN`, `zh-TW` | -| `screened_theatrically` | Filter results to include items that have been screened theatrically.
**Type:** Boolean | -| `with_watch_providers` | A comma or pipe separated list of watch provider ID's.
use in conjunction with watch_region, can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query
**Type:** String | -| `without_watch_providers` | Filter the results to exclude certain watch providers.
**Type:** String | -| `watch_region` | An [ISO 3166-1 code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes). Combine this filter with `with_watch_providers` in order to filter your results by a specific watch provider in a specific region.
**Type:** String | -| `with_watch_monetization_types` | In combination with `watch_region`, you can filter by monetization type.
Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query
**Type:** String
**Values:** `flatrate`, `free`, `ads`, `rent`, `buy` | -| `with_status` | Filter TV shows by their status.
**Type:** String
Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query
**Values:** `0`: Returning Series, `1`: Planned, `2`: In Production, `3`: Ended, `4`: Cancelled, `5`: Pilot | -| `with_type` | Filter TV shows by their type.
Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query
**Type:** String
**Values:** `0`: Documentary, `1`: News, `2`: Miniseries, `3`: Reality, `4`: Scripted, `5`: Show, `6`: Video | - -### Sort Options - -!!!bug - - We have noticed inconsistent responses from TMDb when using `popularity.desc` as the sort order. This can result in shows disappearing from and reapparing in collections/overlays sporadically. - - **Due to the nature of this bug, we suggest you do not use the `popularity.desc` sort options with `tmdb_discover` unless you also set a `limit` of 20 or less**. If you do not set a limit, the data that TMDb returns may be inconsistent.** - - This bug is on TMDb's side that we have made them aware of and are currently awaiting a fix. - - -| Sort Option | Movie Sort | Show Sort | -|:----------------------------|:------------------------------------------:|:------------------------------------------:| -| `popularity.asc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| `popularity.desc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| `title.asc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `title.desc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `original_title.asc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `original_title.desc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `name.asc` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `name.desc` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `original_name.asc` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `original_name.desc` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `revenue.asc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `revenue.desc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `release_date.asc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `release_date.desc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `primary_release_date.asc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `primary_release_date.desc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | -| `first_air_date.asc` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `first_air_date.desc` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | -| `vote_average.asc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| `vote_average.desc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| `vote_count.asc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | -| `vote_count.desc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | - -```yaml -collections: - Movies Released in October 2020: - tmdb_discover: - primary_release_date.gte: 10/01/2020 - primary_release_date.lte: 10/31/2020 -``` -```yaml -collections: - Popular Movies: - collection_order: custom - sync_mode: sync - tmdb_discover: - sort_by: popularity.desc -``` -```yaml -collections: - Highest Rated R Movies: - collection_order: custom - sync_mode: sync - tmdb_discover: - certification_country: US - certification: R - sort_by: vote_average.desc -``` -```yaml -collections: - Most Popular Kids Movies: - collection_order: custom - sync_mode: sync - tmdb_discover: - certification_country: US - certification.lte: G - sort_by: popularity.desc -``` -```yaml -collections: - Highest Rated Movies From 2010: - collection_order: custom - sync_mode: sync - tmdb_discover: - primary_release_year: 2010 - sort_by: vote_average.desc -``` -```yaml -collections: - Best Dramas From 2014: - collection_order: custom - sync_mode: sync - tmdb_discover: - with_genres: 18 - primary_release_year: 2014 - sort_by: vote_average.desc -``` -```yaml -collections: - Highest Rated Science Fiction Movies with Tom Cruise: - collection_order: custom - sync_mode: sync - tmdb_discover: - with_genres: 878 - with_cast: 500 - sort_by: vote_average.desc -``` -```yaml -collections: - Highest Grossing Comedy Movies with Will Ferrell: - collection_order: custom - sync_mode: sync - tmdb_discover: - with_genres: 35 - with_cast: 23659 - sort_by: revenue.desc -``` -```yaml -collections: - Top Rated Movies with Brad Pitt and Edward Norton: - collection_order: custom - sync_mode: sync - tmdb_discover: - with_people: 287,819 - sort_by: vote_average.desc -``` -```yaml -collections: - Popular Movies with David Fincher and Rooney Mara: - collection_order: custom - sync_mode: sync - tmdb_discover: - with_people: 108916,7467 - sort_by: popularity.desc -``` -```yaml -collections: - Top Rated Dramas: - collection_order: custom - sync_mode: sync - tmdb_discover: - with_genres: 18 - sort_by: vote_average.desc - vote_count.gte: 10 -``` -```yaml -collections: - Highest Grossing R Movies with Liam Neeson: - collection_order: custom - sync_mode: sync - tmdb_discover: - certification_country: US - certification: R - sort_by: revenue.desc - with_cast: 3896 -``` +## TMDb Standard Builders + +| Attribute | Description | Works with Movies | Works with Shows | Works with Playlists and Custom Sort | +|:-----------------------------------|:---------------------------------------------------------|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:| +| [`tmdb_discover`](#__tabbed_2_1) | Uses [TMDb's Discover Search](https://developer.themoviedb.org/docs/search-and-query-for-details) to find every movie/show based on the [movie search parameters](https://developers.themoviedb.org/3/discover/movie-discover) or [show search parameters](https://developers.themoviedb.org/3/discover/tv-discover) provided | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [`tmdb_collection`](#__tabbed_2_2) | Finds every item in the TMDb collection | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | +| [`tmdb_list`](#__tabbed_2_3) | Finds every item in the TMDb List | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [`tmdb_movie`](#__tabbed_2_4) | Finds the movie specified | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | +| [`tmdb_show`](#__tabbed_2_5) | Finds the show specified | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | +| [`tmdb_company`](#__tabbed_2_6) | Finds every item from the TMDb company's movie/show list | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | +| [`tmdb_network`](#__tabbed_2_7) | Finds every item from the TMDb network's show list | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | +| [`tmdb_keyword`](#__tabbed_2_8) | Finds every item from the TMDb keyword's movie/show list | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | + +## TMDb Chart Builders + +| Attribute | Description | Works with Movies | Works with Shows | Works with Playlists and Custom Sort | +|:----------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------:|:------------------------------------------:|:-------------------------------------------:| +| [`tmdb_popular`](#__tabbed_4_1) | Finds the movies/shows in TMDb's [Popular Movies](https://www.themoviedb.org/movie)/[Popular Shows](https://www.themoviedb.org/tv) list | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [`tmdb_now_playing`](#__tabbed_4_2) | Finds the movies in TMDb's [Now Playing](https://www.themoviedb.org/movie/now-playing) list | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | +| [`tmdb_top_rated`](#__tabbed_4_3) | Finds the movies/shows in TMDb's [Top Rated Movies](https://www.themoviedb.org/movie/top-rated)/[Top Rated Shows](https://www.themoviedb.org/tv/top-rated) list | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [`tmdb_upcoming`](#__tabbed_4_4) | Finds the movies in TMDb's [Upcoming Movies](https://www.themoviedb.org/movie/upcoming) list | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | +| [`tmdb_airing_today`](#__tabbed_4_5) | Finds the shows in TMDb's [Airing Today Shows](https://www.themoviedb.org/tv/airing-today) list | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [`tmdb_on_the_air`](#__tabbed_4_6) | Finds the shows in TMDb's [On TV Shows](https://www.themoviedb.org/tv/on-the-air) list | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [`tmdb_trending_daily`](#__tabbed_4_7) | Finds the movies/shows in TMDb's Trending Daily list | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | +| [`tmdb_trending_weekly`](#__tabbed_4_8) | Finds the movies/shows in TMDb's Trending Weekly list | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | + + +## TMDb People Builders + +| Attribute | Description | Works with Movies | Works with Shows | Works with Playlists and Custom Sort | +|:---------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------:|:------------------------------------------:|:-------------------------------------------:| +| [`tmdb_actor`](#__tabbed_5_1) | Finds every item in the TMDb Person's Actor Credits | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | +| [`tmdb_crew`](#__tabbed_5_2) | Finds every item in the TMDb Person's Crew Credits | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | +| [`tmdb_director`](#__tabbed_5_3) | Finds every item in the TMDb Person's Director Credits | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | +| [`tmdb_producer`](#__tabbed_5_4) | Finds every item in the TMDb Person's Producer Credits | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | +| [`tmdb_writer`](#__tabbed_5_5) | Finds every item in the TMDb Person's Writer Credits | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | + +=== "TMDb Standard Builders" + + These are the most commonly used TMDb Builders. + + === "Discover" + + Uses [TMDb's Discover Search](https://developer.themoviedb.org/docs/search-and-query-for-details) to find every + movie/show based on the [movie search attributes](https://developers.themoviedb.org/3/discover/movie-discover) or + [show search attributes](https://developers.themoviedb.org/3/discover/tv-discover) provided. + + The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated + and in a specific order. + + | Type | Description | + |:-------------------|:--------------------------------------------------| + | String | Any number of alphanumeric characters | + | Integer | Any whole number greater than zero i.e. 2, 10, 50 | + | Number | Any number greater than zero i.e. 2.5, 7.4, 9 | + | Boolean | Must be `true` or `false` | + | Date: `MM/DD/YYYY` | Date that fits the specified format | + | Year: `YYYY` | Year must be a 4 digit integer i.e. 1990 | + + === "Discover Movies Attributes" + + !!!important + + Note that a number of filters support being comma (,) or pipe (|) separated. Comma's are treated like an AND query + while pipe's are treated like an OR. This allows for quite complex filtering depending on your desired results. + + !!!bug + + We have noticed inconsistent responses from TMDb when using `popularity.asc` and `popularity.desc` as the sort order. This can result in movies/shows disappearing from and reapparing in collections/overlays sporadically. **We suggest users do not use the popularity sort options with `tmdb_discover`**. + + This bug is on TMDb's side and we are awaiting a fix from them. + + | Attribute | Description | + |:--------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `limit` | Specify how many movies you want returned by the query.
**Type:** Integer
**Default:** 100 | + | `region` | Specify a [ISO 3166-1 code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) to filter release dates. Must be uppercase. Will use the `region` specified in the [TMDb Config](../../config/tmdb.md) by default.
**Type:** `^[A-Z]{2}$` | + | `sort_by` | Choose from one of the many available sort options.
**Type:** Any sort option below
**Default:** `popularity.desc` | + | `certification_country` | Used in conjunction with the certification parameter, use this to specify a country with a valid certification.
**Type:** String | + | `certification` | Filter results with a valid certification from the `certification_country` parameter.
**Type:** String | + | `certification.lte` | Filter and only include movies that have a certification that is less than or equal to the specified value.
**Type:** String | + | `certification.gte` | Filter and only include movies that have a certification that is greater than or equal to the specified value.
**Type:** String | + | `include_adult` | A filter and include or exclude adult movies.
**Type:** Boolean | + | `include_video` | A filter and include or exclude videos.
**Type:** Boolean | + | `primary_release_year` | A filter to limit the results to a specific primary release year.
**Type:** Year: YYYY | + | `primary_release_date.gte` | Filter and only include movies that have a primary release date that is greater or equal to the specified value.
**Type:** Date: `MM/DD/YYYY` | + | `primary_release_date.lte` | Filter and only include movies that have a primary release date that is less than or equal to the specified value.
**Type:** Date: `MM/DD/YYYY` | + | `release_date.gte` | Filter and only include movies that have a release date (looking at all release dates) that is greater or equal to the specified value.
**Type:** Date: `MM/DD/YYYY` | + | `release_date.lte` | Filter and only include movies that have a release date (looking at all release dates) that is less than or equal to the specified value.
**Type:** Date: `MM/DD/YYYY` | + | `with_release_type` | Specify a comma (AND) or pipe (OR) separated value to filter release types by.
**Type:** String
**Values:** `1`: Premiere, `2`: Theatrical (limited), `3`: Theatrical, `4`: Digital, `5`: Physical, `6`: TV | + | `year` | A filter to limit the results to a specific year (looking at all release dates).
**Type:** Year: `YYYY` | + | `vote_count.gte` | Filter and only include movies that have a vote count that is greater or equal to the specified value.
**Type:** Integer | + | `vote_count.lte` | Filter and only include movies that have a vote count that is less than or equal to the specified value.
**Type:** Integer | + | `vote_average.gte` | Filter and only include movies that have a rating that is greater or equal to the specified value.
**Type:** Number | + | `vote_average.lte` | Filter and only include movies that have a rating that is less than or equal to the specified value.
**Type:** Number | + | `with_cast` | A comma-separated list of person ID's. Only include movies that have one of the ID's added as an actor.
Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query
**Type:** String | + | `with_crew` | A comma-separated list of person ID's. Only include movies that have one of the ID's added as a crew member.
Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query
**Type:** String | + | `with_people` | A comma-separated list of person ID's. Only include movies that have one of the ID's added as either an actor or a crew member.
Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query
**Type:** String | + | `with_companies` | A comma-separated list of production company ID's. Only include movies that have one of the ID's added as a production company.
Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query
**Type:** String | + | `without_companies` | Filter the results to exclude the specific production companies you specify here. AND / OR filters are supported.
**Type:** String | + | `with_genres` | Comma-separated value of genre ids that you want to include in the results.
Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query
**Type:** String | + | `without_genres` | Comma-separated value of genre ids that you want to exclude from the results.
**Type:** String | + | `with_keywords` | A comma-separated list of keyword ID's. Only includes movies that have one of the ID's added as a keyword.
Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query
**Type:** String | + | `without_keywords` | Exclude items with certain keywords. You can comma and pipe separate these values to create an 'AND' or 'OR' logic.
**Type:** String | + | `with_runtime.gte` | Filter and only include movies that have a runtime that is greater or equal to a value.
**Type:** Integer | + | `with_runtime.lte` | Filter and only include movies that have a runtime that is less than or equal to a value.
**Type:** Integer | + | `with_origin_country` | Specify an origin country string to filter results by their original country value.
**Type:** String | + | `with_original_language` | Specify an ISO 639-1 string to filter results by their original language value.
**Type:** String | + | `with_watch_providers` | A comma or pipe separated list of watch provider ID's.
use in conjunction with watch_region, can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query
**Type:** String | + | `without_watch_providers` | Filter the results to exclude certain watch providers.
**Type:** String | + | `watch_region` | An [ISO 3166-1 code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes). Combine this filter with `with_watch_providers` in order to filter your results by a specific watch provider in a specific region.
**Type:** String
**Values:** [ISO 3166-1 code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) | + | `with_watch_monetization_types` | In combination with `watch_region`, you can filter by monetization type.
Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query
**Type:** String
**Values:** `flatrate`, `free`, `ads`, `rent`, `buy` | + + + === "Discover Shows Attributes" + + ???+ warning "Important" + + Note that a number of filters support being comma (,) or pipe (|) separated. Comma's are treated like an AND query + while pipe's are treated like an OR. This allows for quite complex filtering depending on your desired results. + + + | Attributes | Description | + |:--------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | `limit` | Specify how many movies you want to be returned by the query.
**Type:** Integer
**Default:** 100 | + | `sort_by` | Choose from one of the many available sort options.
**Type:** Any sort option below
**Default:** `popularity.desc` | + | `air_date.gte` | Filter and only include TV shows that have an air date (by looking at all episodes) that is greater or equal to the specified value.
**Type:** Date: `MM/DD/YYYY` | + | `air_date.lte` | Filter and only include TV shows that have an air date (by looking at all episodes) that is less than or equal to the specified value.
**Type:** Date: `MM/DD/YYYY` | + | `first_air_date.gte` | Filter and only include TV shows that have a original air date that is greater or equal to the specified value. Can be used in conjunction with the `include_null_first_air_dates` filter if you want to include items with no air date.
**Type:** Date: `MM/DD/YYYY` | + | `first_air_date.lte` | Filter and only include TV shows that have a original air date that is less than or equal to the specified value. Can be used in conjunction with the `include_null_first_air_dates` filter if you want to include items with no air date.
**Type:** Date: `MM/DD/YYYY` | + | `first_air_date_year` | Filter and only include TV shows that have an original air date year that equal to the specified value. Can be used in conjunction with the `include_null_first_air_dates` filter if you want to include items with no air date.
**Type:** Year: `YYYY` | + | `include_adult` | A filter and include or exclude adult movies.
**Type:** Boolean | + | `include_null_first_air_dates` | Use this filter to include TV shows that don't have an air date while using any of the `first_air_date` filters.
**Type:** Boolean | + | `timezone` | Used in conjunction with the `air_date.gte/lte` filter to calculate the proper UTC offset.
**Type:** String
**Default:** `America/New_York` | + | `vote_count.gte` | Filter and only include TV that have a vote count that is greater or equal to the specified value.
**Type:** Integer | + | `vote_count.lte` | Filter and only include TV that have a vote count that is less than or equal to the specified value.
**Type:** Integer | + | `vote_average.gte` | Filter and only include TV that have a rating that is greater or equal to the specified value.
**Type:** Number | + | `vote_average.lte` | Filter and only include TV that have a rating that is less than or equal to the specified value.
**Type:** Number | + | `with_networks` | Comma-separated value of network ids that you want to include in the results.
**Type:** String | + | `with_companies` | A comma-separated list of production company ID's. Only include movies that have one of the ID's added as a production company.
Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query
**Type:** String | + | `without_companies` | Filter the results to exclude the specific production companies you specify here. AND / OR filters are supported.
**Type:** String | + | `with_genres` | Comma-separated value of genre ids that you want to include in the results.
Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query
**Type:** String | + | `without_genres` | Comma-separated value of genre ids that you want to exclude from the results.
**Type:** String | + | `with_keywords` | A comma-separated list of keyword ID's. Only includes TV shows that have one of the ID's added as a keyword.
Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query
**Type:** String | + | `without_keywords` | Exclude items with certain keywords. You can comma and pipe separate these values to create an 'AND' or 'OR' logic.
**Type:** String | + | `with_runtime.gte` | Filter and only include TV shows with an episode runtime that is greater than or equal to a value.
**Type:** Integer | + | `with_runtime.lte` | Filter and only include TV shows with an episode runtime that is less than or equal to a value.
**Type:** Integer | + | `with_original_language` | Specify an ISO 639-1 string to filter results by their original language value.
**Type:** String | + | `with_name_translation` | Specify a language/country string to filter the results by if the item has a type of name translation.
**Type:** String
**Values:** `ar-AE`, `ar-SA`, `bg-BG`, `bn-BD`, `ca-ES`, `ch-GU`, `cs-CZ`, `da-DK`, `de-DE`, `el-GR`, `en-US`, `eo-EO`, `es-ES`, `es-MX`, `eu-ES`, `fa-IR`, `fi-FI`, `fr-CA`, `fr-FR`, `he-IL`, `hi-IN`, `hu-HU`, `id-ID`, `it-IT`, `ja-JP`, `ka-GE`, `kn-IN`, `ko-KR`, `lt-LT`, `ml-IN`, `nb-NO`, `nl-NL`, `no-NO`, `pl-PL`, `pt-BR`, `pt-PT`, `ro-RO`, `ru-RU`, `sk-SK`, `sl-SI`, `sr-RS`, `sv-SE`, `ta-IN`, `te-IN`, `th-TH`, `tr-TR`, `uk-UA`, `vi-VN`, `zh-CN`, `zh-TW` | + | `screened_theatrically` | Filter results to include items that have been screened theatrically.
**Type:** Boolean | + | `with_watch_providers` | A comma or pipe separated list of watch provider ID's.
use in conjunction with watch_region, can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query
**Type:** String | + | `without_watch_providers` | Filter the results to exclude certain watch providers.
**Type:** String | + | `watch_region` | An [ISO 3166-1 code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes). Combine this filter with `with_watch_providers` in order to filter your results by a specific watch provider in a specific region.
**Type:** String | + | `with_watch_monetization_types` | In combination with `watch_region`, you can filter by monetization type.
Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query
**Type:** String
**Values:** `flatrate`, `free`, `ads`, `rent`, `buy` | + | `with_status` | Filter TV shows by their status.
**Type:** String
Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query
**Values:** `0`: Returning Series, `1`: Planned, `2`: In Production, `3`: Ended, `4`: Cancelled, `5`: Pilot | + | `with_type` | Filter TV shows by their type.
Can be a comma (`,`) for an AND, or a pipe (`|`) for an OR separated query
**Type:** String
**Values:** `0`: Documentary, `1`: News, `2`: Miniseries, `3`: Reality, `4`: Scripted, `5`: Show, `6`: Video | + + === "Sort Options" + + | Sort Option | Movie Sort | Show Sort | + |:----------------------------|:------------------------------------------:|:------------------------------------------:| + | `popularity.asc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | + | `popularity.desc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | + | `title.asc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | + | `title.desc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | + | `original_title.asc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | + | `original_title.desc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | + | `name.asc` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | + | `name.desc` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | + | `original_name.asc` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | + | `original_name.desc` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | + | `revenue.asc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | + | `revenue.desc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | + | `release_date.asc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | + | `release_date.desc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | + | `primary_release_date.asc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | + | `primary_release_date.desc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | + | `first_air_date.asc` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | + | `first_air_date.desc` | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | + | `vote_average.asc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | + | `vote_average.desc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | + | `vote_count.asc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | + | `vote_count.desc` | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | + + ```yaml + collections: + Movies Released in October 2020: + tmdb_discover: + primary_release_date.gte: 10/01/2020 + primary_release_date.lte: 10/31/2020 + ``` + ```yaml + collections: + Popular Movies: + collection_order: custom + sync_mode: sync + tmdb_discover: + sort_by: popularity.desc + ``` + ```yaml + collections: + Highest Rated R Movies: + collection_order: custom + sync_mode: sync + tmdb_discover: + certification_country: US + certification: R + sort_by: vote_average.desc + ``` + ```yaml + collections: + Most Popular Kids Movies: + collection_order: custom + sync_mode: sync + tmdb_discover: + certification_country: US + certification.lte: G + sort_by: popularity.desc + ``` + ```yaml + collections: + Highest Rated Movies From 2010: + collection_order: custom + sync_mode: sync + tmdb_discover: + primary_release_year: 2010 + sort_by: vote_average.desc + ``` + ```yaml + collections: + Best Dramas From 2014: + collection_order: custom + sync_mode: sync + tmdb_discover: + with_genres: 18 + primary_release_year: 2014 + sort_by: vote_average.desc + ``` + ```yaml + collections: + Highest Rated Science Fiction Movies with Tom Cruise: + collection_order: custom + sync_mode: sync + tmdb_discover: + with_genres: 878 + with_cast: 500 + sort_by: vote_average.desc + ``` + ```yaml + collections: + Highest Grossing Comedy Movies with Will Ferrell: + collection_order: custom + sync_mode: sync + tmdb_discover: + with_genres: 35 + with_cast: 23659 + sort_by: revenue.desc + ``` + ```yaml + collections: + Top Rated Movies with Brad Pitt and Edward Norton: + collection_order: custom + sync_mode: sync + tmdb_discover: + with_people: 287,819 + sort_by: vote_average.desc + ``` + ```yaml + collections: + Popular Movies with David Fincher and Rooney Mara: + collection_order: custom + sync_mode: sync + tmdb_discover: + with_people: 108916,7467 + sort_by: popularity.desc + ``` + ```yaml + collections: + Top Rated Dramas: + collection_order: custom + sync_mode: sync + tmdb_discover: + with_genres: 18 + sort_by: vote_average.desc + vote_count.gte: 10 + ``` + ```yaml + collections: + Highest Grossing R Movies with Liam Neeson: + collection_order: custom + sync_mode: sync + tmdb_discover: + certification_country: US + certification: R + sort_by: revenue.desc + with_cast: 3896 + ``` + + + === "Collection" + + Finds every item in the TMDb collection. + + This Builder is expected to have the full URL to the item or the TMDb ID of the item. Multiple values are supported as either a list or a comma-separated string. + + ???+ tip "Details Builder" + + You can replace `tmdb_collection` with `tmdb_collection_details` if you would like to fetch and use the TMDb collection's summary, poster, and background from the list + + ```yaml + collections: + The Lord of the Rings: + tmdb_collection: https://www.themoviedb.org/collection/119 + The Hobbit: + tmdb_collection: 121938 + Middle Earth: + tmdb_collection: + - 119 + - https://www.themoviedb.org/collection/121938 + ``` + + * You can specify multiple collections in `tmdb_collection_details` but it will only use the first one to update the collection details. + * Posters and background in the library's asset directory will be used over the collection details unless `tmdb_poster`/`tmdb_background` is also specified. + + ```yaml + collections: + Harry Potter: + tmdb_collection_details: 1241 #https://www.themoviedb.org/collection/1241 also accepted + Fantastic Beasts: + tmdb_collection_details: 435259 #https://www.themoviedb.org/collection/435259 also accepted + Wizarding World: + tmdb_collection_details: + - 1241 + - https://www.themoviedb.org/collection/435259 + ``` + + === "List" + + Finds every item in the TMDb List. + + This Builder is expected to have the full URL to the item or the TMDb ID of the item. Multiple values are supported as either a list or a comma-separated string. + + The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated + and in a specific order. + + ???+ tip "Details Builder" + + You can replace `tmdb_list` with `tmdb_list_details` if you would like to fetch and use the description and poster from the list + + ```yaml + collections: + Top 50 Grossing Films of All Time (Worldwide): + tmdb_list: 10 #https://www.themoviedb.org/list/10 also accepted + collection_order: custom + sync_mode: sync + ``` + + * You can specify multiple lists in `tmdb_list_details` but it will only use the first one to update the collection details. + + === "Movie" + + Finds the movie specified. + + This Builder is expected to have the full URL to the item or the TMDb ID of the item. Multiple values are supported as either a list or a comma-separated string. + + ???+ tip "Details Builder" + + You can replace `tmdb_movie` with `tmdb_movie_details` if you would like to fetch and use the TMDb movie's summary, poster, and background from the list + + ```yaml + collections: + Anaconda: + tmdb_movie: 336560 #https://www.themoviedb.org/movie/336560 also accepted + ``` + + * You can specify multiple movies in `tmdb_movie_details` but it will only use the first one to update the collection details. + * Posters and background in the library's asset directory will be used over the collection details unless `tmdb_poster`/`tmdb_background` is also specified. + + ```yaml + collections: + Deadpool Specials: + tmdb_movie_details: 558144 + ``` + + === "Show" + + Finds the show specified. + + This Builder is expected to have the full URL to the item or the TMDb ID of the item. Multiple values are supported as either a list or a comma-separated string. + + ???+ tip "Details Builder" + + You can replace `tmdb_show` with `tmdb_show_details` if you would like to fetch and use the TMDb show's summary, poster, and background from the list + + ```yaml + collections: + Star Wars (Animated Shows): + tmdb_show: + - 4194 #https://www.themoviedb.org/tv/4194-star-wars-the-clone-wars also accepted + - 60554 #https://www.themoviedb.org/tv/60554-star-wars-rebels also accepted + ``` + + * You can specify multiple shows in `tmdb_show_details` but it will only use the first one to update the collection details. + * Posters and background in the library's asset directory will be used over the collection details unless `tmdb_poster`/`tmdb_background` is also specified. + + ```yaml + collections: + Pokémon Evolutions & Chronicles: + tmdb_show_details: + - 132636 + - 13230 + ``` + + === "Company" + + Finds every movie from the TMDb company's movie list. + + This Builder is expected to have the full URL to the item or the TMDb ID of the item. Multiple values are supported as either a list or a comma-separated string. + + ```yaml + collections: + Studio Ghibli: + tmdb_company: 10342 #https://www.themoviedb.org/company/10342 also accepted + ``` + + === "Network" + + Finds every item from the TMDb network's movie/show list. + + This Builder is expected to have the full URL to the item or the TMDb ID of the item. Multiple values are supported as either a list or a comma-separated string. + + ```yaml + collections: + CBS: + tmdb_network: 16 #https://www.themoviedb.org/network/16 also accepted + ``` + + === "Keyword" + + Finds every item from the TMDb keyword's movie/show list. + + ```yaml + collections: + Marvel Cinematic Universe: + tmdb_keyword: 180547 #https://www.themoviedb.org/keyword/180547 also accepted + ``` + +=== "TMDb Chart Builders" + + These Builders use TMDb's Chart data + + === "Popular" + + Finds the movies/shows in TMDb's [Popular Movies](https://www.themoviedb.org/movie)/[Popular Shows](https://www.themoviedb.org/tv) list. + + Use `tmdb_region` with this builder to set the region. + + This Builder is expected to have an integer (number) value of how many items to query + + The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated + and in a specific order. + + ```yaml + collections: + TMDb Popular: + tmdb_popular: 30 + collection_order: custom + sync_mode: sync + ``` + + === "Now Playing" + + Finds the movies in TMDb's [Now Playing](https://www.themoviedb.org/movie/now-playing) list. + + Use `tmdb_region` with this builder to set the region. + + This Builder is expected to have an integer (number) value of how many items to query + + The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated + and in a specific order. + + ```yaml + collections: + TMDb Now Playing: + tmdb_now_playing: 30 + collection_order: custom + sync_mode: sync + ``` + + === "Top Rated" + + Finds the movies/shows in TMDb's [Top Rated Movies](https://www.themoviedb.org/movie/top-rated)/[Top Rated Shows](https://www.themoviedb.org/tv/top-rated) list. + + Use `tmdb_region` with this builder to set the region. + + This Builder is expected to have an integer (number) value of how many items to query + + The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated + and in a specific order. + + ```yaml + collections: + TMDb Top Rated: + tmdb_top_rated: 30 + collection_order: custom + sync_mode: sync + ``` + + === "Upcoming" + + Finds the movies in TMDb's [Upcoming Movies](https://www.themoviedb.org/movie/upcoming) list. + + Use `tmdb_region` with this builder to set the region. + + This Builder is expected to have an integer (number) value of how many items to query + + The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated + and in a specific order. + + ```yaml + collections: + TMDb Upcoming: + tmdb_upcoming: 30 + collection_order: custom + sync_mode: sync + ``` + + === "Airing Today" + + Finds the shows in TMDb's [Airing Today Shows](https://www.themoviedb.org/tv/airing-today) list. + + This Builder is expected to have an integer (number) value of how many items to query + + The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated + and in a specific order. + + ```yaml + collections: + TMDb Airing Today: + tmdb_airing_today: 30 + collection_order: custom + sync_mode: sync + ``` + + === "On the Air" + + Finds the shows in TMDb's [On TV Shows](https://www.themoviedb.org/tv/on-the-air) list. + + This Builder is expected to have an integer (number) value of how many items to query + + The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated + and in a specific order. + + ```yaml + collections: + TMDb On the Air: + tmdb_on_the_air: 30 + collection_order: custom + sync_mode: sync + ``` + + === "Trending Daily" + + Finds the movies/shows in TMDb's Trending Daily list. + + This Builder is expected to have an integer (number) value of how many items to query + + The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated + and in a specific order. + + ```yaml + collections: + TMDb Daily Trending: + tmdb_trending_daily: 30 + collection_order: custom + sync_mode: sync + ``` + + === "Trending Weekly" + + Finds the movies/shows in TMDb's Trending Weekly list. + + This Builder is expected to have an integer (number) value of how many items to query + + The `sync_mode: sync` and `collection_order: custom` Setting are recommended since the lists are continuously updated + and in a specific order. + + ```yaml + collections: + TMDb Weekly Trending: + tmdb_trending_weekly: 30 + collection_order: custom + sync_mode: sync + ``` + +=== "TMDb People Builders" + + These Builders use data on people's credited work. + + ???+ tip "People Collections" + + As Plex does not allow People to be part of Collections, Kometa will instead add any media that the person is associated with based om the builder criteria. + + You can not have a Collection of "Top 10 Actors" for example, as Plex does not allow this. + + === "Actor" + + Finds every item in the TMDb Person's Actor Credits. + + ???+ tip "Details Builder" + + You can replace `tmdb_actor` with `tmdb_actor_details` if you would like to fetch and use the TMDb Person's biography and profile from the list + + ```yaml + collections: + Robin Williams: + tmdb_actor: 2157 #https://www.themoviedb.org/person/2157-robin-williams also accepted + ``` + + * You can specify multiple people in `tmdb_actor_details` but it will only use the first one to update the collection details. + + + === "Crew" + + Finds every item in the TMDb Person's Crew Credits. + + ???+ tip "Details Builder" + + You can replace `tmdb_crew` with `tmdb_crew_details` if you would like to fetch and use the TMDb Person's biography and profile from the list + + ```yaml + collections: + Quentin Tarantino: + tmdb_crew: 138 #https://www.themoviedb.org/person/138-quentin-tarantino also accepted + ``` + + * You can specify multiple people in `tmdb_crew_details` but it will only use the first one to update the collection details. + + === "Director" + + Finds every item in the TMDb Person's Director Credits. + + ???+ tip "Details Builder" + + You can replace `tmdb_director` with `tmdb_director_details` if you would like to fetch and use the TMDb Person's biography and profile from the list + + ```yaml + collections: + Steven Spielberg: + tmdb_director: 488 #https://www.themoviedb.org/person/488-steven-spielberg also accepted + ``` + + * You can specify multiple people in `tmdb_director_details` but it will only use the first one to update the collection details. + + + === "Producer" + + Finds every item in the TMDb Person's Producer Credits. + + ???+ tip "Details Builder" + + You can replace `tmdb_producer` with `tmdb_producer_details` if you would like to fetch and use the TMDb Person's biography and profile from the list + + ```yaml + collections: + Adam Sandler: + tmdb_producer: 19292 #https://www.themoviedb.org/person/19292-adam-sandler also accepted + ``` + + * You can specify multiple people in `tmdb_producer_details` but it will only use the first one to update the collection details. + + === "Writer" + + Finds every item in the TMDb Person's Writer Credits. + + ???+ tip "Details Builder" + + You can replace `tmdb_writer` with `tmdb_writer_details` if you would like to fetch and use the TMDb Person's biography and profile from the list + + ```yaml + collections: + Woody Allen: + tmdb_writer: 1243 #https://www.themoviedb.org/person/1243-woody-allen also accepted + ``` + + * You can specify multiple people in `tmdb_writer_details` but it will only use the first one to update the collection details. diff --git a/docs/files/filters.md b/docs/files/filters.md index ecd2801e4..f5814c73d 100644 --- a/docs/files/filters.md +++ b/docs/files/filters.md @@ -95,7 +95,7 @@ You can use the `plex_all: true` builder to filter from your entire library. ???+ warning - Filters can be very slow, particularly on larger libraries. Try to build or narrow your items using a [Smart Label Collection](builders/smart.md#smart-label), [Plex Search](builders/plex.md#plex-search) or another [Builder](overview.md) if possible. + Filters can be very slow, particularly on larger libraries. Try to build or narrow your items using a [Smart Label Collection](builders/plex.md#__tabbed_2_2), [Plex Search](builders/plex.md#__tabbed_3_2) or another [Builder](overview.md) if possible. ## Filter Options @@ -328,7 +328,7 @@ You can use the `plex_all: true` builder to filter from your entire library. | `tmdb_keyword`**2** | Uses the keywords from TMDb to match | `Movies`, `Shows` | | `origin_country`**2** | Uses TMDb origin country [ISO 3166-1 alpha-2 codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) to match
Example: `origin_country: us` | `Shows` | | `tvdb_genre`**2** | Uses the genres from TVDb to match | `Shows` | - | `imdb_keyword`**2** | Uses the keywords from IMDb to match See [Special](#special-filters) for more attributes | `Movies`, `Shows` | + | `imdb_keyword`**2** | Uses the keywords from IMDb to match See [Special Filters](#__tabbed_1_6) for more attributes | `Movies`, `Shows` | **1** Filters using the special `episodes`/`tracks` [filter](#__tabbed_1_6) with the [default percent](settings.md). diff --git a/docs/files/settings.md b/docs/files/settings.md index 28c8ca58e..4bf01b84c 100644 --- a/docs/files/settings.md +++ b/docs/files/settings.md @@ -79,7 +79,7 @@ All the following attributes serve various functions as how the definition funct | `sync_to_trakt_list` | **Description:** Used to specify a trakt list you want the definition synced to.
**Values:** Trakt List Slug you want to sync to | | `sync_missing_to_trakt_list` | **Description:** Used to also sync missing items to the Trakt List specified by `sync_to_trakt_list`.
**Default:** `false`
**Values:** `true` or `false` | | `run_definition` | **Description:** Used to specify if this definition runs.
Multiple can be used for one definition as a list or comma separated string. One `false` or unmatched library type will cause it to fail.
**Values:** `movie`, `show`, `artist`, `true`, `false` | -| `default_percent` | **Description:** Used to declare the default percent for `episodes`, `seasons`, `tracks`, and `albums` [special filters](filters.md#special-filters). See [Example](#default-percent-example) below.
**Default:** `50`.
**Values:** Integer between 1 and 100 | +| `default_percent` | **Description:** Used to declare the default percent for `episodes`, `seasons`, `tracks`, and `albums` [special filters](filters.md#__tabbed_1_6). See [Example](#default-percent-example) below.
**Default:** `50`.
**Values:** Integer between 1 and 100 | | `ignore_blank_results` | **Description:** Used to not have Errors resulting from blank results from builders.
**Default:** `false`
**Values:** `true` or `false` | | `only_run_on_create` | **Description:** Used to only run the collection definition if the collection doesn't already exist.
**Default:** `false`
**Values:** `true` or `false` | | `delete_collections_named` | **Description:** Used to delete any collections in your plex named one of the given collections.
**Values:** List of Collection Names to delete | diff --git a/docs/files/updates.md b/docs/files/updates.md index 357181321..236f0953d 100644 --- a/docs/files/updates.md +++ b/docs/files/updates.md @@ -38,7 +38,7 @@ All the following attributes update various details of the definition's Metadata | Attribute | Description & Values | |:-----------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `tmdb_person` | **Description:** Changes summary and poster to a TMDb Person's biography and profile to the first specified person as well as allow the people specified to be used in [Plex Searches](builders/plex.md#plex-search).
**Values:** TMDb Person ID or Actor Name (Will pull the first ID from the TMDb search results) (List or Comma-separated string) | +| `tmdb_person` | **Description:** Changes summary and poster to a TMDb Person's biography and profile to the first specified person as well as allow the people specified to be used in [Plex Searches](builders/plex.md#__tabbed_3_2).
**Values:** TMDb Person ID or Actor Name (Will pull the first ID from the TMDb search results) (List or Comma-separated string) | | `tmdb_person_offset` | **Description:** Offsets which search results are used by `tmdb_person`.
**Values:** Any number greater than 0
**Default:** 0 | | `sort_title` | **Description:** Changes the sort title.
You can "promote" certain collections to the top of a library by creating a sort title starting with a `+` or "demote" certain collections to the bottom of a library by creating a sort title starting with a `~`.
**Values:** Text to change Sort Title | | `content_rating` | **Description:** Changes the content rating.
**Values:** Text to change Content Rating | @@ -46,7 +46,7 @@ All the following attributes update various details of the definition's Metadata | `label.remove` | **Description:** Removes existing labels from the collection.
**Values:** Comma-separated string of labels to remove | | `label.sync` | **Description:** Matches the labels of the collection to the labels provided (Leave blank to remove all labels)
**Values:** Comma-separated string of labels to sync | | `collection_mode` | **Description:** Changes the Collection Mode
**Values:**
`default`Library default
`hide`Hide Collection
`hide_items`Hide Items in this Collection
`show_items`Show this Collection and its Items
| -| `collection_order` | **Description:** Changes the Collection Order
**Normal Collections Only**
When using `custom.asc`/`custom.desc` you can only have a single builder in the collection.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom.asc`/`custom.desc`Order Collection Via the Builder Order ascending or descending
[Any `plex_search` Sort Option](builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order` | **Description:** Changes the Collection Order
**Normal Collections Only**
When using `custom.asc`/`custom.desc` you can only have a single builder in the collection.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom.asc`/`custom.desc`Order Collection Via the Builder Order ascending or descending
[Any `plex_search` Sort Option](builders/plex.md#__tabbed_1_4)Order Collection by any `plex_search` Sort Option
| | `collection_filtering` | **Description:** Changes the Collection Filtering
**Smart Collections Only**
**Values:**
`admin`Always the server admin user
`user`User currently viewing the content
| | `visible_library` | **Description:** Changes collection visible on Library Recommended Tab (Only works with Plex Pass)
**Values:**
`true`Visible
`false`Not Visible
[Any `schedule` Option](../config/schedule.md)Visible When Scheduled
| | `visible_home` | **Description:** Changes collection visible on Home Tab (Only works with Plex Pass)
**Values:**
`true`Visible
`false`Not Visible
[Any `schedule` Option](../config/schedule.md)Visible When Scheduled
| diff --git a/docs/kometa/environmental.md b/docs/kometa/environmental.md index 389ae1baf..2ffe899c1 100644 --- a/docs/kometa/environmental.md +++ b/docs/kometa/environmental.md @@ -570,7 +570,7 @@ Kometa will load those environment variables when it starts up, and you don't ha To preserve functionality of Kometa, this will **not** remove the Overlay label, which is required for Kometa to know which items have Overlays applied. - This will impact any [Smart Label Collections](../files/builders/smart.md#smart-label) that you have in your + This will impact any [Smart Label Collections](../files/builders/plex.md#__tabbed_2_2) that you have in your library. We do not recommend using this on a regular basis if you also use any operations or collections that update diff --git a/docs/kometa/faqs.md b/docs/kometa/faqs.md index beb16c1f0..a73cc4ea1 100644 --- a/docs/kometa/faqs.md +++ b/docs/kometa/faqs.md @@ -464,7 +464,7 @@ With the release of Kometa 1.20, several changes have been made. Please read the All URLs used with `imdb_list` **must** start with `https://www.imdb.com/list/` - We have introduced the [IMDb Search Builder](../files/builders/imdb.md#imdb-search) which replaces the functionality that `search/title/` and `search/keyword/` used to provide. + We have introduced the [IMDb Search Builder](../files/builders/imdb.md#__tabbed_1_3) which replaces the functionality that `search/title/` and `search/keyword/` used to provide. As an example, the `imdb_search` builder for `https://www.imdb.com/search/keyword/?keywords=christmas-movie` would be: diff --git a/docs/kometa/guides/order.md b/docs/kometa/guides/order.md index 0f16a528d..183f940f9 100644 --- a/docs/kometa/guides/order.md +++ b/docs/kometa/guides/order.md @@ -426,7 +426,7 @@ if you have a Smart Label collection, you can pass the `sort_by` value you want smart_label: audience_rating.desc ``` -The Sort Orders available for "Smart" collections are outlined on the **[Smart Plex Builder](../../files/builders/smart.md)** page. +The Sort Orders available for "Smart" collections are outlined on the **[Plex Builder](../../files/builders/plex.md)** page. ??? tip diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 25c4feb6e..0f1b7b872 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -14,7 +14,7 @@ --md-primary-fg-color: #00bc8c; --md-primary-fg-color--light: #00bc8c; --md-primary-fg-color--dark: #00bc8c; - --md-default-bg-color: #252525; + --md-default-bg-color: #121212; --md-footer-bg-color--dark: var(--md-default-bg-color); --md-primary-bg-color--light: #ffffffb3; --pg-light-border: rgb(47, 47, 47); @@ -234,6 +234,21 @@ table.dualTable td, table.dualTable th { margin: 5px auto; font-size: inherit; } + +.md-typeset .admonition, .md-typeset details { + background-color: #282828; + border: .075rem solid #575757; + border-radius: .2rem; + box-shadow: var(--md-shadow-z1); + color: var(--md-admonition-fg-color); + display: flow-root; + font-size: .64rem; + margin: 1.5625em 0; + padding: 0 .6rem; + page-break-inside: avoid; + transition: box-shadow 125ms; +} + .md-typeset .blank > .admonition-title, .md-typeset .blank > summary { background-color: rgba(43, 155, 70, 0.1); diff --git a/mkdocs.yml b/mkdocs.yml index 0e33b4fdb..7af6eeb4a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -328,8 +328,7 @@ nav: - DEFINITION ATTRIBUTES: - Builders: - Overview: files/builders/overview.md - - Dumb Plex Builders: files/builders/plex.md - - Smart Plex Builders: files/builders/smart.md + - Plex Builders: files/builders/plex.md - TMDb Builders: files/builders/tmdb.md - TVDb Builders: files/builders/tvdb.md - IMDb Builders: files/builders/imdb.md