Skip to content

Defaults Usage Guide

Plex Meta Manager includes a pre-created set of Collection Files and Overlay Files which can be found in the "defaults" folder in the root of your Plex Meta Manager installation directory.

These files offer an easy-to-use and customizable set of Collections and Overlays that the user can achieve without having to worry about creating the files that make the collections and overlays possible.

All Collections come with a matching poster to make a clean, consistent set of collections in your library. These files are stored in the Plex Meta Manager Images Repository and each poster is downloaded straight to your Plex Collection when you run Plex Meta Manager.

Credits to Sohjiro, Bullmoose20, Yozora, Cpt Kuesel, and anon_fawkes for helping drive this entire Default Set of Configs through the concept, design and implementation.

Special thanks to Magic815 for the overlay image inspiration and base template.

Please consider donating towards the project.

Collection Defaults

See the Collection Defaults Page for more information on the specifics of the Collection Defaults.

Overlay Defaults

See the Overlay Defaults Page for more information on the specifics of the Overlay Defaults.

Configurations

To run a default pmm Collection or Overlay file you can simply add it to your collection_files (For Collection Files) or overlay_files (For Overlay Files) using pmm like so:

libraries:
  Movies:
    collection_files:
    - pmm: actor
    - pmm: genre
    overlay_files:
    - pmm: ribbon
    - pmm: ratings

Customizing Configs

Configs can be customized using the template_variables attribute when calling the file. These template_variables will be given to every template call in the file which allows them to affect how that file runs.

For collections, this example disables two keys, which will prevent those collections from being created. It also sets the visibility of one of the keys so that it is visible on the library tab, the server owner's homescreen and shared user's homescreens (assuming they server owner and/or the shared users have the library pinned to their homescreen)

For overlays, this example changes the ratings overlay to apply to episodes rather than shows.

libraries:
  TV Shows:
    collection_files:
      - pmm: imdb
        template_variables:
          use_popular: false
          use_lowest: false
          visible_library_top: true
          visible_home_top: true
          visible_shared_top: true
    overlay_files:
      - pmm: ratings
        template_variables:
          builder_level: episode

Each file has a page on the wiki showing the available template_variables for each file. For example the default pmm: ratings has a page here.

In addition to the defined template_variables almost all default Collection and Overlay files have access to their respective Collection/Overlay Shared Variables.

Example Configuration File

Sample config.yml file (click to expand)
libraries:
  Movies:                                           # Must match a library name in your Plex
    report_path: config/missing/Movies_missing.yml
    template_variables:
      sep_style: purple                               # use the purple separators globally for this library
      collection_mode: hide                         # hide the collections within the "library" tab in Plex.
      placeholder_imdb_id: tt8579674                # 1917 (2019) placeholder id for the separators, avoids a plex bug.
    collection_files:
      - pmm: separator_award                          # An "index card"
      - pmm: bafta                                    # BAFTA Awards
        template_variables:                           # Show collections from latest-10 onwards.
          data:
            starting: latest-10
            ending: latest
      - pmm: golden                                   # Golden Globes Awards
        template_variables:                           # Show collections from latest-10 onwards.
          data:
            starting: latest-10
            ending: latest
      - pmm: oscars                                   # The Oscars
        template_variables:                           # Show collections from latest-10 onwards.
          data:
            starting: latest-10
            ending: latest
      - pmm: separator_chart                          # An "index card"
      - pmm: basic                                    # Some basic chart collections
      - pmm: tmdb                                     # TMDb Charts (Popular, Trending, etc.)
      - pmm: audio_language                           # English, French, Arabic, German, etc. audio language 
      - pmm: resolution                               # 4K HDR, 1080P FHD, etc. with the standards style 
        template_variables:
          style: standards
      - pmm: studio                                   # DreamWorks Studios, Lucasfilm Ltd, etc.
      - pmm: seasonal                                 # Christmas, Halloween, etc.
        template_variables:                           # Disable any US-specific seasonal collections
          schedule_independence: never
          schedule_thanksgiving: never
          schedule_memorial: never
          schedule_labor: never
      - pmm: streaming                                # Streaming on Disney+, Netflix, etc.
        template_variables:
          originals_only: true                      # Only create collections for Original Content (i.e. Netflix Originals)
      - pmm: universe                                 # Marvel Cinematic Universe, Wizarding World, etc.

    remove_overlays: false                          # Set to true if you want to remove overlays
    reapply_overlays: false                         # If you are doing a lot of testing and changes like me, keep this to true to always reapply overlays - can cause image bloat
    #reset_overlays: tmdb                           # if you want to reset the poster to default poster from tmdb - can cause image bloat

    overlay_files:
      - pmm: audio_codec                              # FLAC, DTS-X, TrueHD, etc. style: standard/compact. compact is default
      - pmm: resolution                               # 4K HDR, 1080P FHD, etc.
      - pmm: ribbon                                   # Used for ribbon in bottom right
      - pmm: streaming                                # Streaming on Disney+, Netflix, etc.
      - pmm: video_format                             # Remux, DVD, Blu-Ray, etc. in bottom left
    settings:
      asset_directory:
        - config/assets

    operations:
      split_duplicates: false
      assets_for_all: false

  TV Shows:                                         # Must match a library name in your Plex
    report_path: config/missing/TV_missing.yml
    template_variables:
      sep_style: plum                               # use the plum separators globally for this library
      collection_mode: hide                         # hide the collections within the "library" tab in Plex.
      placeholder_imdb_id: tt1190634                # The Boys (2019) placeholder id for the separators, avoids a plex bug.
    collection_files:
      - pmm: separator_award                          # An "index card"
      - pmm: bafta                                    # BAFTA Awards
        template_variables:                           # Show collections from latest-10 onwards.
          data:
            starting: latest-10
            ending: latest
      - pmm: golden                                   # Golden Globes Awards
        template_variables:                           # Show collections from latest-10 onwards.
          data:
            starting: latest-10
            ending: latest
      - pmm: oscars                                   # The Oscars
        template_variables:                           # Show collections from latest-10 onwards.
          data:
            starting: latest-10
            ending: latest
      - pmm: separator_chart                          # An "index card"
      - pmm: basic                                    # Some basic chart collections
      - pmm: tmdb                                     # TMDb Charts (Popular, Trending, etc.)
      - pmm: audio_language                           # English, French, Arabic, German, etc. audio language 
      - pmm: resolution                               # 4K HDR, 1080P FHD, etc. with the standards style 
        template_variables:
          style: standards
      - pmm: network                                  # ABC, CBC, NBC, FOX, etc.
      - pmm: streaming                                # Streaming on Disney+, Netflix, etc.
        template_variables:
          originals_only: true                      # Only create collections for Original Content (i.e. Netflix Originals)
    remove_overlays: false                          # Set to true if you want to remove overlays
    reapply_overlays: false                         # If you are doing a lot of testing and changes like me, keep this to true to always reapply overlays - can cause image bloat
    #reset_overlays: tmdb                           # if you want to reset the poster to default poster from tmdb - can cause image bloat
    overlay_files:
      - pmm: audio_codec                              # FLAC, DTS-X, TrueHD, etc. on show and episode
      - pmm: audio_codec
        template_variables:
          builder_level: episode
      - pmm: episode_info                             # S##E## information in bottom right on episode
        template_variables:
          builder_level: episode
      - pmm: resolution                               # 4K HDR, 1080P FHD, etc. on show, episode, and season
      - pmm: resolution
        template_variables:
          builder_level: episode
      - pmm: resolution
        template_variables:
          builder_level: season
      - pmm: ribbon                                   # Used for ribbon in bottom right on show
      - pmm: status                                   # Airing, Returning, Ended, Canceled on show
      - pmm: versions                                 # Will show duplicates for that media item on show and episode
      - pmm: versions                                 
        template_variables:
          builder_level: episode
      - pmm: video_format                             # Remux, DVD, Blu-Ray, etc. in bottom left on show, episode, and season
      - pmm: video_format
        template_variables:
          builder_level: episode
    settings:
      asset_directory:
        - config/assets

    operations:
      split_duplicates: false
      assets_for_all: false
playlist_files:
  - pmm: playlist
    template_variables:
      libraries: Movies, TV Shows                       # Must match the names of your libraries in Plex.