From 2ec14ff02348b7ada9fe8d6c6a7dcc46ee08b601 Mon Sep 17 00:00:00 2001 From: meisnate12 Date: Tue, 11 Oct 2022 17:02:49 -0400 Subject: [PATCH] [111] more wiki updates --- VERSION | 2 +- defaults/movie/franchise.yml | 39 +- defaults/show/franchise.yml | 40 +- docs/defaults/award/bafta.md | 2 +- docs/defaults/award/cannes.md | 2 +- docs/defaults/award/choice.md | 2 +- docs/defaults/award/emmy.md | 2 +- docs/defaults/award/golden.md | 2 +- docs/defaults/award/oscars.md | 2 +- docs/defaults/award/other.md | 2 +- docs/defaults/award/spirit.md | 2 +- docs/defaults/award/sundance.md | 2 +- docs/defaults/both/actor.md | 4 +- docs/defaults/both/audio_language.md | 4 +- docs/defaults/both/content_rating_cs.md | 4 +- docs/defaults/both/content_rating_uk.md | 4 +- docs/defaults/both/genre.md | 4 +- docs/defaults/both/resolution.md | 4 +- docs/defaults/both/resolution_standards.md | 4 +- docs/defaults/both/streaming.md | 4 +- docs/defaults/both/studio.md | 4 +- docs/defaults/both/subtitle_language.md | 4 +- docs/defaults/both/year.md | 4 +- docs/defaults/chart/anilist.md | 4 +- docs/defaults/chart/basic.md | 4 +- docs/defaults/chart/flixpatrol.md | 8 +- docs/defaults/chart/imdb.md | 2 +- docs/defaults/chart/myanimelist.md | 4 +- docs/defaults/chart/other.md | 2 +- docs/defaults/chart/tautulli.md | 6 +- docs/defaults/chart/tmdb.md | 4 +- docs/defaults/chart/trakt.md | 4 +- docs/defaults/movie/content_rating_us.md | 6 +- docs/defaults/movie/country.md | 4 +- docs/defaults/movie/decade.md | 4 +- docs/defaults/movie/director.md | 4 +- docs/defaults/movie/franchise.md | 146 ++++++- docs/defaults/movie/producer.md | 4 +- docs/defaults/movie/seasonal.md | 6 +- docs/defaults/movie/writer.md | 4 +- docs/defaults/show/content_rating_us.md | 4 +- docs/defaults/show/country.md | 6 +- docs/defaults/show/decade.md | 4 +- docs/defaults/show/network.md | 6 +- docs/defaults/variables.md | 62 +-- modules/meta.py | 428 +++++++++++---------- 46 files changed, 519 insertions(+), 350 deletions(-) diff --git a/VERSION b/VERSION index 0d139a78..8ae5d37f 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.17.3-develop110 +1.17.3-develop111 diff --git a/defaults/movie/franchise.yml b/defaults/movie/franchise.yml index 89337ea0..f2e2a89d 100644 --- a/defaults/movie/franchise.yml +++ b/defaults/movie/franchise.yml @@ -31,29 +31,48 @@ templates: default: collection_order: release minimum_items: 2 + name_mapping_<>: <> + movie_<>: <> + pre: "_" + order_<>: "" + sort: <> + sort_title: "!<><
><>>><>"
+      sort_title_<>: <>
+      radarr_add_missing_<>: <>
+      radarr_folder_<>: <>
+      radarr_tag_<>: <>
+      item_radarr_tag_<>: <>
+      collection_order_<>: <>
     optional:
-      - collection
+      - summary_<>
+      - name_<>
       - movie
-      - radarr_add_missing
       - name_mapping
       - sort_title
       - build_collection
+      - collection_mode
+      - collection_order
+      - collection_section
+      - radarr_add_missing
       - radarr_folder
       - radarr_tag
       - item_radarr_tag
+    summary: <>>>
+    name: <>>>
     cache_builders: 1
     minimum_items: <>
     tmdb_collection_details: <>
-    tmdb_movie: <>
-    name_mapping: <>
-    sort_title: <>
+    tmdb_movie: <>>>
+    name_mapping: <>>>
+    sort_title: <>>>
     build_collection: <>
     sync_mode: sync
-    collection_order: <>
-    radarr_add_missing: <>
-    radarr_folder: <>
-    radarr_tag: <>
-    item_radarr_tag: <>
+    collection_mode: <>
+    collection_order: <>>>
+    radarr_add_missing: <>>>
+    radarr_folder: <>>>
+    radarr_tag: <>>>
+    item_radarr_tag: <>>>
 
 dynamic_collections:
   TMDb Collections:
diff --git a/defaults/show/franchise.yml b/defaults/show/franchise.yml
index 1fb732ed..47f06919 100644
--- a/defaults/show/franchise.yml
+++ b/defaults/show/franchise.yml
@@ -33,25 +33,45 @@ templates:
     default:
       collection_order: release
       minimum_items: 2
+      name_mapping_<>: <>
+      pre: "_"
+      order_<>: ""
+      sort: <>
+      sort_title: "!<><
><>>><>"
+      sort_title_<>: <>
+      sonarr_add_missing_<>: <>
+      sonarr_folder_<>: <>
+      sonarr_tag_<>: <>
+      item_sonarr_tag_<>: <>
+      collection_order_<>: <>
     optional:
+      - summary_<>
+      - name_<>
+      - name_mapping
+      - sort_title
+      - build_collection
+      - collection_mode
+      - collection_order
+      - collection_section
       - sonarr_add_missing
       - sonarr_folder
       - sonarr_tag
       - item_sonarr_tag
-      - name_mapping
-      - sort_title
-      - build_collection
+    summary: <>>>
+    name: <>>>
     minimum_items: <>
     tmdb_show: <>
     url_poster: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager-Images/master/franchise/<>.jpg
-    name_mapping: <>
-    sort_title: <>
+    name_mapping: <>>>
+    sort_title: <>>>
+    build_collection: <>
     sync_mode: sync
-    collection_order: <>
-    sonarr_add_missing: <>
-    sonarr_folder: <>
-    sonarr_tag: <>
-    item_sonarr_tag: <>
+    collection_mode: <>
+    collection_order: <>>>
+    sonarr_add_missing: <>>>
+    sonarr_folder: <>>>
+    sonarr_tag: <>>>
+    item_sonarr_tag: <>>>
 
 dynamic_collections:
   Show Franchise Collections:
diff --git a/docs/defaults/award/bafta.md b/docs/defaults/award/bafta.md
index bd9c1f10..a5b0881a 100644
--- a/docs/defaults/award/bafta.md
+++ b/docs/defaults/award/bafta.md
@@ -38,7 +38,7 @@ All [Shared Variables](../variables) are available as well as the additional Var
 |:---------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | `use_year_collections`     | **Description:** Turn the individual year collections off.
**Values:** `false` to turn of the collections | | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
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/award/cannes.md b/docs/defaults/award/cannes.md index e831f922..ddee4bcc 100644 --- a/docs/defaults/award/cannes.md +++ b/docs/defaults/award/cannes.md @@ -38,7 +38,7 @@ All [Shared Variables](../variables) are available as well as the additional Var |:---------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `use_year_collections` | **Description:** Turn the individual year collections off
**Values:** `false` to turn of the collections | | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
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/award/choice.md b/docs/defaults/award/choice.md index 5fffdfe0..566635ec 100644 --- a/docs/defaults/award/choice.md +++ b/docs/defaults/award/choice.md @@ -40,7 +40,7 @@ All [Shared Variables](../variables) are available as well as the additional Var |:---------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `use_year_collections` | **Description:** Turn the individual year collections off
**Values:** `false` to turn of the collections | | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
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/award/emmy.md b/docs/defaults/award/emmy.md index 9e84b15b..b3793a2c 100644 --- a/docs/defaults/award/emmy.md +++ b/docs/defaults/award/emmy.md @@ -38,7 +38,7 @@ All [Shared Variables](../variables) are available as well as the additional Var |:---------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `use_year_collections` | **Description:** Turn the individual year collections off
**Values:** `false` to turn of the collections | | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
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/award/golden.md b/docs/defaults/award/golden.md index 976df380..849a1c32 100644 --- a/docs/defaults/award/golden.md +++ b/docs/defaults/award/golden.md @@ -39,7 +39,7 @@ All [Shared Variables](../variables) are available as well as the additional Var |:---------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `use_year_collections` | **Description:** Turn the individual year collections off
**Values:** `false` to turn of the collections | | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
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/award/oscars.md b/docs/defaults/award/oscars.md index 8ca0a154..d5b7def8 100644 --- a/docs/defaults/award/oscars.md +++ b/docs/defaults/award/oscars.md @@ -37,7 +37,7 @@ All [Shared Variables](../variables) are available as well as the additional Var |:---------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `use_year_collections` | **Description:** Turn the individual year collections off
**Values:** `false` to turn of the collections | | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
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/award/other.md b/docs/defaults/award/other.md index 28a46efb..6f7062f3 100644 --- a/docs/defaults/award/other.md +++ b/docs/defaults/award/other.md @@ -39,7 +39,7 @@ All [Shared Variables](../variables) are available as well as the additional Var | Variable | Description & Values | |:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| The below shows an example config.yml with template_variables set away from their defaults: diff --git a/docs/defaults/award/spirit.md b/docs/defaults/award/spirit.md index ee32c545..128c0aa3 100644 --- a/docs/defaults/award/spirit.md +++ b/docs/defaults/award/spirit.md @@ -37,7 +37,7 @@ All [Shared Variables](../variables) are available as well as the additional Var |:---------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `use_year_collections` | **Description:** Turn the individual year collections off
**Values:** `false` to turn of the collections | | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
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/award/sundance.md b/docs/defaults/award/sundance.md index 0379e7b8..3ee3dd3c 100644 --- a/docs/defaults/award/sundance.md +++ b/docs/defaults/award/sundance.md @@ -38,7 +38,7 @@ All [Shared Variables](../variables) are available as well as the additional Var |:---------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `use_year_collections` | **Description:** Turn the individual year collections off
**Values:** `false` to turn of the collections | | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
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/both/actor.md b/docs/defaults/both/actor.md index 55d9a791..bb34013a 100644 --- a/docs/defaults/both/actor.md +++ b/docs/defaults/both/actor.md @@ -47,9 +47,9 @@ All [Shared Variables](../variables) are available as well as the additional Var | `sep_style` | **Description:** Separator Style.
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | | `style ` | **Description:** Controls the visual theme of the collections created
Values:
bwBlack & White Theme
rainierRainier Theme
| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | -| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's Collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | -| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | +| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | | `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
| | `exclude` | **Description:** Exclude these Actors from creating a Dynamic Collection.
**Values:** List of Actor Names | | `actor_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<>`
**Values:** Any string with `<>` in it. | diff --git a/docs/defaults/both/audio_language.md b/docs/defaults/both/audio_language.md index fa95be96..e00b5b73 100644 --- a/docs/defaults/both/audio_language.md +++ b/docs/defaults/both/audio_language.md @@ -41,9 +41,9 @@ All [Shared Variables](../variables) are available as well as the additional Var | `use_separator` | **Description:** Turn the separator collection off.
**Values:** `false` to turn of the collection | | `sep_style` | **Description:** Separator Style.
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | -| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's Collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | -| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | +| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | | `include` | **Description:** Overrides the [default include list](#default-include)
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_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) | | `append_include` | **Description:** Appends to the [default include list](#default-include)
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) | diff --git a/docs/defaults/both/content_rating_cs.md b/docs/defaults/both/content_rating_cs.md index f0af43bf..c31cc184 100644 --- a/docs/defaults/both/content_rating_cs.md +++ b/docs/defaults/both/content_rating_cs.md @@ -45,9 +45,9 @@ All [Shared Variables](../variables) are available as well as the additional Var | `use_separator` | **Description:** Turn the separator collection off.
**Values:** `false` to turn of the collection | | `sep_style` | **Description:** Separator Style.
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | -| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's Collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | -| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | +| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | | `include` | **Description:** Overrides the [default include list](#default-include).
**Values:** List of Content Ratings found in your library | | `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.
**Values:** List of Content Ratings found in your library | | `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). 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 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 af9fd32e..f1690906 100644 --- a/docs/defaults/both/content_rating_uk.md +++ b/docs/defaults/both/content_rating_uk.md @@ -43,9 +43,9 @@ All [Shared Variables](../variables) are available as well as the additional Var | `use_separator` | **Description:** Turn the separator collection off.
**Values:** `false` to turn of the collection | | `sep_style` | **Description:** Separator Style.
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | -| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's Collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | -| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | +| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | | `include` | **Description:** Overrides the [default include list](#default-include).
**Values:** List of Content Ratings found in your library | | `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.
**Values:** List of Content Ratings found in your library | | `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). 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 Content Ratings found in your library | diff --git a/docs/defaults/both/genre.md b/docs/defaults/both/genre.md index f4a0d5e1..6ce9ccc0 100644 --- a/docs/defaults/both/genre.md +++ b/docs/defaults/both/genre.md @@ -42,9 +42,9 @@ All [Shared Variables](../variables) are available as well as the additional Var | `use_separator` | **Description:** Turn the separator collection off.
**Values:** `false` to turn of the collection | | `sep_style` | **Description:** Separator Style.
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | -| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's Collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | -| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | +| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | | `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-addons). 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-addons).
**Values:** Dictionary List of Genres found in your library | diff --git a/docs/defaults/both/resolution.md b/docs/defaults/both/resolution.md index 36b4327b..171c174f 100644 --- a/docs/defaults/both/resolution.md +++ b/docs/defaults/both/resolution.md @@ -42,9 +42,9 @@ All [Shared Variables](../variables) are available as well as the additional Var | `use_separator` | **Description:** Turn the separator collection off.
**Values:** `false` to turn of the collection | | `sep_style` | **Description:** Separator Style.
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | -| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's Collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | -| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | +| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | | `exclude` | **Description:** Exclude these Resolutions from creating a Dynamic Collection.
**Values:** List of Resolutions found in your library | | `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). 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 Resolutions found in your library | | `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Resolutions found in your library | diff --git a/docs/defaults/both/resolution_standards.md b/docs/defaults/both/resolution_standards.md index 891c23b6..70e7ebfa 100644 --- a/docs/defaults/both/resolution_standards.md +++ b/docs/defaults/both/resolution_standards.md @@ -45,9 +45,9 @@ All [Shared Variables](../variables) are available as well as the additional Var | `use_separator` | **Description:** Turn the separator collection off.
**Values:** `false` to turn of the collection | | `sep_style` | **Description:** Separator Style.
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | -| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's Collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | -| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | +| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | | `include` | **Description:** Overrides the [default include list](#default-include).
**Values:** Any Resolutions found in your library | | `exclude` | **Description:** Exclude these Resolutions from creating a Dynamic Collection.
**Values:** List of Resolutions found in your library | | `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). 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 Resolutions found in your library | diff --git a/docs/defaults/both/streaming.md b/docs/defaults/both/streaming.md index 79240cd7..8fdc68bc 100644 --- a/docs/defaults/both/streaming.md +++ b/docs/defaults/both/streaming.md @@ -52,9 +52,9 @@ All [Shared Variables](../variables) are available as well as the additional Var | `use_separator` | **Description:** Turn the separator collection off.
**Values:** `false` to turn of the collection | | `sep_style` | **Description:** Separator Style.
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | -| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's Collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | -| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | +| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | | `exclude` | **Description:** Exclude these Streaming Services from creating a Dynamic Collection.
**Values:** List of Streaming Service Keys | | `streaming_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | | `streaming_summary` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s streaming on <>.`
**Values:** Any string. | diff --git a/docs/defaults/both/studio.md b/docs/defaults/both/studio.md index f52bf773..90ebf5f0 100644 --- a/docs/defaults/both/studio.md +++ b/docs/defaults/both/studio.md @@ -42,9 +42,9 @@ All [Shared Variables](../variables) are available as well as the additional Var | `use_separator` | **Description:** Turn the separator collection off.
**Values:** `false` to turn of the collection | | `sep_style` | **Description:** Separator Style.
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | -| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's Collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | -| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | +| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | | `include` | **Description:** Overrides the [default include list](#default-include).
**Values:** List of Studios found in your library | | `exclude` | **Description:** Exclude these Studios from creating a Dynamic Collection.
**Values:** List of Studios found in your library | | `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). 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 Studios found in your library | diff --git a/docs/defaults/both/subtitle_language.md b/docs/defaults/both/subtitle_language.md index 96a06a57..454152f3 100644 --- a/docs/defaults/both/subtitle_language.md +++ b/docs/defaults/both/subtitle_language.md @@ -41,9 +41,9 @@ All [Shared Variables](../variables) are available as well as the additional Var | `use_separator` | **Description:** Turn the separator collection off.
**Values:** `false` to turn of the collection | | `sep_style` | **Description:** Separator Style.
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | -| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's Collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | -| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | +| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | | `include` | **Description:** Overrides the [default include list](#default-include)
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) | | `exclude` | **Description:** Exclude these Subtitle Languages from creating a Dynamic Collection.
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) | | `append_include` | **Description:** Appends to the [default include list](#default-include)
**Values:** List of [ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) | diff --git a/docs/defaults/both/year.md b/docs/defaults/both/year.md index 37d14f0d..eedcdfd7 100644 --- a/docs/defaults/both/year.md +++ b/docs/defaults/both/year.md @@ -40,9 +40,9 @@ All [Shared Variables](../variables) are available as well as the additional Var | `use_separator` | **Description:** Turn the separator collection off.
**Values:** `false` to turn of the collection | | `sep_style` | **Description:** Separator Style.
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `10`
**Values:** Number Greater then 0 | -| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's Collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | -| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | +| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | | `data` | **Description:** Replaces the `data` dynamic collection value.
AttributeDescription & Values
startingControls the starting year for collections
Default: current_year-5
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 e3bf4f86..63ddb715 100644 --- a/docs/defaults/chart/anilist.md +++ b/docs/defaults/chart/anilist.md @@ -40,9 +40,9 @@ All [Shared Variables](../variables) are available as well as the additional Var | Variable | Description & Values | |:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | **Description:** Changes the number of items in a collection for all collections in a Defaults file.
**Default:** `100`
**Values:** Number greater then 0 | -| `limit_<>` | **Description:** Changes the number of items in a collection of the specified key's Collection.
**Default:** `limit`
**Values:** Number greater then 0 | +| `limit_<>` | **Description:** Changes the number of items in a collection of the specified key's collection.
**Default:** `limit`
**Values:** Number greater then 0 | | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/chart/basic.md b/docs/defaults/chart/basic.md index b8647baf..6ff7f11e 100644 --- a/docs/defaults/chart/basic.md +++ b/docs/defaults/chart/basic.md @@ -38,9 +38,9 @@ All [Shared Variables](../variables) are available as well as the additional Var | Variable | Description & Values | |:----------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | **Description:** Changes the Smart Filter Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | -| `limit_<>` | **Description:** Changes the Smart Filter Limit of the specified key's Collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>` | **Description:** Changes the Smart Filter Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | -| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | +| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | | `in_the_last_<>` | **Description:** Changes how far back the Smart Filter looks.
**Default:**
`released``90`
`episodes``7`
**Values:** Number Greater then 0 | The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/chart/flixpatrol.md b/docs/defaults/chart/flixpatrol.md index 512d8149..1e7b7e8e 100644 --- a/docs/defaults/chart/flixpatrol.md +++ b/docs/defaults/chart/flixpatrol.md @@ -42,13 +42,13 @@ All [Shared Variables](../variables) are available as well as the additional Var | Variable | Description & Values | |:---------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `10`
**Values:** Number Greater then 0 | -| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's Collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `location` | **Description:** Changes the Builder Location for all collections in a Defaults file.
**Default:** `world`
**Values:** [`location` Attribute Options](../../metadata/builders/flixpatrol.md#top-platform-attributes) | -| `location_<>` | **Description:** Changes the Builder Location of the specified key's Collection.
**Default:** `location`
**Values:** [`location` Attribute Options](../../metadata/builders/flixpatrol.md#top-platform-attributes) | +| `location_<>` | **Description:** Changes the Builder Location of the specified key's collection.
**Default:** `location`
**Values:** [`location` Attribute Options](../../metadata/builders/flixpatrol.md#top-platform-attributes) | | `time_window` | **Description:** Changes the Builder Time Window for all collections in a Defaults file.
**Default:** `last_week`
**Values:** [`time_window` Attribute Options](../../metadata/builders/flixpatrol.md#top-platform-attributes) | -| `time_window_<>` | **Description:** Changes the Builder Time Window of the specified key's Collection.
**Default:** `time_window`
**Values:** [`time_window` Attribute Options](../../metadata/builders/flixpatrol.md#top-platform-attributes) | +| `time_window_<>` | **Description:** Changes the Builder Time Window of the specified key's collection.
**Default:** `time_window`
**Values:** [`time_window` Attribute Options](../../metadata/builders/flixpatrol.md#top-platform-attributes) | | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/chart/imdb.md b/docs/defaults/chart/imdb.md index eb543954..d3a51152 100644 --- a/docs/defaults/chart/imdb.md +++ b/docs/defaults/chart/imdb.md @@ -39,7 +39,7 @@ All [Shared Variables](../variables) are available as well as the additional Var | Variable | Description & Values | |:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/chart/myanimelist.md b/docs/defaults/chart/myanimelist.md index 30666fb8..a92f31c8 100644 --- a/docs/defaults/chart/myanimelist.md +++ b/docs/defaults/chart/myanimelist.md @@ -41,9 +41,9 @@ All [Shared Variables](../variables) are available as well as the additional Var | Variable | Description & Values | |:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `100`
**Values:** Number Greater then 0 | -| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's Collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/chart/other.md b/docs/defaults/chart/other.md index 4b725403..7ec32aea 100644 --- a/docs/defaults/chart/other.md +++ b/docs/defaults/chart/other.md @@ -41,7 +41,7 @@ All [Shared Variables](../variables) are available as well as the additional Var |:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit_anidb` | **Description:** Changes the Builder Limit of the AniDB Popular Collection.
**Default:** `30`
**Values:** Number Greater then 0 | | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/chart/tautulli.md b/docs/defaults/chart/tautulli.md index 6157c849..aa63c69c 100644 --- a/docs/defaults/chart/tautulli.md +++ b/docs/defaults/chart/tautulli.md @@ -40,11 +40,11 @@ All [Shared Variables](../variables) are available as well as the additional Var | Variable | Description & Values | |:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `list_days` | **Description:** Changes the `list_days` attribute of the builder for all collections in a Defaults file.
**Values:** Number greater then 0 | -| `list_days_<>` | **Description:** Changes the `list_days` attribute of the builder of the specified key's Collection.
**Values:** Number greater then 0 | +| `list_days_<>` | **Description:** Changes the `list_days` attribute of the builder of the specified key's collection.
**Values:** Number greater then 0 | | `list_size` | **Description:** Changes the `list_size` attribute of the builder for all collections in a Defaults file.
**Values:** Number greater then 0 | -| `list_size_<>` | **Description:** Changes the `list_size` attribute of the builder of the specified key's Collection.
**Values:** Number greater then 0 | +| `list_size_<>` | **Description:** Changes the `list_size` attribute of the builder of the specified key's collection.
**Values:** Number greater then 0 | | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/chart/tmdb.md b/docs/defaults/chart/tmdb.md index 3d72819c..50b45a9d 100644 --- a/docs/defaults/chart/tmdb.md +++ b/docs/defaults/chart/tmdb.md @@ -41,9 +41,9 @@ All [Shared Variables](../variables) are available as well as the additional Var | Variable | Description & Values | |:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `100`
**Values:** Number Greater then 0 | -| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's Collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/chart/trakt.md b/docs/defaults/chart/trakt.md index 7359cda9..bdd1bc5b 100644 --- a/docs/defaults/chart/trakt.md +++ b/docs/defaults/chart/trakt.md @@ -41,9 +41,9 @@ All [Shared Variables](../variables) are available as well as the additional Var | Variable | Description & Values | |:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `100`
**Values:** Number Greater then 0 | -| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's Collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Default:** `custom`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| The below is an example config.yml extract with some Template Variables added in to change how the file works. diff --git a/docs/defaults/movie/content_rating_us.md b/docs/defaults/movie/content_rating_us.md index 3087d7cc..040b8f26 100644 --- a/docs/defaults/movie/content_rating_us.md +++ b/docs/defaults/movie/content_rating_us.md @@ -40,11 +40,11 @@ All [Shared Variables](../variables) are available as well as the additional Var | `use_separator` | **Description:** Turn the separator collection off.
**Values:** `false` to turn of the collection | | `sep_style` | **Description:** Separator Style.
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | -| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's Collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | -| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | +| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | | `include` | **Description:** Overrides the [default include list](#default-include).
**Values:** List of Content Ratings found in your library | -| `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.
**Values:** List of of Content Ratings found in your library | +| `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.
**Values:** List of Content Ratings found in your library | | `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). 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 Content Ratings found in your library | | `append_include` | **Description:** Appends to the [default include list](#default-include).
**Values:** List of Content Ratings found in your library | | `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Content Ratings found in your library | diff --git a/docs/defaults/movie/country.md b/docs/defaults/movie/country.md index 451eb450..d81d0881 100644 --- a/docs/defaults/movie/country.md +++ b/docs/defaults/movie/country.md @@ -57,9 +57,9 @@ All [Shared Variables](../variables) are available as well as the additional Var | `sep_style` | **Description:** Separator Style.
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | | `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 then 0 | -| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's Collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | -| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | +| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | | `include` | **Description:** Overrides the [default include list](#default-include).
**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-addons). 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/decade.md b/docs/defaults/movie/decade.md index 8d47436b..8c63775c 100644 --- a/docs/defaults/movie/decade.md +++ b/docs/defaults/movie/decade.md @@ -37,9 +37,9 @@ All [Shared Variables](../variables) are available as well as the additional Var | `use_separator` | **Description:** Turn the separator collection off.
**Values:** `false` to turn of the collection | | `sep_style` | **Description:** Separator Style.
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `100`
**Values:** Number Greater then 0 | -| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's Collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `critic_rating.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | -| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | +| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | | `exclude` | **Description:** Exclude these Decades from creating a Dynamic Collection.
**Values:** List of Decades found in your library | | `decade_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Best of <>`
**Values:** Any string with `<>` in it. | | `decade_summary` | **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 b69d444d..cd0363ce 100644 --- a/docs/defaults/movie/director.md +++ b/docs/defaults/movie/director.md @@ -44,9 +44,9 @@ All [Shared Variables](../variables) are available as well as the additional Var | `sep_style` | **Description:** Separator Style.
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | | `style ` | **Description:** Controls the visual theme of the collections created
Values:
bwBlack & White Theme
rainierRainier Theme
| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | -| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's Collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | -| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | +| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | | `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
| | `exclude` | **Description:** Exclude these Directors from creating a Dynamic Collection.
**Values:** List of Director Names | | `director_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> (Director)`
**Values:** Any string with `<>` in it. | diff --git a/docs/defaults/movie/franchise.md b/docs/defaults/movie/franchise.md index 80e7a457..72450c7a 100644 --- a/docs/defaults/movie/franchise.md +++ b/docs/defaults/movie/franchise.md @@ -1,14 +1,23 @@ -# Franchise Default Metadata File +# Franchise Collections -The `franchise` Metadata File is used to create collections based on popular Movie franchises, and can be used as a replacement to the TMDb Collections that Plex creates out-of-the-box. +The `franchise` Default Metadata File is used to create collections based on popular Movie franchises, and can be used as a replacement to the TMDb Collections that Plex creates out-of-the-box. Unlike most Default Metadata Files, Franchise works by placing collections inline with the main library items if your library allows it. For example, the "Iron Man" franchise collection will appear next to the "Iron Man" movies within your library. -Example Collections Created: +**This file works with Movie Libraries, but has a TV Library [Counterpart](../show/decade).** ![](../images/moviefranchise.png) +## Collections + +| Collection | Key | Description | +|:-------------------------------------------------|:-------------------------------------------------:|:-------------------------------------------------------| +| `<>`
**Example:** `Iron Man` | `<>`
**Example:** `131292` | Collection of Movies found in this Collection on TMDb. | + +## Config + The below YAML in your config.yml will create the collections: + ```yaml libraries: Movies: @@ -16,13 +25,42 @@ libraries: - pmm: franchise ``` - ## Template Variables -Template Variables can be used to manipulate the file from the default settings which are provided. -Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings. +Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy. + +Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored. + +All [Shared Variables](../variables) are available as well as the additional Variables below which can be used to customize the file. + +| Variable | Description & Values | +|:-----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `name_<>` | **Description:** Changes the name of the specified key's collection.
**Values:** New Collection Name | +| `summary_<>` | **Description:** Changes the summary of the specified key's collection.
**Values:** New Collection Summary | +| `collection_section` | **Description:** Adds a sort title with this collection sections.
**Values:** Any number | +| `order_<>` | **Description:** Controls the sort order of the collections in their collection section.
**Values:** Any number | +| `collection_mode` | **Description:** Controls the collection mode of all collections in this file.
**Values:**
`default`Library default
`hide`Hide Collection
`hide_items`Hide Items in this Collection
`show_items`Show this Collection and its Items
| +| `minimum_items` | **Description:** Controls the minimum items that the collection must have to be created.
**Default:** `2`
**Values:** Any number | +| `movie_<>` | **Description:** Adds the TMDb Movie IDs given to the specified key's collection. Overrides the [default movie](#default-movie) for that movie if used.
**Values:** List of TMDb Movie IDs | +| `name_mapping_<>` | **Description:** Sets the name mapping value for using assets of the specified key's collection.Overrides the [default name_mapping](#default-name_mapping) for that movie if used.
**Values:** Any String | +| `sort_title` | **Description:** Sets the sort title for all collections. Use `<>` to use the collection name. **Example:** `"!02_<>"`
**Values:** Any String with `<>` | +| `sort_title_<>` | **Description:** Sets the sort title of the specified key's collection.
**Default:** `sort_title`
**Values:** Any String | +| `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 | +| `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](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's collection.
**Default:** `collection_order`
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `title_override` | **Description:** Overrides the [default title_override dictionary](#default-title_override).
**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-addons). 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 | +| `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).
**Values:** Dictionary List of TMDB Collection IDs | +| `radarr_add_missing` | **Description:** Override Radarr `add_missing` attribute for all collections in a Defaults file.
**Values:** `true` or `false` | +| `radarr_add_missing_<>`1 | **Description:** Override Radarr `add_missing` attribute of the specified key's collection.
**Default:** `radarr_add_missing`
**Values:** `true` or `false` | +| `radarr_folder` | **Description:** Override Radarr `root_folder_path` attribute for all collections in a Defaults file.
**Values:** Folder Path | +| `radarr_folder_<>`1 | **Description:** Override Radarr `root_folder_path` attribute of the specified key's collection.
**Default:** `radarr_folder`
**Values:** Folder Path | +| `radarr_tag` | **Description:** Override Radarr `tag` attribute for all collections in a Defaults file.
**Values:** List or comma-separated string of tags | +| `radarr_tag_<>`1 | **Description:** Override Radarr `tag` attribute of the specified key's collection.
**Default:** `radarr_tag`
**Values:** List or comma-separated string of tags | +| `item_radarr_tag` | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr for all collections in a Defaults file.
**Values:** List or comma-separated string of tags | +| `item_radarr_tag_<>`1 | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr of the specified key's collection.
**Default:** `item_radarr_tag`
**Values:** List or comma-separated string of tags | -All [Shared Variables](../variables) are available The below is an example config.yml extract with some Template Variables added in to change how the file works. @@ -33,11 +71,97 @@ libraries: - pmm: franchise template_variables: collection_order: alpha - sort_title: "!10_<>" + collection_section: "02" build_collection: false + movie_105995: 336560 radarr_add_missing: true - radarr_folder: /mnt/local/Media/Movies - radarr_tag: <> - item_radarr_tag: <> ``` +## Default `addons` + +```yaml +addons: + 8091: # Alien + - 135416 # Prometheus + 2806: # American Pie + - 298820 # American Pie (Spin-off) + 87800: # Appleseed + - 371526 # Appleseed XIII + 477208: # DC Super Hero Girls + - 557495 # LEGO DC Super Hero Girls + 86066: # Despicable Me + - 544669 # Minions + 9485: # The Fast and the Furious + - 688042 # Hobbs & Shaw + 86115: # Garfield + - 373918 # Garfield CGI + 91361: # Halloween + - 126209 # Halloween (Rob Zombie Series) + 9818: # Mortal Kombat + - 931431 # Mortal Kombat + 495: # Shaft + - 608103 # Shaft (Reboot) + 1582: # Teenage Mutant Ninja Turtles + - 401562 # Teenage Mutant Ninja Turtles (Remake) + 111751: # Texas Chainsaw Massacre + - 425175 # Texas Chainsaw (Reboot) + 2467: # Tomb Raider + - 621142 # Tomb Raider (Reboot) + 748: # X-Men + - 453993 # The Wolverine +``` + +## Default `title_override` + +```yaml +title_override: + 10: "Star Wars: Skywalker Saga" + 535313: Godzilla (MonsterVerse) + 535790: Godzilla (Anime) +``` + +## Default `movie` + +```yaml +105995: 336560 # Anaconda: Lake Placid vs. Anaconda +176097: 14177 # Barbershop: Beauty Shop +448150: 567604 # Deadpool: Once Upon a Deadpool +9735: 6466, 222724 # Friday the 13th: Freddy vs. Jason, Crystal Lake Memories: The Complete History of Friday the 13th +386382: 326359, 460793 # Frozen: Frozen Fever, Olaf's Frozen Adventure +2980: 43074 # Ghostbusters: Ghostbusters +374509: 18983 # Godzilla (Showa): Godzilla, King of the Monsters! +374511: 39256 # Godzilla (Heisei): Godzilla 1985 +535313: 293167 # Godzilla: Kong: Skull Island +9743: 11454 # The Hannibal Lecter: Manhunter +8354: 79218, 717095, 387893 # Ice Age: Ice Age: A Mammoth Christmas, Ice Age Continental Drift: Scrat Got Your Tongue, Ice Age: The Great Egg-Scapade +70068: 658009, 643413, 450001, 751391, 44249, 182127, 44865 # Ip Man: Ip Man: Kung Fu Master, Ip Man and Four Kings, Master Z: Ip Man Legacy, Young Ip Man: Crisis Time, The Legend Is Born: Ip Man, Ip Man: The Final Fight, The Grandmaster +328: 630322 # Jurassic Park: Battle at Big Rock +8580: 38575 # The Karate Kid: The Karate Kid +14740: 161143, 25472, 270946 # Madagascar: Madly Madagascar, Merry Madagascar, Penguins of Madagascar +9818: 664767 # Mortal Kombat: Mortal Kombat Legends: Scorpion's Revenge +171732: 39410 # Rebirth of Mothra: Mothra +8581: 6466, 23437 # A Nightmare on Elm Street: Freddy vs. Jason, A Nightmare on Elm Street +627517: 13155, 68728 # Oz: Return to Oz, Oz the Great and Powerful +10789: 157433 # Pet Sematary: Pet Sematary +708816: 305470, 306264 # Power Rangers: Power Rangers, Power Rangers Super Megaforce: The Legendary Battle +190435: 687354, 11667 # Street Fighter (Animated): Street Fighter Assassin's Fist, Street Fighter +1582: 1273 # Teenage Mutant Ninja Turtles: TMNT +10194: 130925 # Toy Story: Partysaurus Rex +63043: 73362 # TRON: TRON: The Next Day +748: 567604 # X-Men: Once Upon a Deadpool +``` + +## Default `name_mapping` + +```yaml +1565: 28 Days-Weeks Later +508334: Angels in the +115838: Escape From +386534: Has Fallen +87359: Mission Impossible +133352: Resident Evil Biohazard +115575: Star Trek Alternate Reality +115570: Star Trek The Next Generation +151: Star Trek The Original Series +10: Star Wars Skywalker Saga +``` \ No newline at end of file diff --git a/docs/defaults/movie/producer.md b/docs/defaults/movie/producer.md index 6bc789bf..deaaa24b 100644 --- a/docs/defaults/movie/producer.md +++ b/docs/defaults/movie/producer.md @@ -44,9 +44,9 @@ All [Shared Variables](../variables) are available as well as the additional Var | `sep_style` | **Description:** Separator Style.
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | | `style ` | **Description:** Controls the visual theme of the collections created
Values:
bwBlack & White Theme
rainierRainier Theme
| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | -| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's Collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | -| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | +| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | | `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
| | `exclude` | **Description:** Exclude these Producers from creating a Dynamic Collection.
**Values:** List of Producer Names | | `producer_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> (Producer)`
**Values:** Any string with `<>` in it. | diff --git a/docs/defaults/movie/seasonal.md b/docs/defaults/movie/seasonal.md index f0cbda71..f2dccdc0 100644 --- a/docs/defaults/movie/seasonal.md +++ b/docs/defaults/movie/seasonal.md @@ -48,10 +48,10 @@ All [Shared Variables](../variables) are available as well as the additional Var | `use_separator` | **Description:** Turn the separator collection off.
**Values:** `true` to turn on the collection | | `sep_style` | **Description:** Separator Style.
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | -| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's Collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | -| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | -| `schedule_<>` | **Description:** Changes the Schedule of the specified key's Collection.
**Default:**
🎊 New Year's Day Moviesrange(12/26-01/04)
💘 Valentine's Day Moviesrange(02/01-02/29)
☘ St. Patrick's Day Moviesrange(03/01-03/18)
🐰 Easter Moviesrange(03/20-04/30)
🤱 Mother's Day Moviesrange(05/05-05/10)
🪖 Memorial Day Moviesrange(5/18-6/7)
👨 Father's Day Moviesrange(06/15-06/20)
🎆 Independence Day Moviesrange(06/23-07/11)
⚒ Labor Day Moviesrange(09/01-09/10)
🎃 Halloween Moviesrange(10/01-10/31)
🦃 Thanksgiving Moviesrange(11/01-11/30)
🎅 Christmas Moviesrange(12/01-12/31)

**Values:** [Any Schedule Option](../../metadata/details/schedule) | +| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | +| `schedule_<>` | **Description:** Changes the Schedule of the specified key's collection.
**Default:**
🎊 New Year's Day Moviesrange(12/26-01/04)
💘 Valentine's Day Moviesrange(02/01-02/29)
☘ St. Patrick's Day Moviesrange(03/01-03/18)
🐰 Easter Moviesrange(03/20-04/30)
🤱 Mother's Day Moviesrange(05/05-05/10)
🪖 Memorial Day Moviesrange(5/18-6/7)
👨 Father's Day Moviesrange(06/15-06/20)
🎆 Independence Day Moviesrange(06/23-07/11)
⚒ Labor Day Moviesrange(09/01-09/10)
🎃 Halloween Moviesrange(10/01-10/31)
🦃 Thanksgiving Moviesrange(11/01-11/30)
🎅 Christmas Moviesrange(12/01-12/31)

**Values:** [Any Schedule Option](../../metadata/details/schedule) | | `exclude` | **Description:** Exclude these Seasons from creating a Dynamic Collection.
**Values:** List of Seasons Keys | | `seasonal_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> <>s`
**Values:** Any string with `<>` in it. | | `seasonal_summary` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `A collection of <> <>s that may relate to the season.`
**Values:** Any string. | diff --git a/docs/defaults/movie/writer.md b/docs/defaults/movie/writer.md index 03d827ca..4a3944cb 100644 --- a/docs/defaults/movie/writer.md +++ b/docs/defaults/movie/writer.md @@ -44,9 +44,9 @@ All [Shared Variables](../variables) are available as well as the additional Var | `sep_style` | **Description:** Separator Style.
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | | `style ` | **Description:** Controls the visual theme of the collections created
Values:
bwBlack & White Theme
rainierRainier Theme
| | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | -| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's Collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | -| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | +| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | | `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
| | `exclude` | **Description:** Exclude these Writers from creating a Dynamic Collection.
**Values:** List of Writer Names | | `writer_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<> (Writer)`
**Values:** Any string with `<>` in it. | diff --git a/docs/defaults/show/content_rating_us.md b/docs/defaults/show/content_rating_us.md index 8fb758ac..1153c123 100644 --- a/docs/defaults/show/content_rating_us.md +++ b/docs/defaults/show/content_rating_us.md @@ -40,9 +40,9 @@ All [Shared Variables](../variables) are available as well as the additional Var | `use_separator` | **Description:** Turn the separator collection off.
**Values:** `false` to turn of the collection | | `sep_style` | **Description:** Separator Style.
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | -| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's Collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | -| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | +| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | | `include` | **Description:** Overrides the [default include list](#default-include).
**Values:** List of Content Ratings found in your library | | `exclude` | **Description:** Exclude these Content Ratings from creating a Dynamic Collection.
**Values:** List of Content Ratings found in your library | | `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). 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 Content Ratings found in your library | diff --git a/docs/defaults/show/country.md b/docs/defaults/show/country.md index cda2a7ec..ddbbf153 100644 --- a/docs/defaults/show/country.md +++ b/docs/defaults/show/country.md @@ -45,14 +45,14 @@ All [Shared Variables](../variables) are available as well as the additional Var | `sep_style` | **Description:** Separator Style.
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | | `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 then 0 | -| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's Collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | -| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | +| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | | `include` | **Description:** Overrides the [default include list](#default-include).
**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) | | `exclude` | **Description:** Exclude these Countries from creating a Dynamic Collection.
**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) | | `addons` | **Description:** 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 [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-include).
**Values:** List of [2 digit ISO 3166-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) | -| `key_name_override` | **Description:** Overrides the [default key_name_override dictionary](#default-key_name_override).`key_name` by `key` | +| `key_name_override` | **Description:** Overrides the [default key_name_override dictionary](#default-key_name_override).
**Values:** Dictionary with `key: new_key_name` entries | | `country_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `<>`
**Values:** Any string with `<>` in it. | | `country_other_name` | **Description:** Changes the Other Collection name.
**Default:** `Other Countries`
**Values:** Any string. | | `country_summary` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `<>s filmed in <>.`
**Values:** Any string. | diff --git a/docs/defaults/show/decade.md b/docs/defaults/show/decade.md index cffa1b2e..4882cde0 100644 --- a/docs/defaults/show/decade.md +++ b/docs/defaults/show/decade.md @@ -37,9 +37,9 @@ All [Shared Variables](../variables) are available as well as the additional Var | `use_separator` | **Description:** Turn the separator collection off.
**Values:** `false` to turn of the collection | | `sep_style` | **Description:** Separator Style.
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Default:** `100`
**Values:** Number Greater then 0 | -| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's Collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `critic_rating.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | -| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | +| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | | `exclude` | **Description:** Exclude these Decades from creating a Dynamic Collection.
**Values:** List of Decades found in your library | | `decade_name` | **Description:** Changes the title format of the Dynamic Collections.
**Default:** `Best of <>`
**Values:** Any string with `<>` in it. | | `decade_summary` | **Description:** Changes the summary format of the Dynamic Collections.
**Default:** `Top <> <>s of the <>.`
**Values:** Any string. | diff --git a/docs/defaults/show/network.md b/docs/defaults/show/network.md index a11550a7..2b8d5096 100644 --- a/docs/defaults/show/network.md +++ b/docs/defaults/show/network.md @@ -37,11 +37,11 @@ All [Shared Variables](../variables) are available as well as the additional Var | `use_separator` | **Description:** Turn the separator collection off.
**Values:** `false` to turn of the collection | | `sep_style` | **Description:** Separator Style.
**Default:** `orig`
**Values:** `orig`, `red`, `blue`, `green`, `gray`, `purple`, or `stb` | | `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.
**Values:** Number Greater then 0 | -| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's Collection.
**Default:** `limit`
**Values:** Number Greater then 0 | +| `limit_<>` | **Description:** Changes the Builder Limit of the specified key's collection.
**Default:** `limit`
**Values:** Number Greater then 0 | | `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.
**Default:** `release.desc`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | -| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's Collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | +| `sort_by_<>` | **Description:** Changes the Smart Filter Sort of the specified key's collection.
**Default:** `sort_by`
**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) | | `include` | **Description:** Overrides the [default include list](#default-include).
**Values:** List of Networks found in your library | -| `exclude` | **Description:** Exclude these Networks from creating a Dynamic Collection.
**Values:** List of of Networks found in your library | +| `exclude` | **Description:** Exclude these Networks from creating a Dynamic Collection.
**Values:** List of Networks found in your library | | `addons` | **Description:** Overrides the [default addons dictionary](#default-addons). 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 Networks found in your library | | `append_include` | **Description:** Appends to the [default include list](#default-include).
**Values:** List of Networks found in your library | | `append_addons` | **Description:** Appends to the [default addons dictionary](#default-addons).
**Values:** Dictionary List of Networks found in your library | diff --git a/docs/defaults/variables.md b/docs/defaults/variables.md index c40510c0..84c01893 100644 --- a/docs/defaults/variables.md +++ b/docs/defaults/variables.md @@ -6,36 +6,36 @@ Note that the `templates_variables:` section only needs to be used if you do wan Below are the available variables which can be used to customize the file. -| Variable | Description & Values | -|:-----------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `language` | **Description:** Set the language of Collection Names and Summaries
**Default:** `default`
**Values:** `default` (English), `fr` (French), or `de` (German) | -| `use_<>`1 | **Description:** Turns off individual Collections in a Defaults file.
**Values:** `false` to turn off the collection | -| `name_<>`1 | **Description:** Changes the name of the specified key's Collection.
**Values:** New Collection Name | -| `summary_<>`1 | **Description:** Changes the summary of the specified key's Collection.
**Values:** New Collection Summary | -| `collection_section` | **Description:** Changes the sort order of the collection sections against other default collection sections.
**Values:** Any number | -| `order_<>`1 | **Description:** Controls the sort order of the collections in each collection section.
**Values:** Any number | -| `collection_mode` | **Description:** Controls the collection mode of all collections in a Defaults file.
**Values:**
`default`Library default
`hide`Hide Collection
`hide_items`Hide Items in this Collection
`show_items`Show this Collection and its Items
| -| `visible_library` | **Description:** Controls visible on Library for all collections in a Defaults file. (Only works with Plex Pass)
**Values:**
`true`Visible
`false`Not Visible
[Any `schedule` Option](../metadata/details/schedule)Visible When Scheduled
| -| `visible_library_<>`1 | **Description:** Controls visible on Library of the specified key's Collection. (Only works with Plex Pass)
**Values:**
`true`Visible
`false`Not Visible
[Any `schedule` Option](../metadata/details/schedule)Visible When Scheduled
| -| `visible_home` | **Description:** Controls visible on Home for all collections in a Defaults file. (Only works with Plex Pass)
**Values:**
`true`Visible
`false`Not Visible
[Any `schedule` Option](../metadata/details/schedule)Visible When Scheduled
| -| `visible_home_<>`1 | **Description:** Controls visible on Home of the specified key's Collection. (Only works with Plex Pass)
**Values:**
`true`Visible
`false`Not Visible
[Any `schedule` Option](../metadata/details/schedule)Visible When Scheduled
| -| `visible_shared` | **Description:** Controls visible on Shared Users' Home for all collections in a Defaults file. (Only works with Plex Pass)
**Values:**
`true`Visible
`false`Not Visible
[Any `schedule` Option](../metadata/details/schedule)Visible When Scheduled
| -| `visible_shared_<>`1 | **Description:** Controls visible on Shared Users' Home of the specified key's Collection. (Only works with Plex Pass)
**Values:**
`true`Visible
`false`Not Visible
[Any `schedule` Option](../metadata/details/schedule)Visible When Scheduled
| -| `radarr_add_missing` | **Description:** Override Radarr `add_missing` attribute for all collections in a Defaults file.
**Values:** `true` or `false` | -| `radarr_add_missing_<>`1 | **Description:** Override Radarr `add_missing` attribute of the specified key's Collection.
**Values:** `true` or `false` | -| `radarr_folder` | **Description:** Override Radarr `root_folder_path` attribute for all collections in a Defaults file.
**Values:** Folder Path | -| `radarr_folder_<>`1 | **Description:** Override Radarr `root_folder_path` attribute of the specified key's Collection.
**Values:** Folder Path | -| `radarr_tag` | **Description:** Override Radarr `tag` attribute for all collections in a Defaults file.
**Values:** List or comma-separated string of tags | -| `radarr_tag_<>`1 | **Description:** Override Radarr `tag` attribute of the specified key's Collection.
**Values:** List or comma-separated string of tags | -| `item_radarr_tag` | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr for all collections in a Defaults file.
**Values:** List or comma-separated string of tags | -| `item_radarr_tag_<>`1 | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr of the specified key's Collection.
**Values:** List or comma-separated string of tags | -| `sonarr_add_missing` | **Description:** Override Sonarr `add_missing` attribute for all collections in a Defaults file.
**Values:** `true` or `false` | -| `sonarr_add_missing_<>`1 | **Description:** Override Sonarr `add_missing` attribute of the specified key's Collection.
**Values:** `true` or `false` | -| `sonarr_folder` | **Description:** Override Sonarr `root_folder_path` attribute for all collections in a Defaults file.
**Values:** Folder Path | -| `sonarr_folder_<>`1 | **Description:** Override Sonarr `root_folder_path` attribute of the specified key's Collection.
**Values:** Folder Path | -| `sonarr_tag` | **Description:** Override Sonarr `tag` attribute for all collections in a Defaults file.
**Values:** List or comma-separated string of tags | -| `sonarr_tag_<>`1 | **Description:** Override Sonarr `tag` attribute of the specified key's Collection.
**Values:** List or comma-separated string of tags | -| `item_sonarr_tag` | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr for all collections in a Defaults file.
**Values:** List or comma-separated string of tags | -| `item_sonarr_tag_<>`1 | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr of the specified key's Collection.
**Values:** List or comma-separated string of tags | +| Variable | Description & Values | +|:-----------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `language` | **Description:** Set the language of Collection Names and Summaries
**Default:** `default`
**Values:** `default` (English), `fr` (French), or `de` (German) | +| `use_<>`1 | **Description:** Turns off individual Collections in a Defaults file.
**Values:** `false` to turn off the collection | +| `name_<>`1 | **Description:** Changes the name of the specified key's collection.
**Values:** New Collection Name | +| `summary_<>`1 | **Description:** Changes the summary of the specified key's collection.
**Values:** New Collection Summary | +| `collection_section` | **Description:** Changes the sort order of the collection sections against other default collection sections.
**Values:** Any number | +| `order_<>`1 | **Description:** Controls the sort order of the collections in their collection section.
**Values:** Any number | +| `collection_mode` | **Description:** Controls the collection mode of all collections in a Defaults file.
**Values:**
`default`Library default
`hide`Hide Collection
`hide_items`Hide Items in this Collection
`show_items`Show this Collection and its Items
| +| `visible_library` | **Description:** Controls visible on Library for all collections in a Defaults file. (Only works with Plex Pass)
**Values:**
`true`Visible
`false`Not Visible
[Any `schedule` Option](../metadata/details/schedule)Visible When Scheduled
| +| `visible_library_<>`1 | **Description:** Controls visible on Library of the specified key's collection. (Only works with Plex Pass)
**Default:** `visible_library`
**Values:**
`true`Visible
`false`Not Visible
[Any `schedule` Option](../metadata/details/schedule)Visible When Scheduled
| +| `visible_home` | **Description:** Controls visible on Home for all collections in a Defaults file. (Only works with Plex Pass)
**Values:**
`true`Visible
`false`Not Visible
[Any `schedule` Option](../metadata/details/schedule)Visible When Scheduled
| +| `visible_home_<>`1 | **Description:** Controls visible on Home of the specified key's collection. (Only works with Plex Pass)
**Default:** `visible_home`
**Values:**
`true`Visible
`false`Not Visible
[Any `schedule` Option](../metadata/details/schedule)Visible When Scheduled
| +| `visible_shared` | **Description:** Controls visible on Shared Users' Home for all collections in a Defaults file. (Only works with Plex Pass)
**Values:**
`true`Visible
`false`Not Visible
[Any `schedule` Option](../metadata/details/schedule)Visible When Scheduled
| +| `visible_shared_<>`1 | **Description:** Controls visible on Shared Users' Home of the specified key's collection. (Only works with Plex Pass)
**Default:** `visible_shared`
**Values:**
`true`Visible
`false`Not Visible
[Any `schedule` Option](../metadata/details/schedule)Visible When Scheduled
| +| `radarr_add_missing` | **Description:** Override Radarr `add_missing` attribute for all collections in a Defaults file.
**Values:** `true` or `false` | +| `radarr_add_missing_<>`1 | **Description:** Override Radarr `add_missing` attribute of the specified key's collection.
**Default:** `radarr_add_missing`
**Values:** `true` or `false` | +| `radarr_folder` | **Description:** Override Radarr `root_folder_path` attribute for all collections in a Defaults file.
**Values:** Folder Path | +| `radarr_folder_<>`1 | **Description:** Override Radarr `root_folder_path` attribute of the specified key's collection.
**Default:** `radarr_folder`
**Values:** Folder Path | +| `radarr_tag` | **Description:** Override Radarr `tag` attribute for all collections in a Defaults file.
**Values:** List or comma-separated string of tags | +| `radarr_tag_<>`1 | **Description:** Override Radarr `tag` attribute of the specified key's collection.
**Default:** `radarr_tag`
**Values:** List or comma-separated string of tags | +| `item_radarr_tag` | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr for all collections in a Defaults file.
**Values:** List or comma-separated string of tags | +| `item_radarr_tag_<>`1 | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr of the specified key's collection.
**Default:** `item_radarr_tag`
**Values:** List or comma-separated string of tags | +| `sonarr_add_missing` | **Description:** Override Sonarr `add_missing` attribute for all collections in a Defaults file.
**Values:** `true` or `false` | +| `sonarr_add_missing_<>`1 | **Description:** Override Sonarr `add_missing` attribute of the specified key's collection.
**Default:** `sonarr_add_missing`
**Values:** `true` or `false` | +| `sonarr_folder` | **Description:** Override Sonarr `root_folder_path` attribute for all collections in a Defaults file.
**Values:** Folder Path | +| `sonarr_folder_<>`1 | **Description:** Override Sonarr `root_folder_path` attribute of the specified key's collection.
**Default:** `sonarr_folder`
**Values:** Folder Path | +| `sonarr_tag` | **Description:** Override Sonarr `tag` attribute for all collections in a Defaults file.
**Values:** List or comma-separated string of tags | +| `sonarr_tag_<>`1 | **Description:** Override Sonarr `tag` attribute of the specified key's collection.
**Default:** `sonarr_tag`
**Values:** List or comma-separated string of tags | +| `item_sonarr_tag` | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr for all collections in a Defaults file.
**Values:** List or comma-separated string of tags | +| `item_sonarr_tag_<>`1 | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr of the specified key's collection.
**Default:** `item_sonarr_tag`
**Values:** List or comma-separated string of tags | 1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<>` with when calling. \ No newline at end of file diff --git a/modules/meta.py b/modules/meta.py index b846e897..f92dba72 100644 --- a/modules/meta.py +++ b/modules/meta.py @@ -534,221 +534,227 @@ class MetadataFile(DataFile): raise Failed(f"Config Error: {map_name} type attribute: network only works with the New Plex TV Agent") elif dynamic[methods["type"]].lower().startswith("trakt") and not self.config.Trakt: raise Failed(f"Config Error: {map_name} type attribute: {dynamic[methods['type']]} requires trakt to be configured") - else: - auto_type = dynamic[methods["type"]].lower() - og_exclude = [] - if "exclude" in self.temp_vars: - og_exclude = util.parse("Config", "exclude", self.temp_vars["exclude"], parent="template_variable", datatype="strlist") - elif "exclude" in methods: - og_exclude = util.parse("Config", "exclude", dynamic, parent=map_name, methods=methods, datatype="strlist") - if "append_exclude" in self.temp_vars: - og_exclude.extend(util.parse("Config", "append_exclude", self.temp_vars["append_exclude"], parent="template_variable", datatype="strlist")) - include = [] - if "include" in self.temp_vars: - include = util.parse("Config", "include", self.temp_vars["include"], parent="template_variable", datatype="strlist") - elif "include" in methods: - include = [i for i in util.parse("Config", "include", dynamic, parent=map_name, methods=methods, datatype="strlist") if i not in og_exclude] - if "append_include" in self.temp_vars: - include.extend(util.parse("Config", "append_include", self.temp_vars["append_include"], parent="template_variable", datatype="strlist")) - addons = util.parse("Config", "addons", dynamic, parent=map_name, methods=methods, datatype="dictliststr") if "addons" in methods else {} - if "append_addons" in self.temp_vars: - append_addons = util.parse("Config", "append_addons", dynamic, parent=map_name, methods=methods, datatype="dictliststr") - for k, v in append_addons.items(): - if k not in addons: - addons[k] = [] - addons[k].extend(v) - exclude = [str(e) for e in og_exclude] - for k, v in addons.items(): - if k in v: - logger.warning(f"Config Warning: {k} cannot be an addon for itself") - exclude.extend([y for y in v if y != k and y not in exclude]) - default_title_format = "<>" - default_template = None - auto_list = {} + auto_type = dynamic[methods["type"]].lower() + og_exclude = [] + if "exclude" in self.temp_vars: + og_exclude = util.parse("Config", "exclude", self.temp_vars["exclude"], parent="template_variable", datatype="strlist") + elif "exclude" in methods: + og_exclude = util.parse("Config", "exclude", dynamic, parent=map_name, methods=methods, datatype="strlist") + if "append_exclude" in self.temp_vars: + og_exclude.extend(util.parse("Config", "append_exclude", self.temp_vars["append_exclude"], parent="template_variable", datatype="strlist")) + include = [] + if "include" in self.temp_vars: + include = util.parse("Config", "include", self.temp_vars["include"], parent="template_variable", datatype="strlist") + elif "include" in methods: + include = [i for i in util.parse("Config", "include", dynamic, parent=map_name, methods=methods, datatype="strlist") if i not in og_exclude] + if "append_include" in self.temp_vars: + include.extend(util.parse("Config", "append_include", self.temp_vars["append_include"], parent="template_variable", datatype="strlist")) + addons = util.parse("Config", "addons", dynamic, parent=map_name, methods=methods, datatype="dictliststr") if "addons" in methods else {} + if "append_addons" in self.temp_vars: + append_addons = util.parse("Config", "append_addons", dynamic, parent=map_name, methods=methods, datatype="dictliststr") + for k, v in append_addons.items(): + if k not in addons: + addons[k] = [] + addons[k].extend(v) + exclude = [str(e) for e in og_exclude] + for k, v in addons.items(): + if k in v: + logger.warning(f"Config Warning: {k} cannot be an addon for itself") + exclude.extend([y for y in v if y != k and y not in exclude]) + default_title_format = "<>" + default_template = None + auto_list = {} + all_keys = [] + dynamic_data = None + def _check_dict(check_dict): + for ck, cv in check_dict.items(): + all_keys.append(ck) + if str(ck) not in exclude and str(cv) not in exclude: + auto_list[str(ck)] = cv + if auto_type == "decade" and library.is_show: + all_items = library.get_all() + if addons: + raise Failed(f"Config Error: addons cannot be used with show decades") + addons = {} all_keys = [] - dynamic_data = None - def _check_dict(check_dict): - for ck, cv in check_dict.items(): - all_keys.append(ck) - if str(ck) not in exclude and str(cv) not in exclude: - auto_list[str(ck)] = cv - if auto_type == "decade" and library.is_show: - all_items = library.get_all() - if addons: - raise Failed(f"Config Error: addons cannot be used with show decades") - addons = {} + for i, item in enumerate(all_items, 1): + logger.ghost(f"Processing: {i}/{len(all_items)} {item.title}") + if item.year: + decade = str(int(math.floor(item.year / 10) * 10)) + if decade not in addons: + addons[decade] = [] + if item.year not in addons[decade]: + addons[decade].append(item.year) + all_keys.append(item.year) + auto_list = {str(k): f"{k}s" for k in addons if str(k) not in exclude and f"{k}s" not in exclude} + default_template = {"smart_filter": {"limit": 50, "sort_by": "critic_rating.desc", "any": {"year": f"<>"}}} + default_title_format = "Best <>s of <>" + elif auto_type in ["genre", "mood", "style", "album_style", "country", "studio", "edition", "network", "year", "decade", "content_rating", "subtitle_language", "audio_language", "resolution"]: + search_tag = auto_type_translation[auto_type] if auto_type in auto_type_translation else auto_type + if library.is_show and auto_type in ["resolution", "subtitle_language", "audio_language"]: + tags = library.get_tags(f"episode.{search_tag}") + else: + tags = library.get_tags(search_tag) + if auto_type in ["subtitle_language", "audio_language"]: all_keys = [] - for i, item in enumerate(all_items, 1): - logger.ghost(f"Processing: {i}/{len(all_items)} {item.title}") - if item.year: - decade = str(int(math.floor(item.year / 10) * 10)) - if decade not in addons: - addons[decade] = [] - if item.year not in addons[decade]: - addons[decade].append(item.year) - all_keys.append(item.year) - auto_list = {str(k): f"{k}s" for k in addons if str(k) not in exclude and f"{k}s" not in exclude} - default_template = {"smart_filter": {"limit": 50, "sort_by": "critic_rating.desc", "any": {"year": f"<>"}}} - default_title_format = "Best <>s of <>" - elif auto_type in ["genre", "mood", "style", "album_style", "country", "studio", "edition", "network", "year", "decade", "content_rating", "subtitle_language", "audio_language", "resolution"]: - search_tag = auto_type_translation[auto_type] if auto_type in auto_type_translation else auto_type - if library.is_show and auto_type in ["resolution", "subtitle_language", "audio_language"]: - tags = library.get_tags(f"episode.{search_tag}") - else: - tags = library.get_tags(search_tag) - if auto_type in ["subtitle_language", "audio_language"]: - all_keys = [] - auto_list = {} - for i in tags: - all_keys.append(str(i.key)) - final_title = self.config.TMDb.TMDb._iso_639_1[str(i.key)].english_name if str(i.key) in self.config.TMDb.TMDb._iso_639_1 else str(i.title) - if all([x not in exclude for x in [final_title, str(i.title), str(i.key)]]): - auto_list[str(i.key)] = final_title - elif auto_type in ["resolution", "decade"]: - all_keys = [str(i.key) for i in tags] - auto_list = {str(i.key): i.title for i in tags if str(i.title) not in exclude and str(i.key) not in exclude} - else: - all_keys = [str(i.title) for i in tags] - auto_list = {str(i.title): i.title for i in tags if str(i.title) not in exclude} - if library.is_music: - final_var = auto_type if auto_type.startswith("album") else f"artist_{auto_type}" - default_template = {"smart_filter": {"limit": 50, "sort_by": "plays.desc", "any": {final_var: f"<>"}}} - if auto_type.startswith("album"): - default_template["builder_level"] = "album" - default_title_format = f"Most Played <> {'Albums' if auto_type.startswith('album') else '<>'}s" - elif auto_type == "resolution": - default_template = {"smart_filter": {"sort_by": "title.asc", "any": {auto_type: f"<>"}}} - default_title_format = "<> <>s" - else: - default_template = {"smart_filter": {"limit": 50, "sort_by": "critic_rating.desc", "any": {f"{auto_type}.is" if auto_type == "studio" else auto_type: "<>"}}} - default_title_format = "Best <>s of <>" if auto_type in ["year", "decade"] else "Top <> <>s" - elif auto_type == "tmdb_collection": - all_items = library.get_all() - for i, item in enumerate(all_items, 1): - logger.ghost(f"Processing: {i}/{len(all_items)} {item.title}") - tmdb_id, tvdb_id, imdb_id = library.get_ids(item) - tmdb_item = config.TMDb.get_item(item, tmdb_id, tvdb_id, imdb_id, is_movie=True) - if tmdb_item and tmdb_item.collection_id and tmdb_item.collection_name: - all_keys.append(str(tmdb_item.collection_id)) - if str(tmdb_item.collection_id) not in exclude and tmdb_item.collection_name not in exclude: - auto_list[str(tmdb_item.collection_id)] = tmdb_item.collection_name - logger.exorcise() - elif auto_type == "original_language": - all_items = library.get_all() - for i, item in enumerate(all_items, 1): - logger.ghost(f"Processing: {i}/{len(all_items)} {item.title}") - tmdb_id, tvdb_id, imdb_id = library.get_ids(item) - tmdb_item = config.TMDb.get_item(item, tmdb_id, tvdb_id, imdb_id, is_movie=library.type == "Movie") - if tmdb_item and tmdb_item.language_iso: - all_keys.append(tmdb_item.language_iso) - if tmdb_item.language_iso not in exclude and tmdb_item.language_name not in exclude: - auto_list[tmdb_item.language_iso] = tmdb_item.language_name - logger.exorcise() - default_title_format = "<> <>s" - elif auto_type == "origin_country": - all_items = library.get_all() - for i, item in enumerate(all_items, 1): - logger.ghost(f"Processing: {i}/{len(all_items)} {item.title}") - tmdb_id, tvdb_id, imdb_id = library.get_ids(item) - tmdb_item = config.TMDb.get_item(item, tmdb_id, tvdb_id, imdb_id, is_movie=library.type == "Movie") - if tmdb_item and tmdb_item.countries: - for country in tmdb_item.countries: - all_keys.append(country.iso_3166_1.lower()) - if country.iso_3166_1.lower() not in exclude and country.name not in exclude: - auto_list[country.iso_3166_1.lower()] = country.name - logger.exorcise() + auto_list = {} + for i in tags: + all_keys.append(str(i.key)) + final_title = self.config.TMDb.TMDb._iso_639_1[str(i.key)].english_name if str(i.key) in self.config.TMDb.TMDb._iso_639_1 else str(i.title) + if all([x not in exclude for x in [final_title, str(i.title), str(i.key)]]): + auto_list[str(i.key)] = final_title + elif auto_type in ["resolution", "decade"]: + all_keys = [str(i.key) for i in tags] + auto_list = {str(i.key): i.title for i in tags if str(i.title) not in exclude and str(i.key) not in exclude} + else: + all_keys = [str(i.title) for i in tags] + auto_list = {str(i.title): i.title for i in tags if str(i.title) not in exclude} + if library.is_music: + final_var = auto_type if auto_type.startswith("album") else f"artist_{auto_type}" + default_template = {"smart_filter": {"limit": 50, "sort_by": "plays.desc", "any": {final_var: f"<>"}}} + if auto_type.startswith("album"): + default_template["builder_level"] = "album" + default_title_format = f"Most Played <> {'Albums' if auto_type.startswith('album') else '<>'}s" + elif auto_type == "resolution": + default_template = {"smart_filter": {"sort_by": "title.asc", "any": {auto_type: f"<>"}}} default_title_format = "<> <>s" - elif auto_type in ["actor", "director", "writer", "producer"]: - people = {} - if "data" not in methods: - raise Failed(f"Config Error: {map_name} data attribute not found") - elif "data" in self.temp_vars: - dynamic_data = util.parse("Config", "data", self.temp_vars["data"], datatype="dict") - else: - dynamic_data = util.parse("Config", "data", dynamic, parent=map_name, methods=methods, datatype="dict") - person_methods = {am.lower(): am for am in dynamic_data} - if "actor_depth" in person_methods: - person_methods["depth"] = person_methods.pop("actor_depth") - if "actor_minimum" in person_methods: - person_methods["minimum"] = person_methods.pop("actor_minimum") - if "number_of_actors" in person_methods: - person_methods["limit"] = person_methods.pop("number_of_actors") - person_depth = util.parse("Config", "depth", dynamic_data, parent=f"{map_name} data", methods=person_methods, datatype="int", default=3, minimum=1) - person_minimum = util.parse("Config", "minimum", dynamic_data, parent=f"{map_name} data", methods=person_methods, datatype="int", default=3, minimum=1) if "minimum" in person_methods else None - person_limit = util.parse("Config", "limit", dynamic_data, parent=f"{map_name} data", methods=person_methods, datatype="int", default=25, minimum=1) if "limit" in person_methods else None - lib_all = library.get_all() - for i, item in enumerate(lib_all, 1): - logger.ghost(f"Scanning: {i}/{len(lib_all)} {item.title}") - try: - item = self.library.reload(item) - for person in getattr(item, f"{auto_type}s")[:person_depth]: - if person.id not in people: - people[person.id] = {"name": person.tag, "count": 0} - people[person.id]["count"] += 1 - except Failed as e: - logger.error(f"Plex Error: {e}") - roles = [data for _, data in people.items()] - roles.sort(key=operator.itemgetter('count'), reverse=True) - if not person_minimum: - person_minimum = 1 if person_limit else 3 - if not person_limit: - person_limit = len(roles) - person_count = 0 - for role in roles: - if person_count < person_limit and role["count"] >= person_minimum and role["name"] not in exclude: - auto_list[role["name"]] = role["name"] - all_keys.append(role["name"]) - person_count += 1 - default_template = {"plex_search": {"any": {auto_type: "<>"}}} - elif auto_type == "number": - if "data" not in methods: - raise Failed(f"Config Error: {map_name} data attribute not found") - elif "data" in self.temp_vars: - dynamic_data = util.parse("Config", "data", self.temp_vars["data"], datatype="dict") - else: - dynamic_data = util.parse("Config", "data", dynamic, parent=map_name, methods=methods, datatype="dict") - number_methods = {nm.lower(): nm for nm in dynamic_data} - if "starting" in number_methods and str(dynamic_data[number_methods["starting"]]).startswith("current_year"): - year_values = str(dynamic_data[number_methods["starting"]]).split("-") - starting = datetime.now().year - (0 if len(year_values) == 1 else int(year_values[1].strip())) - else: - starting = util.parse("Config", "starting", dynamic_data, parent=f"{map_name} data", methods=number_methods, datatype="int", default=0, minimum=0) - if "ending" in number_methods and str(dynamic_data[number_methods["ending"]]).startswith("current_year"): - year_values = str(dynamic_data[number_methods["ending"]]).split("-") - ending = datetime.now().year - (0 if len(year_values) == 1 else int(year_values[1].strip())) - else: - ending = util.parse("Config", "ending", dynamic_data, parent=f"{map_name} data", methods=number_methods, datatype="int", default=0, minimum=1) - increment = util.parse("Config", "increment", dynamic_data, parent=f"{map_name} data", methods=number_methods, datatype="int", default=1, minimum=1) if "increment" in number_methods else 1 - if starting > ending: - raise Failed(f"Config Error: {map_name} data ending must be greater than starting") - current = starting - while current <= ending: - all_keys.append(str(current)) - if str(current) not in exclude and current not in exclude: - auto_list[str(current)] = str(current) - current += increment - elif auto_type == "custom": - if "data" not in methods: - raise Failed(f"Config Error: {map_name} data attribute not found") - for k, v in util.parse("Config", "data", dynamic, parent=map_name, methods=methods, datatype="strdict").items(): - all_keys.append(k) - if k not in exclude and v not in exclude: - auto_list[k] = v - elif auto_type == "trakt_user_lists": - dynamic_data = util.parse("Config", "data", dynamic, parent=map_name, methods=methods, datatype="list") - for option in dynamic_data: - _check_dict({self.config.Trakt.build_user_url(u[0], u[1]): u[2] for u in self.config.Trakt.all_user_lists(option)}) - elif auto_type == "trakt_liked_lists": - _check_dict(self.config.Trakt.all_liked_lists()) - elif auto_type == "tmdb_popular_people": - dynamic_data = util.parse("Config", "data", dynamic, parent=map_name, methods=methods, datatype="int", minimum=1) - _check_dict(self.config.TMDb.get_popular_people(dynamic_data)) - elif auto_type == "trakt_people_list": - dynamic_data = util.parse("Config", "data", dynamic, parent=map_name, methods=methods, datatype="list") - for option in dynamic_data: - _check_dict(self.config.Trakt.get_people(option)) else: - raise Failed(f"Config Error: {map_name} type attribute {dynamic[methods['type']]} invalid") + default_template = {"smart_filter": {"limit": 50, "sort_by": "critic_rating.desc", "any": {f"{auto_type}.is" if auto_type == "studio" else auto_type: "<>"}}} + default_title_format = "Best <>s of <>" if auto_type in ["year", "decade"] else "Top <> <>s" + elif auto_type == "tmdb_collection": + all_items = library.get_all() + for i, item in enumerate(all_items, 1): + logger.ghost(f"Processing: {i}/{len(all_items)} {item.title}") + tmdb_id, tvdb_id, imdb_id = library.get_ids(item) + tmdb_item = config.TMDb.get_item(item, tmdb_id, tvdb_id, imdb_id, is_movie=True) + if tmdb_item and tmdb_item.collection_id and tmdb_item.collection_name: + all_keys.append(str(tmdb_item.collection_id)) + if str(tmdb_item.collection_id) not in exclude and tmdb_item.collection_name not in exclude: + auto_list[str(tmdb_item.collection_id)] = tmdb_item.collection_name + logger.exorcise() + elif auto_type == "original_language": + all_items = library.get_all() + for i, item in enumerate(all_items, 1): + logger.ghost(f"Processing: {i}/{len(all_items)} {item.title}") + tmdb_id, tvdb_id, imdb_id = library.get_ids(item) + tmdb_item = config.TMDb.get_item(item, tmdb_id, tvdb_id, imdb_id, is_movie=library.type == "Movie") + if tmdb_item and tmdb_item.language_iso: + all_keys.append(tmdb_item.language_iso) + if tmdb_item.language_iso not in exclude and tmdb_item.language_name not in exclude: + auto_list[tmdb_item.language_iso] = tmdb_item.language_name + logger.exorcise() + default_title_format = "<> <>s" + elif auto_type == "origin_country": + all_items = library.get_all() + for i, item in enumerate(all_items, 1): + logger.ghost(f"Processing: {i}/{len(all_items)} {item.title}") + tmdb_id, tvdb_id, imdb_id = library.get_ids(item) + tmdb_item = config.TMDb.get_item(item, tmdb_id, tvdb_id, imdb_id, is_movie=library.type == "Movie") + if tmdb_item and tmdb_item.countries: + for country in tmdb_item.countries: + all_keys.append(country.iso_3166_1.lower()) + if country.iso_3166_1.lower() not in exclude and country.name not in exclude: + auto_list[country.iso_3166_1.lower()] = country.name + logger.exorcise() + default_title_format = "<> <>s" + elif auto_type in ["actor", "director", "writer", "producer"]: + people = {} + if "data" not in methods: + raise Failed(f"Config Error: {map_name} data attribute not found") + elif "data" in self.temp_vars: + dynamic_data = util.parse("Config", "data", self.temp_vars["data"], datatype="dict") + else: + dynamic_data = util.parse("Config", "data", dynamic, parent=map_name, methods=methods, datatype="dict") + person_methods = {am.lower(): am for am in dynamic_data} + if "actor_depth" in person_methods: + person_methods["depth"] = person_methods.pop("actor_depth") + if "actor_minimum" in person_methods: + person_methods["minimum"] = person_methods.pop("actor_minimum") + if "number_of_actors" in person_methods: + person_methods["limit"] = person_methods.pop("number_of_actors") + person_depth = util.parse("Config", "depth", dynamic_data, parent=f"{map_name} data", methods=person_methods, datatype="int", default=3, minimum=1) + person_minimum = util.parse("Config", "minimum", dynamic_data, parent=f"{map_name} data", methods=person_methods, datatype="int", default=3, minimum=1) if "minimum" in person_methods else None + person_limit = util.parse("Config", "limit", dynamic_data, parent=f"{map_name} data", methods=person_methods, datatype="int", default=25, minimum=1) if "limit" in person_methods else None + lib_all = library.get_all() + for i, item in enumerate(lib_all, 1): + logger.ghost(f"Scanning: {i}/{len(lib_all)} {item.title}") + try: + item = self.library.reload(item) + for person in getattr(item, f"{auto_type}s")[:person_depth]: + if person.id not in people: + people[person.id] = {"name": person.tag, "count": 0} + people[person.id]["count"] += 1 + except Failed as e: + logger.error(f"Plex Error: {e}") + roles = [data for _, data in people.items()] + roles.sort(key=operator.itemgetter('count'), reverse=True) + if not person_minimum: + person_minimum = 1 if person_limit else 3 + if not person_limit: + person_limit = len(roles) + person_count = 0 + for role in roles: + if person_count < person_limit and role["count"] >= person_minimum and role["name"] not in exclude: + auto_list[role["name"]] = role["name"] + all_keys.append(role["name"]) + person_count += 1 + default_template = {"plex_search": {"any": {auto_type: "<>"}}} + elif auto_type == "number": + if "data" not in methods: + raise Failed(f"Config Error: {map_name} data attribute not found") + elif "data" in self.temp_vars: + dynamic_data = util.parse("Config", "data", self.temp_vars["data"], datatype="dict") + else: + dynamic_data = util.parse("Config", "data", dynamic, parent=map_name, methods=methods, datatype="dict") + number_methods = {nm.lower(): nm for nm in dynamic_data} + if "starting" in number_methods and str(dynamic_data[number_methods["starting"]]).startswith("current_year"): + year_values = str(dynamic_data[number_methods["starting"]]).split("-") + starting = datetime.now().year - (0 if len(year_values) == 1 else int(year_values[1].strip())) + else: + starting = util.parse("Config", "starting", dynamic_data, parent=f"{map_name} data", methods=number_methods, datatype="int", default=0, minimum=0) + if "ending" in number_methods and str(dynamic_data[number_methods["ending"]]).startswith("current_year"): + year_values = str(dynamic_data[number_methods["ending"]]).split("-") + ending = datetime.now().year - (0 if len(year_values) == 1 else int(year_values[1].strip())) + else: + ending = util.parse("Config", "ending", dynamic_data, parent=f"{map_name} data", methods=number_methods, datatype="int", default=0, minimum=1) + increment = util.parse("Config", "increment", dynamic_data, parent=f"{map_name} data", methods=number_methods, datatype="int", default=1, minimum=1) if "increment" in number_methods else 1 + if starting > ending: + raise Failed(f"Config Error: {map_name} data ending must be greater than starting") + current = starting + while current <= ending: + all_keys.append(str(current)) + if str(current) not in exclude and current not in exclude: + auto_list[str(current)] = str(current) + current += increment + elif auto_type == "custom": + if "data" not in methods: + raise Failed(f"Config Error: {map_name} data attribute not found") + for k, v in util.parse("Config", "data", dynamic, parent=map_name, methods=methods, datatype="strdict").items(): + all_keys.append(k) + if k not in exclude and v not in exclude: + auto_list[k] = v + elif auto_type == "trakt_user_lists": + dynamic_data = util.parse("Config", "data", dynamic, parent=map_name, methods=methods, datatype="list") + for option in dynamic_data: + _check_dict({self.config.Trakt.build_user_url(u[0], u[1]): u[2] for u in self.config.Trakt.all_user_lists(option)}) + elif auto_type == "trakt_liked_lists": + _check_dict(self.config.Trakt.all_liked_lists()) + elif auto_type == "tmdb_popular_people": + dynamic_data = util.parse("Config", "data", dynamic, parent=map_name, methods=methods, datatype="int", minimum=1) + _check_dict(self.config.TMDb.get_popular_people(dynamic_data)) + elif auto_type == "trakt_people_list": + dynamic_data = util.parse("Config", "data", dynamic, parent=map_name, methods=methods, datatype="list") + for option in dynamic_data: + _check_dict(self.config.Trakt.get_people(option)) + else: + raise Failed(f"Config Error: {map_name} type attribute {dynamic[methods['type']]} invalid") + + if "append_data" in self.temp_vars: + for k, v in util.parse("Config", "append_data", dynamic, parent=map_name, methods=methods, datatype="strdict").items(): + all_keys.append(k) + if k not in exclude and v not in exclude: + auto_list[k] = v + for add_key, combined_keys in addons.items(): if add_key not in all_keys and add_key not in og_exclude: final_keys = [ck for ck in combined_keys if ck in all_keys]