6.5 KiB

Raw Blame History

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 Variable Default Values

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.

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 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

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.

Example Template Variable Amendments

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

???+ tip

Anywhere you see this icon:

> :fontawesome-solid-circle-plus:

That's a tooltip, you can press them to get more information.

libraries:
  Movies:
    metadata_path:
      - pmm: based
        template_variables:
          sep_style: navy #(1)!
          use_comics: false #(2)!
          order_true_story: 01 #(3)!
          visible_library_video_games: true #(4)!
          visible_home_video_games: true #(5)!
          visible_shared_video_games: true #(6)!

Use the navy Separator Style
Do not create a "Based on a Comic" collection
Make the "Based on a True Story" collection appear in the collection list before the other collections in this file
Pin the "Based on a Video Game" collection to the Recommended tab of the library
Pin the "Based on a Video Game" collection to the home screen of the server owner
Pin the "Based on a Video Game" collection to the home screen of other users of the server

6.5 KiB Raw Blame History