You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Plex-Meta-Manager/docs/defaults/both/actor.md

4.6 KiB

Actor Default Metadata File

The - pmm: actor Metadata File is used to dynamically create collections based on the most popular actors/actresses in your library.

Example Collections Created:

The below YAML in your config.yml will create the collections:

libraries:
  Movies:
    metadata_path:
      - pmm: actor

Rainier Style

Below is a screenshot of the alternative Rainier style which can be set via template variables

Template Variables

Template Variables can be used to manipulate the actor file from the default settings which are provided.

Note that the templates_variables: section only needs to be used if you do NOT want to use the default settings.

Below are the available variables which can be used to customize the actor file.

Variable Usage Default Value Values
style Controls the visual theme of the collections created bw bw - Black and white theme or
rainier - Rainier theme
sort_by Controls the sort method for the collections release.desc Any sort method in the Sorts Options Table
collection_section Controls the sort order of these collections against other default collections 17 Any number
collection_mode Controls the collection mode of these collections default default - Library default
hide - Hide Collection
hide_items- Hide Items in this Collection
show_items - Show this Collection and its Items
use_separator Controls whether a separator is created true true or false
sep_style Sets the theme of the separator orig orig, blue, gray, green, purple, red, stb
item_radarr_tag Radarr Tag for existing items list of tag(s) to be applied to existing items
item_sonarr_tag Sonarr Tag for existing items list of tag(s) to be applied to existing items

The below shows an example config.yml with all the template_variables set away from their defaults:

libraries:
  Movies:
    metadata_path:
      - pmm: actor
        template_variables:
          style: rainier
          sort_by: title.asc
          collection_section: 12
          collection_mode: show_items
          use_separator: false
          sep_style: purple

Dynamic Collections attributes can also be edited to tweak the setup of the collections. The YAML file which creates the actor collections can be found here

An example of this is; To amend the maximum amount of collections that are created (default is 25), the following template variable can be used:

libraries:
  Movies:
    metadata_path:
      - pmm: actor
        template_variables:
          data:
            limit: 10

Further information on editing Dynamic Collections using template variables can be found here