Actor Collections¶

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

Requirements & Recommendations¶

Supported Library Types: Movie, Show

Collections Section 140¶

Collection	Key	Description
`Actors Collections`	`separator`	Separator Collection to denote the Section of Collections.
`<<actor_name>>` Example: `Frank Welker`	`<<actor_name>>` Example: `Frank Welker`	Collection of Movies/Shows the actor is top billing in.

Poster Styles¶

This Default can use the style template variable to easily change the posters styles.

Black & White Style (Default)¶

Rainier Style¶

Signature Style¶

Diiivoy Style¶

Diiivoy Color Style¶

Config¶

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

libraries:
  Movies:
    metadata_path:
      - pmm: actor
  TV Shows:
    metadata_path:
      - pmm: actor

Template Variables¶

Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.

Note that the template_variables: section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it’s just ignored.

All Shared Collection Variables are available as well as the additional Variables below which can be used to customize the file.

This file contains a Separator so all Shared Separator Variables are available as well.

Variable

Description & Values

style

Description: Controls the visual theme of the collections created.
Default: bw
Values: bw, rainier, signature, diiivoy, or diiivoycolor

limit

Description: Changes the Builder Limit for all collections in a Defaults file.
Values: Number Greater than 0

limit_<<key>>¹

Description: Changes the Builder Limit of the specified key’s collection.
Default: limit
Values: Number Greater than 0

sort_by

Description: Changes the Smart Filter Sort for all collections in a Defaults file.
Default: release.desc
Values: Any smart_filter Sort Option

sort_by_<<key>>¹

Description: Changes the Smart Filter Sort of the specified key’s collection.
Default: sort_by
Values: Any smart_filter Sort Option

data

Description: Replaces the data dynamic collection value.

Attribute	Description & Values
`depth`	Controls the depth within the casting credits to search for common actors Default: 5 Values: Number greater than 0
`limit`	Controls the maximum number of collections to create Default: 25 Values: Number greater than 0

include

Description: Force these Actors to be included to create a Dynamic Collection.
Values: List of Actor Names

exclude

Description: Exclude these Actors from creating a Dynamic Collection.
Values: List of Actor Names

name_format

Description: Changes the title format of the Dynamic Collections.
Default: <<key_name>>
Values: Any string with <<key_name>> in it.

summary_format

Description: Changes the summary format of the Dynamic Collections.
Default: <<library_translationU>>s with <<key_name>>.
Values: Any string with <<key_name>> in it.

tmdb_birthday

Description: Controls if the Definition is run based on tmdb_person’s Birthday. Has 3 possible attributes this_month, before and after.
Values:

`this_month`	Run’s if Birthday is in current Month	`true`/`false`
`before`	Run if X Number of Days before the Birthday	Number 0 or greater
`after`	Run if X Number of Days after the Birthday	Number 0 or greater

tmdb_person_offset_<<key>>¹

Description: Changes the summary tmdb_person_offset for the specific key.
Default: 0
Values: Dictionary of Actor Name as the keys and the tmdb_person_offset as the value.

Each default collection has a key that when calling to effect a specific collection you must replace <<key>> with when calling.

The below is an example config.yml extract with some Template Variables added in to change how the file works.

libraries:
  Movies:
    metadata_path:
      - pmm: actor
        template_variables:
          data:
            depth: 10
            limit: 20
          style: diiivoy
          sort_by: title.asc
          use_separator: false
          sep_style: purple
          tmdb_person_offset_Richard Brooks: 1