Skip to content

Latest commit

 

History

History
139 lines (120 loc) · 3.69 KB

Image-Overlay-Detail.md

File metadata and controls

139 lines (120 loc) · 3.69 KB

In order to add an overlay to a set of items you must add item_overlay: OVERLAY_NAME to the collection config, where OVERLAY_NAME matches the exact name of a folder in your overlays directory.

Your overlays directory must be inside your config folder structured like below:

config
├── overlays
│   ├── OVERLAY_NAME
│       ├── overlay.png
  • OVERLAY_NAME is the folder contacting your overlay.png and its name is what you give item_overlay to refer to this specific overlay.
  • overlay.png is the overlay file with the banner. You can create you're own with this PSD. The font can be found here.
  • An item can only be in one overlay search so make sure you exclude other searches when using multiple overlays.
  • Posters will be backed up in the overlay director and if an item is removed from the search the original poster should be added back.
  • revert_overlay can be added to an overlay collection configuration to revert all movies changed by that overlay back to their original posters.

Example Folder Structure

This is an example of the default set found here which would have 5 overlay options 4K, 4K-Dolby, 4K-HDR, Dolby, and HDR and have a directory structured like below:

config
├── config.yml
├── Movies.yml
├── TV Shows.yml
├── overlays
│   ├── 4K
│       ├── overlay.png
│   ├── 4K-Dolby
│       ├── overlay.png
│   ├── 4K-HDR
│       ├── overlay.png
│   ├── Dolby
│       ├── overlay.png
│   ├── HDR
│       ├── overlay.png

Examples Collection Configs

4K Overlay Only

4K Overlay

Add a 4K overlay to all 4K Movies

collections:
  4K Overlay:
    plex_search:
      all:
        resolution: 4K
    item_overlay: 4K
    build_collection: false

4K and HDR Overlays

Here's an example of how you could add 4K, 4K-HDR, and HDR overlays

collections:
  4K Overlay:
    plex_search:
      all:
        resolution: 4K
        hdr: false
    item_overlay: 4K
    build_collection: false
  4K-HDR Overlay:
    plex_search:
      all:
        resolution: 4K
        hdr: true
    item_overlay: 4K-HDR
    build_collection: false
  HDR Overlay:
    plex_search:
      all:
        hdr: true
    filters:
      resolution.not: 4K
    item_overlay: HDR
    build_collection: false

4K, HDR, Dolby Overlays

Here's an example of how you could add 4K, 4K-HDR, 4K-Dolby, Dolby, and HDR overlays

Note: This only works is your filenames have a tag in them for Dolby files as Plex cannot detect dolby yet

collections:
  4K:
    plex_search:
      all:
        resolution: 4K
        hdr: false
    filters:
      filepath.not: DoVi
    item_overlay: 4K
    build_collection: false
  4K-HDR:
    plex_search:
      all:
        resolution: 4K
        hdr: true
    filters:
      filepath.not: DoVi
    item_overlay: 4K-HDR
    build_collection: false
  4K-Dolby:
    plex_search:
      all:
        resolution: 4K
    filters:
      filepath: DoVi
    item_overlay: 4K-Dolby
    build_collection: false
  HDR:
    plex_search:
      all:
        hdr: true
    filters:
      filepath.not: DoVi
      resolution.not: 4K
    item_overlay: HDR
    build_collection: false
  Dolby:
    plex_all: true
    filters:
      filepath: DoVi
      resolution.not: 4K
    item_overlay: Dolby
    build_collection: false