Network Collections¶
The network
Default Collection File is used to dynamically create collections based on the networks available in your library.
Important
This default requires that the library be set to use the "Plex TV Series" scanner and the "Plex Series" agent.
The error in this case will be Plex Error: plex_search attribute: network not supported
.
Requirements & Recommendations¶
Supported Library Types: Show
Collections Section 050¶
Collection | Key | Description |
---|---|---|
Network Collections |
separator |
Separator Collection to denote the Section of Collections. |
<<network>> Example: NBC |
<<network>> Example: NBC |
Collection of Shows the aired on the network. |
Poster Styles¶
This Default can use the style
template variable to easily change the posters styles.
Color Style (Default)¶
White Style¶
Config¶
The below YAML in your config.yml will create the collections:
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 |
---|---|
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 |
style |
Description: Choose between the default color version or the white one. Values: color or white |
include |
Description: Overrides the default include list. Values: List of Networks found in your library |
append_include |
Description: Appends to the default include list. Values: List of Networks found in your library |
remove_include |
Description: Removes from the default include list. Values: List of Networks found in your library |
exclude |
Description: Exclude these Networks from creating a Dynamic Collection. Values: List of Networks 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 Networks found in your library |
append_addons |
Description: Appends to the default addons dictionary. Values: Dictionary List of Networks found in your library |
remove_addons |
Description: Removes from the default addons dictionary. Values: Dictionary List of Networks found in your library |
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 broadcast on <<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: network
template_variables:
style: white
append_exclude:
- BBC #(1)!
sort_by: title.asc
collection_mode: show_items #(2)!
sep_style: gray #(3)!
- exclude "BBC" from the list of items that should be included in the Collection list
- Show these collections and their items within the "Library" tab
- Use the gray Separator Style
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:
- "#0"
- 7mate
- ABC
- ABC Family
- ABC Kids
- ABC TV
- ABS-CBN
- Acorn TV
- Adult Swim
- AHC
- Alibi
- ALTBalaji
- Amazon Kids+
- AMC
- AMC+
- Animal Planet
- ANIMAX
- Angel Studios
- Antena 3
- Apple TV+
- ARD
- Arte
- Atresplayer Premium
- AT-X
- Audience
- AXN
- Azteca Uno
- A&E
- BBC America
- BBC Four
- BBC iPlayer
- BBC One
- BBC Scotland
- BBC Three
- BBC Two
- BET
- BET+
- bilibili
- Binge
- BluTV
- Boomerang
- Bravo
- BritBox
- C More
- Canale 5
- Canal+
- Cartoon Network
- Cartoonito
- CBC
- CBC Television
- Cbeebies
- CBS
- Channel 3
- Channel 4
- Channel 5
- CHCH-DT
- Cinemax
- Citytv
- CNN
- Comedy Central
- Cooking Channel
- Crackle
- Crave
- Criterion Channel
- Crunchyroll
- CTV
- Cuatro
- Curiosity Stream
- Dave
- DC Universe
- Discovery
- Discovery Kids
- discovery+
- Disney Channel
- Disney Junior
- Disney XD
- Disney+
- DR1
- Dropout
- Eden
- Elisa Viihde
- Elisa Viihde Viaplay
- ENA
- Epix
- ESPN
- EXXEN
- E!
- Facebook Watch
- Family Channel
- Ficción Producciones
- Flooxer
- Food Network
- FOX
- Fox Kids
- France 2
- Freeform
- Freevee
- Fuji TV
- funnyordie.com
- FX
- FXX
- GAİN
- Game Show Network
- Global TV
- Globoplay
- GMA Network
- Hallmark
- HBO
- HBO Max
- HGTV
- History
- HOT3
- Hulu
- ICTV
- IFC
- IMDb TV
- Investigation Discovery
- ION Television
- iQiyi
- ITV
- ITV Encore
- ITV1
- ITV2
- ITV3
- ITV4
- ITVBe
- ITVX
- JioCinema
- joyn
- JTBC
- Kan 11
- Kanal 5
- KBS2
- Kids WB
- La 1
- La Une
- Las Estrellas
- Lifetime
- Lionsgate+
- Logo
- Magnolia Network
- MasterClass
- Max
- MBC
- MBN
- MGM+
- mitele
- Movistar Plus+
- MTV
- M-Net
- National Geographic
- NBC
- Netflix
- Network 10
- NFL Network
- NHK
- Nick
- Nick Jr
- Nickelodeon
- Nicktoons
- Nine Network
- Nippon TV
- NRK1
- OCS City
- OCS Max
- ORF
- Oxygen
- Pantaya
- Paramount Network
- Paramount+
- PBS
- PBS Kids
- Peacock
- Planète+ A&E
- Prime Video
- Quibi
- Rai 1
- Reelz
- RTÉ One
- RTL
- RTL Télé
- RTP1
- RÚV
- S4C
- SAT.1
- SBS
- Science
- Seeso
- Seven Network
- Shahid
- Showcase
- Showmax
- Showtime
- Shudder
- Sky
- Smithsonian
- Space
- Spectrum
- Spike
- Stöð 2
- Stan
- Starz
- STAR+
- Sundance TV
- SVT
- SVT Play
- SVT1
- Syfy
- Syndication
- TBS
- Telecinco
- Telefe
- Telemundo
- Televisión de Galicia
- Televisión Pública Argentina
- Tencent Video
- TF1
- The CW
- The Daily Wire
- The Roku Channel
- The WB
- TLC
- TNT
- Tokyo MX
- Travel Channel
- truTV
- Turner Classic Movies
- TV 2
- tv asahi
- TV Globo
- TV Land
- TV Tokyo
- TV3
- TV4
- TV4 Play
- TVB Jade
- tving
- tvN
- TVNZ 1
- TVNZ 2
- TVP1
- UKTV
- UniMás
- Universal Kids
- Universal TV
- Univision
- UPN
- USA Network
- U+ Mobile TV
- VH1
- Viaplay
- Vice
- Virgin Media One
- ViuTV
- ViX+
- VRT 1
- VRT Max
- VTM
- W
- WE tv
- Xbox Live
- YLE
- Youku
- YouTube
- ZDF
- ZEE5
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:
ABC:
- ABC.com
ABC TV:
- ABC (AU)
- ABC Comedy
- ABC Me
- ABC News
- ABC iview
AMC:
- AMC.com
Animal Planet:
- Animal Planet Brasil
- Animal Planet Deutschland
Angel Studios:
- VidAngel
BET:
- BET Her
Canal+:
- Canal+ Poland
- Canal+ Family
- Canal+ Discovery
- Canal+ Afrique
Cartoon Network:
- Cartoon Network Latin America
- Cartoon Network Anything
CBC:
- CBCDrama
CBC Television:
- CBC Gem
- CBC News Network
- CBC Comedy
CBS:
- CBS.com
- CBS All Access
CTV:
- CTV Two
- CTV News Channel
- CTV Sci-Fi Channel
- CTV Comedy Channel
- CTV Life Channel
- ctv.ca
Discovery:
- Discovery Health Channel
- Discovery Channel
- Discovery Home & Health Brasil
- Discovery Family
- Discovery Real Time
- Discovery Asia
- Discovery Home & Health
- Discovery Life
- Discovery World
- Discovery Science
- Discovery Channel (UK)
Disney Channel:
- Toon Disney
- Playhouse Disney
- Disney Channel Asia
- disney.com
- Disney Channel Middle East
Disney Junior:
- Disney Junior Latin America
- Disney Junior Brasil
Disney+:
- Disney+ Hotstar
ESPN:
- ESPN2
- ESPN+
- ESPN Classic
- ESPNU
- ESPNews
- ESPN Australia
- Sony ESPN
- ESPN.com
- ESPN Deportes
FOX:
- Fox
- Fox News Channel
- Fox Sports
- Fox Reality Channel
- Fox Sports Networks
- Fox Latin America
- Fox Brasil
- Fox Soccer
- Fox Sports 2
- Fox Nation
- Fox Sports 1
- fox.com
- Fox Sports Detroit
Freevee:
- Amazon Freevee
Hallmark:
- Hallmark Channel
- Hallmark Drama
- Hallmark Movie & Mysteries
- Hallmark Movies Now
HBO:
- HBO Brasil
- HBO Europe
- HBO Asia
- HBO Latin America
- HBO España
- HBO Nordic
- HBO Canada
- HBO Family
- HBO Mundi
HGTV:
- HGTV Canada
History:
- History Channel Italia
- H2
Lifetime:
- Lifetime Movies
Max:
- HBO Go
- HBO Max
MTV:
- MTV2
- MTV3
- MTV Lebanon
- MTV Latin America
- MTV Italia
- MTV Australia
- MTV Canada
- MTV Global
- MTV Nederland
National Geographic:
- National Geographic Channel
- National Geographic Brasil
- National Geographic Latinoamerica
- National Geographic India
- Nat Geo Wild
NBC:
- CNBC
- MSNBC
- NBCSN
- CNBC Europe
- CNBC Asia
- WNBC
- Nikkei CNBC
- KNBC
- CNBC World
- CNBC TV18
- NBC Weather Plus
- NBC Radio Network
Network Ten:
- Network 10
Nickelodeon:
- Nick at Nite
ReelzChannel:
- Reelz
Sky:
- Sky One
- Sky Atlantic
- Sky Atlantic (IT)
- Sky Arts
- Sky History
- Sky Living
- Sky Crime
- Sky Uno
- Sky Max
- Sky Sports
- Sky Documentaries
- Sky Nature
- Sky News
- Sky Cinema
- Sky News Australia
- Sky Italia
- Sky Comedy
- Sky Sports F1
- Sky Two
- Sky Witness
- sky Travel
- Sky Vision
- Sky News Weather Channel
- SkyShowtime
Smithsonian:
- Smithsonian Channel
- Smithsonian Earth
Spike:
- Spike TV
Starz:
- Starz Encore
Sundance TV:
- SundanceTV
TBS:
- TBS.com
- TBS Brasil
The CW:
- CW seed
TNT:
- TNT Comedy
- TNT Latin America
- TNT España
- TNT Serie
- TNT Glitz
Travel Channel:
- Travel Channel United Kingdom
VH1:
- VH1 Classic
Vice:
- Viceland
- Vice TV
- Vice.com
YouTube:
- YouTube Premium