Skip to content

Latest commit

 

History

History
122 lines (105 loc) · 9.36 KB

Collection-Details.md

File metadata and controls

122 lines (105 loc) · 9.36 KB
Raw

Here is an example with multiple details being set:

collections:
  IMDb Top 250:
    imdb_list: https://www.imdb.com/search/title/?groups=top_250&count=25
    sort_title: +100
    sync_mode: sync
    add_to_arr: true
    show_filtered: true
    filters:
      original_language: en
  Reddit Top 250:
    trakt_list: https://trakt.tv/users/jay-greene/lists/reddit-top-250-2019-edition
    sort_title: +101
    sync_mode: sync
  Star Wars:
    tmdb_collection: 10
    tmdb_summary: 10
    tmdb_poster: 10
    tmdb_background: 10
  Pixar:
    studio: Pixar
    content_rating: PG
    url_poster: https://theposterdb.com/api/assets/29378/view?
    url_background: https://wallpaperaccess.com/full/331622.jpg
    summary: A collection of Pixar movies
    collection_order: alpha
  Robin Williams:
    actor: Robin Williams
    tmdb_biography: 2157
    tmdb_profile: 2157
    collection_mode: show_items
    collection_order: alpha
  Samuel L. Jackson:
    actor: tmdb
    tmdb_person: 2231
    collection_mode: show_items
    collection_order: alpha
  Marvel Cinematic Universe:
    tmdb_list: 7069903
    tmdb_description: 7069903
    tmdb_list_poster: 7069903
  28 Days/Weeks Later:
    tmdb_collection_details: 1565
    name_mapping: 28 Days-Weeks Later

The available collection details attributes for each collection are split into different sections

Settings Attributes

All the following attributes serve various functions as how the collection functions inside of Plex Meta Manager.

Name Attribute Description Allowed Values
Schedule schedule Used to schedule this collection schedule mapping details
Template template Used to specify a template and template variables to use for this collection template mapping details
Sync Mode sync_mode Used to change how collection builders sync with this collection
Default Mode: settings library value		 append: Only Add Items to the Collection
sync: Add & Remove Items from the Collection
Add to Radarr/Sonarr add_to_arr Collection level add toggle for Randar/Sonarr
Default: Randar/Sonarr library value		 boolean: true or false
Radarr/Sonarr Tags arr_tag Collection level tag attribute override for Randar/Sonarr
Default: Randar/Sonarr library value		 Comma-seperated string of tags
Show Filtered Collections show_filtered Collection level show_filtered toggle
Default: settings library value		 boolean: true or false
Show Missing Collections show_missing Collection level show_missing toggle
Default: settings library value		 boolean: true or false
Save Missing Collections save_missing Collection level save_missing toggle
Default: settings library value		 boolean: true or false
Name Mapping name_mapping Used to specify the folder name in the Image Assets Directory Folder Name In Assets Directory
Test Mode test When running in Test Mode (--run-tests option) only collections with test: true will be run
Default: false		 boolean: true or false
  • Name Mapping: If your collection name contains characters that are not allowed in file paths (i.e. for windows <, >, :, ", /, \, |, ?, * cannot be in the file path) but you want them in your collection name you can use the name_mapping attribute to specific this collection's name in the file system.

Metadata Attributes

All the following attributes update various details of the collection's Metadata.

Name Attribute Description Allowed Values
TMDb Person tmdb_person Used to change the collection's summary and poster to a TMDb Person's biography and profile as well as allow the people specified to be used in Plex Searches TMDb Person ID (List or Comma-separated string)
Sort Title sort_title Used to change the collection's sort title Text to change Sort Title
Content Rating content_rating Used to change the collection's content rating Text to change Content Rating
Label label Used to change the collection's labels Comma-seperated string of labels to append or sync
Label Sync Mode label_sync_mode Used with label to change the label sync mode
Default Mode: append		 append: Only Add Labels to the Item
sync: Add & Remove Labels from the Item
Collection Mode collection_mode Used to change the Collection Mode default: Library default
hide: Hide Collection
hide_items: Hide Items in this Collection
show_items: Show this Collection and its Items
Collection Order collection_order Used to change the Collection Order release: Order Collection by Release Dates
alpha: Order Collection Alphabetically
  • Sort Title: You can use sort_title to "promote" certain collections to the top of a library by creating a sort title starting with a + or "demote" certain collections to the bottom of a library by creating a sort title starting with a ~.

Summary Attributes

All the following attributes update the summary of the collection from various sources.

Name Attribute Description Allowed Values
Summary summary Used to change the collection's summary Text to change Summary
TMDb Summary tmdb_summary Used to change the collection's summary to a TMDb Movie/Collection summary for a movie library or a TMDb Show summary for a show library TMDb Movie/Show/Collection ID
TMDb Description tmdb_description Used to change the collection's summary to a TMDb List Discription TMDb List ID
TMDb Biography tmdb_biography Used to change the collection's summary to a TMDb Person's biography TMDb Person ID

Poster Attributes

All the following attributes update the poster of the collection from various sources.

Name Attribute Description Allowed Values
URL Poster2 url_poster Used to change the collection's poster to a URL URL of image publicly available on the internet
TMDb Poster2 tmdb_poster Used to change the collection's poster to a TMDb Movie/Collection poster for a movie library or a TMDb Show poster for a show library TMDb Movie/Show/Collection ID
TMDb List Poster2 tmdb_list_poster Used to change the collection's poster to a TMDb List poster TMDb List ID
TMDb Profile2 tmdb_profile Used to change the collection's poster to a TMDb Person's profile TMDb Person ID
File Poster2 file_poster Used to change the collection's poster to an image in the file system Path to image in the file system
  • If no poster is specified the script will look in the library's Image Asset Directories for a folder named either the collection name or the name_mapping if specified and look for a poster.ext file in that folder (replacing .ext with the image extension).

Background Attributes

All the following attributes update the background of the collection from various sources.

Name Attribute Description Allowed Values
URL Background3 url_background Use to change the collection's background to a URL URL of image publicly available on the internet
TMDb Background3 tmdb_background Used to change the collection's background to a TMDb Movie/Collection background for a movie library or a TMDb Show background for a show library TMDb Movie/Show/Collection ID
File Background3 file_background Used to change the collection's background to an image in the file system Path to image in the file system
  • If no background is specified the script will look in the library's Image Asset Directories for a folder named either the collection name or the name_mapping if specified and look for a background.ext file in that folder (replacing .ext with the image extension).