Plex
/
Plex-Meta-Manager
mirror of https://github.com/meisnate12/Plex-Meta-Manager.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'fdf3494227'
${ noResults }
Plex-Meta-Manager/docs/defaults/movie/seasonal.md

17 KiB
Raw Blame History

Seasonal Collections

The seasonal Default Metadata File is used to dynamically create seasonal collections based on holidays .

This file only works with Movie Libraries.

Collections Section 00

Collection Key Description
Seasonal Collections separator Separator Collection to denote the Section of Collections.
🎊 New Year's Day Movies years Collection of Movies related to New Year's Day.
💘 Valentine's Day Movies valentine Collection of Movies related to Valentine's Day.
☘ St. Patrick's Day Movies patrick Collection of Movies related to St. Patrick's Day.
🐰 Easter Movies easter Collection of Movies related to Easter.
🤱 Mother's Day Movies mother Collection of Movies related to Mother's Day.
🪖 Memorial Day Movies memorial Collection of Movies related to Memorial Day.
👨 Father's Day Movies father Collection of Movies related to Father's Day.
🎆 Independence Day Movies independence Collection of Movies related to Independence Day.
⚒ Labor Day Movies labor Collection of Movies related to Labor Day.
🎃 Halloween Movies halloween Collection of Movies related to Halloween.
🦃 Thanksgiving Movies thanksgiving Collection of Movies related to Thanksgiving.
🎅 Christmas Movies christmas Collection of Movies related to Christmas.

Config

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

libraries:
  Movies:
    metadata_path:
      - pmm: seasonal

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: true to turn on the collection
sep_style Description: 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
schedule_<<key>> Description: Changes the Schedule of the specified key's Collection.
Default:
🎊 New Year's Day Moviesrange(12/26-01/04)
💘 Valentine's Day Moviesrange(02/01-02/29)
☘ St. Patrick's Day Moviesrange(03/01-03/18)
🐰 Easter Moviesrange(03/20-04/30)
🤱 Mother's Day Moviesrange(05/05-05/10)
🪖 Memorial Day Moviesrange(5/18-6/7)
👨 Father's Day Moviesrange(06/15-06/20)
🎆 Independence Day Moviesrange(06/23-07/11)
⚒ Labor Day Moviesrange(09/01-09/10)
🎃 Halloween Moviesrange(10/01-10/31)
🦃 Thanksgiving Moviesrange(11/01-11/30)
🎅 Christmas Moviesrange(12/01-12/31)

Values: Any Schedule Option
exclude Description: Exclude these Seasons from creating a Dynamic Collection.
Values: List of Seasons Keys
seasonal_name Description: Changes the title format of the Dynamic Collections.
Default: <<key_name>> <<library_translationU>>s
Values: Any string with <<key_name>> in it.
seasonal_summary Description: Changes the summary format of the Dynamic Collections.
Default: A collection of <<key_name>> <<library_translation>>s that may relate to the season.
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: seasonal
        template_variables:
          use_separator: true
          sep_style: stb
          use_independence: false
          schedule_thanksgiving: range(10/01-10/30)
          sort_by: random