Skip to content

Latest commit

 

History

History
190 lines (149 loc) · 19.3 KB

Settings-Attributes.md

File metadata and controls

190 lines (149 loc) · 19.3 KB

Configuring different options for Plex Meta Manager can be done in the Settings. These include enabling a cache to store each Plex GUID and its accompanying IDs to vastly speed up the execution of the script, defining the Image Asset Directory for local assets, setting a global Sync Mode, and many other display features.

A settings mapping can be either in the root of the config file as global mapping for all libraries or you can specify the settings mapping individually per library. Some settings can be individually set per collection using Setting Details.

Below is a settings mapping example and the full set of attributes:

settings:
  cache: true
  cache_expiration: 60
  asset_directory: config/assets
  asset_folders: true
  asset_depth: 0
  create_asset_folders: false
  dimensional_asset_rename: false
  download_url_assets: false
  show_missing_season_assets: false
  show_missing_episode_assets: false
  show_asset_not_needed: true
  sync_mode: append
  collection_minimum: 1
  delete_below_minimum: true
  delete_not_scheduled: false
  run_again_delay: 2
  missing_only_released: false
  only_filter_missing: false
  show_unmanaged: true
  show_filtered: false
  show_options: false
  show_missing: true
  show_missing_assets: true
  save_missing: true
  tvdb_language: eng
  ignore_ids:
  ignore_imdb_ids:
  item_refresh_delay: 0
  playlist_sync_to_users: all
  verify_ssl: true
Name Attribute Allowed Values Global Level Library Level Collection/Playlist Level
Cache cache boolean: true or false
default: true		 ✔️ ❌ ❌
Cache Expiration cache_expiration integer
default: 60		 ✔️ ❌ ❌
Image Asset Directory asset_directory list of paths
default: [Directory containing YAML config]/assets		 ✔️ ✔️ ❌
Image Asset Folders asset_folders boolean: true or false
default: true		 ✔️ ✔️ ❌
Asset Depth asset_depth integer
default: 0		 ✔️ ✔️ ❌
Create Asset Folders create_asset_folders boolean: true or false
default: false		 ✔️ ✔️ ❌
Dimensional Asset Rename dimensional_asset_rename boolean: true or false
default: false		 ✔️ ✔️ ❌
Download URL Assets download_url_assets boolean: true or false
default: false		 ✔️ ✔️ ❌
Show Missing Season Assets show_missing_season_assets boolean: true or false
default: false		 ✔️ ✔️ ❌
Show Missing Episode Assets show_missing_episode_assets boolean: true or false
default: false		 ✔️ ✔️ ❌
Show Asset Not Needed show_asset_not_needed boolean: true or false
default: false		 ✔️ ✔️ ❌
Sync Mode sync_mode append or sync
default: append		 ✔️ ✔️ ✔️
Default Collection Order default_collection_order release: Order Collection by Release Dates
alpha: Order Collection Alphabetically
custom: Order Collection Via the Builder Order
Any plex_search Sort Option		 ✔️ ✔️ ❌
Minimum Items minimum_items integer
default: 1		 ✔️ ✔️ ✔️
Delete Below Minimum delete_below_minimum boolean: true or false
default: false		 ✔️ ✔️ ✔️
Delete Not Scheduled delete_not_scheduled boolean: true or false
default: false		 ✔️ ✔️ ✔️
Run Again Delay run_again_delay integer
default: 0		 ✔️ ❌ ❌
Missing Only Released missing_only_released boolean: true or false
default: false		 ✔️ ✔️ ✔️
Only Filter Missing only_filter_missing boolean: true or false
default: false		 ✔️ ✔️ ✔️
Show Unmanaged Collections show_unmanaged boolean: true or false
default: true		 ✔️ ✔️ ❌
Show Filtered show_filtered boolean: true or false
default: false		 ✔️ ✔️ ✔️
Show Options show_options boolean: true or false
default: false		 ✔️ ✔️ ✔️
Show Missing show_missing boolean: true or false
default: true		 ✔️ ✔️ ✔️
Show Missing Assets show_missing_assets boolean: true or false
default: true		 ✔️ ✔️ ✔️
Save Missing save_missing boolean: true or false
default: true		 ✔️ ✔️ ✔️
TVDb Language tvdb_language ISO 639-2 Language Code or Blank for original Language
default:		 ✔️ ❌ ❌
Ignore IDs ignore_ids List or comma-separated String of TMDb/TVDb IDs ✔️ ✔️ ✔️
Ignore IMDb IDs ignore_imdb_ids List or comma-separated String of IMDb IDs ✔️ ✔️ ✔️
Item Refresh Delay item_refresh_delay Amount of time to wait between each item_refresh of every movie/show a collection/playlist integer
default: 0		 ✔️ ✔️ ✔️
Playlist Sync to Users playlist_sync_to_users all or List or comma-separated String of Users to sync the playlist to.
default: all		 ✔️ ❌ ✔️
Custom Repo custom_repo Defines the custom repo you use with the repo attribute when defining metadata_paths and playlist_files ✔️ ❌ ❌
Verify SSL verify_ssl Turn SSL Verification on or off. ✔️ ❌ ❌
Missing Path missing_path Path to missing YAML file for the library ❌ ✔️ ❌

Cache

Will use a cached database for faster processing. The cache file is created in the same location as your config file.

You can change the number of cache_expiration to set the number of days before each cache mapping expires and has to be reloaded

Image Asset Folders

When searching Image Asset Directories search for named folders vs named files
i.e. assets/Star Wars.png vs assets/Star Wars/poster.png.

Asset Depth

When using asset_folders this determines how many folder levels deep you want to search for an item.

Create Asset Folders

When using the assets_for_all Library Operation folders will be created for each Item in your library for assets to be placed in.

Dimensional Asset Rename

When using asset_folders this will scan the folder for image files and rename the first image found that has a height greater than its width to poster.ext as long as an asset poster was not found and the first image found that has a width greater than its height to background.ext as long as an asset background was not found.

Download URL Assets

When using download_url_assets if you are using url_poster or url_background in your collection config this will download the image to your asset folder if no image is found.

Show Missing Season Assets

When searching for assets for a show if a Season poster is found then this will display all other missing Season posters.

Show Missing Episode Assets

When searching for assets for a show if an Episode Title Card is found then this will display all other missing Episode Title Cards.

Show Asset Not Needed

When searching for assets show or hide the update not needed Messages.

Sync Mode

Set the default sync_mode. It can be either append when you want to add only and sync when you want to add and remove from collections.

Default Collection Order

Sets the collection_order for every collection run You can use any of these options:

  • release: Order Collection by Release Dates
  • alpha: Order Collection Alphabetically
  • custom: Order Collection Via the Builder Order
  • Any plex_search Sort Option

Minimum Items

Minimum number of items that must be found in order to update a collection/playlist.

Delete Below Minimum

When a collection is run it will be deleted if it is below the minimum specified by minimum_items.

Delete Not Scheduled

When a collection is skipped due to it not being scheduled delete it.

Run Again Delay

Number of minutes to run run_again collections after daily run is finished.

A collection is a run_again collection if it has the run_again Setting Detail attribute set to true.

Missing Only Released

Library Level toggle to filter missing items from a collection that has yet to be released.

Only Filter Missing

Library Level toggle to only filter missing items from a collection.

Show Unmanaged Collections

Show collections not managed by Plex Meta Manager at the end of each run.

Show Filtered

Library Level toggle to show items filtered from collections.

Show Options

Library Level toggle to show the available options for an attribute when using plex_search, smart_filter or filters.

Show Missing

Library Level toggle to show items missing from collections.

Show Missing Assets

Library Level toggle to silence missing assets warnings.

Save Missing

Library Level toggle to save items missing from collections to a filein the same directory as your Metadata file.

TVDb Language

Use an ISO 639-2 Language Code to specify the language to query TVDb in.

If no language is specified or the specified language is not found then the original language is used.

Ignore IDs

List or comma-separated String of TMDb/TVDb IDs to ignore in all collections

Ignore IMDb IDs

List or comma-separated String of IMDb IDs to ignore in all collections

Item Refresh Delay

Amount of time to wait between each item_refresh of every movie/show a collection/playlist.

Playlist Sync to Users

all or List or comma-separated String of Users to sync the playlist to in addition to yourself. To Sync a playlist to only yourself leave playlist_sync_to_users blank. Defaults to all.

Custom Repo

Defines the custom repo you use with the repo attribute when defining metadata_paths and playlist_files

  • If you want to link you're own GitHub make sure you're using the raw link like below. https://raw.githubusercontent.com/zluckytraveler/Plex-Meta-Manager-Configs/master/zluckytraveler/

Verify SSL

Turn SSl Verification on or off.

Missing Path

Path where to save the missing YAML File. Default is /config/<<library_name>>_missing.yml where <<library_name>> is your library name.

  • This setting can only be set under setting for each particular library.
libraries:
  Movies:
    settings:
      missing_path: /config/Missing/Movies.yml