Mirrors/Plex-Meta-Manager
2
0
Fork 0
mirror of https://github.com/meisnate12/Plex-Meta-Manager synced 2024-12-25 12:23:06 +00:00
Code Issues Projects Releases Packages Wiki Activity
Plex-Meta-Manager/docs/defaults/both/resolution_standards.md
meisnate12 853beb019f [117] finish collection defaults in the wiki
2022-10-13 17:02:05 -04:00

7.7 KiB
Raw Blame History

Resolution Standards Collections

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

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

To avoid duplication, this file should not be used in combination with resolution.

This file works with Movie and TV Libraries.

Collections Section 15

Collection Key Description
Resolution Collections separator Separator Collection to denote the Section of Collections.
<<Resolution>> Movies/Shows
Example: Full HD Movies		 <<Number>>
Example: Full HD		 Collection of Movies/Shows that have this Resolution.
Other Resolution Movies/Shows other Collection of Movies/Shows that not a standard Resolution.

Config

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

libraries:
  Movies:
    metadata_path:
      - pmm: resolution_standards
  TV Shows:
    metadata_path:
      - pmm: resolution_standards

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 templates_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 Variables are available as well as the additional Variables below which can be used to customize the file.

Variable Description & Values
use_separator Description: Turn the Separator Collection off.
Values: false to turn of the collection
sep_style Description: Choose the Separator Style.
Default: orig
Values: orig, red, blue, green, gray, purple, or stb
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.

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_standards
        template_variables:
          use_separator: false
          sep_style: stb
          use_other: false
          exclude:
            - HD Ready
          sort_by: title.asc

Default include

include:
  - SD
  - HD Ready
  - Full HD
  - Ultra HD

Default addons

addons:
  SD:
    - 144
    - 240
    - 360
    - 576
    - sd
  HD Ready:
    - 720
  Full HD:
    - 1080
    - 2k
  Ultra HD:
    - 4k
    - 8k