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
Award Collections¶
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|---|---|---|---|---|
| Award Separator | separator_award |
Award Collections | ||
| Academy Awards (Oscars) | oscars |
Oscars Best Picture Winners, Oscars Best Director Winners, Oscars 2022 | ||
| Berlin International Film Festival Awards | berlinale |
Berlinale Golden Bears, Berlinale 2021 | ||
| British Academy of Film Awards | bafta |
BAFTA Best Films, BAFTA 2021 | ||
| Cannes Film Festival Awards | cannes |
Cannes Golden Palm Winners, Cannes 2018 | ||
| César Awards | cesar |
César Best Film Winners, César 2018 | ||
| Critics Choice Awards | choice |
Critics Choice Best Picture Winners, Critics Choice Awards 2020 | ||
| Emmy Awards | emmy |
Emmys Best in Category Winners, Emmys 2021 | ||
| Golden Globe Awards | golden |
Golden Globes Best Picture Winners, Golden Globes Best Director Winners, Golden Globe 2019 | ||
| Independent Spirit Awards | spirit |
Spirit Best Feature Winners, Independent Spirit Awards 2021 | ||
| National Film Registry | nfr |
National Film Registry All Time, National Film Registry 2021 | ||
| People's Choice Awards | pca |
People's Choice Award Winners, People's Choice Awards 2022 | ||
| Razzie Awards | razzie |
Razzies Golden Raspberry Winners, Razzie 2023 | ||
| Screen Actors Guild Awards | sag |
Screen Actors Guild Award Winners, Screen Actors Guild 2021 | ||
| Sundance Film Festival Awards | sundance |
Sundance Grand Jury Winners, Sundance Film Festival 2017 | ||
| Toronto International Film Festival Awards | tiff |
Toronto People's Choice Award, Toronto International Film Festival 2020 | ||
| Venice Film Festival Awards | venice |
Venice Golden Lions, Venice 2023 |
Chart Collections¶
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|---|---|---|---|---|
| Chart Separator | separator_chart |
Chart Collections | ||
| Basic Charts | basic |
Newly Released, New Episodes | ||
| Tautulli Charts1 | tautulli |
Plex Popular, Plex Watched | ||
| IMDb Charts | imdb |
IMDb Popular, IMDb Top 250 | ||
| TMDb Charts | tmdb |
TMDb Popular, TMDb Airing Today | ||
| Trakt Charts2 | trakt |
Trakt Popular, Trakt Trending | ||
| AniList Charts | anilist |
AniList Popular, AniList Season | ||
| MyAnimeList Charts | myanimelist |
MyAnimeList Popular, MyAnimeList Top Rated | ||
| Letterboxd Charts | letterboxd |
Letterboxd Top 250, Top 250 Most Fans | ||
| Other Charts | other_chart |
AniDB Popular, Common Sense Selection |
1 Requires Tautulli Authentication
2 Requires Trakt Authentication
Content Collections¶
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|---|---|---|---|---|
| Genres | genre |
Action, Drama, Science Fiction | ||
| Franchises Movie/Show | franchise |
Star Wars: Skywalker Saga, Godzilla (Anime) | ||
| Universes | universe |
Marvel Cinematic Universal, Wizarding World | ||
| Based On... | based |
Based on a Book, Based on a True Story | ||
| Collectionless | collectionless |
Collectionless |
Content Rating Collections¶
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|---|---|---|---|---|
| US Content Ratings Movie/Show | content_rating_us |
G, PG, NC-17 | ||
| UK Content Ratings | content_rating_uk |
U, PG, 12A | ||
| DE Content Ratings | content_rating_de |
Films 12, Films 16, Films 18 | ||
| MyAnimeList Content Ratings | content_rating_mal |
G, PG, PG-13, R, R+, Rx | ||
| Common Sense Media Content Ratings | content_rating_cs |
1, 2, 3, 4, 5, 6, 15, 16, 17, 18 |
Location Collections¶
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|---|---|---|---|---|
| Countries Movie/Show | country |
Belgium, India | ||
| Regions Movie/Show | region |
Iberia, Balkans | ||
| Continents Movie/Show | continent |
Asia, North America |
Media Collections¶
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|---|---|---|---|---|
| Aspect Ratios | aspect |
1.33, 1.65, 1.78, 1.85, 2.77 | ||
| Resolutions | resolution |
4K Movies, 1080p Movies, 720p Movies | ||
| Audio Languages | audio_language |
French Audio, Korean Audio | ||
| Subtitle Languages | subtitle_language |
German Subtitles, Swedish Subtitles |
Production Collections¶
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|---|---|---|---|---|
| Networks | network |
Disney Channel, Lifetime | ||
| Streaming | streaming |
Disney+ Movies, Max Shows | ||
| Studios | studio |
DreamWorks Studios, Walt Disney Pictures |
People Collections¶
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|---|---|---|---|---|
| Actors | actor |
Chris Hemsworth, Margot Robbie | ||
| Directors | director |
Steven Spielberg (Director), Olivia Wilde (Director) | ||
| Producers | producer |
James Cameron (Producer), Reese Witherspoon (Producer) | ||
| Writers | writer |
James Cameron (Writer), Lilly Wachowski (Writer) |
Time Collections¶
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|---|---|---|---|---|
| Seasonal | seasonal |
Easter, Christmas | ||
| Years | year |
Best of 2010, Best of 2019 | ||
| Decades Movie/Show | decade |
Best of 2012, Best of 2022 |
Configurations¶
To run a default Kometa Collection file you can simply add it to your collection_files using default like so:
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 homescreen and shared user's homescreens (assuming they server owner and/or the shared users have the library pinned to their homescreen)
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 default
default: 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.
Or maybe you want to disable separators globally per library.
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.