| `name` | **Description:** Changes the name of the collection.<br>**Values:** New Collection Name |
| `summary` | **Description:** Changes the summary of the collection.<br>**Values:** New Collection Summary |
| `sort_title` | **Description:** Sets the sort title for the collection.<br>**Default:** `~_Collectionless`<br>**Values:** Any String |
| `collection_order` | **Description:** Changes the Collection Order for all collections in this file.<br>**Default:** `alpha`<br>**Values:**<tableclass="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
| `url_poster` | **Description:** Changes the poster url of thecollection.<br>**Values:** URL directly to the Image |
| `exclude` | **Description:** Exclude these Collections from being considered for collectionless.<br>**Values:** List of Collections |
| `exclude_prefix` | **Description:** Overrides the [default exclude_prefix list](#default-exclude_prefix). Exclude Collections with one of these prefixes from being considered for collectionless.<br>**Default:** [default exclude_prefix list](#default-exclude_prefix)<br>**Values:** List of Prefixes | |
| `name_collectionless` | **Description:** Changes the name of the collection.<br>**Values:** New Collection Name |
| `summary_collectionless` | **Description:** Changes the summary of the collection.<br>**Values:** New Collection Summary |
| `sort_title`| **Description:** Sets the sort title for the collection.<br>**Default:** `~_Collectionless`<br>**Values:** Any String |
| `collection_order`| **Description:** Changes the Collection Order for all collections in this file.<br>**Default:** `alpha`<br>**Values:**<tableclass="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../metadata/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
| `url_poster`| **Description:** Changes the poster url of thecollection.<br>**Values:** URL directly to the Image |
| `exclude`| **Description:** Exclude these Collections from being considered for collectionless.<br>**Values:** List of Collections |
| `exclude_prefix`| **Description:** Overrides the [default exclude_prefix list](#default-exclude_prefix). Exclude Collections with one of these prefixes from being considered for collectionless.<br>**Default:** [default exclude_prefix list](#default-exclude_prefix)<br>**Values:** List of Prefixes | |
The below is an example config.yml extract with some Template Variables added in to change how the file works.
- pmm: basic # Keep this as the last chart item so that collection_mode: hide works properly on library tab for CHART COLLECTION
- pmm: collectionless # Collectionless movies/shows (Keep this as the last chart item so that collection_mode: hide works properly on library tab for CHART COLLECTION)
- pmm: actor # Actors
template_variables: # bw, rainier, or orig style is used. depth and limit is set low but sometimes I boost to 10, 150
style: bw
data:
depth: 1
limit: 15
- pmm: director # Directors
template_variables: # bw, rainier, or orig style is used. depth and limit is set low but sometimes I boost to 10, 150
style: bw
data:
depth: 1
limit: 15
- pmm: producer # Producers
template_variables: # bw, rainier, or orig style is used. depth and limit is set low but sometimes I boost to 10, 150
exclude: # ever have some random person... you can exclude them if you want
- Jeremy Kleiner
- Thomas Hayslip
style: bw
data:
depth: 1
limit: 15
- pmm: writer # Writers
template_variables: # bw, rainier, or orig style is used. depth and limit is set low but sometimes I boost to 10, 150
style: bw
data:
depth: 1
limit: 15
- pmm: audio_language # English, French, Arabic, German, etc. audio language
- pmm: content_rating_cs # Choose content_rating_uk, content_rating_us, or content_rating_cs
- pmm: genre # Action, Comedy, Drama, etc.
- pmm: resolution # 4K HDR, 1080P FHD, etc. with the standards style
template_variables:
style: standards
- pmm: studio # DreamWorks Studios, Lucasfilm Ltd, etc.
- pmm: studio_anime # Anime Studios etc.
- pmm: subtitle_language # English, French, Arabic, German, etc. subtitles
- pmm: year # Year the media item was released starting from 1880 to current_year
template_variables:
data:
starting: 1880
ending: current_year
- pmm: country # Country associated to the media item
- pmm: decade # Decade the media item was released
- pmm: seasonal # Christmas, Halloween, etc.
template_variables: # Canadian Thankgsgiving is a different date range. Otherwise, I want to ALWAYS see the seasonal
schedule_independence: daily
schedule_easter: daily
schedule_valentine: daily
schedule_patrick: daily
schedule_thanksgiving: range(10/01-10/31)
schedule_halloween: daily
schedule_christmas: daily
schedule_years: daily
schedule_mother: daily
schedule_memorial: daily
schedule_father: daily
schedule_labor: daily
- pmm: streaming # Streaming on Disney+, Netflix, etc.
- pmm: universe # Marvel Cinematic Universe, Wizarding World, etc.
overlay_path:
- remove_overlays: false
- pmm: audio_codec
- pmm: audio_language
- pmm: commonsense
- pmm: direct_play
- pmm: edition
- pmm: episode_info
- pmm: flixpatrol
- pmm: mediastinger
- pmm: ratings
- remove_overlays: false # Set to true if you want to remove overlays
- reapply_overlay: false # If you are doing a lot of testing and changes like me, keep this to true to always reapply overlays
- pmm: audio_codec # FLAC, DTS-X, TrueHD, etc.
- pmm: language_count # blank means 1 audio language track, dual means 2, multi means > 2
- pmm: commonsense # Age 2+, Age 14+, etc.
- pmm: flixpatrol # Top 10 flixpatrol for 'this_year', positioned on the left
template_variables:
rating1: critic
position: left
time_window: this_year
- pmm: mediastinger # Mediastinger overlay when the media item contains a stinger at the end of the movie/show or during the credits
- pmm: ratings # Ratings with custom fonts matched to the style of the rating, font_size, and on the right in 'square' format
template_variables:
rating1: user
rating1_image: rt_tomato
- pmm: resolution
- pmm: ribbon
- pmm: runtimes
- pmm: special_release
- pmm: streaming
- pmm: versions
- pmm: video_format
TV Shows:
rating2: critic
rating2_image: imdb
rating3: audience
rating3_image: tmdb
horizontal_position: right
- pmm: resolution # 4K HDR, 1080P FHD, etc.
- pmm: ribbon # Used for ribbon in bottom right
- pmm: streaming # Streaming on Disney+, Netflix, etc.
- pmm: versions # Will show duplicates for that media item in top right area
- pmm: video_format # Remux, DVD, Blu-Ray, etc. in bottom left
settings:
asset_directory:
- config/assets
operations:
split_duplicates: false
assets_for_all: false
delete_unmanaged_collections: true # Any manually added collection outside of PMM will be deleted
mass_user_rating_update: mdb_tomatoes # Update user ratings with mdb_tomatoes
mass_critic_rating_update: imdb # Update critic ratings with imdb
mass_audience_rating_update: tmdb # Update audience ratings with tmdb
mass_genre_update: tmdb # Update all genres from tmdb
mass_content_rating_update: mdb_commonsense # Changes Content Rating to "1", "2" etc. to specify appropriate age
mass_originally_available_update: tmdb # Update all original available date from tmdb
mass_imdb_parental_labels: without_none
TV Shows: # Must match a library name in your Plex
report_path: config/missing/TV_missing.yml
template_variables:
sep_style: gray # use the gray separators globally for this library
collection_mode: hide # hide the collections
language: fr # could be default, de, fr, pt-br or another lang code that we have tranlsated
metadata_path:
- pmm: choice
- pmm: golden
- pmm: emmy
- pmm: anilist
- pmm: basic
- pmm: imdb
- pmm: myanimelist
- pmm: other_chart
- pmm: tautulli
- pmm: tmdb
- pmm: trakt
- pmm: actor
- pmm: audio_language
- pmm: content_rating_us # Choose content_rating_uk or content_rating_us
- pmm: genre
- pmm: resolution_standards # Choose resolution_standards or resolution
- pmm: streaming
- pmm: studio
- pmm: subtitle_language
- pmm: year
- pmm: country
- pmm: decade
- pmm: network
- pmm: separator_award # An "index card"
- pmm: choice # Critic's Choice Awards
template_variables: # based on when the award show started
data:
starting: 2014
ending: current_year
- pmm: golden # Golden Globes Awards
template_variables: # based on when the award show started
data:
starting: 1943
ending: current_year
- pmm: emmy # Emmy Awards
template_variables: # based on when the award show started
- pmm: basic # Keep this as the last chart item so that collection_mode: hide works properly on library tab for CHART COLLECTION
- pmm: collectionless # Collectionless movies/shows (Keep this as the last chart item so that collection_mode: hide works properly on library tab for CHART COLLECTION)
- pmm: actor # Actors
template_variables: # bw, rainier, or orig style is used. depth and limit is set low but sometimes I boost to 10, 150
exclude: # ever have some random person... you can exclude them if you want
- Macy Nyman
style: bw
data:
depth: 1
limit: 15
- pmm: audio_language # English, French, Arabic, German, etc. audio language
- pmm: content_rating_cs # Choose content_rating_uk, content_rating_us, or content_rating_cs
- pmm: genre # Action, Comedy, Drama, etc.
- pmm: resolution # 4K HDR, 1080P FHD, etc. with the standards style
template_variables:
style: standards
- pmm: studio # DreamWorks Studios, Lucasfilm Ltd, etc.
- pmm: studio_anime # Anime Studios etc.
- pmm: subtitle_language # English, French, Arabic, German, etc. subtitles
- pmm: year # Year the media item was released starting from 1880 to current_year
template_variables:
data:
starting: 1880
ending: current_year
- pmm: country # Country associated to the media item
- pmm: decade # Decade the media item was released
- pmm: network # ABC, CBC, NBC, FOX, etc.
- pmm: streaming # Streaming on Disney+, Netflix, etc.
overlay_path:
- remove_overlays: false
- pmm: audio_codec
- remove_overlays: false # Set to true if you want to remove overlays
- reapply_overlay: false # If you are doing a lot of testing and changes like me, keep this to true to always reapply overlays
- pmm: audio_codec # FLAC, DTS-X, TrueHD, etc. and works with overlay_level show, episode, and season
- pmm: audio_codec
template_variables:
overlay_level: episode
- pmm: audio_codec
template_variables:
overlay_level: season
- pmm: audio_language
- pmm: audio_language
- pmm: language_count # blank means 1 audio language track, dual means 2, multi means > 2 and works with overlay_level show, episode, and season
- pmm: language_count
template_variables:
overlay_level: episode
- pmm: audio_language
- pmm: language_count
template_variables:
overlay_level: season
- pmm: commonsense
- pmm: commonsense # Age 2+, Age 14+, etc. and works with overlay_level show, episode, and season
- pmm: commonsense
template_variables:
overlay_level: episode
- pmm: commonsense
template_variables:
overlay_level: season
- pmm: direct_play
- pmm: direct_play
template_variables:
overlay_level: episode
- pmm: direct_play
template_variables:
overlay_level: season
- pmm: edition
- pmm: edition
template_variables:
overlay_level: episode
- pmm: episode_info
template_variables:
overlay_level: episode
- pmm: flixpatrol
- pmm: flixpatrol
template_variables:
overlay_level: episode
- pmm: flixpatrol
template_variables:
overlay_level: season
- pmm: mediastinger
- pmm: mediastinger
- pmm: episode_info # SE##E## information in bottom right and works with overlay_level episode
template_variables:
overlay_level: episode
- pmm: mediastinger
- pmm: flixpatrol # Top 10 flixpatrol for 'this_year', positioned on the left and works with overlay_level show
template_variables:
overlay_level: season
- pmm: ratings
position: left
time_window: this_year
- pmm: mediastinger # Mediastinger overlay when the media item contains a stinger at the end of the movie/show or during the credits and works with overlay_level show
- pmm: ratings # Ratings with custom fonts matched to the style of the rating, font_size, and on the right in 'square' format. overlay_level: show has 3 ratings max
template_variables:
rating2: audience
rating1: user
rating1_image: rt_tomato
rating2: critic
rating2_image: imdb
- pmm: ratings
rating3: audience
rating3_image: tmdb
horizontal_position: right
- pmm: ratings # Ratings with custom fonts matched to the style of the rating, font_size, and on the right in 'square' format. overlay_level: episode has 2 ratings max
template_variables:
rating1: critic
rating1_image: imdb
rating2: audience
rating2_image: imdb
rating2_image: tmdb
horizontal_position: right
overlay_level: episode
- pmm: resolution
- pmm: resolution # 4K HDR, 1080P FHD, etc. and works with overlay_level show, episode, and season
- pmm: resolution
template_variables:
overlay_level: episode
- pmm: resolution
template_variables:
overlay_level: season
- pmm: ribbon
- pmm: ribbon
template_variables:
overlay_level: episode
- pmm: ribbon # Used for ribbon in bottom right and works with overlay_level show and season
- pmm: ribbon
template_variables:
overlay_level: season
- pmm: runtimes
- pmm: episode_info # Runtime information in bottom right and works with overlay_level episode
template_variables:
overlay_level: episode
- pmm: special_release
- pmm: special_release
- pmm: status # Airing, Returning, Ended, Canceled and works with overlay_level show
- pmm: streaming # Streaming on Disney+, Netflix, etc. and works with overlay_level show, episode, and season
- pmm: streaming
template_variables:
overlay_level: episode
- pmm: special_release
- pmm: streaming
template_variables:
overlay_level: season
- pmm: streaming
- pmm: versions
- pmm: versions
- pmm: versions # Will show duplicates for that media item in top right area and works with overlay_level show, episode, and season
template_variables:
overlay_level: episode
- pmm: versions
@ -181,14 +311,33 @@ libraries:
- pmm: versions
template_variables:
overlay_level: show
- pmm: video_format
- pmm: video_format # Remux, DVD, Blu-Ray, etc. in bottom left and works with overlay_level show, episode, and season
- pmm: video_format
template_variables:
overlay_level: episode
- pmm: video_format
template_variables:
overlay_level: season
settings:
asset_directory:
- config/assets
operations:
split_duplicates: false
assets_for_all: false
delete_unmanaged_collections: true # Any manually added collection outside of PMM will be deleted
mass_user_rating_update: mdb_tomatoes # Update user ratings with mdb_tomatoes
mass_critic_rating_update: imdb # Update critic ratings with imdb
mass_audience_rating_update: tmdb # Update audience ratings with tmdb
mass_genre_update: tmdb # Update all genres from tmdb
mass_content_rating_update: mdb_commonsense # Changes Content Rating to "1", "2" etc. to specify appropriate age
mass_originally_available_update: tmdb # Update all original available date from tmdb
mass_episode_critic_rating_update: imdb # Update critic ratings with imdb for episodes
mass_episode_audience_rating_update: tmdb # Update audience ratings with tmdb for episodes
| `position` | **Description:** Changes the position of all Overlay Queues in this File.<br>**Default:** `left`<br>**Values:** `left`, `right`, `half`, or List of Coordinates |
| `position_audio_flags` | **Description:** Changes the position of the audio flags Overlays.<br>**Default:** `left`<br>**Values:** `left`, `right`, `half`, or List of Coordinates |
| `position_subtitle_flags` | **Description:** Changes the position of the subtitle flags Overlays.<br>**Default:** `left`<br>**Values:** `left`, `right`, `half`, or List of Coordinates |
| `position` | **Description:** Use the Custom Given Queue instead of the the provided Queues.<br>**Values:** List of Coordinates |
| `horizontal_position` | **Description:** Choose the horizontal position for the flag group.<br>**Default:** `left`<br>**Values:** `left`, `right`, or `center` |
| `vertical_position` | **Description:** Choose the vertical position for the flag group.<br>**Default:** `top`<br>**Values:** `top`, `bottom`, or `center` |
| `flag_alignment` | **Description:** Choose the display alignment for the flag group.<br>**Default:** `vertical`<br>**Values:** `horizontal`, or `vertical` |
The `ratings` Default Overlay File is used to create an overlay based on if there's an after credit scene on each item within your library.
The `ratings` Default Overlay File is used to create an overlay based on the Critic Rating, Audience Rating, and User Rating in Plex for each item within your library.
This file only updates the overlays based on the data in Plex. Use the [Mass * Rating Update Library Operation](../../config/operations.md#mass--rating-update) and the [Mass Episode * Rating Update Library Operation](../../config/operations.md#mass-episode--rating-update) to update Plex to the Ratings you want on the Overlay.
| `use_<<key>>`<sup>1</sup> | **Description:** Turns off individual Overlays in a Defaults file.<br>**Values:** `false` to turn off the overlay |
| `file` | **Description:** Controls the image associated with the Overlay to a local file. Use `pmm: null` with this to no use the default image.<br>**Values:** Filepath to Overlay Image |
| `url` | **Description:** Controls the image associated with the Overlay to a url. Use `pmm: null` with this to no use the default image.<br>**Values:** URL to Overlay Image |
| `git` | **Description:** Controls the image associated with the Overlay to the git repo. Use `pmm: null` with this to no use the default image.<br>**Values:** Git Path to Overlay Image |
| `repo` | **Description:** Controls the image associated with the Overlay to a custom repo. Use `pmm: null` with this to no use the default image.<br>**Values:** Repo Path to Overlay Image |
| `file` | **Description:** Controls the image associated with the Overlay to a local file. Use `pmm: null` with this to not use the default image.<br>**Values:** Filepath to Overlay Image |
| `url` | **Description:** Controls the image associated with the Overlay to a url. Use `pmm: null` with this to not use the default image.<br>**Values:** URL to Overlay Image |
| `git` | **Description:** Controls the image associated with the Overlay to the git repo. Use `pmm: null` with this to not use the default image.<br>**Values:** Git Path to Overlay Image |
| `repo` | **Description:** Controls the image associated with the Overlay to a custom repo. Use `pmm: null` with this to not use the default image.<br>**Values:** Repo Path to Overlay Image |
| `pmm` | **Description:** Controls the image associated with the Overlay to a pmm file.<br>**Values:** PMM Overlay Image |
| `horizontal_offset` | **Description:** Controls the Horizontal Offset of this overlay. Can be a %.<br>**Values:** Number 0 or greater or 0%-100% |
| `horizontal_align` | **Description:** Controls the Horizontal Alignment of the overlay.<br>**Values:** `left`, `center`, or `right` |
parser.add_argument("-rl","-l","--library","--libraries","--run-library","--run-libraries",dest="libraries",help="Process only specified libraries (comma-separated list)",type=str)
parser.add_argument("-rm","-m","--metadata","--metadata-files","--run-metadata-files",dest="metadata",help="Process only specified Metadata files (comma-separated list)",type=str)
parser.add_argument("-ca","--cache-library","--cache-libraries",dest="cache_libraries",help="Cache Library load for 1 day",action="store_true",default=False)
parser.add_argument("-dc","--delete","--delete-collections",dest="delete",help="Deletes all Collections in the Plex Library before running",action="store_true",default=False)
parser.add_argument("-dc","--delete","--delete-collections",dest="delete_collections",help="Deletes all Collections in the Plex Library before running",action="store_true",default=False)
parser.add_argument("-dl","--delete-label","--delete-labels",dest="delete_labels",help="Deletes all Labels in the Plex Library before running",action="store_true",default=False)
parser.add_argument("-nc","--no-countdown",dest="no_countdown",help="Run without displaying the countdown",action="store_true",default=False)
parser.add_argument("-nm","--no-missing",dest="no_missing",help="Run without running the missing section",action="store_true",default=False)
parser.add_argument("-nr","--no-report",dest="no_report",help="Run without saving a report",action="store_true",default=False)
meisnate12
2 years ago