Based On… Collections¶

The based Default Metadata File is used to create collections with items that are based on or inspired by various media outlets (such as Books or Video Games).

Requirements & Recommendations¶

Supported Library Types: Movie, Show

Collections Section 085¶

Collection	Key	Description
`Based on... Collections`	`separator`	Separator Collection to denote the Section of Collections.
`Based on a Book`	`books`	Collection of Movies/Shows based on or inspired by books
`Based on a Comic`	`comics`	Collection of Movies/Shows based on or inspired by comics
`Based on a True Story`	`true_story`	Collection of Movies/Shows based on or inspired by true stories
`Based on a Video Game`	`video_games`	Collection of Movies/Shows based on or inspired by video games

Config¶

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

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

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

limit

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

limit_<<key>>¹

Description: Changes the Builder Limit of the specified key’s collection.
Default: limit
Values: Number Greater then 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

sync_mode

Description: Changes the Sync Mode for all collections in a Defaults file.
Default: sync
Values:

`sync`	Add and Remove Items based on Builders
`append`	Only Add Items based on Builders

sync_mode_<<key>>¹

Description: Changes the Sync Mode of the specified key’s collection.
Default: sync_mode
Values:

`sync`	Add and Remove Items based on Builders
`append`	Only Add Items based on Builders

exclude

Description: Exclude these Media Outlets from creating a Dynamic Collection.
Values: List of Media Outlet Keys

name_format

Description: Changes the title format of the Dynamic Collections.
Default: Based on a <<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 based on or inspired by <<translated_key_name>>s.
Values: Any string.

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: based
        template_variables:
          use_separator: false
          sep_style: purple
          use_comics: false
          order_true_story: 01
          visible_library_video_games: true
          visible_home_video_games: true
          visible_shared_video_games: true