Seasonal Collections¶

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

Requirements & Recommendations¶

Supported Library Types: Movie

Collections Section 000¶

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.
`🎖 Veteran's Day Movies`	`veteran`	Collection of Movies related to Veteran's Day.
`🦃 Thanksgiving Movies`	`thanksgiving`	Collection of Movies related to Thanksgiving.
`🎅 Christmas Movies`	`christmas`	Collection of Movies related to Christmas.
`🌊🌺 Asian American Pacific Islander Movies`	`aapi`	Collection of Movies related to Asian American Pacific Islander Month
`♿ Disability Month Movies`	`disabilities`	Collection of Movies related to Disability Month
`✊ 🏿 Black History Month Movies`	`black_history`	Collection of Movies related to Black History Month
`🏳️‍🌈 LGBTQ Month Movies`	`lgbtq`	Collection of Movies related to LGBTQ Month
`🪅 National Hispanic Heritage Movies`	`latinx`	Collection of Movies related to National Hispanic Heritage Month
`🚺 Women's History Month Movies`	`women`	Collection of Movies related to Women's History Month

Config¶

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

libraries:
  Movies:
    collection_files:
      - default: 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 template_variables: section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.

Variable Lists (click to expand)

File-Specific Template Variables are variables available specifically for this Kometa Defaults file.
Shared Template Variables are additional variables shared across the Kometa Defaults.
Shared Separator Variables are additional variables available since this Default contains a Separator.

File-Specific Template VariablesShared Template VariablesShared Separator Variables

Variable Description & Values

tmdb_collection_<<key>>¹ Description: Adds the TMDb Collection IDs given to the specified key's collection. Overrides the default tmdb_collection for that collection if used.
Values: List of TMDb Collection IDs

tmdb_movie_<<key>>¹ Description: Adds the TMDb Movie IDs given to the specified key's collection. Overrides the default tmdb_movie for that collection if used.
Values: List of TMDb Movie IDs

imdb_list_<<key>>¹ Description: Adds the Movies in the IMDb List to the specified key's collection. Overrides the default imdb_list for that collection if used.
Values: List of IMDb List URLs

imdb_search_<<key>>¹ Description: Adds the Movies in the IMDb Search to the specified key's collection. Overrides the default imdb_search for that collection if used.
Values: List of IMDb List URLs

trakt_list_<<key>>¹ Description: Adds the Movies in the Trakt List to the specified key's collection. Overrides the default trakt_list for that collection if used.
Values: List of Trakt List URLs

mdblist_list_<<key>>¹ Description: Adds the Movies in the MDb List to the specified key's collection. Overrides the default mdblist_list for that collection if used.
Values: List of MDbList URLs

emoji Description: Controls the Emoji Prefix for all Collections. Set to "" to remove all emojis.
Values: Any String

emoji_<<key>>¹ Description: Controls the Emoji Prefix for the specified key's collection. Overrides the default emoji for that collection if used.
Values: Any String

limit Description: Changes the Builder Limit for all collections in this 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

sync_mode

Description: Changes the Sync Mode for all collections in a Defaults file.
Default: sync
Values:

`sync`	Add and Remove Items based on Builders
`append`	Only Add Items based on Builders

sync_mode_<<key>>¹

Description: Changes the Sync Mode of the specified key's collection.
Default: sync_mode
Values:

`sync`	Add and Remove Items based on Builders
`append`	Only Add Items based on Builders

sort_by Description: Changes the Smart Filter Sort for all collections in this 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 Description: Changes the Schedule for all collections in this file. Use daily to have all collections show.
Values: Any Schedule Option

schedule_<<key>>¹ Description: Changes the Schedule of the specified key's collection. Overrides the default schedule for that collection if used.
Values: Any Schedule Option

data Description: Overrides the default data dictionary. Defines the data that the custom dynamic collection processes.
Values: Dictionary List of keys/names

append_data Description: Appends to the default data dictionary.
Values: Dictionary List of keys/names

remove_data Description: Removes from the default data dictionary.
Values: List of keys to remove

exclude Description: Exclude these Seasons from creating a Dynamic Collection.
Values: List of Seasons Keys

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: A collection of <<key_name>> <<library_translation>>s that may relate to the season.
Values: Any string.

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

Variable Description & Values

language Description: Set the language of Collection Names and Summaries
Default: default
Values: default (English), fr (French), or de (German)

use_all Description: Turns off all Collections in a Defaults file.
Values: false to turn off the collection

use_<<key>>¹ Description: Turns off individual Collections in a Defaults file.
Values: false to turn off the collection

name_<<key>>¹ Description: Changes the name of the specified key's collection.
Values: New Collection Name

summary_<<key>>¹ Description: Changes the summary of the specified key's collection.
Values: New Collection Summary

collection_section Description: Changes the sort order of the collection sections against other default collection sections. (Use quotes to not lose leading zeros "05")
Values: Any number

sort_prefix Description: Changes the prefix of the sort title.
Default: !
Values: Any String

sort_title Description: Changes the sort title of all collections.
Default: <<sort_prefix>><<collection_section>><<pre>><<order_<<key>>>><<title>>
Values: Any String

name_mapping Description: Changes the name_mapping of all collections.
Default: <<title>>
Values: Any String with <<key_name>> in it.

order_<<key>>¹ Description: Controls the sort order of the collections in their collection section.
Values: Any number

collection_mode

Description: Controls the collection mode of all collections in a Defaults file.
Values:

`default`	Library default
`hide`	Hide Collection
`hide_items`	Hide Items in this Collection
`show_items`	Show this Collection and its Items

ignore_ids Description: Set a list or comma-separated string of TMDb/TVDb IDs to ignore in all collections.
Values: List or comma-separated string of TMDb/TVDb IDs

ignore_imdb_ids Description: Set a list or comma-separated string of IMDb IDs to ignore in all collections.
Values: List or comma-separated string of IMDb IDs

minimum_items Description: Set the number of minimum items for a collection to be created for all collections.
Values: Any number greater than 0

minimum_items_<<key>>¹ Description: Set the number of minimum items for a collection to be created for the specified key's collection.
Values: Any number greater than 0

schedule Description: Set the schedule for all of the collections in a Defaults file.
Values: Any Scheduling Option

schedule_<<key>> Description: Set the schedule for a specific key's collection.
Values: Any Scheduling Option

delete_collections_named Description: Used to delete any collections in your plex named one of the given collections.
Values: List of Collection Names to delete

url_poster Description: Changes the poster url for all collections.
Values: URL directly to the Image

url_poster_<<key>>¹ Description: Changes the poster url of the specified key's collection.
Values: URL directly to the Image

file_poster Description: Sets the poster filepath for all collections.
Values: Filepath directly to the Image

file_poster_<<key>>¹ Description: Sets the poster filepath of the specified key's collection.
Values: Filepath directly to the Image

url_background Description: Sets the background url for all collections.
Values: URL directly to the Image

url_background__<<key>>¹ Description: Sets the background url of the specified key's collection.
Values: URL directly to the Image

file_background Description: Sets the background filepath for all collections.
Values: Filepath directly to the Image

file_background__<<key>>¹ Description: Sets the background filepath of the specified key's collection.
Values: Filepath directly to the Image

visible_library

Description: Controls visible on Library Recommended Tab for all collections in a Defaults file. (Only works with Plex Pass)
Values:

`true`	Visible
`false`	Not Visible
Any `schedule` Option	Visible When Scheduled

visible_library_<<key>>¹

Description: Controls visible on Library Recommended Tab of the specified key's collection. (Only works with Plex Pass)
Default: visible_library
Values:

`true`	Visible
`false`	Not Visible
Any `schedule` Option	Visible When Scheduled

visible_home

Description: Controls visible on Home Tab for all collections in a Defaults file. (Only works with Plex Pass)
Values:

`true`	Visible
`false`	Not Visible
Any `schedule` Option	Visible When Scheduled

visible_home_<<key>>¹

Description: Controls visible on Home Tab of the specified key's collection. (Only works with Plex Pass)
Default: visible_home
Values:

`true`	Visible
`false`	Not Visible
Any `schedule` Option	Visible When Scheduled

visible_shared

Description: Controls visible on Shared Users' Home Tab for all collections in a Defaults file. (Only works with Plex Pass)
Values:

`true`	Visible
`false`	Not Visible
Any `schedule` Option	Visible When Scheduled

visible_shared_<<key>>¹

Description: Controls visible on Shared Users' Home Tab of the specified key's collection. (Only works with Plex Pass)
Default: visible_shared
Values:

`true`	Visible
`false`	Not Visible
Any `schedule` Option	Visible When Scheduled

radarr_upgrade_existing Description: Override Radarr upgrade_existing attribute for all collections in a Defaults file.
Values: true or false

radarr_upgrade_existing_<<key>>¹ Description: Override Radarr upgrade_existing attribute of the specified key's collection.
Values: true or false

radarr_monitor_existing Description: Override Radarr monitor_existing attribute for all collections in a Defaults file.
Values: true or false

radarr_monitor_existing_<<key>>¹ Description: Override Radarr monitor_existing attribute of the specified key's collection.
Values: true or false

radarr_add_missing Description: Override Radarr add_missing attribute for all collections in a Defaults file.
Values: true or false

radarr_add_missing_<<key>>¹ Description: Override Radarr add_missing attribute of the specified key's collection.
Default: radarr_add_missing
Values: true or false

radarr_folder Description: Override Radarr root_folder_path attribute for all collections in a Defaults file.
Values: Folder Path

radarr_folder_<<key>>¹ Description: Override Radarr root_folder_path attribute of the specified key's collection.
Default: radarr_folder
Values: Folder Path

radarr_search Description: Override Radarr search attribute or all collections in a Defaults file.
Values: true or false

radarr_search_<<key>>¹ Description: Override Radarr search attribute of the specified key's collection.
Default: radarr_search
Values: true or false

radarr_tag Description: Override Radarr tag attribute for all collections in a Defaults file.
Values: List or comma-separated string of tags

radarr_tag_<<key>>¹ Description: Override Radarr tag attribute of the specified key's collection.
Default: radarr_tag
Values: List or comma-separated string of tags

item_radarr_tag Description: Used to append a tag in Radarr for every movie found by the builders that's in Radarr for all collections in a Defaults file.
Values: List or comma-separated string of tags

item_radarr_tag_<<key>>¹ Description: Used to append a tag in Radarr for every movie found by the builders that's in Radarr of the specified key's collection.
Default: item_radarr_tag
Values: List or comma-separated string of tags

sonarr_upgrade_existing Description: Override Sonarr upgrade_existing attribute for all collections in a Defaults file.
Values: true or false

sonarr_upgrade_existing_<<key>>¹ Description: Override Sonarr upgrade_existing attribute of the specified key's collection.
Values: true or false

sonarr_monitor_existing Description: Override Sonarr monitor_existing attribute for all collections in a Defaults file.
Values: true or false

sonarr_monitor_existing_<<key>>¹ Description: Override Sonarr monitor_existing attribute of the specified key's collection.
Values: true or false

sonarr_add_missing Description: Override Sonarr add_missing attribute for all collections in a Defaults file.
Values: true or false

sonarr_add_missing_<<key>>¹ Description: Override Sonarr add_missing attribute of the specified key's collection.
Default: sonarr_add_missing
Values: true or false

sonarr_folder Description: Override Sonarr root_folder_path attribute for all collections in a Defaults file.
Values: Folder Path

sonarr_folder_<<key>>¹ Description: Override Sonarr root_folder_path attribute of the specified key's collection.
Default: sonarr_folder
Values: Folder Path

sonarr_search Description: Override Sonarr search attribute or all collections in a Defaults file.
Values: true or false

sonarr_search_<<key>>¹ Description: Override Sonarr search attribute of the specified key's collection.
Default: sonarr_search
Values: true or false

sonarr_tag Description: Override Sonarr tag attribute for all collections in a Defaults file.
Values: List or comma-separated string of tags

sonarr_tag_<<key>>¹ Description: Override Sonarr tag attribute of the specified key's collection.
Default: sonarr_tag
Values: List or comma-separated string of tags

item_sonarr_tag Description: Used to append a tag in Sonarr for every series found by the builders that's in Sonarr for all collections in a Defaults file.
Values: List or comma-separated string of tags

item_sonarr_tag_<<key>>¹ Description: Used to append a tag in Sonarr for every series found by the builders that's in Sonarr of the specified key's collection.
Default: item_sonarr_tag
Values: List or comma-separated string of tags

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

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: amethyst, aqua, blue, forest, fuchsia, gold, gray, green, navy, ocean, olive, orchid, orig, pink, plum, purple, red, rust, salmon, sand, stb, or tan

sort_prefix Description: Changes the prefix of the sort title.
Default: !
Values: Any String

sort_title Description: Changes the sort title of all collections.
Default: <<sort_prefix>><<collection_section>>_!<<title>>
Values: Any String

placeholder_tmdb_movie Description: Add a placeholder Movie to the Separator. Only valid for Movie libraries.
Values: TMDb Movie ID

placeholder_tvdb_show Description: Add a placeholder Show to the Separator. Only valid for Show libraries.
Values: TVDb Show ID

placeholder_imdb_id Description: Add a placeholder Movie/Show to the Separator. Valid for Movie or Show libraries assuming the ID points to an item of the correct type.
Values: IMDb ID

name_separator Description: Changes the name of the specified key's collection.
Values: New Collection Name

summary_separator Description: Changes the summary of the specified key's collection.
Values: New Collection Summary

collection_section Description: Changes the sort order of the collection sections against other default collection sections.
Values: Any number

collection_mode

Description: Controls the collection mode of all collections in a Defaults file.
Values:

`default`	Library default
`hide`	Hide Collection
`hide_items`	Hide Items in this Collection
`show_items`	Show this Collection and its Items

url_poster_separator Description: Changes the poster url of the specified key's collection.
Values: URL directly to the Image

Example Template Variable Amendments

The below is an example config.yml extract with some Template Variables added in to change how the file works.

Click the icon to learn more

libraries:
  Movies:
    collection_files:
      - default: seasonal
        template_variables:
          use_independence: false #(1)!
          schedule_thanksgiving: range(10/01-10/30) #(2)!
          sort_by: random #(3)!
          append_data:
            apes: Planet of the Apes Day #(4)!
          schedule_apes: range(11/24-11/26) #(5)!
          imdb_list_apes: https://www.imdb.com/list/ls005126084/ #(6)!
          emoji_veteran: "🐵 " #(7)!

Do not create the "Independence Day" collection
Set a custom schedule for the Thanksgiving Day collection
Sort the collections created by this file in random order
Create a new Seasonal collection called "Planet of the Apes Day", and set the key for this collection to apes
Set a scheduled range for the "Planet of the Apes Day" collection. Planet Of The Apes Day is 11/25.
Add an IMDb List to be used for the "Planet of the Apes Day" collection
Add the 🐵 emoji to the "Planet of the Apes Day" collection so that the title in Plex is "🐵 Planet of the Apes Day Movies"

Default Values¶

These are lists provided for reference to show what values will be in use if you do no customization. These do not show how to change a name or a list.

If you want to customize these values, use the methods described above.

Default data (click to expand) ¶

data: 
  years: New Year's Day
  valentine: Valentine's Day
  patrick: St. Patrick's Day
  easter: Easter
  mother: Mother's Day
  memorial: Memorial Day
  father: Father's Day
  independence: Independence Day
  labor: Labor Day
  halloween: Halloween
  veteran: Veteran's Day
  thanksgiving: Thanksgiving
  christmas: Christmas
  aapi: Asian American & Pacific Islander Heritage Month
  disabilities: Day of Persons with Disabilities
  black_history: Black History Month
  lgbtq: LGBTQ+ Pride Month
  latinx: Latinx Heritage Month
  women: Women's History Month

Default Template Variable emoji (click to expand) ¶

Tip

Pass emoji_<<key>> to the file as template variables to change this value per collection.

emoji:
  years: "🎊 "
  valentine: "💘 "
  patrick: "☘ "
  easter: "🐰 "
  mother: "🤱 "
  memorial: "🪖 "
  father: "👨 "
  independence: "🎆 "
  labor: "⚒ "
  halloween: "🎃 "
  veteran: "🎖"
  thanksgiving: "🦃 "
  christmas: "🎅 "
  aapi: "🌊🌺 "
  disabilities: "♿ "
  lgbtq: "🏳️‍🌈 "
  latinx: "🪅 "
  women: "🚺 "
  black_history: "✊ 🏿 "

Default Template Variable schedule (click to expand) ¶

Tip

Pass schedule_<<key>> to the file as template variables to change this value per collection.

schedule:
  years: range(12/26-01/04)
  valentine: range(02/01-02/29)
  patrick: range(03/01-03/18)
  easter: range(03/20-04/30)
  mother: range(05/05-05/10)
  memorial: range(5/18-6/7)
  father: range(06/15-06/20)
  independence: range(06/23-07/11)
  labor: range(09/01-09/10)
  halloween: range(10/01-10/31)
  veteran: range(11/01-11/30)
  thanksgiving: range(11/01-11/30)
  christmas: range(12/01-12/31)
  aapi: range(04/30-05/31)
  disabilities: range(12/02-12/04)
  black_history: range(02/01-03/01)
  lgbtq: range(05/31-06/30)
  latinx: range(09/15-10/15)
  women: range(02/28-03/31)

Default Template Variable imdb_list (click to expand) ¶

Tip

Pass imdb_list_<<key>> to the file as template variables to change this value per collection.

imdb_list:
  years: https://www.imdb.com/list/ls066838460/
  valentine:
    - https://www.imdb.com/list/ls000094398/
    - https://www.imdb.com/list/ls057783436/
    - https://www.imdb.com/list/ls064427905/
  patrick: https://www.imdb.com/list/ls063934595/
  easter:
    - https://www.imdb.com/list/ls062665509/
    - https://www.imdb.com/list/ls051733651/
  mother: https://www.imdb.com/list/ls072551197/
  memorial: https://www.imdb.com/list/ls561621160/
  father: https://www.imdb.com/list/ls020471057/
  independence:
    - https://www.imdb.com/list/ls068664510/
    - https://www.imdb.com/list/ls080925875/
  labor: https://www.imdb.com/list/ls002014923/
  halloween:
    - https://www.imdb.com/list/ls023118929/
    - https://www.imdb.com/list/ls000099714/
  veteran:
    - https://www.imdb.com/list/ls565595526/
  thanksgiving:
    - https://www.imdb.com/list/ls000835734/
    - https://www.imdb.com/list/ls091597850/
  christmas: https://www.imdb.com/list/ls000096828/

Default Template Variable imdb_search (click to expand) ¶

Tip

Pass imdb_search_<<key>> to the file as template variables to change this value per collection.

imdb_search:
  women:
    type: movie
    keyword.any: women in film, women's rights, women's suffrage, womens rights, womens suffrage
    sort_by: rating.desc
    limit: 500

Default Template Variable tmdb_collection (click to expand) ¶

Tip

Pass tmdb_collection_<<key>> to the file as template variables to change this value per collection.

tmdb_collection:
  halloween:
    - 185103    # Hotel Transylvania
    - 11716     # Addams Family
    - 750822    # Addams Family Animated
    - 313086    # Conjuring
    - 91361     # Halloween Collection
    - 8581      # A Nightmare on Elm Street Collection
    - 1733      # The Mummy Collection
    - 8091      # Alien Collection
    - 2980      # Ghostbusters
    - 751156    # Hocus Pocus

Default Template Variable tmdb_movie (click to expand) ¶

Tip

Pass tmdb_movie_<<key>> to the file as template variables to change this value per collection.

tmdb_movie:
  halloween:
    - 23437    # A Nightmare on Elm Street (2010)

Default Template Variable mdblist_list (click to expand) ¶

Tip

Pass mdblist_list_<<key>> to the file as template variables to change this value per collection.

mdblist_list:
  aapi:
    - https://mdblist.com/lists/k0meta/asian-american-pacific-islander-heritage-month
  disabilities:
    - https://mdblist.com/lists/k0meta/day-of-persons-with-disabilities
  lgbtq:
    - https://mdblist.com/lists/k0meta/lgbtq-pride-month
  latinx:
    - https://mdblist.com/lists/k0meta/latinx-heritage-month

Default Template Variable trakt_list (click to expand) ¶

Tip

Pass trakt_list_<<key>> to the file as template variables to change this value per collection.

trakt_list:
  black_history:
    - https://trakt.tv/users/hoochzilla/lists/black-cinema?display=movie&sort=title,asc
    - https://trakt.tv/users/bluephi8/lists/black-history?display=movie&sort=title,asc