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 |
---|---|---|
|
|
Separator Collection to denote the Section of Collections. |
|
|
Collection of Movies/Shows based on or inspired by books |
|
|
Collection of Movies/Shows based on or inspired by comics |
|
|
Collection of Movies/Shows based on or inspired by true stories |
|
|
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 |
||||
---|---|---|---|---|---|
|
Description: Changes the Builder Limit for all collections in a Defaults file. |
||||
|
Description: Changes the Builder Limit of the specified key’s collection. |
||||
|
Description: Changes the Smart Filter Sort for all collections in a Defaults file. |
||||
|
Description: Changes the Smart Filter Sort of the specified key’s collection. |
||||
|
Description: Changes the Sync Mode for all collections in a Defaults file.
|
||||
|
Description: Changes the Sync Mode of the specified key’s collection.
|
||||
|
Description: Exclude these Media Outlets from creating a Dynamic Collection. |
||||
|
Description: Changes the title format of the Dynamic Collections. |
||||
|
Description: Changes the summary format of the Dynamic Collections. |
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