7.8 KiB

Raw Blame History

Resolution Collections

The resolution Default Collection File is used to dynamically create collections based on the resolutions available in your library.

Requirements & Recommendations

Supported Library Types: Movie, Show

Collections Section 120

Collection	Key	Description
`Resolution Collections`	`separator`	Separator Collection to denote the Section of Collections.
`<<Resolution>> Movies/Shows` Example: `1080p Movies`	`<<Number>>` Example: `1080`	Collection of Movies/Shows that have this Resolution.

Standards Style

Below is a screenshot of the alternative Standards (standards) style which can be set via the style template variable.

Standards Style takes the base resolutions ("4K" and "720p") and turns them into the commonly-known standards name ("Ultra HD" and "HD Ready")

Config

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

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

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

style

Description: Controls the visual theme of the collections created.

Values:
`default`	Default Theme
`standards`	Standards Theme

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

include Description: Overrides the default include list.
Values: Any Resolutions found in your library

exclude Description: Exclude these Resolutions from creating a Dynamic Collection.
Values: List of Resolutions found in your library

addons Description: Overrides the default addons dictionary. Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
Values: Dictionary List of Resolutions found in your library

append_include Description: Appends to the default include list.
Values: List of Resolutions found in your library

remove_include Description: Removes from the default include list.
Values: List of Resolutions found in your library

append_addons Description: Appends to the default addons dictionary.
Values: Dictionary List of Resolutions found in your library

remove_addons Description: Removes from the default addons dictionary.
Values: Dictionary List of Resolutions found in your library

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

summary_format Description: Changes the summary format of the Dynamic Collections.
Default: <<library_translationU>>s that have the resolution <<key_name>>.
Values: Any string.

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: resolution
        template_variables:
          sep_style: green #(1)!
          exclude:
            - sd #(2)!
          sort_by: title.asc

Use the green Separator Style
Do not use the "sd" resolution as part of the "480p Movies/Shows" Collections

Default values

These are lists provided for reference to show what values will be in use if you do no customization. If you want to customize these values, use the methods described above. These do not show how to change a name or a list.

Default `include`

include:
  - 4k
  - 1080
  - 720
  - 480

Default `addons`

addons:
  4k:
    - 8k
  1080:
    - 2k
  480:
    - 144
    - 240
    - 360
    - sd
    - 576

7.8 KiB Raw Blame History