4.7 KiB

Raw Blame History

Overlay Files

Overlay files are used to create and maintain overlays within the Plex libraries on the server.

Overlays and templates are defined within one or more Overlay files, which are linked to libraries in the Libraries Attribute within the Configuration File.

To remove all overlays use the remove_overlays library operation.

To change a single overlay original Image either replace the image in the assets folder or remove the Overlay shared label and then PMM will overlay the new image

These are the attributes which can be used within the Overlay File:

Attribute	Description
`templates`	contains definitions of templates that can be leveraged by multiple overlays
`external_templates`	contains path types that point to external templates that can be leveraged by multiple overlays
`overlays`	contains definitions of overlays you wish to add

overlays is required in order to run the Overlay File.
Example Overlay Files can be found in the Plex Meta Manager Configs Repository

Overlay Attributes

Each overlay requires its own section within the overlays attribute.

overlays:
  IMDb Top 250:
    # ... builders, details, and filters for this overlay
  4K:
    # ... builders, details, and filters for this overlay
  etc:
    # ... builders, details, and filters for this overlay

Each section must have the only required attribute, overlay.

Attribute	Description	Required
`name`	Name of the overlay. Each overlay name should be unique.	✅
`url`	URL of Overlay Image Online	❌
`git`	Location in the Configs Repo of the Overlay Image	❌
`repo`	Location in the Custom Repo of the Overlay Image	❌

If url, git, and repo are all not defined then PMM will look in your config/overlays folder for a .png file named the same as the name attribute.

overlays:
  IMDb Top 250:
    overlay:
      name: IMDb Top 250
    imdb_chart: top_movies

There are three types of attributes that can be utilized within an overlay:

Builders

Builders use third-party services to source items for overlays. Multiple builders can be used in the same overlay from a variety of sources listed below.

Details

Only a few details can be used with overlays: limit, show_missing, save_missing, missing_only_released, minimum_items, cache_builders, tmdb_region

Filters

These filter media items added to the collection by any of the Builders.

Filters

Examples

overlays:
  4K:
    overlay:
      name: 4K    # This will look for a local overlays/4K.png in your configs folder
    plex_search:
      all:
        resolution: 4K
  HDR:
    overlay:
      name: HDR
      git: PMM/overlays/HDR
    plex_search:
      all:
        hdr: true
  Dolby:
    overlay:
      name: Dolby
      url: https://somewebsite.com/dolby_overlay.png
    plex_all: true
    filters:
      has_dolby_vision: true

4.7 KiB Raw Blame History