7.7 KiB

Raw Blame History

Resolution Collections

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

Requirements & Recommendations

Supported Library Types: Movie, Show

Collections Section 15

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:
    metadata_path:
      - pmm: resolution
  TV Shows:
    metadata_path:
      - pmm: resolution

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

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

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

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

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

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

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

resolution_other_summary Description: Changes the summary format of the Dynamic Collections.
Default: <<library_translationU>>s that have other uncommon resolutions.
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: resolution
        template_variables:
          use_separator: false
          sep_style: green
          exclude:
            - SD
          sort_by: title.asc

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.7 KiB Raw Blame History