Skip to content

Region Collections

The region Default Collection File is used to dynamically create collections based on the countries within your library. The collection aims to be inclusive, with all 230 countries incorporated into 39 countries or collections of countries. Some care has been taken to ensure all countries are included, and the groupings won't fit well with everyone's collections. Western and Southern Europe, Oceania, and North America could be useful groupings for those libraries with more of an Asian focus, for instance. Please see the comments in the yml below where a decision point might be seen as controversial. You are welcome to edit this to fit your own audience's needs.

This file has a Show Library Counterpart.

Requirements & Recommendations

Supported Library Types: Movie

Collections Section 081

Collection Key Description
Region Collections separator Separator Collection to denote the Section of Collections.
<<Region>>
Example: Nordic		 <<Region>>
Example: Nordic		 Collection of Movies that have been tagged with countries in this region.
Other Regions other Collection of Movies that are in other uncommon Regions.

Config

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

libraries:
  Movies:
    collection_files:
      - default: region

Color Style

Below is a screenshot of the alternative Color (color) style which can be set via the style template variable.

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.

Variable Description & Values
style Description: Controls the visual theme of the collections created
Values:
whiteWhite Theme
colorColor Theme
limit Description: Changes the Builder Limit for all collections in a Defaults file.
Values: Number Greater than 0
limit_<<key>>1 Description: Changes the Builder Limit of the specified key's collection.
Default: limit
Values: Number Greater than 0
sort_by Description: Changes the Smart Filter Sort for all collections in a Defaults file.
Default: release.desc
Values: Any smart_filter Sort Option
sort_by_<<key>>1 Description: Changes the Smart Filter Sort of the specified key's collection.
Default: sort_by
Values: Any smart_filter Sort Option
include Description: Overrides the default include list.
Values: List of Countries found in your library
exclude Description: Exclude these Countries from creating a Dynamic Collection.
Values: List of Countries found in your library
addons Description: Overrides the default addons dictionary. Defines how multiple keys can be combined under a parent key. The parent key doesn't have to already exist in Plex
Values: Dictionary List of Countries found in your library
append_include Description: Appends to the default include list.
Values: List of Countries found in your library
remove_include Description: Removes from the default include list.
Values: List of Countries found in your library
append_addons Description: Appends to the default addons dictionary.
Values: Dictionary List of Countries found in your library
remove_addons Description: Removes from the default addons dictionary.
Values: Dictionary List of Countries found in your library
key_name_override Description: Overrides the default key_name_override dictionary.
Values: Dictionary with key: new_key_name entries
name_format Description: Changes the title format of the Dynamic Collections.
Default: <<key_name>>
Values: Any string with <<key_name>> in it.
summary_format Description: Changes the summary format of the Dynamic Collections.
Default: <<library_translationU>>s filmed in <<key_name>>.
Values: Any string.
  1. Each default collection has a key that when calling to effect a specific collection you must replace <<key>> with when calling.

File paths need to be valid in the context where Kometa is running; this is primarily an issue when running in docker, as Kometa inside the container cannot see host paths.

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>>1 Description: Turns off individual Collections in a Defaults file.
Values: false to turn off the collection
name_<<key>>1 Description: Changes the name of the specified key's collection.
Values: New Collection Name
summary_<<key>>1 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>>1 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:
defaultLibrary default
hideHide Collection
hide_itemsHide Items in this Collection
show_itemsShow 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>>1 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>>1 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>>1 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>>1 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>>1 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:
trueVisible
falseNot Visible
Any schedule OptionVisible When Scheduled
visible_library_<<key>>1 Description: Controls visible on Library Recommended Tab of the specified key's collection. (Only works with Plex Pass)
Default: visible_library
Values:
trueVisible
falseNot Visible
Any schedule OptionVisible When Scheduled
visible_home Description: Controls visible on Home Tab for all collections in a Defaults file. (Only works with Plex Pass)
Values:
trueVisible
falseNot Visible
Any schedule OptionVisible When Scheduled
visible_home_<<key>>1 Description: Controls visible on Home Tab of the specified key's collection. (Only works with Plex Pass)
Default: visible_home
Values:
trueVisible
falseNot Visible
Any schedule OptionVisible 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:
trueVisible
falseNot Visible
Any schedule OptionVisible When Scheduled
visible_shared_<<key>>1 Description: Controls visible on Shared Users' Home Tab of the specified key's collection. (Only works with Plex Pass)
Default: visible_shared
Values:
trueVisible
falseNot Visible
Any schedule OptionVisible 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>>1 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>>1 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>>1 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>>1 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>>1 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>>1 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>>1 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>>1 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>>1 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>>1 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>>1 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>>1 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>>1 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>>1 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
  1. 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:
defaultLibrary default
hideHide Collection
hide_itemsHide Items in this Collection
show_itemsShow 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: region
        template_variables:
          use_other: false #(1)!
          use_separator: false #(2)!
          style: color #(3)!
          exclude:
            - French #(4)!
          sort_by: title.asc
  1. Do not create the "Other Regions" collection
  2. Do not create a "Region Collections" separator
  3. Set the Color Style
  4. Exclude "French" from the list of collections that are created

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 include (click to expand) 
###############################################################################
################################## 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 ############
###############################################################################
include: 
  - Northern Africa
  - Eastern Africa
  - Central Africa
  - Southern Africa
  - Western Africa
  - Caribbean
  - Central America
  - South America
  - North America
  - Antarctica
  - Central Asia
  - Eastern Asia
  - South-Eastern Asia
  - Southern Asia
  - Western Asia
  - Eastern Europe
  - Northern Europe
  - Southern Europe
  - Western Europe
  - Australia and New Zealand
  - Melanesia
  - Micronesia
  - Polynesia
Default addons (click to expand) 
###############################################################################
################################## 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 ############
###############################################################################
addons: 
  Northern Africa:
    - Algeria
    - Egypt
    - Libya
    - Morocco
    - Sudan
    - Tunisia
    - Western Sahara
  Eastern Africa:
    - British Indian Ocean Territory
    - Burundi
    - Comoros
    - Djibouti
    - Eritrea
    - Ethiopia
    - French Southern Territories
    - Kenya
    - Madagascar
    - Malawi
    - Mauritius
    - Mayotte
    - Mozambique
    - Réunion
    - Rwanda
    - Seychelles
    - Somalia
    - South Sudan
    - Uganda
    - Tanzania
    - United Republic of Tanzania # Tanzania
    - Zambia
    - Zimbabwe
  Central Africa:
    - Angola
    - Cameroon
    - Central African Republic
    - Chad
    - Republic of the Congo
    - Congo # Republic of the Congo
    - Democratic Republic of the Congo
    - Zaire # Democratic Republic of the Congo
    - Equatorial Guinea
    - Gabon
    - São Tomé and Príncipe
    - Sao Tome and Principe # São Tomé and Príncipe
  Southern Africa:
    - Botswana
    - Eswatini
    - Swaziland # Eswatini
    - Lesotho
    - Namibia
    - South Africa
  Western Africa:
    - Benin
    - Burkina Faso
    - Cape Verde
    - Cabo Verde # Cape Verde
    - Côte d'Ivoire
    - Côte d’Ivoire # Côte d'Ivoire
    - Ivory Coast # Côte d'Ivoire
    - Gambia
    - Ghana
    - Guinea
    - Guinea-Bissau
    - Liberia
    - Mali
    - Mauritania
    - Niger
    - Nigeria
    - Saint Helena, Ascension and Tristan da Cunha
    - Saint Helena # Saint Helena, Ascension and Tristan da Cunha
    - St. Helena # Saint Helena, Ascension and Tristan da Cunha
    - Ascension # Saint Helena, Ascension and Tristan da Cunha
    - Tristan da Cunha # Saint Helena, Ascension and Tristan da Cunha
    - Senegal
    - Sierra Leone
    - Togo
  Caribbean:
    - Anguilla
    - Antigua and Barbuda
    - Antigua # Antigua and Barbuda
    - Barbuda # Antigua and Barbuda
    - Aruba
    - Bahamas
    - Barbados
    - Bonaire, Sint Eustatius and Saba
    - Bonaire # Bonaire, Sint Eustatius and Saba
    - Sint Eustatius # Bonaire, Sint Eustatius and Saba
    - Saba # Bonaire, Sint Eustatius and Saba
    - Netherlands Antilles
    - British Virgin Islands
    - Cayman Islands
    - Cuba
    - Curaçao
    - Dominica
    - Dominican Republic
    - Grenada
    - Guadeloupe
    - Haiti
    - Jamaica
    - Martinique
    - Montserrat
    - Puerto Rico
    - Saint Barthélemy
    - Saint Kitts and Nevis
    - St. Kitts and Nevis # Saint Kitts and Nevis
    - Saint Lucia
    - St. Lucia # Saint Lucia
    - Saint Martin
    - Saint Vincent and the Grenadines
    - Saint Vincent and Grenadines # Saint Vincent and the Grenadines
    - St. Vincent and the Grenadines # Saint Vincent and the Grenadines
    - St. Vincent and Grenadines # Saint Vincent and the Grenadines
    - Sint Maarten
    - Trinidad and Tobago
    - Turks and Caicos Islands
    - US Virgin Islands
    - U.S. Virgin Islands # US Virgin Islands
    - United States Virgin Islands # US Virgin Islands
  Central America:
    - Belize
    - Costa Rica
    - El Salvador
    - Guatemala
    - Honduras
    - Mexico
    - Nicaragua
    - Panama
  South America:
    - Argentina
    - Bolivia
    - Plurinational State of Bolivia # Bolivia
    - Bouvet Island
    - Brazil
    - Chile
    - Colombia
    - Ecuador
    - Falkland Islands
    - Malvinas # Falkland Islands
    - French Guiana
    - Guyana
    - Paraguay
    - Peru
    - South Georgia and the South Sandwich Islands
    - South Georgia and South Sandwich Islands # South Georgia and the South Sandwich Islands
    - South Georgia # South Georgia and the South Sandwich Islands
    - South Sandwich Islands # South Georgia and the South Sandwich Islands
    - Suriname
    - Uruguay
    - Venezuela
    - Bolivarian Republic of Venezuela # Venezuela
  North America:
    - Bermuda
    - Canada
    - Greenland
    - Saint Pierre and Miquelon
    - St. Pierre and Miquelon # Saint Pierre and Miquelon
    - United States
    - United States of America # United States
  Central Asia:
    - Kazakhstan
    - Kyrgyzstan
    - Tajikistan
    - Turkmenistan
    - Uzbekistan
  Eastern Asia:
    - China
    - Hong Kong
    - Hong Kong SAR China # Hong Kong
    - Macao
    - Macau # Macao
    - Macau SAR China # Macao
    - North Korea
    - Democratic People's Republic of Korea # North Korea
    - Japan
    - Mongolia
    - South Korea
    - Republic of Korea # South Korea
    - Korea # South Korea
    - Taiwan
    - Taiwan, Province of China # Taiwan
  South-Eastern Asia:
    - Brunei
    - Brunei Darussalam # Brunei
    - Cambodia
    - Indonesia
    - Laos
    - Lao People's Democratic Republic # Laos
    - Lao # Laos
    - Malaysia
    - Myanmar
    - Burma # Myanmar
    - Philippines
    - Singapore
    - Thailand
    - East Timor
    - Timor-Leste # East Timor
    - Vietnam
    - Viet Nam # Vietnam
  Southern Asia:
    - Afghanistan
    - Bangladesh
    - Bhutan
    - India
    - Iran
    - Islamic Republic of Iran # Iran
    - Maldives
    - Nepal
    - Pakistan
    - Sri Lanka
  Western Asia:
    - Armenia
    - Azerbaijan
    - Bahrain
    - Cyprus
    - Georgia
    - Iraq
    - Israel
    - Jordan
    - Kuwait
    - Lebanon
    - Oman
    - Qatar
    - Saudi Arabia
    - Palestine
    - State of Palestine # Palestine
    - Syria
    - Syrian Arab Republic # Syria
    - Turkey
    - Türkiye # Turkey
    - United Arab Emirates
    - Yemen
  Eastern Europe:
    - Belarus
    - Bulgaria
    - Czech Republic
    - Czechia # Czech Republic
    - Czechoslovakia # Czech Republic
    - Hungary
    - Poland
    - Moldova
    - Republic of Moldova # Moldova
    - Romania
    - Russia
    - Russian Federation # Russia
    - Soviet Union # Russia
    - Slovakia
    - Ukraine
  Northern Europe:
    - Åland Islands
    - Guernsey
    - Jersey
    - Sark
    - Denmark
    - Estonia
    - Faroe Islands
    - Finland
    - Iceland
    - Ireland
    - Northern Ireland
    - Isle of Man
    - Latvia
    - Lithuania
    - Norway
    - Svalbard and Jan Mayen Islands
    - Svalbard and Jan Mayen # Svalbard and Jan Mayen Islands
    - Sweden
    - United Kingdom
  Southern Europe:
    - Albania
    - Andorra
    - Bosnia and Herzegovina
    - Croatia
    - Gibraltar
    - Greece
    - Kosovo
    - Vatican City
    - Holy See # Vatican City
    - Italy
    - Malta
    - Montenegro
    - North Macedonia
    - Macedonia # North Macedonia
    - Republic of North Macedonia # North Macedonia
    - Portugal
    - San Marino
    - Serbia
    - Serbia and Montenegro
    - Slovenia
    - Spain
    - Yugoslavia
  Western Europe:
    - Austria
    - Belgium
    - France
    - French Republic # France
    - Germany
    - East Germany
    - Liechtenstein
    - Luxembourg
    - Monaco
    - Netherlands
    - Switzerland
  Australia and New Zealand:
    - Australia
    - Christmas Island
    - Cocos (Keeling) Islands
    - Heard Island and McDonald Islands
    - Heard and McDonald Islands # Heard Island and McDonald Islands
    - New Zealand
    - Norfolk Island
  Melanesia:
    - Fiji
    - New Caledonia
    - Papua New Guinea
    - New Guinea # Papua New Guinea
    - Solomon Islands
    - Vanuatu
  Micronesia:
    - Guam
    - Kiribati
    - Marshall Islands
    - Federated States of Micronesia # Micronesia
    - Nauru
    - Northern Mariana Islands
    - Palau
    - US Minor Outlying Islands
    - United States Minor Outlying Islands # US Minor Outlying Islands
    - United States Outlying Islands # US Minor Outlying Islands
    - U.S. Minor Outlying Islands # US Minor Outlying Islands
    - U.S. Outlying Islands # US Minor Outlying Islands
    - US Outlying Islands # US Minor Outlying Islands
  Polynesia:
    - American Samoa
    - Cook Islands
    - French Polynesia
    - Niue
    - Pitcairn
    - Pitcairn Islands # Pitcairn
    - Samoa
    - Tokelau
    - Tonga
    - Tuvalu
    - Wallis and Futuna Islands
    - Wallis and Futuna # Wallis and Futuna Islands