Plex
/
Plex-Meta-Manager
mirror of https://github.com/meisnate12/Plex-Meta-Manager.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'create-config-file'
${ noResults }
Plex-Meta-Manager/docs/defaults/collection_variables.md

27 KiB
Raw Permalink Blame History

File paths need to be valid in the context where Kometa is running; this is primarily an issue when running in docker, as Kometa inside the container cannot see host paths.

Variable Description & Values
language Description: Set the language of Collection Names and Summaries
Default: default
Values: default (English), fr (French), or de (German)
use_all Description: Turns off all Collections in a Defaults file.
Values: false to turn off the collection
use_<<key>>1 Description: Turns off individual Collections in a Defaults file.
Values: false to turn off the collection
name_<<key>>1 Description: Changes the name of the key's collection.
Values: New Collection Name
summary_<<key>>1 Description: Changes the summary of the key's collection.
Values: New Collection Summary
collection_section Description: Changes the sort order of the collection sections against other default collection sections. (Use quotes to not lose leading zeros "05")
Values: Any number
sort_prefix Description: Changes the prefix of the sort title.
Default: !
Values: Any String
sort_title Description: Changes the sort title of all collections.
Default: <<sort_prefix>><<collection_section>><<pre>><<order_<<key>>>><<title>>
Values: Any String
name_mapping Description: Changes the name_mapping of all collections.
Default: <<title>>
Values: Any String with <<key_name>> in it.
order_<<key>>1 Description: Controls the sort order of the collections in their collection section.
Values: Any number
collection_mode Description: Controls the collection mode of all collections in a Defaults file.
Values:
defaultLibrary default
hideHide Collection
hide_itemsHide Items in this Collection
show_itemsShow this Collection and its Items
ignore_ids Description: Set a list or comma-separated string of TMDb/TVDb IDs to ignore in all collections.
Values: List or comma-separated string of TMDb/TVDb IDs
ignore_imdb_ids Description: Set a list or comma-separated string of IMDb IDs to ignore in all collections.
Values: List or comma-separated string of IMDb IDs
minimum_items Description: Set the number of minimum items for a collection to be created for all collections.
Values: Any number greater than 0
minimum_items_<<key>>1 Description: Set the number of minimum items for a collection to be created for the key's collection.
Values: Any number greater than 0
schedule Description: Set the schedule for all of the collections in a Defaults file.
Values: Any Scheduling Option
schedule_<<key>> Description: Set the schedule for a specific key's collection.
Values: Any Scheduling Option
delete_collections_named Description: Used to delete any collections in your plex named one of the given collections.
Values: List of Collection Names to delete
url_poster Description: Changes the poster url for all collections.
Values: URL directly to the Image
url_poster_<<key>>1 Description: Changes the poster url of the key's collection.
Values: URL directly to the Image
file_poster Description: Sets the poster filepath for all collections.
Values: Filepath directly to the Image
file_poster_<<key>>1 Description: Sets the poster filepath of the key's collection.
Values: Filepath directly to the Image
url_background Description: Sets the background url for all collections.
Values: URL directly to the Image
url_background_<<key>>1 Description: Sets the background url of the key's collection.
Values: URL directly to the Image
file_background Description: Sets the background filepath for all collections.
Values: Filepath directly to the Image
file_background_<<key>>1 Description: Sets the background filepath of the key's collection.
Values: Filepath directly to the Image
visible_library Description: Controls visible on Library Recommended Tab for all collections in a Defaults file. (Only works with Plex Pass)
Values:
trueVisible
falseNot Visible
Any schedule OptionVisible When Scheduled
visible_library_<<key>>1 Description: Controls visible on Library Recommended Tab of the key's collection. (Only works with Plex Pass)
Default: visible_library
Values:
trueVisible
falseNot Visible
Any schedule OptionVisible When Scheduled
visible_home Description: Controls visible on Home Tab for all collections in a Defaults file. (Only works with Plex Pass)
Values:
trueVisible
falseNot Visible
Any schedule OptionVisible When Scheduled
visible_home_<<key>>1 Description: Controls visible on Home Tab of the key's collection. (Only works with Plex Pass)
Default: visible_home
Values:
trueVisible
falseNot Visible
Any schedule OptionVisible When Scheduled
visible_shared Description: Controls visible on Shared Users' Home Tab for all collections in a Defaults file. (Only works with Plex Pass)
Values:
trueVisible
falseNot Visible
Any schedule OptionVisible When Scheduled
visible_shared_<<key>>1 Description: Controls visible on Shared Users' Home Tab of the key's collection. (Only works with Plex Pass)
Default: visible_shared
Values:
trueVisible
falseNot Visible
Any schedule OptionVisible When Scheduled
radarr_upgrade_existing Description: Override Radarr upgrade_existing attribute for all collections in a Defaults file.
Values: true or false
radarr_upgrade_existing_<<key>>1 Description: Override Radarr upgrade_existing attribute of the key's collection.
Values: true or false
radarr_monitor_existing Description: Override Radarr monitor_existing attribute for all collections in a Defaults file.
Values: true or false
radarr_monitor_existing_<<key>>1 Description: Override Radarr monitor_existing attribute of the key's collection.
Values: true or false
radarr_add_missing Description: Override Radarr add_missing attribute for all collections in a Defaults file.
Values: true or false
radarr_add_missing_<<key>>1 Description: Override Radarr add_missing attribute of the key's collection.
Default: radarr_add_missing
Values: true or false
radarr_folder Description: Override Radarr root_folder_path attribute for all collections in a Defaults file.
Values: Folder Path
radarr_folder_<<key>>1 Description: Override Radarr root_folder_path attribute of the key's collection.
Default: radarr_folder
Values: Folder Path
radarr_search Description: Override Radarr search attribute or all collections in a Defaults file.
Values: true or false
radarr_search_<<key>>1 Description: Override Radarr search attribute of the key's collection.
Default: radarr_search
Values: true or false
radarr_tag Description: Override Radarr tag attribute for all collections in a Defaults file.
Values: List or comma-separated string of tags
radarr_tag_<<key>>1 Description: Override Radarr tag attribute of the key's collection.
Default: radarr_tag
Values: List or comma-separated string of tags
item_radarr_tag Description: Used to append a tag in Radarr for every movie found by the builders that's in Radarr for all collections in a Defaults file.
Values: List or comma-separated string of tags
item_radarr_tag_<<key>>1 Description: Used to append a tag in Radarr for every movie found by the builders that's in Radarr of the key's collection.
Default: item_radarr_tag
Values: List or comma-separated string of tags
sonarr_upgrade_existing Description: Override Sonarr upgrade_existing attribute for all collections in a Defaults file.
Values: true or false
sonarr_upgrade_existing_<<key>>1 Description: Override Sonarr upgrade_existing attribute of the key's collection.
Values: true or false
sonarr_monitor_existing Description: Override Sonarr monitor_existing attribute for all collections in a Defaults file.
Values: true or false
sonarr_monitor_existing_<<key>>1 Description: Override Sonarr monitor_existing attribute of the key's collection.
Values: true or false
sonarr_add_missing Description: Override Sonarr add_missing attribute for all collections in a Defaults file.
Values: true or false
sonarr_add_missing_<<key>>1 Description: Override Sonarr add_missing attribute of the key's collection.
Default: sonarr_add_missing
Values: true or false
sonarr_folder Description: Override Sonarr root_folder_path attribute for all collections in a Defaults file.
Values: Folder Path
sonarr_folder_<<key>>1 Description: Override Sonarr root_folder_path attribute of the key's collection.
Default: sonarr_folder
Values: Folder Path
sonarr_search Description: Override Sonarr search attribute or all collections in a Defaults file.
Values: true or false
sonarr_search_<<key>>1 Description: Override Sonarr search attribute of the key's collection.
Default: sonarr_search
Values: true or false
sonarr_tag Description: Override Sonarr tag attribute for all collections in a Defaults file.
Values: List or comma-separated string of tags
sonarr_tag_<<key>>1 Description: Override Sonarr tag attribute of the key's collection.
Default: sonarr_tag
Values: List or comma-separated string of tags
item_sonarr_tag Description: Used to append a tag in Sonarr for every series found by the builders that's in Sonarr for all collections in a Defaults file.
Values: List or comma-separated string of tags
item_sonarr_tag_<<key>>1 Description: Used to append a tag in Sonarr for every series found by the builders that's in Sonarr of the key's collection.
Default: item_sonarr_tag
Values: List or comma-separated string of tags
  1. Each default collection has a key that when calling to effect a specific collection you must replace <<key>> with when calling.