Country Collections¶
The country
Default Collection File is used to dynamically create collections based on the countries available in your
library.
This file has a Show Library Counterpart.
Requirements & Recommendations¶
Supported Library Types: Movie
Collections Section 080¶
Collection | Key | Description |
---|---|---|
Country Collections |
separator |
Separator Collection to denote the Section of Collections. |
<<Country>> Example: Germany |
<<Country>> Example: Germany |
Collection of Movies that have this Country. |
Other Countries |
other |
Collection of Movies that are in other uncommon Countries. |
Config¶
The below YAML in your config.yml will create the collections:
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
|
|||||
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 |
|||||
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 |
|||||
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_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. |
- 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:
|
||||||||
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:
|
||||||||
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:
|
||||||||
visible_home |
Description: Controls visible on Home Tab for all collections in a Defaults file. (Only works with Plex Pass) Values:
|
||||||||
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:
|
||||||||
visible_shared |
Description: Controls visible on Shared Users' Home Tab for all collections in a Defaults file. (Only works with Plex Pass) Values:
|
||||||||
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:
|
||||||||
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 |
- 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:
|
||||||||
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: country
template_variables:
use_other: false #(1)!
use_separator: false #(2)!
style: color #(3)!
exclude:
- France #(4)!
sort_by: title.asc
- Do not create the "Other Countries" collection
- Do not create a "Country Collections" separator
- Set the Color Style
- Exclude "France" 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:
- 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
- Zambia
- Zimbabwe
# Central Africa:
- Angola
- Cameroon
- Central African Republic
- Chad
- Republic of the Congo
- Democratic Republic of the Congo
- Equatorial Guinea
- Gabon
- São Tomé and Príncipe
# Southern Africa:
- Botswana
- Eswatini
- Lesotho
- Namibia
- South Africa
# Western Africa:
- Benin
- Burkina Faso
- Cape Verde
- Côte d'Ivoire
- Gambia
- Ghana
- Guinea
- Guinea-Bissau
- Liberia
- Mali
- Mauritania
- Niger
- Nigeria
- Saint Helena, Ascension and Tristan da Cunha
- Senegal
- Sierra Leone
- Togo
# Caribbean:
- Anguilla
- Antigua and Barbuda
- Aruba
- Bahamas
- Barbados
- 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
- Saint Lucia
- Saint Martin
- Saint Vincent and the Grenadines
- Sint Maarten
- Trinidad and Tobago
- Turks and Caicos Islands
- US Virgin Islands
# Central America:
- Belize
- Costa Rica
- El Salvador
- Guatemala
- Honduras
- Mexico
- Nicaragua
- Panama
# South America:
- Argentina
- Bolivia
- Bouvet Island
- Brazil
- Chile
- Colombia
- Ecuador
- Falkland Islands
- French Guiana
- Guyana
- Paraguay
- Peru
- South Georgia and the South Sandwich Islands
- Suriname
- Uruguay
- Venezuela
# North America:
- Bermuda
- Canada
- Greenland
- Saint Pierre and Miquelon
- United States
# Antarctica:
- Antarctica
# Central Asia:
- Kazakhstan
- Kyrgyzstan
- Tajikistan
- Turkmenistan
- Uzbekistan
# Eastern Asia:
- China
- Hong Kong
- Macao
- North Korea
- Japan
- Mongolia
- South Korea
- Taiwan
# South-Eastern Asia:
- Brunei
- Cambodia
- Indonesia
- Laos
- Malaysia
- Myanmar
- Philippines
- Singapore
- Thailand
- East Timor
- Vietnam
# Southern Asia:
- Afghanistan
- Bangladesh
- Bhutan
- India
- Iran
- Maldives
- Nepal
- Pakistan
- Sri Lanka
# Western Asia:
- Armenia
- Azerbaijan
- Bahrain
- Cyprus
- Georgia
- Iraq
- Israel
- Jordan
- Kuwait
- Lebanon
- Oman
- Qatar
- Saudi Arabia
- Palestine
- Syria
- Turkey
- United Arab Emirates
- Yemen
# Eastern Europe:
- Belarus
- Bulgaria
- Czech Republic
- Hungary
- Poland
- Moldova
- Romania
- 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
- Sweden
- United Kingdom
# Southern Europe:
- Albania
- Andorra
- Bosnia and Herzegovina
- Croatia
- Gibraltar
- Greece
- Kosovo
- Vatican City
- Italy
- Malta
- Montenegro
- North Macedonia
- Portugal
- San Marino
- Serbia
- Serbia and Montenegro
- Slovenia
- Spain
- Yugoslavia
# Western Europe:
- Austria
- Belgium
- France
- Germany
- Liechtenstein
- Luxembourg
- Monaco
- Netherlands
- Switzerland
#Australia and New Zealand:
- Australia
- Christmas Island
- Cocos (Keeling) Islands
- Heard Island and McDonald Islands
- New Zealand
- Norfolk Island
# Melanesia:
- Fiji
- New Caledonia
- Papua New Guinea
- Solomon Islands
- Vanuatu
# Micronesia:
- Guam
- Kiribati
- Marshall Islands
- Micronesia
- Nauru
- Northern Mariana Islands
- Palau
- US Minor Outlying Islands
# Polynesia:
- American Samoa
- Cook Islands
- French Polynesia
- Niue
- Pitcairn Islands
- Samoa
- Tokelau
- Tonga
- Tuvalu
- Wallis and Futuna Islands
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:
Tanzania:
- United Republic of Tanzania
Republic of the Congo:
- Congo
Democratic Republic of the Congo:
- Zaire
São Tomé and Príncipe:
- Sao Tome and Principe
Eswatini:
- Swaziland
Cape Verde:
- Cabo Verde
Côte d'Ivoire:
- Côte d’Ivoire
- Ivory Coast
Saint Helena, Ascension and Tristan da Cunha:
- Saint Helena
- St. Helena
- Ascension
- Tristan da Cunha
Antigua and Barbuda:
- Antigua
- Barbuda
Bonaire, Sint Eustatius and Saba:
- Bonaire
- Sint Eustatius
- Saba
Saint Kitts and Nevis:
- St. Kitts and Nevis
Saint Lucia:
- St. Lucia
Saint Vincent and the Grenadines:
- Saint Vincent and Grenadines
- St. Vincent and the Grenadines
- St. Vincent and Grenadines
US Virgin Islands:
- U.S. Virgin Islands
- United States Virgin Islands
Bolivia:
- Plurinational State of Bolivia
Falkland Islands:
- Malvinas
South Georgia and the South Sandwich Islands:
- South Georgia and South Sandwich Islands
- South Georgia
- South Sandwich Islands
Venezuela:
- Bolivarian Republic of Venezuela
Saint Pierre and Miquelon:
- St. Pierre and Miquelon
United States:
- United States of America
Hong Kong:
- Hong Kong SAR China
Macao:
- Macau
- Macau SAR China
North Korea:
- Democratic People's Republic of Korea
South Korea:
- Republic of Korea
- Korea
Taiwan:
- Taiwan, Province of China
Brunei:
- Brunei Darussalam
Laos:
- Lao People's Democratic Republic
- Lao
Myanmar:
- Burma
East Timor:
- Timor-Leste
Vietnam:
- Viet Nam
Iran:
- Islamic Republic of Iran
Palestine:
- State of Palestine
Syria:
- Syrian Arab Republic
Turkey:
- Türkiye
Czech Republic:
- Czechia
- Czechoslovakia
Moldova:
- Republic of Moldova
Russia:
- Russian Federation
- Soviet Union
Svalbard and Jan Mayen Islands:
- Svalbard and Jan Mayen
Vatican City:
- Holy See
North Macedonia:
- Macedonia
- Republic of North Macedonia
France:
- French Republic
Germany:
- East Germany
Heard Island and McDonald Islands:
- Heard and McDonald Islands
Papua New Guinea:
- New Guinea
Micronesia:
- Federated States of Micronesia
US Minor Outlying Islands:
- United States Minor Outlying Islands
- United States Outlying Islands
- U.S. Minor Outlying Islands
- U.S. Outlying Islands
- US Outlying Islands
Pitcairn Islands:
- Pitcairn
Wallis and Futuna Islands:
- Wallis and Futuna