You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
19 KiB
19 KiB
Continent Collections
The continent Default Metadata 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 seven continents.
This file has a Movie Library Counterpart.
Requirements & Recommendations
Supported Library Types: Show
Collections Section 082
| Collection | Key | Description |
|---|---|---|
Continent Collections |
separator |
Separator Collection to denote the Section of Collections. |
<<Continent>>Example: South America |
<<2 digit ISO 3166-1 code>>Example: br |
Collection of TV Shows that have this Continent. |
Other Continents |
other |
Collection of TV Shows that are in other uncommon Continents. |
Config
The below YAML in your config.yml will create the collections:
libraries:
TV Shows:
metadata_path:
- pmm: continent
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 is its default value if it has one if not it's just ignored.
All Shared Collection Variables are available as well as the additional Variables below which can be used to customize the file.
This file contains a Separator so all Shared Separator Variables are available as well.
| 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 then 0 |
|||||
limit_<<key>>1 |
Description: Changes the Builder Limit of the specified key's collection. Default: limitValues: Number Greater then 0 |
|||||
sync_mode |
Description: Changes the Sync Mode for all collections in a Defaults file. Default: syncValues:
|
|||||
sync_mode_<<key>>1 |
Description: Changes the Sync Mode of the specified key's collection. Default: sync_modeValues:
|
|||||
sort_by |
Description: Changes the Smart Filter Sort for all collections in a Defaults file. Default: release.descValues: Any smart_filter Sort Option |
|||||
sort_by_<<key>>1 |
Description: Changes the Smart Filter Sort of the specified key's collection. Default: sort_byValues: Any smart_filter Sort Option |
|||||
include |
Description: Overrides the default include list. Values: List of 2 digit ISO 3166-1 codes |
|||||
exclude |
Description: Exclude these Countries from creating a Dynamic Collection. Values: List of 2 digit ISO 3166-1 codes |
|||||
addons |
Description: 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 2 digit ISO 3166-1 codes |
|||||
append_include |
Description: Appends to the default include list. Values: List of 2 digit ISO 3166-1 codes |
|||||
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
keythat when calling to effect a specific collection you must replace<<key>>with when calling.
The below is an example config.yml extract with some Template Variables added in to change how the file works.
libraries:
TV Shows:
metadata_path:
- pmm: continent
template_variables:
use_other: false
use_separator: false
style: color
sep_style: purple
exclude:
- nz
sort_by: title.asc
Default values
These are lists provided for reference to show what values will be in use if you do no customization. If you want to customize these values, use the methods described above. These do not show how to change a name or a list.
Default include
# Countries where other countries will be grouped into
include:
- aq # Antarctica
- nz # New Zealand
- br # Brazil
- cn # China
- za # South Africa
- gb # United Kingdom
- us # United States of America
Default key_name_override
# Name changes for the above countries
key_name_override:
nz: Oceania
br: South America
cn: Asia
za: Africa
gb: Europe
us: North America
Default addons
# Grouping of countries into continents
addons:
aq: # Antarctica
- bv # Bouvet Island
cn: # China - Asia
- af # Afghanistan
- kz # Kazakhstan
- kg # Kyrgyzstan
- tj # Tajikistan
- tm # Turkmenistan
- uz # Uzbekistan
- mn # Mongolia
- in # India
- pk # Pakistan
- bt # Bhutan
- bd # Bangladesh
- np # Nepal
- lk # Sri Lanka
- mv # Maldives
- jp # Japan
- hk # Hong Kong
- mo # Macao
- th # Thailand
- bn # Brunei
- kh # Cambodia
- id # Indonesia
- la # Lao
- my # Malaysia
- mm # Myanmar
- ph # Philippines
- sg # Singapore
- vn # Vietnam
- tr # Turkey
- bh # Bahrain
- cy # Cyprus
- eg # Egypt
- ir # Iran
- iq # Iraq
- il # Israel
- jo # Jordan
- kw # Kuwait
- lb # Lebanon
- om # Oman
- ps # Palestine
- qa # Qatar
- sa # Saudi Arabia
- sy # Syria
- ae # United Arab Emirates
- ye # Yemen
- tw # Taiwan
- kr # Korea
br: # Brazil - South America
- ar # Argentina
- cl # Chile
- py # Paraguay
- uy # Uruguay
- fk # Falkland Islands
- cr # Costa Rica
- bz # Belize
- sv # El Salvador
- gt # Guatemala
- hn # Honduras
- ni # Nicaragua
- pa # Panama
- pe # Peru
- bo # Bolivia
- co # Colombia
- ec # Ecuador
- ve # Venezuela
- gf # French Guiana
- gy # Guyana
- sr # Suriname
gb: # United Kingdom - Europe
- am # Armenia
- az # Azerbaijan
- ge # Georgia
- be # Belgium
- lu # Luxembourg
- nl # Netherlands
- hr # Croatia
- al # Albania
- ba # Bosnia and Herzegovina
- bg # Bulgaria
- mk # Macedonia
- me # Montenegro
- ro # Romania
- rs # Serbia
- si # Slovenia
- dk # Denmark
- ax # Åland Islands
- fo # Faroe Islands
- fi # Finland
- gl # Greenland
- is # Iceland
- no # Norway
- sj # Svalbard and Jan Mayen
- se # Sweden
- ie # Ireland
- gr # Greece
- pl # Poland
- by # Belarus
- cz # Czech Republic
- ee # Estonia
- hu # Hungary
- lv # Latvia
- lt # Lithuania
- md # Moldova
- sk # Slovakia
- ua # Ukraine
- es # Spain
- ad # Andorra
- pt # Portugal
- ch # Switzerland
- at # Austria
- li # Liechtenstein
- ru # Russia
- gg # Guernsey
- gi # Gibraltar
- im # Isle of Man
- je # Jersey
- mt # Malta
- de # Germany
- fr # France
- mc # Monaco
- it # Italy
- va # Holy See
- sm # San Marino
us: # United States of America - North America
- bs # Bahamas
- ai # Anguilla
- ag # Antigua
- aw # Aruba
- bb # Barbados
- bm # Bermuda
- bq # Bonaire
- ky # Cayman Islands
- cu # Cuba
- cw # Curaçao
- dm # Dominica
- do # Dominican Republic
- gd # Grenada
- gp # Guadeloupe
- ht # Haiti
- jm # Jamaica
- mq # Martinique
- ms # Montserrat
- pr # Puerto Rico
- bl # Saint Barthélemy
- lc # Saint Lucia
- tt # Trinidad and Tobago
- tc # Turks and Caicos
- ca # Canada
- mx # Mexico
za: # South Africa - Africa
- td # Chad
- ao # Angola
- cm # Cameroon
- cf # Central African Republic
- cg # Congo
- gq # Equatorial Guinea
- ga # Gabon
- st # Sao Tome and Principe
- ke # Kenya
- bi # Burundi
- km # Comoros
- dj # Djibouti
- er # Eritrea
- et # Ethiopia
- mg # Madagascar
- mw # Malawi
- mu # Mauritius
- yt # Mayotte
- mz # Mozambique
- re # Réunion
- rw # Rwanda
- sc # Seychelles
- so # Somalia
- ss # South Sudan
- tz # Tanzania
- ug # Uganda
- zm # Zambia
- zw # Zimbabwe
- ma # Morocco
- dz # Algeria
- eg # Egypt
- ly # Libya
- sd # Sudan
- tn # Tunisia
- ng # Nigeria
- bj # Benin
- bf # Burkina Faso
- cv # Cabo Verde
- ci # Côte d'Ivoire
- gm # Gambia
- gh # Ghana
- gn # Guinea
- gw # Guinea-Bissau
- lr # Liberia
- ml # Mali
- mr # Mauritania
- ne # Niger
- sn # Senegal
- sl # Sierra Leone
- tg # Togo
- bw # Botswana
- sz # Eswatini
- ls # Lesotho
- na # Namibia
nz: # New Zealand - Oceania
- au # Australia
- cx # Christmas Island
- cc # Cocos (Keeling) Islands
- pg # New Guinea
- tl # Timor-Leste
- ck # Cook Islands
- fj # Fiji
- pf # French Polynesia
- gu # Guam
- ki # Kiribati
- mh # Marshall Islands
- fm # Micronesia
- nr # Nauru
- nc # New Caledonia
- nu # Niue
- nf # Norfolk Island
- pw # Palau
- pn # Pitcairn
- ws # Samoa
- sb # Solomon Islands
- tk # Tokelau
- to # Tonga
- tv # Tuvalu
- vu # Vanuatu