Skip to content

Collection Defaults

There are many Default Collection Files built into Kometa itself which offer an easy-to-use and customizable set of Collections that the user can achieve without having to worry about creating the files that makes the collections possible.

This is the simplest way to create Collections using Kometa.

Collections

These files can generally be used on both Movie and Show library-types, or are part of a category of collection (such as Award Shows.)

These collections are applied by calling the below paths into the collection_files section of your config.yml

Default Path Example Collections Allowed Media
Award Separator separator_award Award Collections Movies
Shows
Academy Awards (Oscars) oscars Oscars Best Picture Winners, Oscars Best Director Winners, Oscars 2022 Movies
Berlin International Film Festival Awards berlinale Berlinale Golden Bears, Berlinale 2021 Movies
British Academy of Film Awards bafta BAFTA Best Films, BAFTA 2021 Movies
Cannes Film Festival Awards cannes Cannes Golden Palm Winners, Cannes 2018 Movies
César Awards cesar César Best Film Winners, César 2018 Movies
Critics Choice Awards choice Critics Choice Best Picture Winners, Critics Choice Awards 2020 Movies
Shows
Emmy Awards emmy Emmys Best in Category Winners, Emmys 2021 Movies
Shows
Golden Globe Awards golden Golden Globes Best Picture Winners, Golden Globes Best Director Winners, Golden Globe 2019 Movies
Shows
Independent Spirit Awards spirit Spirit Best Feature Winners, Independent Spirit Awards 2021 Movies
National Film Registry nfr National Film Registry All Time, National Film Registry 2021 Movies
People's Choice Awards pca People's Choice Award Winners, People's Choice Awards 2022 Movies
Shows
Razzie Awards razzie Razzies Golden Raspberry Winners, Razzie 2023 Movies
Screen Actors Guild Awards sag Screen Actors Guild Award Winners, Screen Actors Guild 2021 Movies
Shows
Sundance Film Festival Awards sundance Sundance Grand Jury Winners, Sundance Film Festival 2017 Movies
Toronto International Film Festival Awards tiff Toronto People's Choice Award, Toronto International Film Festival 2020 Movies
Venice Film Festival Awards venice Venice Golden Lions, Venice 2023 Movies
Default Path Example Collections Allowed Media
Chart Separator separator_chart Chart Collections Movies
Shows
Basic Charts basic Newly Released, New Episodes Movies
Shows
AniList Charts anilist AniList Popular, AniList Season Movies
Shows
IMDb Charts imdb IMDb Popular, IMDb Top 250 Movies
Shows
Letterboxd Charts letterboxd Letterboxd Top 250, Top 250 Most Fans Movies
MyAnimeList Charts myanimelist MyAnimeList Popular, MyAnimeList Top Rated Movies
Shows
Tautulli Charts(1) tautulli Plex Popular, Plex Watched Movies
Shows
TMDb Charts tmdb TMDb Popular, TMDb Airing Today Movies
Shows
Trakt Charts(2) trakt Trakt Popular, Trakt Trending Movies
Shows
Other Charts other_chart AniDB Popular, Common Sense Selection Movies
Shows
  1. Requires Tautulli Authentication
  2. Requires Trakt Authentication
Default Path Example Collections Allowed Media
Genres genre Action, Drama, Science Fiction Movies
Shows
Franchises Movie/Show franchise Star Wars: Skywalker Saga, Godzilla (Anime) Movies
Shows
Universes universe Marvel Cinematic Universal, Wizarding World Movies
Shows
Based On... based Based on a Book, Based on a True Story Movies
Shows
Collectionless collectionless Collectionless Movies
Shows
Default Path Example Collections Allowed Media
US Content Ratings Movie/Show content_rating_us G, PG, NC-17 Movies
Shows
UK Content Ratings content_rating_uk U, PG, 12A Movies
Shows
DE Content Ratings content_rating_de Films 12, Films 16, Films 18 Movies
Shows
AU Content Ratings content_rating_au G, PG, M, MA15+, R18+, X18+, NR Movies
Shows
NZ Content Ratings content_rating_nz G, PG, M, R13, RP13, R15, R16, RP16, R18, RP18, R, NR Movies
Shows
MyAnimeList Content Ratings content_rating_mal G, PG, PG-13, R, R+, Rx Movies
Shows
Common Sense Media Content Ratings content_rating_cs 1, 2, 3, 4, 5, 6, 15, 16, 17, 18 Movies
Shows
Default Path Example Collections Allowed Media
Countries Movie/Show country Belgium, India Movies
Shows
Regions Movie/Show region Iberia, Balkans Movies
Shows
Continents Movie/Show continent Asia, North America Movies
Shows
Default Path Example Collections Allowed Media
Aspect Ratios aspect 1.33, 1.65, 1.78, 1.85, 2.77 Movies
Shows
Resolutions resolution 4K Movies, 1080p Movies, 720p Movies Movies
Shows
Audio Languages audio_language French Audio, Korean Audio Movies
Shows
Subtitle Languages subtitle_language German Subtitles, Swedish Subtitles Movies
Shows
Default Path Example Collections Allowed Media
Actors actor Chris Hemsworth, Margot Robbie Movies
Shows
Directors director Steven Spielberg (Director), Olivia Wilde (Director) Movies
Producers producer James Cameron (Producer), Reese Witherspoon (Producer) Movies
Writers writer James Cameron (Writer), Lilly Wachowski (Writer) Movies
Default Path Example Collections Allowed Media
Networks network Disney Channel, Lifetime Shows
Streaming streaming Disney+ Movies, Max Shows Movies
Shows
Studios studio DreamWorks Studios, Walt Disney Pictures Movies
Shows
Default Path Example Collections Allowed Media
Seasonal seasonal Easter, Christmas Movies
Years year Best of 2010, Best of 2019 Movies
Shows
Decades Movie/Show decade Best of 2012s, Best of 2022s Movies
Shows

Configurations

To run a default Kometa Collection File you can simply add it to your collection_files using default like so:

libraries:
  Movies:
    collection_files:
      - default: actor
      - default: genre

Separators

Most Metadata Files use separators to denote different sections of collection like actor collections vs studio collections.

Chart Separator and Award Separator each have their own file, while the other Separators are part of their respective files.

Click to expand to see an example of Separators.

Library On/Off

Chart Separators are turned On by default (except seasonal), to turn the Separators On/Off on a per Library basis.

libraries:
  LIBRARYNAME:
    template_variables:
      use_separator: false
    collection_files:
      - default: actor
      - default: genre

Collection Section Order

All Default Collection Files have a collection_section attribute. These attributes determine the order of the various sections and can be set by customizing your config.

For example: collection_section: 01 translates to sort_title: "!<<collection_section>><<pre>><<order_<<key>>>><<sort>>" and so for genre if you have a Fantasy collection, plex is going to show !06_Fantasy

This is the default Kometa collection ordering:

Collection Collection Section
seasonal 000
basic 010
anilist 020
imdb 020
letterboxd 020
myanimelist 020
other_chart 020
tautulli 020
tmdb 020
trakt 020
streaming 030
universe 040
network 050
genre 060
studio 070
country 080
region 081
continent 082
based 085
audio_language 090
subtitle_language 095
decade 100
year 105
content_rating_us 110
content_rating_uk 110
content_rating_de 110
content_rating_mal 110
content_rating_cs 110
resolution 120
aspect 125
bafta 130
berlinale 130
cannes 130
cesar 130
choice 130
emmy 130
golden 130
oscars 130
spirit 130
nfr 130
pca 130
razzie 130
sundance 130
tiff 130
venice 130
actor 140
director 150
producer 160
writer 170

Customizing Configs

Configs can be customized using the template_variables attribute when calling the file. These template_variables will be given to every template call in the file which allows them to affect how that file runs.

This example disables two keys, which will prevent those collections from being created. It also sets the visibility of one of the keys so that it is visible on the library tab, the server owner's home screen and shared user's home screens (assuming the server owner and/or the shared users have the library pinned to their home screen).

libraries:
  TV Shows:
    collection_files:
      - default: imdb
        template_variables:
          use_popular: false
          use_lowest: false
          visible_library_top: true
          visible_home_top: true
          visible_shared_top: true

Each file has a page on the wiki showing the available template_variables for each file. For example the defaultdefault: genre has a page here.

In addition to the defined template_variables almost all default Metadata Files have access to the Shared Variables.

Examples

For example if you want yearly oscar collections that go back 10 years instead of 5 all of which gets sent to radarr use the data and radarr_add_missing Template Variables.

libraries:
  Movies:
    collection_files:
      - default: oscars
        template_variables:
          radarr_add_missing: true
          data:
            starting: latest-10
            ending: latest

Or maybe you want to change the number of actor collections made using default: actor.

libraries:
  Movies:
    overlay_files:
      - default: actor
        template_variables:
          collection_mode: hide
          data:
            depth: 5
            limit: 50

Or maybe you want to change the collection sort order of the genre collections using default: genre.

libraries:
  Movies:
    collection_files:
      - default: genre
        template_variables:
          collection_section: 11

Or maybe you want to disable separators globally per library.

libraries:
  LIBRARYNAME:
    template_variables:
      use_separator: false
    collection_files:
      - ...

Alternatively it can be turned off individually per git file:

libraries:
  LIBRARYNAME:
    collection_files:
      - default: <file1>    # separator is disabled
        template_variables:
          use_separator: false
      - default: <file2>    # separator is enabled by default
      - default: <file3>    # separator is disabled
        template_variables:
          use_separator: false

Example Configuration File

Sample config.yml file (click to expand) 
libraries:
  Movies:                                           # Must match a library name in your Plex
    report_path: config/missing/Movies_missing.yml
    template_variables:
      sep_style: purple                               # use the purple separators globally for this library
      collection_mode: hide                         # hide the collections within the "library" tab in Plex.
      placeholder_imdb_id: tt8579674                # 1917 (2019) placeholder id for the separators, avoids a plex bug.
    collection_files:
      - default: separator_award                          # An "index card"
      - default: bafta                                    # BAFTA Awards
        template_variables:                           # Show collections from latest-10 onwards.
          data:
            starting: latest-10
            ending: latest
      - default: golden                                   # Golden Globes Awards
        template_variables:                           # Show collections from latest-10 onwards.
          data:
            starting: latest-10
            ending: latest
      - default: oscars                                   # The Oscars
        template_variables:                           # Show collections from latest-10 onwards.
          data:
            starting: latest-10
            ending: latest
      - default: separator_chart                          # An "index card"
      - default: basic                                    # Some basic chart collections
      - default: tmdb                                     # TMDb Charts (Popular, Trending, etc.)
      - default: audio_language                           # English, French, Arabic, German, etc. audio language 
      - default: resolution                               # 4K HDR, 1080P FHD, etc. with the standards style 
        template_variables:
          style: standards
      - default: studio                                   # DreamWorks Studios, Lucasfilm Ltd, etc.
      - default: seasonal                                 # Christmas, Halloween, etc.
        template_variables:                           # Disable any US-specific seasonal collections
          schedule_independence: never
          schedule_thanksgiving: never
          schedule_memorial: never
          schedule_labor: never
      - default: streaming                                # Streaming on Disney+, Netflix, etc.
        template_variables:
          originals_only: true                      # Only create collections for Original Content (i.e. Netflix Originals)
      - default: universe                                 # Marvel Cinematic Universe, Wizarding World, etc.

    remove_overlays: false                          # Set to true if you want to remove overlays
    reapply_overlays: false                         # Set to true if you want to force-reapply overlays to everything
                                                    # THERE IS RARELY IF EVER A REASON TO DO THIS AS IT WILL EXTEND RUN TIMES ANS CAUSE IMAGE BLOAT
                                                    # IF YOU THINK YOU WANT TO DO THIS YOU ARE ALMOST CERTAINLY MISTAKEN
    #reset_overlays: tmdb                           # if you want to reset the poster to default poster from tmdb - can cause image bloat

    overlay_files:
      - default: audio_codec                              # FLAC, DTS-X, TrueHD, etc. style: standard/compact. compact is default
      - default: resolution                               # 4K HDR, 1080P FHD, etc.
      - default: ribbon                                   # Used for ribbon in bottom right
      - default: streaming                                # Streaming on Disney+, Netflix, etc.
      - default: video_format                             # Remux, DVD, Blu-Ray, etc. in bottom left
    settings:
      asset_directory:
        - config/assets

    operations:
      split_duplicates: false
      assets_for_all: false

  TV Shows:                                         # Must match a library name in your Plex
    report_path: config/missing/TV_missing.yml
    template_variables:
      sep_style: plum                               # use the plum separators globally for this library
      collection_mode: hide                         # hide the collections within the "library" tab in Plex.
      placeholder_imdb_id: tt1190634                # The Boys (2019) placeholder id for the separators, avoids a plex bug.
    collection_files:
      - default: separator_award                          # An "index card"
      - default: bafta                                    # BAFTA Awards
        template_variables:                           # Show collections from latest-10 onwards.
          data:
            starting: latest-10
            ending: latest
      - default: golden                                   # Golden Globes Awards
        template_variables:                           # Show collections from latest-10 onwards.
          data:
            starting: latest-10
            ending: latest
      - default: oscars                                   # The Oscars
        template_variables:                           # Show collections from latest-10 onwards.
          data:
            starting: latest-10
            ending: latest
      - default: separator_chart                          # An "index card"
      - default: basic                                    # Some basic chart collections
      - default: tmdb                                     # TMDb Charts (Popular, Trending, etc.)
      - default: audio_language                           # English, French, Arabic, German, etc. audio language 
      - default: resolution                               # 4K HDR, 1080P FHD, etc. with the standards style 
        template_variables:
          style: standards
      - default: network                                  # ABC, CBC, NBC, FOX, etc.
      - default: streaming                                # Streaming on Disney+, Netflix, etc.
        template_variables:
          originals_only: true                      # Only create collections for Original Content (i.e. Netflix Originals)
    remove_overlays: false                          # Set to true if you want to remove overlays
    reapply_overlays: false                         # If you are doing a lot of testing and changes like me, keep this to true to always reapply overlays - can cause image bloat
    #reset_overlays: tmdb                           # if you want to reset the poster to default poster from tmdb - can cause image bloat
    overlay_files:
      - default: audio_codec                              # FLAC, DTS-X, TrueHD, etc. on show and episode
      - default: audio_codec
        template_variables:
          builder_level: episode
      - default: episode_info                             # S##E## information in bottom right on episode
        template_variables:
          builder_level: episode
      - default: resolution                               # 4K HDR, 1080P FHD, etc. on show, episode, and season
      - default: resolution
        template_variables:
          builder_level: episode
      - default: resolution
        template_variables:
          builder_level: season
      - default: ribbon                                   # Used for ribbon in bottom right on show
      - default: status                                   # Airing, Returning, Ended, Canceled on show
      - default: versions                                 # Will show duplicates for that media item on show and episode
      - default: versions                                 
        template_variables:
          builder_level: episode
      - default: video_format                             # Remux, DVD, Blu-Ray, etc. in bottom left on show, episode, and season
      - default: video_format
        template_variables:
          builder_level: episode
    settings:
      asset_directory:
        - config/assets

    operations:
      split_duplicates: false
      assets_for_all: false
playlist_files:
  - default: playlist
    template_variables:
      libraries: Movies, TV Shows                       # Must match the names of your libraries in Plex.