11 KiB

Raw Blame History

Library Attributes

Within the Configuration File, the libraries attribute specifies the Plex libraries that the user wants Plex Meta Manager to act on.

Attributes are used to instruct Plex Meta Manager what actions to take, such as "load the following libraries" or "execute the following Collection Definition files". These attributes can be specified individually per library, or can be inherited from the global value if it has been set. If an attribute is specified at both the library and global level, then the library level attribute will take priority.

Example

This example is an advanced version of the library mappings which highlights some attributes being set at the global level, and some being set at the library level:

Click to Expand

In this example, the "TV Shows On Second Plex" library has a library-level plex configuration, which takes priority over the plex configuration set at the global level.

The "Anime" library also has a library-level radarr configuration, which takes priority over the radarr configuration set at the global level.

libraries:
  Movies:
    metadata_path:
      - file: config/Movies.yml
      - pmm: imdb
      - pmm: studio
      - pmm: genre
      - pmm: actor
    operations:
      mass_critic_rating_update: tmdb
      split_duplicates: true
  TV Shows:
    metadata_path:
      - file: config/TV Shows.yml
      - pmm: tmdb
      - pmm: network
    overlay_path:
      - remove_overlays: false
      - file: config/Overlays.yml
  TV Shows On Second Plex:
    library_name: TV Shows
    plex:
      url: http://192.168.1.98:32400
      token: ####################
    metadata_path:
      - file: config/TV Shows.yml
      - pmm: tmdb
      - pmm: network
  Anime:
    metadata_path:
      - file: config/Anime.yml
      - pmm: myanimelist
    radarr:
      url: http://192.168.1.45:7878
      token: ################################
      root_folder_path: S:/Anime
    settings:
      asset_directory: config/assets/anime
plex:
  url: http://192.168.1.12:32400
  token: ####################
radarr:
  url: http://192.168.1.12:7878
  token: ################################
  add: true
  root_folder_path: S:/Movies
  monitor: true
  availability: announced
  quality_profile: HD-1080p
  tag: pmm
  search: false

Attributes

The available attributes for each library are as follows:

Attribute	Values	Default	Required
`library_name`	Library name (required only when trying to use multiple libraries with the same name)	Base Attribute Name	❌
`metadata_path`	Location of Metadata YAML files	`/config/<<MAPPING_NAME>>.yml`	❌
`overlay_path`	Location of Overlay YAML files	None	❌
`report_path`	Location to create the YAML file listing added, removed, filtered, and missing items for this library	`/config/<<MAPPING_NAME>>_report.yml`	❌
`template_variables`	Library template variables to be applied to every Metadata and Overlay file run.	N/A	❌
`schedule`	Use any schedule option to control when this library is run.	daily	❌
`operations`	Library Operations to run	N/A	❌
`settings`	Any `setting` attribute that overrides a global value	global	❌
`plex`	Any `plex` attribute that overrides a global value	global	✅ Either here or globally
`radarr`	Any `radarr` attribute that overrides a global value	global	❌
`sonarr`	Any `sonarr` attribute that overrides a global value	global	❌
`tautulli`	Any `tautulli` attribute that overrides a global value	global	❌

Library Name

Each library that the user wants Plex Meta Manager to interact with must be documented with a library attribute. A library attribute is represented by the mapping name (i.e. Movies or TV Shows), this must have a unique name that correlates with a library of the same name within the Plex Media Server. In the situation that two servers are being connected to which both have libraries of the same name, the library_name attribute can be utilized to specify the real Library Name, whilst the library attribute's mapping name can be made into a placeholder. This is showcased below:

Example

libraries:
  Movies01:
    library_name: Movies
  Movies02:
    library_name: Movies
    plex:
      url: http://192.168.1.35:32400
      token: ####################
  TV Shows:
  Anime:
plex:
  url: http://192.168.1.12:32400
  token: ####################

In this example, "Movies01", "TV Shows", and "Anime" will all use the global plex server (http://192.168.1.12:32400) which is defined using the global plex mapping. "Movies02" will use the plex server http://192.168.1.35:32400 which is defined under its plex mapping over the global mapping.

Metadata Path

The metadata_path attribute is used to define Metadata Files by specifying the path type and path of the files that will be executed against the parent library. See Path Types for how to define them.

libraries:
  TV Shows:
    metadata_path:
      - file: config/TV Shows.yml
      - pmm: tmdb
      - pmm: network

By default, when metadata_path is missing the script will look within the root PMM directory for a metadata file called <MAPPING_NAME>.yml. In this example, Plex Meta Manager will look for a file named TV Shows.yml.

libraries:
  TV Shows:

Overlay Path

The overlay_path attribute is used to define Overlay Files by specifying the path type and path of the files that will be executed against the parent library. See Path Types for how to define them.

libraries:
  TV Shows:
    metadata_path:
      - file: config/TV Shows.yml
    overlay_path:
      - file: config/Overlays.yml

Special Overlay Path Calls

Remove Overlays

You can remove overlays from a library by adding remove_overlays: true to overlay_path. This will remove all overlays when run and not generate new ones.

libraries:
  TV Shows:
    metadata_path:
      - file: config/TV Shows.yml
    overlay_path:
      - remove_overlays: true
      - file: config/Overlays.yml

Reapply Overlays

You can reapply overlays from a library by adding reapply_overlays: true to overlay_path. This will reapply overlays to every item in your library.

libraries:
  TV Shows:
    metadata_path:
      - file: config/TV Shows.yml
    overlay_path:
      - reapply_overlays: true
      - file: config/Overlays.yml

Reset Overlays

You can reset overlays from a library by adding reset_overlays to overlay_path and setting it to either tmdb or plex depending on where you want to source the images from. This will use the reset image when overlaying items in your library.

libraries:
  TV Shows:
    metadata_path:
      - file: config/TV Shows.yml
    overlay_path:
      - reset_overlays: plex
      - file: config/Overlays.yml

Schedule Overlays

You can schedule all overlays from a library by adding schedule to overlay_path and setting it to Any Schedule Option.

You cannot schedule individual Overlay Files.

libraries:
  TV Shows:
    metadata_path:
      - file: config/TV Shows.yml
    overlay_path:
      - schedule: weekly(sunday)
      - file: config/Overlays.yml

Report Path

The report_path attribute is used to define where to save the YAML Report file. This file is used to store information about what media is added, removed, filtered, and missing from the Plex library compared to what is expected from the Metadata file.

If your Metadata file creates a collection with Movie 1, Movie 2 and Movie 3 but your Plex library only has Movie 1 and Movie 3, then the missing YAML file will be updated to inform the user that Movie 2 was missing from the library.

The default and recommended path is /config/<<MAPPING_NAME>>report.yml where <<MAPPING_NAME>> is the name of the library attribute, as showcased below:

libraries:
  Movies:
    report_path: /config/Movies_report.yml

Alternatively, Report YAML files can be placed in their own directory, as below:

libraries:
  Movies:
    report_path: /config/reports/Movies.yml

Library Template Variables

Library template variables to be applied to every Metadata and Overlay file run.

libraries:
  Movies:
    template_variables:
      collection_mode: hide_items

11 KiB Raw Blame History

Library Attributes