Playlists¶

The playlist Default Playlist File is used to create playlists based on popular Movie/TV Show universes (such as the Marvel Cinematic Universe or Star Trek).

This file assumes that you have libraries named Movies and TV Shows. If you do not have these libraries or want to use alternative/additional libraries, use the libraries template variable which is outlined in the Template Variables table.

Playlists¶

Playlist	Key	Description
`Arrowverse (Timeline Order)`	`arrow`	Playlist of Movies and Episodes in the Arrowverse (Timeline Order)
`DC Animated Universe (Timeline Order)`	`dcau`	Playlist of Movies and Episodes in the DC Animated Universe (Timeline Order)
`Dragon Ball (Timeline Order)`	`dragonball`	Playlist of Movies and Episodes in the Dragon Ball (Timeline Order)
`Marvel Cinematic Universe (Timeline Order)`	`mcu`	Playlist of Movies and Episodes in the Marvel Cinematic Universe (Timeline Order)
`Pokémon (Timeline Order)`	`pokemon`	Playlist of Movies and Episodes in the Pokémon (Timeline Order)
`Star Trek (Timeline Order)`	`startrek`	Playlist of Movies and Episodes in the Star Trek (Timeline Order)
`Star Wars (Timeline Order)`	`starwars`	Playlist of Movies and Episodes in the Star Wars (Timeline Order)
`Star Wars The Clone Wars (Timeline Order)`	`clonewars`	Playlist of Movies and Episodes in the Star Wars The Clone Wars (Timeline Order)
`X-Men (Timeline Order)`	`xmen`	Playlist of Movies and Episodes in the X-Men (Timeline Order)

Config¶

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

playlist_files:
  - default: playlist

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.

Example Template Variable Amendments (Click to Expand)

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

playlist_files:
  - default: playlist
    template_variables:
      radarr_add_missing: true #(1)!

Adds items from the source list which are not in Plex to Radarr

Example Template Adding Default Playlists (Click to Expand)

The below is an example config.yml extract showing how to enable/disable specific playlists using their keys. By default, all keys/playlists are enabled.

Click the icon to learn more

playlist_files:
  - default: playlist
    template_variables:
      use_mcu: true #(1)!
      use_xmen: false #(2)!

Enable the default MCU playlist
Disable the default X-Men playlist

File-Specific Template Variables are variables available specifically for this Kometa Defaults File.

Warning

Shared Collection Variables are NOT available to this Defaults File.

File-Specific Template Variables

Variable	Description & Values
`delete_playlist_<<key>>`¹	Description: Will delete the key's playlists for the users defined by sync_to_users. Values: `true` or `false`
`delete_playlist`	Description: Will delete all playlists for the users defined by sync_to_users. Values: `true` or `false`
`exclude_user_<<key>>`¹	Description: Sets the users to exclude from sync the key's playlist. Default: `sync_to_users` Value Values: Comma-separated string or list of user names.
`exclude_user`	Description: Sets the users to exclude from sync for all playlists. Default: `playlist_sync_to_users` Global Setting Value Values: Comma-separated string or list of user names.
`ignore_ids`	Description: Set a list or comma-separated string of TMDb/TVDb IDs to ignore in all playlists. 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 playlists. Values: List or comma-separated string of IMDb IDs
`imdb_list_<<key>>`¹	Description: Adds the Movies in the IMDb List to the key's playlist. Overrides the [default trakt_list] for that playlist if used. Values: List of Trakt List URLs
`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 key's playlist. Default: `item_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 playlists 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 key's playlist. Default: `item_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 playlists in a Defaults file. Values: List or comma-separated string of tags
`libraries`	Description: Sets the names of the libraries to use for the Playlists. Default: `Movies, TV Shows` Values: Comma-separated string or list of library mapping names defined in the `libraries` attribute in the base of your [Configuration File](../config/overview.md.
`mdblist_list_<<key>>`¹	Description: Adds the Movies in the MDBList List to the key's playlist. Overrides the [default trakt_list] for that playlist if used. Values: List of Trakt List URLs
`name_<<key>>`¹	Description: Changes the name of the key's playlist. Values: New Playlist Name
`radarr_add_missing_<<key>>`¹	Description: Override Radarr `add_missing` attribute of the key's playlist. Default: `radarr_add_missing` Values: `true` or `false`
`radarr_add_missing`	Description: Override Radarr `add_missing` attribute for all playlists in a Defaults file. Values: `true` or `false`
`radarr_folder_<<key>>`¹	Description: Override Radarr `root_folder_path` attribute of the key's playlist. Default: `radarr_folder` Values: Folder Path
`radarr_folder`	Description: Override Radarr `root_folder_path` attribute for all playlists in a Defaults file. Values: Folder Path
`radarr_tag_<<key>>`¹	Description: Override Radarr `tag` attribute of the key's playlist. Default: `radarr_tag` Values: List or comma-separated string of tags
`radarr_tag`	Description: Override Radarr `tag` attribute for all playlists in a Defaults file. Values: List or comma-separated string of tags
`sonarr_add_missing_<<key>>`¹	Description: Override Sonarr `add_missing` attribute of the key's playlist. Default: `sonarr_add_missing` Values: `true` or `false`
`sonarr_add_missing`	Description: Override Sonarr `add_missing` attribute for all playlists in a Defaults file. Values: `true` or `false`
`sonarr_folder_<<key>>`¹	Description: Override Sonarr `root_folder_path` attribute of the key's playlist. Default: `sonarr_folder` Values: Folder Path
`sonarr_folder`	Description: Override Sonarr `root_folder_path` attribute for all playlists in a Defaults file. Values: Folder Path
`sonarr_tag_<<key>>`¹	Description: Override Sonarr `tag` attribute of the key's playlist. Default: `sonarr_tag` Values: List or comma-separated string of tags
`sonarr_tag`	Description: Override Sonarr `tag` attribute for all playlists in a Defaults file. Values: List or comma-separated string of tags
`summary_<<key>>`¹	Description: Changes the summary of the key's playlist. Values: New Playlist Summary
`sync_to_users_<<key>>`¹	Description: Sets the users to sync the key's playlist to. Default: `sync_to_user` Value Values: Comma-separated string or list of user names.
`sync_to_users`	Description: Sets the users to sync all playlists to. Default: `playlist_sync_to_users` Global Setting Value Values: Comma-separated string or list of user names.
`trakt_list_<<key>>`¹	Description: Adds the Movies in the Trakt List to the key's playlist. Overrides the [default trakt_list] for that playlist if used. Values: List of Trakt List URLs
`url_poster_<<key>>`¹	Description: Changes the poster url of the key's playlist. Values: URL directly to the Image
`use_<<key>>`¹	Description: Turns off individual Playlists in a Defaults file. Values: `false` to turn off the playlist

Each default collection has a key that you must replace <<key>> with when using this Template Variable. These keys are found in the table at the top of this page.

Default Value Source¶

This is a reference showing the source of the data used in this Defaults File.

Nothing in this section is required for using the Defaults File, but it can be useful for understanding where the data comes from.

Nothing in this section is directly useful for customizing this Defaults File.

Nothing here is a code example for end user use. It all looks like code, since it is taken directly from the Kometa source code to ensure it is up-to-date and accurate, but it is not intended for end user use, and is expressed in a different format to the way you would customize the defaults via Template Variables.

I want to customize this default

To learn how to customize any Defaults File using Template Variables see the Defaults Usage Guide.

Each Defaults File has its own set of Template Variables, which are used to control the behavior of that default. The Template Variables for this file can be found here.

I want to know what's behind the defaults

The lists provided here are for reference to show what values will be in use if no customization is done.

These do not show how to customize the defaults.

Nothing here is a code example for end user use. It all looks like code, since it is taken directly from the Kometa source code to ensure it is up-to-date and accurate, but it is not intended for end user use.

These lists are provided for reference only.

If you want to customize these collections, refer to the Defaults Usage Guide to learn how to use Template Variables.

PlaylistsDefault imdb_listDefault mdblist_list

The default Playlists use the IMDb List Builder and MDBList List Builder to create the playlists.

These lists are provided for reference only. If you want to customize this default, refer to "I want to customize this default".

###############################################################################
################################## IMPORTANT ##################################
#####################  THIS DATA IS PROVIDED FOR REFERENCE ####################
##  DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
#############  SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################

imdb_list: 
  - key: arrow
    value: https://www.imdb.com/list/ls566667558/
  - key: clonewars
    value: https://www.imdb.com/list/ls544963772/
  - key: dcau
    value: https://www.imdb.com/list/ls566357882/
  - key: mcu
    value: https://www.imdb.com/list/ls539646485/
  - key: starwars
    value: https://www.imdb.com/list/ls501373412/
  - key: startrek
    value: https://www.imdb.com/list/ls547463722/
  - key: xmen
    value: https://www.imdb.com/list/ls567618635/

These lists are provided for reference only. If you want to customize this default, refer to "I want to customize this default".

###############################################################################
################################## IMPORTANT ##################################
#####################  THIS DATA IS PROVIDED FOR REFERENCE ####################
##  DO NOT COPY/PASTE THIS INTO YOUR CONFIG FILE, IT WILL ONLY CAUSE ERRORS ###
#############  SEE ABOVE FOR HOW TO MODIFY OR AUGMENT THESE VALUES ############
###############################################################################

mdblist_list: 
  - key: dragonball
    value: https://mdblist.com/lists/k0meta/external/46559
  - key: pokemon
    value: https://mdblist.com/lists/k0meta/external/46555