Plex-Meta-Manager/docs/defaults/variables.md
2022-10-05 01:55:17 -04:00

7.2 KiB

Shared Template Variables

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.

Below are the available variables which can be used to customize the file.

Variable Description & Values
use_<<key>>1 Description: Turns off individual Collections in a Default's file.
Values: false to turn off the collection
collection_section Description: Controls the sort order of the collection sections against other default collection sections.
Values: Any number
order_<<key>>1 Description: Controls the sort order of the collections in each collection section.
Values: Any number
collection_mode Description: Controls the collection mode of these collections.
Values:
defaultLibrary default
hideHide Collection
hide_itemsHide Items in this Collection
show_itemsShow this Collection and its Items
visible_library_<<key>>1 Description: Controls collection visible on Library (Only works with Plex Pass)
Values:
trueVisible
falseNot Visible
Any schedule OptionVisible When Scheduled
visible_home_<<key>>1 Description: Controls collection visible on Home (Only works with Plex Pass)
Values:
trueVisible
falseNot Visible
Any schedule OptionVisible When Scheduled
visible_shared_<<key>>1 Description: Controls collection visible on Shared Users' Home (Only works with Plex Pass)
Values:
trueVisible
falseNot Visible
Any schedule OptionVisible When Scheduled
radarr_add_missing Description: Override Radarr add_missing attribute for these collections
Values: true or false
radarr_folder Description: Override Radarr root_folder_path attribute for these collections
Values: Folder Path
radarr_tag Description: Override Radarr tag attribute for these collections
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 these collections
Values: List or comma-separated string of tags
sonarr_add_missing Description: Override Sonarr add_missing attribute for these collections
Values: true or false
sonarr_folder Description: Override Sonarr root_folder_path attribute for these collections
Values: Folder Path
sonarr_tag Description: Override Sonarr tag attribute for these collections
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 these collections
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.