From 4786d099b6567ec376becd38e43dcaa4ba50e99b Mon Sep 17 00:00:00 2001 From: meisnate12 Date: Sat, 8 Oct 2022 12:31:06 -0400 Subject: [PATCH] [106] finished charts on the wiki --- VERSION | 2 +- defaults/chart/basic.yml | 53 ++-------- defaults/chart/flixpatrol.yml | 9 +- defaults/chart/imdb.yml | 63 ++---------- defaults/chart/myanimelist.yml | 73 ++------------ defaults/chart/other_chart.yml | 64 ++---------- defaults/chart/tautulli.yml | 66 +++--------- defaults/chart/tmdb.yml | 112 ++++++--------------- defaults/chart/trakt.yml | 3 +- defaults/templates.yml | 6 +- docs/defaults/award/bafta.md | 10 +- docs/defaults/award/cannes.md | 10 +- docs/defaults/award/choice.md | 10 +- docs/defaults/award/emmy.md | 8 +- docs/defaults/award/golden.md | 10 +- docs/defaults/award/oscars.md | 9 +- docs/defaults/award/other.md | 12 +-- docs/defaults/award/spirit.md | 18 ++-- docs/defaults/award/sundance.md | 10 +- docs/defaults/both/actor.md | 16 ++- docs/defaults/both/audio_language.md | 2 +- docs/defaults/both/content_rating_cs.md | 2 +- docs/defaults/both/content_rating_uk.md | 2 +- docs/defaults/both/genre.md | 2 +- docs/defaults/both/resolution.md | 2 +- docs/defaults/both/resolution_standards.md | 2 +- docs/defaults/both/streaming.md | 2 +- docs/defaults/both/studio.md | 2 +- docs/defaults/both/subtitle_language.md | 2 +- docs/defaults/both/year.md | 4 +- docs/defaults/chart/anilist.md | 22 ++-- docs/defaults/chart/basic.md | 64 +++++------- docs/defaults/chart/flixpatrol.md | 63 ++++++++++++ docs/defaults/chart/imdb.md | 74 +++++--------- docs/defaults/chart/myanimelist.md | 76 ++++++-------- docs/defaults/chart/other.md | 70 +++++-------- docs/defaults/chart/tautulli.md | 67 ++++++------ docs/defaults/chart/tmdb.md | 77 ++++++-------- docs/defaults/chart/trakt.md | 75 +++++--------- docs/defaults/files.md | 2 +- docs/defaults/movie/content_rating_us.md | 2 +- docs/defaults/movie/country.md | 2 +- docs/defaults/movie/decade.md | 2 +- docs/defaults/movie/director.md | 2 +- docs/defaults/movie/franchise.md | 2 +- docs/defaults/movie/producer.md | 2 +- docs/defaults/movie/universe.md | 4 +- docs/defaults/movie/writer.md | 2 +- docs/defaults/separators.md | 30 ++++++ docs/defaults/show/content_rating_us.md | 2 +- docs/defaults/show/country.md | 2 +- docs/defaults/show/decade.md | 2 +- docs/defaults/show/franchise.md | 2 +- docs/defaults/show/network.md | 2 +- docs/defaults/variables.md | 60 +++++------ docs/metadata/builders/plex.md | 2 +- 56 files changed, 500 insertions(+), 796 deletions(-) create mode 100644 docs/defaults/chart/flixpatrol.md diff --git a/VERSION b/VERSION index 2ee949f6..fcfd6bdd 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.17.3-develop105 +1.17.3-develop106 diff --git a/defaults/chart/basic.yml b/defaults/chart/basic.yml index 32d80d6c..bac4a04c 100644 --- a/defaults/chart/basic.yml +++ b/defaults/chart/basic.yml @@ -1,50 +1,9 @@ -############################################################# -# Basic Plex Chart Collections # -# Created by Yozora, Bullmoose20, & Sohjiro # -############################################################# -# Call this from your config.yml (Movie or Show) # -# If nothing is specified these are the defaults # -# # -# metadata_path: # -# - git: PMM/chart/basic # -# template_variables: # -# # Turn the separator collection on/off # -# use_separator: true # -# # Separator style (red, blue, green, gray, # -# purple, stb, orig) # -# sep_style: orig # -# # Sets the collection mode of the collection # -# collection_mode: # -# # Sets the value at the start of the sort title # -# collection_section: "01" # -# # -# # For each collection use the "key" to set # -# # the options. # -# # Available collections # -# # KEY COLLECTION # -# # released Newly Released # -# # episodes New Episodes # -# # -# # Available options. Replace "key" with the # -# # desired collection's key from the chart above. # -# # -# # Customize summary of collection # -# summary_key: A collection of ... # -# # Turn the collection on/off # -# use_key: true # -# # Determines collection order in it's section # -# order_key: # -# # Set visible_library for the collection # -# visible_library_key: # -# # Set visible_home for the collection # -# visible_home_key: # -# # Set visible_shared for the collection # -# visible_shared_key: # -# # Radarr Tag for existing items # -# item_radarr_tag_key: # -# # Sonarr Tag for existing items # -# item_sonarr_tag_key: # -############################################################# +############################################################################## +# Basic Charts Collections # +# Created by Yozora, Bullmoose20, & Sohjiro # +# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # +# https://metamanager.wiki/en/latest/defaults/chart/basic.html # +############################################################################## external_templates: pmm: templates diff --git a/defaults/chart/flixpatrol.yml b/defaults/chart/flixpatrol.yml index b06c143b..f6e944eb 100644 --- a/defaults/chart/flixpatrol.yml +++ b/defaults/chart/flixpatrol.yml @@ -1,3 +1,10 @@ +############################################################################## +# FlixPatrol Charts Collections # +# Created by Yozora, Bullmoose20, & Sohjiro # +# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # +# https://metamanager.wiki/en/latest/defaults/chart/flixpatrol.html # +############################################################################## + external_templates: pmm: templates template_variables: @@ -10,7 +17,7 @@ translations: templates: flixpatrol: default: - location: united_states + location: world location_<>: <> time_window: last_week time_window_<>: <> diff --git a/defaults/chart/imdb.yml b/defaults/chart/imdb.yml index 00792eef..ef4cb33b 100644 --- a/defaults/chart/imdb.yml +++ b/defaults/chart/imdb.yml @@ -1,60 +1,9 @@ -############################################################# -# IMDb Chart Collections # -# Created by Yozora, Bullmoose20, & Sohjiro # -############################################################# -# Call this from your config.yml (Movie or Show) # -# If nothing is specified these are the defaults # -# # -# metadata_path: # -# - git: PMM/chart/imdb # -# template_variables: # -# # Sets the collection mode of the collection # -# collection_mode: # -# # Sets the value at the start of the sort title # -# collection_section: "01" # -# # -# # For each collection use the "key" to set # -# # the options. # -# # Available collections # -# # KEY COLLECTION # -# # popular IMDb Popular # -# # top IMDb Top 250 # -# # lowest IMDb Lowest Rated # -# # -# # Available options. Replace "key" with the # -# # desired collection's key from the chart above. # -# # -# # Customize summary of collection # -# summary_key: A collection of ... # -# # Turn the collection on/off # -# use_key: true # -# # Determines collection order in its section # -# order_key: # -# # Determines collection order of the collection # -# collection_order_key: custom # -# # Set visible_library for the collection # -# visible_library_key: # -# # Set visible_home for the collection # -# visible_home_key: # -# # Set visible_shared for the collection # -# visible_shared_key: # -# # Adds missing from the collection to radarr # -# radarr_add_missing_key: # -# # Adds missing from the collection to sonarr # -# sonarr_add_missing_key: # -# # Radarr Folder to add to # -# radarr_folder_key: # -# # Sonarr Folder to add to # -# sonarr_folder_key: # -# # Radarr Tag for added missing # -# radarr_tag_key: # -# # Sonarr Tag for added missing # -# sonarr_tag_key: # -# # Radarr Tag for existing items # -# item_radarr_tag_key: # -# # Sonarr Tag for existing items # -# item_sonarr_tag_key: # -############################################################# +############################################################################## +# IMDb Charts Collections # +# Created by Yozora, Bullmoose20, & Sohjiro # +# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # +# https://metamanager.wiki/en/latest/defaults/chart/imdb.html # +############################################################################## external_templates: pmm: templates diff --git a/defaults/chart/myanimelist.yml b/defaults/chart/myanimelist.yml index a8931b12..fecaab17 100644 --- a/defaults/chart/myanimelist.yml +++ b/defaults/chart/myanimelist.yml @@ -1,64 +1,9 @@ -############################################################# -# MyAnimeList Chart Collections # -# Created by Yozora, Bullmoose20, & Sohjiro # -############################################################# -# Call this from your config.yml (Movie or Show) # -# If nothing is specified these are the defaults # -# # -# metadata_path: # -# - git: PMM/chart/anilist # -# template_variables: # -# # Sets the collection mode of the collection # -# collection_mode: # -# # Sets the value at the start of the sort title # -# collection_section: "01" # -# # -# # For each collection use the "key" to set # -# # the options. # -# # Available collections # -# # KEY COLLECTION # -# # popular MyAnimeList Popular # -# # favorited MyAnimeList Favorited # -# # top MyAnimeList Top Rated # -# # airing MyAnimeList Top Airing # -# # season MyAnimeList Season # -# # -# # Available options. Replace "key" with the # -# # desired collection's key from the chart above. # -# # -# # Customize summary of collection # -# summary_key: A collection of ... # -# # Turn the collection on/off # -# use_key: true # -# # Determines collection order in it's section # -# order_key: # -# # Determines collection order of the collection # -# collection_order_key: custom # -# # Set visible_library for the collection # -# visible_library_key: # -# # Set visible_home for the collection # -# visible_home_key: # -# # Set visible_shared for the collection # -# visible_shared_key: # -# # Set limit for the collection # -# limit_key: 100 # -# # Adds missing from the collection to radarr # -# radarr_add_missing_key: # -# # Adds missing from the collection to sonarr # -# sonarr_add_missing_key: # -# # Radarr Folder to add to # -# radarr_folder_key: # -# # Sonarr Folder to add to # -# sonarr_folder_key: # -# # Radarr Tag for added missing # -# radarr_tag_key: # -# # Sonarr Tag for added missing # -# sonarr_tag_key: # -# # Radarr Tag for existing items # -# item_radarr_tag_key: # -# # Sonarr Tag for existing items # -# item_sonarr_tag_key: # -############################################################# +############################################################################## +# MyAnimeList Charts Collections # +# Created by Yozora, Bullmoose20, & Sohjiro # +# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # +# https://metamanager.wiki/en/latest/defaults/chart/myanimelist.html # +############################################################################## external_templates: pmm: templates @@ -71,13 +16,15 @@ translations: templates: mal: default: - limit_<>: 100 + limit: 100 + limit_<>: <> chart: <> mal_<>: <>>> season: default: - limit_season: 100 + limit: 100 + limit_season: <> mal_season: season: current sort_by: score diff --git a/defaults/chart/other_chart.yml b/defaults/chart/other_chart.yml index ff250aa2..f44e515f 100644 --- a/defaults/chart/other_chart.yml +++ b/defaults/chart/other_chart.yml @@ -1,61 +1,9 @@ -############################################################# -# Other Chart Collections # -# Created by Yozora, Bullmoose20, & Sohjiro # -############################################################# -# Call this from your config.yml (Movie or Show) # -# If nothing is specified these are the defaults # -# # -# metadata_path: # -# - git: PMM/chart/other # -# template_variables: # -# # Sets the collection mode of the collection # -# collection_mode: # -# # Sets the value at the start of the sort title # -# collection_section: "01" # -# # -# # For each collection use the "key" to set # -# # the options. # -# # Available collections # -# # KEY COLLECTION # -# # anidb AniDB Popular # -# # commonsense Common Sense Selected # -# # stevenlu StevenLu's Popular Movies # -# # pirated Top 10 Pirated Movies # -# # -# # Available options. Replace "key" with the # -# # desired collection's key from the chart above. # -# # -# # Customize summary of collection # -# summary_key: A collection of ... # -# # Turn the collection on/off # -# use_key: true # -# # Determines collection order in its section # -# order_key: # -# # Determines collection order of the collection # -# collection_order_key: custom # -# # Set visible_library for the collection # -# visible_library_key: # -# # Set visible_home for the collection # -# visible_home_key: # -# # Set visible_shared for the collection # -# visible_shared_key: # -# # Adds missing from the collection to radarr # -# radarr_add_missing_key: # -# # Adds missing from the collection to sonarr # -# sonarr_add_missing_key: # -# # Radarr Folder to add to # -# radarr_folder_key: # -# # Sonarr Folder to add to # -# sonarr_folder_key: # -# # Radarr Tag for added missing # -# radarr_tag_key: # -# # Sonarr Tag for added missing # -# sonarr_tag_key: # -# # Radarr Tag for existing items # -# item_radarr_tag_key: # -# # Sonarr Tag for existing items # -# item_sonarr_tag_key: # -############################################################# +############################################################################## +# Other Charts Collections # +# Created by Yozora, Bullmoose20, & Sohjiro # +# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # +# https://metamanager.wiki/en/latest/defaults/chart/other.html # +############################################################################## external_templates: pmm: templates diff --git a/defaults/chart/tautulli.yml b/defaults/chart/tautulli.yml index 8a275714..e6a83e75 100644 --- a/defaults/chart/tautulli.yml +++ b/defaults/chart/tautulli.yml @@ -1,53 +1,9 @@ -############################################################# -# Basic Tautulli Chart Collections # -# Created by Yozora, Bullmoose20, & Sohjiro # -############################################################# -# REQUIRES TAUTULLI AUTHENTICATION # -# https://metamanager.wiki/en/latest/config/tautulli.html # -# # -# Call this from your config.yml (Movie or Show) # -# If nothing is specified these are the defaults # -# # -# metadata_path: # -# - git: PMM/chart/tautulli # -# template_variables: # -# # Sets the collection mode of the collection # -# collection_mode: # -# # Sets the value at the start of the sort title # -# collection_section: "01" # -# # -# # For each collection use the "key" to set # -# # the options. # -# # Available collections # -# # KEY COLLECTION # -# # popular Plex Popular # -# # watched Plex Watched # -# # -# # Available options. Replace "key" with the # -# # desired collection's key from the chart above. # -# # -# # Customize summary of collection # -# summary_key: A collection of ... # -# # Turn the collection on/off # -# use_key: true # -# # Determines collection order in its section # -# order_key: # -# # Determines collection order of the collection # -# collection_order_key: custom # -# # Set visible_library for the collection # -# visible_library_key: # -# # Set visible_home for the collection # -# visible_home_key: # -# # Set visible_shared for the collection # -# visible_shared_key: # -# # Set list_days for the collection # -# list_days_key: 30 # -# # Set list_size for the collection # -# list_size_key: 20 # -# item_radarr_tag_key: # -# # Sonarr Tag for existing items # -# item_sonarr_tag_key: # -############################################################# +############################################################################## +# Tautulli Charts Collections # +# Created by Yozora, Bullmoose20, & Sohjiro # +# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # +# https://metamanager.wiki/en/latest/defaults/chart/tautulli.html # +############################################################################## external_templates: pmm: templates @@ -60,11 +16,13 @@ translations: templates: tautulli: default: - list_days_popular: 30 - list_size_popular: 20 + list_days: 30 + list_size: 20 + list_days_<>: <> + list_size_<>: <> tautulli_<>: - list_days: <> - list_size: <> + list_days: <>>> + list_size: <>>> list_buffer: 20 collections: diff --git a/defaults/chart/tmdb.yml b/defaults/chart/tmdb.yml index 76dfe0d9..1d954894 100644 --- a/defaults/chart/tmdb.yml +++ b/defaults/chart/tmdb.yml @@ -1,64 +1,9 @@ -############################################################# -# TMDb Chart Collections # -# Created by Yozora, Bullmoose20, & Sohjiro # -############################################################# -# Call this from your config.yml (Movie or Show) # -# If nothing is specified these are the defaults # -# # -# metadata_path: # -# - git: PMM/chart/tmdb # -# template_variables: # -# # Sets the collection mode of the collection # -# collection_mode: # -# # Sets the value at the start of the sort title # -# collection_section: "01" # -# # -# # For each collection use the "key" to set # -# # the options. # -# # Available collections # -# # KEY COLLECTION # -# # airing TMDb Airing Today # -# # air TMDb On The Air # -# # popular TMDb Popular # -# # top TMDb Top Rated # -# # trending TMDb Trending # -# # -# # Available options. Replace "key" with the # -# # desired collection's key from the chart above. # -# # -# # Customize summary of collection # -# summary_key: A collection of ... # -# # Turn the collection on/off # -# use_key: true # -# # Determines collection order in its section # -# order_key: # -# # Determines collection order of the collection # -# collection_order_key: custom # -# # Set visible_library for the collection # -# visible_library_key: # -# # Set visible_home for the collection # -# visible_home_key: # -# # Set visible_shared for the collection # -# visible_shared_key: # -# # Set limit for the collection # -# limit_key: 100 # -# # Adds missing from the collection to radarr # -# radarr_add_missing_key: # -# # Adds missing from the collection to sonarr # -# sonarr_add_missing_key: # -# # Radarr Folder to add to # -# radarr_folder_key: # -# # Sonarr Folder to add to # -# sonarr_folder_key: # -# # Radarr Tag for added missing # -# radarr_tag_key: # -# # Sonarr Tag for added missing # -# sonarr_tag_key: # -# # Radarr Tag for existing items # -# item_radarr_tag_key: # -# # Sonarr Tag for existing items # -# item_sonarr_tag_key: # -############################################################# +############################################################################## +# TMDb Charts Collections # +# Created by Yozora, Bullmoose20, & Sohjiro # +# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL # +# https://metamanager.wiki/en/latest/defaults/chart/tmdb.html # +############################################################################## external_templates: pmm: templates @@ -71,68 +16,69 @@ translations: templates: tmdb: default: - limit_<>: 100 + limit: 100 + limit_<>: <> chart: <> tmdb_<>: <>>> collections: - TMDb Airing Today: + TMDb Popular: variables: - key: airing + key: popular template: - name: tmdb - chart: airing_today - name: shared - allowed_libraries: show - name: arr - name: custom - name: translation - translation_key: tmdb_airing + translation_key: tmdb_popular - TMDb On The Air: + TMDb Top Rated: variables: - key: air + key: top template: - name: tmdb - chart: on_the_air + chart: top_rated - name: shared - allowed_libraries: show - name: arr - name: custom - name: translation - translation_key: tmdb_air + translation_key: tmdb_top - TMDb Popular: + TMDb Trending: variables: - key: popular + key: trending template: - name: tmdb + chart: trending_weekly - name: shared - name: arr - name: custom - name: translation - translation_key: tmdb_popular + translation_key: tmdb_trending - TMDb Top Rated: + TMDb Airing Today: variables: - key: top + key: airing template: - name: tmdb - chart: top_rated + chart: airing_today - name: shared + allowed_libraries: show - name: arr - name: custom - name: translation - translation_key: tmdb_top + translation_key: tmdb_airing - TMDb Trending: + TMDb On The Air: variables: - key: trending + key: air template: - name: tmdb - chart: trending_weekly + chart: on_the_air - name: shared + allowed_libraries: show - name: arr - name: custom - name: translation - translation_key: tmdb_trending \ No newline at end of file + translation_key: tmdb_air diff --git a/defaults/chart/trakt.yml b/defaults/chart/trakt.yml index 64589989..7598f7bd 100644 --- a/defaults/chart/trakt.yml +++ b/defaults/chart/trakt.yml @@ -74,7 +74,8 @@ translations: templates: trakt: default: - limit_<>: 100 + limit: 100 + limit_<>: <> trakt_chart: chart: <> limit: <>>> diff --git a/defaults/templates.yml b/defaults/templates.yml index f38562dd..f919c03d 100644 --- a/defaults/templates.yml +++ b/defaults/templates.yml @@ -73,6 +73,8 @@ templates: smart_filter: default: sort_by: release.desc + sort_by_<>: <> + limit_<>: <> search_value: <> optional: - tmdb_person @@ -82,8 +84,8 @@ templates: - type tmdb_person: <> smart_filter: - sort_by: <> - limit: <> + sort_by: <>>> + limit: <>>> type: <> any: <>: <> diff --git a/docs/defaults/award/bafta.md b/docs/defaults/award/bafta.md index 15267ec1..da004188 100644 --- a/docs/defaults/award/bafta.md +++ b/docs/defaults/award/bafta.md @@ -2,7 +2,7 @@ The `bafta` Metadata File is used to create collections based on the British Academy of Film and Television Arts Awards. -This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html) +This Default file requires [Trakt Authentication](../../config/trakt) This file only works with Movie Libraries. @@ -30,18 +30,18 @@ libraries: 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 just ignored. +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 | |:---------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `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.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order` | **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
| | `data` | **Description:** Changes the following values of the collection builder
Values:
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • 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
| -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/award/cannes.md b/docs/defaults/award/cannes.md index fc3e0441..49831d41 100644 --- a/docs/defaults/award/cannes.md +++ b/docs/defaults/award/cannes.md @@ -2,7 +2,7 @@ The `cannes` Metadata File is used to create collections based on the Cannes Film Awards. -This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html) +This Default file requires [Trakt Authentication](../../config/trakt) This file only works with Movie Libraries. @@ -30,18 +30,18 @@ libraries: 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 just ignored. +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 | |:---------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `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.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order` | **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
| | `data` | **Description:** Changes the following values of the collection builder
Values:
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • 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
| -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/award/choice.md b/docs/defaults/award/choice.md index c024f94f..5a375a92 100644 --- a/docs/defaults/award/choice.md +++ b/docs/defaults/award/choice.md @@ -2,7 +2,7 @@ The `choice` Metadata File is used to create collections based on the Critics Choice Awards. -This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html) +This Default file requires [Trakt Authentication](../../config/trakt) This file works with Movie and TV Libraries. @@ -32,18 +32,18 @@ libraries: 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 just ignored. +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 | |:---------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `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.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order` | **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
| | `data` | **Description:** Changes the following values of the collection builder
Values:
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • 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
| -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/award/emmy.md b/docs/defaults/award/emmy.md index a0fcdf9a..7815196e 100644 --- a/docs/defaults/award/emmy.md +++ b/docs/defaults/award/emmy.md @@ -30,18 +30,18 @@ libraries: 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 just ignored. +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 | |:---------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `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.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order` | **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
| | `data` | **Description:** Changes the following values of the collection builder
Values:
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • 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
| -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/award/golden.md b/docs/defaults/award/golden.md index 6d05fe37..b45d91da 100644 --- a/docs/defaults/award/golden.md +++ b/docs/defaults/award/golden.md @@ -2,7 +2,7 @@ The `golden` Metadata File is used to create collections based on the Golden Globe Awards. -The `Golden Globe Best Motion Pictures` only works with Movie Libraries but the year collections work with both Movie and TV libraries. +The `Golden Globe Best Motion Pictures` Collection only works with Movie Libraries but the year collections work with both Movie and TV libraries. The below YAML in your config.yml will create the collections: @@ -31,18 +31,18 @@ libraries: 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 just ignored. +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 | |:---------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `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.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order` | **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
| | `data` | **Description:** Changes the following values of the collection builder
Values:
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • 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
| -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/award/oscars.md b/docs/defaults/award/oscars.md index 61612644..194f7ea1 100644 --- a/docs/defaults/award/oscars.md +++ b/docs/defaults/award/oscars.md @@ -5,6 +5,7 @@ The `oscars` Metadata File is used to create collections based on the Academy Aw This file only works with Movie Libraries. The below YAML in your config.yml will create the collections: + ```yaml libraries: Movies: @@ -28,18 +29,18 @@ libraries: 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 just ignored. +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 | |:---------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `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.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order` | **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
| | `data` | **Description:** Changes the following values of the collection builder
Values:
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • 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
| -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/award/other.md b/docs/defaults/award/other.md index defbc1b8..808ae500 100644 --- a/docs/defaults/award/other.md +++ b/docs/defaults/award/other.md @@ -2,7 +2,7 @@ The `other_award` Metadata File is used to create collections based on numerous other awards. -This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html) +This Default file requires [Trakt Authentication](../../config/trakt) This file only works with Movie Libraries. @@ -32,14 +32,14 @@ libraries: 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 just ignored. +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 | -|:---------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| 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
| 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 39cecabb..fda37ea9 100644 --- a/docs/defaults/award/spirit.md +++ b/docs/defaults/award/spirit.md @@ -2,7 +2,7 @@ The `spirit` Metadata File is used to create collections based on the Independent Spirit Awards. -This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html) +This Default file requires [Trakt Authentication](../../config/trakt) This file only works with Movie Libraries. @@ -29,18 +29,18 @@ libraries: 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 just ignored. +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 | -|:---------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `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.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `data` | **Description:** Changes the following values of the collection builder
Values:
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • 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
| +| Variable | Description & Values | +|:---------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `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
| +| `data` | **Description:** Changes the following values of the collection builder
Values:
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • 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
| -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/award/sundance.md b/docs/defaults/award/sundance.md index 0bb64091..9507210f 100644 --- a/docs/defaults/award/sundance.md +++ b/docs/defaults/award/sundance.md @@ -2,7 +2,7 @@ The `sundance` Metadata File is used to create collections based on the Sundance Film Festival Awards. -This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html) +This Default file requires [Trakt Authentication](../../config/trakt) This file only works with Movie Libraries. @@ -30,18 +30,18 @@ libraries: 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 just ignored. +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 | |:---------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `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.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order` | **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
| | `data` | **Description:** Changes the following values of the collection builder
Values:
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-5
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • 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
| -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/both/actor.md b/docs/defaults/both/actor.md index 5f3d7644..512e932e 100644 --- a/docs/defaults/both/actor.md +++ b/docs/defaults/both/actor.md @@ -2,9 +2,7 @@ The `actor` Metadata File is used to dynamically create collections based on the most popular actors/actresses in your library. -Example Collections Created: - -![](../images/actor1.png) +This file works with Movie and TV Libraries. The below YAML in your config.yml will create the collections: ```yaml @@ -14,6 +12,16 @@ libraries: - pmm: actor ``` +## Collections + +| Collection | Key | Description | +|:-----------|:----------:|:------------------------------------------------------| +| `<>` | `<>` | Collection of Emmys Award Winners for the given year. | + +Example Collections Created: + +![](../images/actor1.png) + ## Rainier Style Below is a screenshot of the alternative `Rainier` style which can be set via template variables @@ -34,7 +42,7 @@ All [Shared Variables](../variables) are available as well as the additional Var | `data` | **Description:** Changes the following values of the collection builder
**Values:**
AttributeDescription & Values
depthControls the depth within the casting credits to search for common actors
Values: Number greater than 0		Default: 5
limitControls the maximum number of collections to create
Values: Number greater than 0		Default: 25
| -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/both/audio_language.md b/docs/defaults/both/audio_language.md index dbad0ca7..6d8a34b9 100644 --- a/docs/defaults/both/audio_language.md +++ b/docs/defaults/both/audio_language.md @@ -30,7 +30,7 @@ All [Shared Variables](../variables) are available as well as the additional Var | `append_include` | **Description:** Appends to the existing include list
**Values:** Any list of [two-digit ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) | | `append_exclude` | **Description:** Appends to the existing exclude list
**Values:** Any list of [two-digit ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) | -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/both/content_rating_cs.md b/docs/defaults/both/content_rating_cs.md index 5fa65573..70fedd00 100644 --- a/docs/defaults/both/content_rating_cs.md +++ b/docs/defaults/both/content_rating_cs.md @@ -34,7 +34,7 @@ All [Shared Variables](../variables) are available as well as the additional Var | `append_exclude` | **Description:** Appends to the existing exclude list
**Values:** Any Content Rating found in your library | | `append_addons` | **Description:** Appends to the existing addons list
**Values:** Any Content Rating found in your library | -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/both/content_rating_uk.md b/docs/defaults/both/content_rating_uk.md index 7409ec87..7e515830 100644 --- a/docs/defaults/both/content_rating_uk.md +++ b/docs/defaults/both/content_rating_uk.md @@ -34,7 +34,7 @@ All [Shared Variables](../variables) are available as well as the additional Var | `append_exclude` | **Description:** Appends to the existing exclude list
**Values:** Any Content Rating found in your library | | `append_addons` | **Description:** Appends to the existing addons list
**Values:** Any Content Rating found in your library | -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/both/genre.md b/docs/defaults/both/genre.md index 0bead311..701b7862 100644 --- a/docs/defaults/both/genre.md +++ b/docs/defaults/both/genre.md @@ -34,7 +34,7 @@ All [Shared Variables](../variables) are available as well as the additional Var | `append_exclude` | **Description:** Appends to the existing exclude list
**Values:** Any Genre found in your library | | `append_addons` | **Description:** Appends to the existing addons list
**Values:** Any Genre found in your library | -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/both/resolution.md b/docs/defaults/both/resolution.md index 5c0d3862..f135737a 100644 --- a/docs/defaults/both/resolution.md +++ b/docs/defaults/both/resolution.md @@ -34,7 +34,7 @@ All [Shared Variables](../variables) are available as well as the additional Var | `append_exclude` | **Description:** Appends to the existing exclude list
**Values:** Any Resolution found in your library | | `append_addons` | **Description:** Appends to the existing addons list
**Values:** Any Resolution found in your library | -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/both/resolution_standards.md b/docs/defaults/both/resolution_standards.md index 2f86bf59..198af34f 100644 --- a/docs/defaults/both/resolution_standards.md +++ b/docs/defaults/both/resolution_standards.md @@ -36,7 +36,7 @@ All [Shared Variables](../variables) are available as well as the additional Var | `append_exclude` | **Description:** Appends to the existing exclude list
**Values:** Any Resolution found in your library | | `append_addons` | **Description:** Appends to the existing addons list
**Values:** Any Resolution found in your library | -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/both/streaming.md b/docs/defaults/both/streaming.md index a8cbda37..c199fb01 100644 --- a/docs/defaults/both/streaming.md +++ b/docs/defaults/both/streaming.md @@ -40,7 +40,7 @@ All [Shared Variables](../variables) are available using the below keys. | paramount | Paramount+ | | peacock | Peacock | -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/both/studio.md b/docs/defaults/both/studio.md index fc54b132..babc81b5 100644 --- a/docs/defaults/both/studio.md +++ b/docs/defaults/both/studio.md @@ -34,7 +34,7 @@ All [Shared Variables](../variables) are available as well as the additional Var | `append_exclude` | **Description:** Appends to the existing exclude list
**Values:** Any Studio found in your library | | `append_addons` | **Description:** Appends to the existing addons list
**Values:** Any Studio found in your library | -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/both/subtitle_language.md b/docs/defaults/both/subtitle_language.md index 38b4b098..f40b43f2 100644 --- a/docs/defaults/both/subtitle_language.md +++ b/docs/defaults/both/subtitle_language.md @@ -30,7 +30,7 @@ All [Shared Variables](../variables) are available as well as the additional Var | `append_include` | **Description:** Appends to the existing include list
**Values:** Any list of [two-digit ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) | | `append_exclude` | **Description:** Appends to the existing exclude list
**Values:** Any list of [two-digit ISO 639-1 codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) | -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/both/year.md b/docs/defaults/both/year.md index 31c35169..3ec7489d 100644 --- a/docs/defaults/both/year.md +++ b/docs/defaults/both/year.md @@ -24,11 +24,11 @@ All [Shared Variables](../variables) are available as well as the additional Var | Variable | Description & Values | |:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `collection_order` | **Description:** Changes the Collection Order
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| `collection_order` | **Description:** Changes the 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:** Changes the following values of the collection builder
**Values:**
AttributeDescription & Values
startingControls the starting year for collections
Values: Number greater than 0		Default: current_year-10
endingControls the ending year for collections
Values: Number greater than 1		Default: current_year
incrementControls the incriment (i.e. every 5th year)
Values: Number greater than 0		Default: 1
  • 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
| -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/chart/anilist.md b/docs/defaults/chart/anilist.md index 93fbd9e8..3825b154 100644 --- a/docs/defaults/chart/anilist.md +++ b/docs/defaults/chart/anilist.md @@ -1,4 +1,4 @@ -# Anilist Chart Default Metadata File +# Anilist Charts Default Metadata File The `anilist` Metadata File is used to create collections based on Anilist charts. @@ -20,8 +20,8 @@ libraries: | Collection | Key | Description | |:--------------------|:----------:|:-----------------------------------------------------| -| `AniList Popular` | `popular` | Collection of the most Popular Anime on AniList. | -| `AniList Top Rated` | `top` | Collection of the Top Rated Anime on AniList. | +| `AniList Popular` | `popular` | Collection of the most Popular Anime on AniList. | +| `AniList Top Rated` | `top` | Collection of the Top Rated Anime on AniList. | | `AniList Trending` | `trending` | Collection of the Trending Anime on AniList. | | `AniList Season` | `season` | Collection of the Current Season's Anime on AniList. | @@ -33,18 +33,18 @@ libraries: 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 just ignored. +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 | -|:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `limit` | **Description:** Changes the number of items in a collection for all collections in a Defaults file.
**Values:** Number greater then 0 | -| `limit_<>` | **Description:** Changes the number of items in a collection 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.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| -| `collection_order_<>` | **Description:** Changes the Collection Order of the specified key's Collection.
**Values:**
`release`Order Collection by Release Dates
`alpha`Order Collection Alphabetically
`custom`Order Collection Via the Builder Order
[Any `plex_search` Sort Option](../builders/plex.md#sort-options)Order Collection by any `plex_search` Sort Option
| +| 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 | +| `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
| -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/chart/basic.md b/docs/defaults/chart/basic.md index e4665cb7..18201894 100644 --- a/docs/defaults/chart/basic.md +++ b/docs/defaults/chart/basic.md @@ -1,55 +1,51 @@ -# Basic Chart Default Metadata File +# Basic Charts Default Metadata File The `basic` Metadata File is used to create collections based on recently released media in your library. -Example Collections Created: - -![](../images/basic.png) +This file works with Movie and TV Libraries. The below YAML in your config.yml will create the collections: + ```yaml libraries: Movies: metadata_path: - pmm: basic + TV Shows: + metadata_path: + - pmm: basic ``` +## Collections -## 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. +| Collection | Key | Description | +|:-----------------|:----------:|:---------------------------------------------------------------| +| `Newly Released` | `released` | Collection of Movies or TV Shows released in the last 90 days. | +| `New Episodes` | `episodes` | Collection of Episodes released in the last 7 days. | -As this file is more complex than others, a key system is used to control each collection that is created by the file. Each key refers to one chart and is used to control multiple template variables. +### Examples -Below are the keys and what they refer to: +Example Collections Created: -| Key | Chart | -|:---------|:---------------| -| released | Newly Released | -| episodes | New Episodes | +![](../images/basic.png) +## Template Variables +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. -Below are the available variables which can be used to customize the file. Note that any use of `key` within the variable should be replaced with the `key` from the above table (i.e. `use_episodes` instead of `use_key`, `order_released` instead of `order_key`) +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 | Usage | Default Value | Values | -|:-----------------------|:-------------------------------------------------------------------------------|--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| use_key | Turn the collection on/off | `true` | `true` or `false` | -| order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_released` to put released first in the list of charts) | -| summary_key | Determines summary of collection | | Any summary text | -| limit_key | Determines limit of collection | `100` | Any number | -| collection_order | Determines collection order of the collection | | | -| visible_library_key | Set visible_library for the collection | `false` | `true` or `false` | -| visible_home_key | Set visible_home for the collection | `false` | `true` or `false` | -| visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` | -| item_sonarr_tag_key | Sonarr Tag for existing items | `false` | Tag(s) to add to existing items | -| item_radarr_tag_key | Radarr Tag for existing items | | Tag(s) to add to existing items | -| collection_section | Controls the sort order of these collections against other default collections | `01` | Any number | -| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`show_items` - Show this Collection and its Items | +| 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 | +| `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) | +| `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 changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: @@ -58,14 +54,8 @@ libraries: - pmm: basic template_variables: use_released: false - order_released: 01 - summary_released: "Newly Released items" - limit_released: 10 + in_the_last_episodes: 14 visible_library_released: true visible_home_released: true visible_shared_released: true - item_sonarr_tag_released: New Episodes - item_radarr_tag_season: Newly Released - collection_section: 09 - collection_mode: show_items ``` diff --git a/docs/defaults/chart/flixpatrol.md b/docs/defaults/chart/flixpatrol.md new file mode 100644 index 00000000..5bbec2d3 --- /dev/null +++ b/docs/defaults/chart/flixpatrol.md @@ -0,0 +1,63 @@ +# FlixPatrol Charts Default Metadata File + +The `flixpatrol` Metadata File is used to create collections based on FlixPatrol Charts. + +The `IMDb Lowest Rated` Collection only works with Movie Libraries but the rest of the collections work with both Movie and TV libraries. + +The below YAML in your config.yml will create the collections: + +```yaml +libraries: + Movies: + metadata_path: + - pmm: flixpatrol + TV Shows: + metadata_path: + - pmm: flixpatrol +``` + +## Collections + +| Collection | Key | Description | +|:------------------------------------|:-----------:|:------------------------------------------------------------------------------| +| `Netflix Top 10 Moves/Shows` | `netflix` | Collection of the Top Movies/Shows on Netflix according to FlixPatrol. | +| `Disney Top 10 Moves/Shows` | `disney` | Collection of the Top Movies/Shows on Disney Plus according to FlixPatrol. | +| `HBO Top 10 Moves/Shows` | `hbo` | Collection of the Top Movies/Shows on HBO according to FlixPatrol. | +| `Hulu Top 10 Moves/Shows` | `hulu` | Collection of the Top Movies/Shows on Hulu according to FlixPatrol. | +| `Paramount Plus Top 10 Moves/Shows` | `paramount` | Collection of the Top Movies/Shows on Paramount Plus according to FlixPatrol. | +| `Prime Video Top 10 Moves/Shows` | `prime` | Collection of the Top Movies/Shows on Prime Video according to FlixPatrol. | + +### Examples + +![](../images/flixpatrol.png) + +## Template Variables + +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 | +|:---------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `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 | +| `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) | +| `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) | +| `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
| + +The below is an example config.yml extract with some Template Variables added in to change how the file works. + +```yaml +libraries: + Movies: + metadata_path: + - pmm: flixpatrol + template_variables: + location: united_states + time_window: last_month +``` diff --git a/docs/defaults/chart/imdb.md b/docs/defaults/chart/imdb.md index f701096d..b745c303 100644 --- a/docs/defaults/chart/imdb.md +++ b/docs/defaults/chart/imdb.md @@ -1,62 +1,47 @@ -# IMDb Chart Default Metadata File +# IMDb Charts Default Metadata File The `imdb` Metadata File is used to create collections based on IMDb Charts. -Example Collections Created: - -![](../images/imdb.png) +The `IMDb Lowest Rated` Collection only works with Movie Libraries but the rest of the collections work with both Movie and TV libraries. The below YAML in your config.yml will create the collections: + ```yaml libraries: Movies: metadata_path: - pmm: imdb + TV Shows: + metadata_path: + - pmm: imdb ``` +## Collections -## 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. - -As this file is more complex than others, a key system is used to control each collection that is created by the file. Each key refers to one imdb chart and is used to control multiple template variables. +| Collection | Key | Description | +|:--------------------|:---------:|:-----------------------------------------------------| +| `IMDb Popular` | `popular` | Collection of the most Popular Movies/Shows on IMDb. | +| `IMDb Top 250` | `top` | Collection of Top 250 Movies/Shows on IMDb. | +| `IMDb Lowest Rated` | `lowest` | Collection of the lowest Rated Movies on IMDb. | -Below are the keys and what they refer to: +### Examples -| Key | Chart | -|:--------|:------------------| -| popular | IMDb Popular | -| top | IMDb Top 250 | -| lowest | IMDb Lowest Rated | +![](../images/imdb.png) +## Template Variables +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. -Below are the available variables which can be used to customize the file. Note that any use of `key` within the variable should be replaced with the `key` from the above table (i.e. `use_top` instead of `use_key`, `order_popular` instead of `order_key`) +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 | Usage | Default Value | Values | -|:-----------------------|:-------------------------------------------------------------------------------|--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| use_key | Turn the collection on/off | `true` | `true` or `false` | -| order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_popular` to put popular first in the list of imdb charts) | -| summary_key | Determines summary of collection | | Any summary text | -| limit_key | Determines limit of collection | `100` | Any number | -| collection_order | Determines collection order of the collection | | | -| visible_library_key | Set visible_library for the collection | `false` | `true` or `false` | -| visible_home_key | Set visible_home for the collection | `false` | `true` or `false` | -| visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` | -| sonarr_add_missing_key | Adds missing from the collection to sonarr | `false` | `true` or `false` | -| sonarr_folder_key | Sonarr Folder to add to | | Folder to add missing items to | -| sonarr_tag_key | Sonarr Tag for added missing | | Tag(s) to add to missing items | -| item_sonarr_tag_key | Sonarr Tag for existing items | `false` | Tag(s) to add to existing items | -| radarr_add_missing_key | Adds missing from the collection to radarr | | `true` or `false` | -| radarr_folder_key | Radarr Folder to add to | | Folder to add missing items to | -| radarr_tag_key | Radarr Tag for added missing | | Tag(s) to add to missing items | -| item_radarr_tag_key | Radarr Tag for existing items | | Tag(s) to add to existing items | -| collection_section | Controls the sort order of these collections against other default collections | `01` | Any number | -| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`show_items` - Show this Collection and its Items | +| 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
| -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: @@ -65,14 +50,7 @@ libraries: - pmm: imdb template_variables: use_popular: false - order_popular: 01 - summary_popular: "Popular movies on IMDb right now" - limit_popular: 10 - visible_library_popular: true - visible_home_popular: true - visible_shared_popular: true - item_sonarr_tag_popular: New Episodes - item_radarr_tag_season: Newly popular - collection_section: 09 - collection_mode: show_items + visible_library_top: true + visible_home_top: true + visible_shared_top: true ``` diff --git a/docs/defaults/chart/myanimelist.md b/docs/defaults/chart/myanimelist.md index 946a388e..fae22f6e 100644 --- a/docs/defaults/chart/myanimelist.md +++ b/docs/defaults/chart/myanimelist.md @@ -1,64 +1,51 @@ -# MyAnimeList Chart Default Metadata File +# MyAnimeList Charts Default Metadata File The `myanimelist` Metadata File is used to create collections based on MyAnimeList Charts. -Example Collections Created: - -![](../images/myanimelist.png) +This file works with Movie and TV Libraries. The below YAML in your config.yml will create the collections: + ```yaml libraries: Movies: metadata_path: - pmm: myanimelist + TV Shows: + metadata_path: + - pmm: myanimelist ``` +## Collections -## 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. - -As this file is more complex than others, a key system is used to control each collection that is created by the file. Each key refers to one MyAnimeList chart and is used to control multiple template variables. +| Collection | Key | Description | +|:-------------------------|:-----------:|:--------------------------------------------------------| +| `MyAnimeList Popular` | `popular` | Collection of the most Popular Anime on MyAnimeList. | +| `MyAnimeList Favorited` | `favorited` | Collection of most Favorited Anime on MyAnimeList. | +| `MyAnimeList Top Rated` | `top` | Collection of the Top Rated Anime on MyAnimeList. | +| `MyAnimeList Top Airing` | `airing` | Collection of the Top Rated Airing on MyAnimeList. | +| `MyAnimeList Season` | `season` | Collection of the Current Seasons Anime on MyAnimeList. | -Below are the keys and what they refer to: +### Examples -| Key | Chart | -|:----------|:-----------------------| -| airing | MyAnimeList Top Airing | -| favorited | MyAnimeList Favorited | -| popular | MyAnimeList Popular | -| season | MyAnimeList Season | -| top | MyAnimeList Top Rated | +![](../images/myanimelist.png) +## Template Variables +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. -Below are the available variables which can be used to customize the file. Note that any use of `key` within the variable should be replaced with the `key` from the above table (i.e. `use_season` instead of `use_key`, `order_popular` instead of `order_key`) +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 | Usage | Default Value | Values | -|:-----------------------|:-------------------------------------------------------------------------------|--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| use_key | Turn the collection on/off | `true` | `true` or `false` | -| order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_popular` to put popular first in the list of myanimelist charts) | -| summary_key | Determines summary of collection | | Any summary text | -| limit_key | Determines limit of collection | `100` | Any number | -| collection_order | Determines collection order of the collection | | | -| visible_library_key | Set visible_library for the collection | `false` | `true` or `false` | -| visible_home_key | Set visible_home for the collection | `false` | `true` or `false` | -| visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` | -| sonarr_add_missing_key | Adds missing from the collection to sonarr | `false` | `true` or `false` | -| sonarr_folder_key | Sonarr Folder to add to | | Folder to add missing items to | -| sonarr_tag_key | Sonarr Tag for added missing | | Tag(s) to add to missing items | -| item_sonarr_tag_key | Sonarr Tag for existing items | `false` | Tag(s) to add to existing items | -| radarr_add_missing_key | Adds missing from the collection to radarr | | `true` or `false` | -| radarr_folder_key | Radarr Folder to add to | | Folder to add missing items to | -| radarr_tag_key | Radarr Tag for added missing | | Tag(s) to add to missing items | -| item_radarr_tag_key | Radarr Tag for existing items | | Tag(s) to add to existing items | -| collection_section | Controls the sort order of these collections against other default collections | `01` | Any number | -| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`show_items` - Show this Collection and its Items | +| 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 | +| `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
| -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: @@ -66,15 +53,10 @@ libraries: metadata_path: - pmm: myanimelist template_variables: - use_popular: false + use_season: false order_popular: 01 - summary_popular: "Popular movies on myanimelist right now" - limit_popular: 10 + limit_popular: 20 visible_library_popular: true visible_home_popular: true visible_shared_popular: true - item_sonarr_tag_popular: New Episodes - item_radarr_tag_season: Newly popular - collection_section: 09 - collection_mode: show_items ``` diff --git a/docs/defaults/chart/other.md b/docs/defaults/chart/other.md index 1ef02a8b..c6eff0be 100644 --- a/docs/defaults/chart/other.md +++ b/docs/defaults/chart/other.md @@ -1,59 +1,49 @@ -# Other Chart Default Metadata File +# Other Charts Default Metadata File The `other_chart` Metadata File is used to create collections based on other Charts. -Example Collections Created: - -![](../images/chartother.png) +The `StevenLu's Popular Movies` and `Top 10 Pirated Movies of the Week` Collections only work with Movie Libraries but the rest of the collections work with both Movie and TV libraries. The below YAML in your config.yml will create the collections: + ```yaml libraries: Movies: metadata_path: - pmm: other_chart + TV Shows: + metadata_path: + - pmm: other_chart ``` -## Template Variables -Template Variables can be used to manipulate the file from the default settings which are provided. +## Collections + +| Collection | Key | Description | +|:------------------------------------|:-------------:|:-----------------------------------------------------| +| `AniDB Popular` | `anidb` | Collection of the most Popular Anime on AniDB. | +| `Common Sense Selection` | `commonsense` | Collection of Common Sense Selection Movies/Shows. | +| `StevenLu's Popular Movies` | `stevenlu` | Collection of StevenLu's Popular Movies. | +| `Top 10 Pirated Movies of the Week` | `pirated` | Collection of the Top 10 Pirated Movies of the Week. | -Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings. +### Examples -As this file is more complex than others, a key system is used to control each collection that is created by the file. Each key refers to one chart and is used to control multiple template variables. +![](../images/chartother.png) -Below are the keys and what they refer to: +## Template Variables -| Key | Chart | -|:------------|:--------------------------| -| anidb | AniDB Popular | -| commonsense | Common Sense Selection | -| stevenlu | StevenLu's Popular Movies | -| pirated | Top 10 Pirated Movies | +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. -Below are the available variables which can be used to customize the file. Note that any use of `key` within the variable should be replaced with the `key` from the above table (i.e. `use_commonsense` instead of `use_key`, `order_anidb` instead of `order_key`) +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 | Usage | Default Value | Values | -|:-----------------------|:-------------------------------------------------------------------------------|--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| use_key | Turn the collection on/off | `true` | `true` or `false` | -| order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_commonsense` to put commonsense first in the list of other charts) | -| summary_key | Determines summary of collection | | Any summary text | -| collection_order | Determines collection order of the collection | | | -| visible_library_key | Set visible_library for the collection | `false` | `true` or `false` | -| visible_home_key | Set visible_home for the collection | `false` | `true` or `false` | -| visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` | -| sonarr_add_missing_key | Adds missing from the collection to sonarr | `false` | `true` or `false` | -| sonarr_folder_key | Sonarr Folder to add to | | Folder to add missing items to | -| sonarr_tag_key | Sonarr Tag for added missing | | Tag(s) to add to missing items | -| item_sonarr_tag_key | Sonarr Tag for existing items | `false` | Tag(s) to add to existing items | -| radarr_add_missing_key | Adds missing from the collection to radarr | | `true` or `false` | -| radarr_folder_key | Radarr Folder to add to | | Folder to add missing items to | -| radarr_tag_key | Radarr Tag for added missing | | Tag(s) to add to missing items | -| item_radarr_tag_key | Radarr Tag for existing items | | Tag(s) to add to existing items | -| collection_section | Controls the sort order of these collections against other default collections | `01` | Any number | -| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`show_items` - Show this Collection and its Items | +| Variable | Description & Values | +|:---------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `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
| -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: @@ -61,14 +51,8 @@ libraries: metadata_path: - pmm: other_chart template_variables: - use_commonsense: false - order_commonsense: 01 - summary_commonsense: "Common Sense Selection" + use_anidb: false visible_library_commonsense: true visible_home_commonsense: true visible_shared_commonsense: true - item_sonarr_tag_commonsense: New Episodes - item_radarr_tag_season: Newly commonsense - collection_section: 09 - collection_mode: show_items ``` diff --git a/docs/defaults/chart/tautulli.md b/docs/defaults/chart/tautulli.md index 500661d2..4b18966a 100644 --- a/docs/defaults/chart/tautulli.md +++ b/docs/defaults/chart/tautulli.md @@ -1,55 +1,52 @@ -# Tautulli Chart Default Metadata File +# Tautulli Charts Default Metadata File The `tautulli` Metadata File is used to create collections based on Tautulli/Plex Charts. -Example Collections Created: +This Default file requires [Tautulli Authentication](../../config/tautulli) -![](../images/tautulli.png) +This file works with Movie and TV Libraries. The below YAML in your config.yml will create the collections: + ```yaml libraries: Movies: metadata_path: - pmm: tautulli + TV Shows: + metadata_path: + - pmm: tautulli ``` -## Template Variables -Template Variables can be used to manipulate the file from the default settings which are provided. +## Collections -Note that the `templates_variables:` section only needs to be used if you do NOT want to use the default settings. +| Collection | Key | Description | +|:---------------|:---------:|:-----------------------------------------------------| +| `Plex Popular` | `popular` | Collection of the most Popular Movies/Shows on Plex. | +| `Plex Watched` | `watched` | Collection of the most Watched Movies/Shows on Plex. | -As this file is more complex than tautullis, a key system is used to control each collection that is created by the file. Each key refers to one chart and is used to control multiple template variables. +### Examples -Below are the keys and what they refer to: +![](../images/tautulli.png) -| Key | Chart | -|:---------|:-------------| -| popular | Plex Popular | -| watched | Plex Watched | +## Template Variables +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. -Below are the available variables which can be used to customize the file. Note that any use of `key` within the variable should be replaced with the `key` from the above table (i.e. `use_watched` instead of `use_key`, `order_watched` instead of `order_key`) +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 | Usage | Default Value | Values | -|:-----------------------|:----------------------------------------------------------------------------------|--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| use_key | Turn the collection on/off | `true` | `true` or `false` | -| order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_watched` to put watched first in the list of tautulli charts) | -| summary_key | Determines summary of collection | | Any summary text | -| limit_key | Determines limit of collection | `100` | Any number | -| list_days_key | Set list_days for the collection | `30` | Any number | -| list_size_key | Set list_size for the collection | `20` | Any number | -| collection_order | Determines collection order of the collection | | | -| visible_library_key | Set visible_library for the collection | `false` | `true` or `false` | -| visible_home_key | Set visible_home for the collection | `false` | `true` or `false` | -| visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` | -| item_sonarr_tag_key | Sonarr Tag for existing items | `false` | Tag(s) to add to existing items | -| item_radarr_tag_key | Radarr Tag for existing items | | Tag(s) to add to existing items | -| collection_section | Controls the sort order of these collections against tautulli default collections | `01` | Any number | -| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`show_items` - Show this Collection and its Items | +| 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_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 | +| `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
| -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: @@ -58,15 +55,9 @@ libraries: - pmm: tautulli template_variables: use_watched: false - order_watched: 01 - summary_watched: "Things that have been watched on Plex in the past 7 days" - list_days_watched: 7 - list_size_watched: 10 + list_days_popular: 7 + list_size_popular: 10 visible_library_watched: true visible_home_watched: true visible_shared_watched: true - item_sonarr_tag_watched: Plex Watched - item_radarr_tag_season: Plex Watched - collection_section: 09 - collection_mode: show_items ``` diff --git a/docs/defaults/chart/tmdb.md b/docs/defaults/chart/tmdb.md index 1fe34c6f..fcfdfc6e 100644 --- a/docs/defaults/chart/tmdb.md +++ b/docs/defaults/chart/tmdb.md @@ -1,64 +1,51 @@ -# TMDb Chart Default Metadata File +# TMDb Charts Default Metadata File The `tmdb` Metadata File is used to create collections based on TMDb Charts. -Example Collections Created: - -![](../images/tmdb.png) +The `TMDb Airing Today` and `TMDb On The Air` Collections only work with TV Libraries but the rest of the collections work with both Movie and TV libraries. The below YAML in your config.yml will create the collections: + ```yaml libraries: Movies: metadata_path: - pmm: tmdb + TV Shows: + metadata_path: + - pmm: tmdb ``` +## Collections -## 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. - -As this file is more complex than others, a key system is used to control each collection that is created by the file. Each key refers to one tmdb chart and is used to control multiple template variables. +| Collection | Key | Description | +|:--------------------|:----------:|:-----------------------------------------------------| +| `TMDb Popular` | `popular` | Collection of the Most Popular Movies/Shows on TMDb. | +| `TMDb Top Rated` | `top` | Collection of the Top Rated Movies/Shows on TMDb. | +| `TMDb Trending` | `trending` | Collection of Trending Movies/Shows on TMDb. | +| `TMDb Airing Today` | `airing` | Collection of Shows Airing Today on TMDb. | +| `TMDb On The Air` | `air` | Collection of Shows currently On The Air on TMDb. | -Below are the keys and what they refer to: +### Examples -| Key | Chart | -|:---------|:------------------| -| air | TMDb On The Air | -| airing | TMDb Airing Today | -| popular | TMDb Popular | -| top | TMDb Top Rated | -| trending | TMDb Trending | +![](../images/tmdb.png) +## Template Variables +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. -Below are the available variables which can be used to customize the file. Note that any use of `key` within the variable should be replaced with the `key` from the above table (i.e. `use_top` instead of `use_key`, `order_popular` instead of `order_key`) +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 | Usage | Default Value | Values | -|:-----------------------|:-------------------------------------------------------------------------------|--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| use_key | Turn the collection on/off | `true` | `true` or `false` | -| order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_popular` to put popular first in the list of tmdb charts) | -| summary_key | Determines summary of collection | | Any summary text | -| limit_key | Determines limit of collection | `100` | Any number | -| collection_order | Determines collection order of the collection | | | -| visible_library_key | Set visible_library for the collection | `false` | `true` or `false` | -| visible_home_key | Set visible_home for the collection | `false` | `true` or `false` | -| visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` | -| sonarr_add_missing_key | Adds missing from the collection to sonarr | `false` | `true` or `false` | -| sonarr_folder_key | Sonarr Folder to add to | | Folder to add missing items to | -| sonarr_tag_key | Sonarr Tag for added missing | | Tag(s) to add to missing items | -| item_sonarr_tag_key | Sonarr Tag for existing items | `false` | Tag(s) to add to existing items | -| radarr_add_missing_key | Adds missing from the collection to radarr | | `true` or `false` | -| radarr_folder_key | Radarr Folder to add to | | Folder to add missing items to | -| radarr_tag_key | Radarr Tag for added missing | | Tag(s) to add to missing items | -| item_radarr_tag_key | Radarr Tag for existing items | | Tag(s) to add to existing items | -| collection_section | Controls the sort order of these collections against other default collections | `01` | Any number | -| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`show_items` - Show this Collection and its Items | +| 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 | +| `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
| -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: @@ -66,15 +53,9 @@ libraries: metadata_path: - pmm: tmdb template_variables: - use_popular: false - order_popular: 01 - summary_popular: "Popular movies on TMDb right now" - limit_popular: 10 + use_trending false + limit_popular: 20 visible_library_popular: true visible_home_popular: true visible_shared_popular: true - item_sonarr_tag_popular: New Episodes - item_radarr_tag_season: Newly popular - collection_section: 09 - collection_mode: show_items ``` diff --git a/docs/defaults/chart/trakt.md b/docs/defaults/chart/trakt.md index 010c9cca..9687cf16 100644 --- a/docs/defaults/chart/trakt.md +++ b/docs/defaults/chart/trakt.md @@ -1,10 +1,8 @@ -# Trakt Chart Default Metadata File +# Trakt Charts Default Metadata File The `trakt` Metadata File is used to create collections based on Trakt Charts. -Example Collections Created: - -![](../images/trakt.png) +This file works with Movie and TV Libraries. The below YAML in your config.yml will create the collections: ```yaml @@ -14,51 +12,36 @@ libraries: - pmm: trakt ``` +## Collections -## 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. +| Collection | Key | Description | +|:--------------------|:-------------:|:--------------------------------------------------------| +| `Trakt Collected` | `collected` | Collection of the Most Collected Movies/Shows on Trakt. | +| `Trakt Popular` | `popular` | Collection of the Most Popular Movies/Shows on Trakt. | +| `Trakt Recommended` | `recommended` | Collection of Recommended Movies/Shows on Trakt. | +| `Trakt Trending` | `trending` | Collection of Trending Movies/Shows on Trakt. | +| `Trakt Watched` | `watched` | Collection of the Most Watched Movies/Shows on Trakt. | -As this file is more complex than others, a key system is used to control each collection that is created by the file. Each key refers to one trakt chart and is used to control multiple template variables. +### Examples -Below are the keys and what they refer to: - -| Key | Chart | -|:------------|:------------------| -| collected | Trakt Collected | -| popular | Trakt Popular | -| recommended | Trakt Recommended | -| trending | Trakt Trending | -| watched | Trakt Watched | +![](../images/trakt.png) +## Template Variables +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. -Below are the available variables which can be used to customize the file. Note that any use of `key` within the variable should be replaced with the `key` from the above table (i.e. `use_watched` instead of `use_key`, `order_popular` instead of `order_key`) +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 | Usage | Default Value | Values | -|:-----------------------|:-------------------------------------------------------------------------------|--------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| use_key | Turn the collection on/off | `true` | `true` or `false` | -| order_key | Determine collection order in its section | Alphabetical Order | Any number (i.e. `01` for `order_popular` to put popular first in the list of trakt charts) | -| summary_key | Determines summary of collection | | Any summary text | -| limit_key | Determines limit of collection | `100` | Any number | -| collection_order | Determines collection order of the collection | | | -| visible_library_key | Set visible_library for the collection | `false` | `true` or `false` | -| visible_home_key | Set visible_home for the collection | `false` | `true` or `false` | -| visible_shared_key | Set visible_shared for the collection | `false` | `true` or `false` | -| sonarr_add_missing_key | Adds missing from the collection to sonarr | `false` | `true` or `false` | -| sonarr_folder_key | Sonarr Folder to add to | | Folder to add missing items to | -| sonarr_tag_key | Sonarr Tag for added missing | | Tag(s) to add to missing items | -| item_sonarr_tag_key | Sonarr Tag for existing items | `false` | Tag(s) to add to existing items | -| radarr_add_missing_key | Adds missing from the collection to radarr | | `true` or `false` | -| radarr_folder_key | Radarr Folder to add to | | Folder to add missing items to | -| radarr_tag_key | Radarr Tag for added missing | | Tag(s) to add to missing items | -| item_radarr_tag_key | Radarr Tag for existing items | | Tag(s) to add to existing items | -| collection_section | Controls the sort order of these collections against other default collections | `01` | Any number | -| collection_mode | Controls the collection mode of these collections | `default` | `default` - Library default
`hide` - Hide Collection
`hide_items`- Hide Items in this Collection
`show_items` - Show this Collection and its Items | +| 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 | +| `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
| -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: @@ -66,15 +49,11 @@ libraries: metadata_path: - pmm: trakt template_variables: - use_popular: false - order_popular: 01 - summary_popular: "Popular movies on Trakt right now" - limit_popular: 10 + use_collected: false + use_recommended: false + use_watched: false + limit: 20 visible_library_popular: true visible_home_popular: true visible_shared_popular: true - item_sonarr_tag_popular: New Episodes - item_radarr_tag_season: Newly popular - collection_section: 09 - collection_mode: show_items ``` diff --git a/docs/defaults/files.md b/docs/defaults/files.md index 341a13c4..8a8355fe 100644 --- a/docs/defaults/files.md +++ b/docs/defaults/files.md @@ -67,7 +67,7 @@ It should be noted that when an overlay has ❗ for a season or episode, it In the scenario where there is missing data such as age ratings for episodes, then generally the highest-level data available will be applied at the lower level (i.e. a Show's CommonSense age rating would apply to all episodes). -These overlays are applied by calling the below paths into the `overlay_path:` [section](https://metamanager.wiki/en/nightly/config/libraries.html#overlay-path) of your config.yml +These overlays are applied by calling the below paths into the `overlay_path:` [section](../config/libraries.md#overlay-path) of your config.yml ### Overlay Files diff --git a/docs/defaults/movie/content_rating_us.md b/docs/defaults/movie/content_rating_us.md index e3a91fea..3fa8ae37 100644 --- a/docs/defaults/movie/content_rating_us.md +++ b/docs/defaults/movie/content_rating_us.md @@ -34,7 +34,7 @@ All [Shared Variables](../variables) are available as well as the additional Var | `append_exclude` | **Description:** Appends to the existing exclude list
**Values:** Any Content Rating found in your library | | `append_addons` | **Description:** Appends to the existing addons list
**Values:** Any Content Rating found in your library | -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/movie/country.md b/docs/defaults/movie/country.md index e7c66d77..f15493b0 100644 --- a/docs/defaults/movie/country.md +++ b/docs/defaults/movie/country.md @@ -35,7 +35,7 @@ All [Shared Variables](../variables) are available as well as the additional Var | `append_exclude` | **Description:** Appends to the existing exclude list
**Values:** Any Content Rating found in your library | | `append_addons` | **Description:** Appends to the existing addons list
**Values:** Any Content Rating found in your library | -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/movie/decade.md b/docs/defaults/movie/decade.md index 61c8bb64..80b5f150 100644 --- a/docs/defaults/movie/decade.md +++ b/docs/defaults/movie/decade.md @@ -26,7 +26,7 @@ All [Shared Variables](../variables) are available as well as the additional Var |:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `sort_by` | **Description:** Controls the sort method for the collections
**Values:** Any sort method in the [Sorts Options Table](#sort-options) | -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml diff --git a/docs/defaults/movie/director.md b/docs/defaults/movie/director.md index e253c120..a95a1986 100644 --- a/docs/defaults/movie/director.md +++ b/docs/defaults/movie/director.md @@ -35,7 +35,7 @@ All [Shared Variables](../variables) are available as well as the additional Var | `data` | **Description:** Changes the following values of the collection builder
**Values:**
AttributeDescription & Values
depthControls the depth within the casting credits to search for common actors
Values: Number greater than 0		Default: 5
limitControls the maximum number of collections to create
Values: Number greater than 0		Default: 25
| -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/movie/franchise.md b/docs/defaults/movie/franchise.md index 3ec0a9a8..80e7a457 100644 --- a/docs/defaults/movie/franchise.md +++ b/docs/defaults/movie/franchise.md @@ -24,7 +24,7 @@ Note that the `templates_variables:` section only needs to be used if you do NOT All [Shared Variables](../variables) are available -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/movie/producer.md b/docs/defaults/movie/producer.md index eda442d3..496bbba8 100644 --- a/docs/defaults/movie/producer.md +++ b/docs/defaults/movie/producer.md @@ -35,7 +35,7 @@ All [Shared Variables](../variables) are available as well as the additional Var | `data` | **Description:** Changes the following values of the collection builder
**Values:**
AttributeDescription & Values
depthControls the depth within the casting credits to search for common actors
Values: Number greater than 0		Default: 5
limitControls the maximum number of collections to create
Values: Number greater than 0		Default: 25
| -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/movie/universe.md b/docs/defaults/movie/universe.md index ec9a6995..f388abff 100644 --- a/docs/defaults/movie/universe.md +++ b/docs/defaults/movie/universe.md @@ -2,7 +2,7 @@ The `universe` Metadata File is used to create collections based on popular Movie universes (such as the Marvel Cinematic Universe or Wizarding World) -This Default file requires [Trakt Authentication](https://metamanager.wiki/en/latest/config/trakt.html) +This Default file requires [Trakt Authentication](../../config/trakt) Example Collections Created: @@ -24,7 +24,7 @@ Note that the `templates_variables:` section only needs to be used if you do NOT All [Shared Variables](../variables) are available -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml diff --git a/docs/defaults/movie/writer.md b/docs/defaults/movie/writer.md index 7bee6be3..bec29ed4 100644 --- a/docs/defaults/movie/writer.md +++ b/docs/defaults/movie/writer.md @@ -35,7 +35,7 @@ All [Shared Variables](../variables) are available as well as the additional Var | `data` | **Description:** Changes the following values of the collection builder
**Values:**
AttributeDescription & Values
depthControls the depth within the casting credits to search for common actors
Values: Number greater than 0		Default: 5
limitControls the maximum number of collections to create
Values: Number greater than 0		Default: 25
| -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/separators.md b/docs/defaults/separators.md index 23c6b5aa..227c5a53 100644 --- a/docs/defaults/separators.md +++ b/docs/defaults/separators.md @@ -30,6 +30,36 @@ libraries: use_separator: false ``` + + + + + + +############################################################################## + +| Key | +|:--------------------------------------------------------------------------:| +| IMDb Charts Collections | +| Created by Yozora, Bullmoose20, & Sohjiro | +| EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL | +| https://metamanager.wiki/en/latest/defaults/chart/imdb.html | +| FlixPatrol Charts Collections | +| Created by Yozora, Bullmoose20, & Sohjiro | +| EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL | +| https://metamanager.wiki/en/latest/defaults/chart/flixpatrol.html | + + + + + +| IMDb Charts Collections | +| Created by Yozora, Bullmoose20, & Sohjiro | +| EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL | +| https://metamanager.wiki/en/latest/defaults/chart/imdb.html | + + + ## Separator Files These are all the files that contain a separator. diff --git a/docs/defaults/show/content_rating_us.md b/docs/defaults/show/content_rating_us.md index 1ee19dfb..c7986cf5 100644 --- a/docs/defaults/show/content_rating_us.md +++ b/docs/defaults/show/content_rating_us.md @@ -34,7 +34,7 @@ All [Shared Variables](../variables) are available as well as the additional Var | `append_exclude` | **Description:** Appends to the existing exclude list
**Values:** Any Content Rating found in your library | | `append_addons` | **Description:** Appends to the existing addons list
**Values:** Any Content Rating found in your library | -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/show/country.md b/docs/defaults/show/country.md index 041cb3a8..ec3bce2d 100644 --- a/docs/defaults/show/country.md +++ b/docs/defaults/show/country.md @@ -35,7 +35,7 @@ All [Shared Variables](../variables) are available as well as the additional Var | `append_exclude` | **Description:** Appends to the existing exclude list
**Values:** Any Content Rating found in your library | | `append_addons` | **Description:** Appends to the existing addons list
**Values:** Any Content Rating found in your library | -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/show/decade.md b/docs/defaults/show/decade.md index 5bacc0f1..c4e7aa78 100644 --- a/docs/defaults/show/decade.md +++ b/docs/defaults/show/decade.md @@ -26,7 +26,7 @@ All [Shared Variables](../variables) are available as well as the additional Var |:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `sort_by` | **Description:** Controls the sort method for the collections
**Values:** Any sort method in the [Sorts Options Table](#sort-options) | -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/show/franchise.md b/docs/defaults/show/franchise.md index 4c9ed45b..7db13178 100644 --- a/docs/defaults/show/franchise.md +++ b/docs/defaults/show/franchise.md @@ -24,7 +24,7 @@ Note that the `templates_variables:` section only needs to be used if you do NOT All [Shared Variables](../variables) are available -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/show/network.md b/docs/defaults/show/network.md index e1692357..5d2a5128 100644 --- a/docs/defaults/show/network.md +++ b/docs/defaults/show/network.md @@ -32,7 +32,7 @@ All [Shared Variables](../variables) are available as well as the additional Var | `append_exclude` | **Description:** Appends to the existing exclude list
**Values:** Any Content Rating found in your library | | `append_addons` | **Description:** Appends to the existing addons list
**Values:** Any Content Rating found in your library | -The below is an example config.yml extract with some template_variables changed from their defaults. +The below is an example config.yml extract with some Template Variables added in to change how the file works. ```yaml libraries: diff --git a/docs/defaults/variables.md b/docs/defaults/variables.md index 0c8057c3..10a0b914 100644 --- a/docs/defaults/variables.md +++ b/docs/defaults/variables.md @@ -2,39 +2,39 @@ There are some `templates_variables` that all the PMM Defaults expect `franchise` can use 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 want to actually change how the defaults work. Any value not specified is just ignored. +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. Below are the available variables which can be used to customize the file. -| Variable | Description & Values | -|:-----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `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 | +| Variable | Description & Values | +|:-----------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `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 | +| `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 | 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/docs/metadata/builders/plex.md b/docs/metadata/builders/plex.md index 104b8b9a..444501b5 100644 --- a/docs/metadata/builders/plex.md +++ b/docs/metadata/builders/plex.md @@ -32,7 +32,7 @@ Finds every item in your Watchlist. The expected input is the sort you want returned. It defaults to `added.asc`. -### Sort Options +### Watchlist Sort Options | Sort Option | Description | |:--------------------------------------------|:--------------------------------------------|