4.0 KiB

Raw Blame History

Basic Charts Collections

The basic Default Collection File is used to create collections based on recently released media in your library.

Requirements & Recommendations

Supported Library Types: Movie, Show

Collections Section 010

Collection	Key	Description
`Newly Released`	`released`	Collection of Movies or TV Shows released in the last 90 days.
`New Episodes`	`episodes`	Collection of Episodes released in the last 7 days.

Config

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

libraries:
  Movies:
    collection_files:
      - pmm: basic
  TV Shows:
    collection_files:
      - pmm: basic

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.

Variable Description & Values

limit Description: Changes the Smart Filter Limit for all collections in a Defaults file.
Values: Number greater than 0

limit_<<key>>¹ Description: Changes the Smart Filter 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

in_the_last_<<key>>¹

Description: Changes how far back the Smart Filter looks.

Default:
`released`	`90`
`episodes`	`7`

Values: Number greater than 0

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

{% include-markdown "../collection_variables.md" %}

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:
    collection_files:
      - pmm: basic
        template_variables:
          in_the_last_episodes: 14 #(1)!
          visible_library_released: true #(2)!
          visible_home_released: true #(3)!
          visible_shared_released: true #(4)!

Change the Smart Filter to look at episodes in the last 14 days.
Pin the "Newly Released" collection to the Recommended tab of the library
Pin the "Newly Released" collection to the home screen of the server owner
Pin the "Newly Released" collection to the home screen of other users of the server

4.0 KiB Raw Blame History