Defaults Usage Guide¶

Kometa includes a pre-created set of Collection Files and Overlay Files which can be found in the "defaults" folder in the root of your Kometa installation directory.

These files offer an easy-to-use and customizable set of Collections and Overlays that the user can achieve without having to worry about creating the files that make the collections and overlays possible.

All Collections come with a matching poster to make a clean, consistent set of collections in your library. These files are stored in the Kometa Images Repository and each poster is downloaded straight to your Plex Collection when you run Kometa.

Credits to Sohjiro, Bullmoose20, Yozora, Cpt Kuesel, and anon_fawkes for helping drive this entire Default Set of Configs through the concept, design and implementation.

Special thanks to Magic815 for the overlay image inspiration and base template.

Please consider donating towards the project.

Configurations¶

To run a default Kometa Collection or Overlay File you can simply add it to your collection_files (For Collection Files) or overlay_files (For Overlay Files) using default like so:

libraries:
  Movies:
    collection_files:
    - default: actor
    - default: genre
    overlay_files:
    - default: ribbon
    - default: ratings

Customizing these defaults¶

Configs can be customized using the template_variables attribute when calling the file.

These Template Variables can be used to customize individual collections/overlays or the set as a whole.

A given default may have variables that are specific to it, and may also leverage a common set of shared Template Variables. These lists are shown on each Defaults File's wiki page.

Customizing individual components¶

Each Defaults File uses "keys" to refer to the collections and overlays that it creates, and you can use those keys to modify the behavior of individual collections or overlays created by the file.

For, example, the IMDB default creates three collections, each with their own "key":

Collection	Key
`IMDb Popular`	`popular`
`IMDb Top 250`	`top`
`IMDb Lowest Rated`	`lowest`

You use that key to customize the individual collection or overlay.

This example disables two keys, which will prevent those collections from being created. It also sets the visibility of one of the keys [top] 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)

It also changes the resolution overlay to skip applying the overlay to 480p movies.

The Template Variables in this example happen to be all shared Template Variables.

Press the icon to learn more

Customizing Defaults Files via Template Variables

libraries:
  Movies:
    collection_files:
      - default: imdb
        template_variables:
          use_popular: false #(1)!
          use_lowest: false #(2)!
          visible_library_top: true #(3)!
          visible_home_top: true
          visible_shared_top: true
    overlay_files:
      - default: resolution
        template_variables:
          use_480p: false #(4)!

Turns off the popular key, stopping the "IMDb Popular" collection from being processed
Turns off the lowest key, stopping the "IMDb Lowest Rated" collection from being processed
Sets visible_library, visible_home and visible_shared to true for the top key, pinning the "IMDb Top 250" collection for the server owner, shared users, and on the library's recommended tab.
Turns off the 480p key, stopping the "480p" based resolution overlays from being processed

Customizing the set as a whole¶

In addition to the keys, each default can be customized with other Template Variables that are not key-specific.

This example uses a file-specific variable to change the order of all the IMDB chart collections to alphabetical by title and a shared variable to schedule these IMDB collections to be run only on Wednesdays.

On the resolution overlay, it uses a file-specific variable to disable all the "edition" overlays and a shared variable to align the overlay on the right side of the poster.

Press the icon to learn more

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
          collection_order: alpha #(1)!
          schedule: weekly(wednesday) #(2)!
    overlay_files:
      - default: resolution
        template_variables:
          use_480p: false
          use_edition: false #(3)!
          horizontal_align: right #(4)!

File-Specific Template Variable that will set the sort order for all Collections created by the imdb file
Shared Template Variable that will schedule the imdb file to only be processed on a Wednesday
File-Specific Template Variable that will prevent the resolution file from processing any edition overlays (such as the "Extended Edition" dovetail)
Shared Template Variable that will set the alignment of overlays produced by the resolution file to be right-aligned

All of the Defaults Files are customized in this basic fashion.

NOTE: this template_variable system is specific to the Defaults. If and when you start creating your own collection or overlay files, you cannot use this template_variables setup unless you specifically write your files to implement it.

Each of these Defaults Files has a page on the wiki showing its keys, available template_variables, and default settings. For example, the Defaults Overlay File default: resolution has a page here.

The shared Template Variables can be reviewed here for Collections and Overlays. These are also linked from each Defaults File's wiki page. Keep in mind that most, but not all Defaults Files have access to the shared variables. This will be noted on the individual files' page.

Collection Defaults¶

See the Collection Defaults Page for more information on the specifics of the Collection Defaults.

Overlay Defaults¶

See the Overlay Defaults Page for more information on the specifics of the Overlay Defaults.

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.