National Film Registry Collections¶

The nfr Default Collection File is used to create collections based on the National Film Registry.

Requirements & Recommendations¶

Supported Library Types: Movie

Collections Section 130¶

Collection	Key	Description
`National Film Registry All Time`	`all_time`	Collection of Films added to the National Film Registry.
`National Film Registry <<year>>` Example: `National Film Registry 2022`	`<<year>>` Example: `2022`	Collection of Films added to the National Film Registry for the given year.

Config¶

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

libraries:
  Movies:
    collection_files:
      - default: nfr

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.

File-Specific Template VariablesShared Template Variables

Variable Description & Values

use_year_collections Description: Turn the individual year collections off.
Values: false to turn of the collections

year_collection_section Description: Change the collection section for year collections only. (Use quotes to not lose leading zeros "05")
Values: Any number

sync_mode

Description: Changes the Sync Mode for all collections in a Defaults file.
Default: sync
Values:

`sync`	Add and Remove Items based on Builders
`append`	Only Add Items based on Builders

sync_mode_<<key>>¹

Description: Changes the Sync Mode of the specified key's collection.
Default: sync_mode
Values:

`sync`	Add and Remove Items based on Builders
`append`	Only Add Items based on Builders

collection_order

Description: Changes the Collection Order for all collections in a Defaults file.
Default: custom
Values:

`release`	Order Collection by Release Dates
`alpha`	Order Collection Alphabetically
`custom`	Order Collection Via the Builder Order
Any `plex_search` Sort Option	Order Collection by any `plex_search` Sort Option

collection_order_<<key>>¹

Description: Changes the Collection Order of the specified key's collection.
Default: collection_order
Values:

`release`	Order Collection by Release Dates
`alpha`	Order Collection Alphabetically
`custom`	Order Collection Via the Builder Order
Any `plex_search` Sort Option	Order Collection by any `plex_search` Sort Option

data

Description: Replaces the data dynamic collection value.

Attribute	Description & Values
`starting`	Controls the starting year for collections Default: latest-5 Values: Number greater than 0
`ending`	Controls the ending year for collections Default: latest Values: Number greater than 1
`increment`	Controls the increment (i.e. every 5th year) Default: 1 Values: Number greater than 0

starting and ending can also have the value latest
You can also use a value relative to the latest by doing latest-5

exclude Description: Exclude these Years from creating a Dynamic Collection.
Values: List of Years

name_format Description: Changes the title format of the Dynamic Collections.
Default: National Film Registry <<key_name>>
Values: Any string with <<key_name>> in it.

summary_format Description: Changes the summary format of the Dynamic Collections.
Default: <<key_name>> National Film Registry.
Values: Any string with <<key_name>> in it.

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>>¹ Description: Turns off individual Collections in a Defaults file.
Values: false to turn off the collection

name_<<key>>¹ Description: Changes the name of the specified key's collection.
Values: New Collection Name

summary_<<key>>¹ 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>>¹ 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:

`default`	Library default
`hide`	Hide Collection
`hide_items`	Hide Items in this Collection
`show_items`	Show 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>>¹ 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>>¹ 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>>¹ 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>>¹ 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>>¹ 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:

`true`	Visible
`false`	Not Visible
Any `schedule` Option	Visible When Scheduled

visible_library_<<key>>¹

Description: Controls visible on Library Recommended Tab of the specified key's collection. (Only works with Plex Pass)
Default: visible_library
Values:

`true`	Visible
`false`	Not Visible
Any `schedule` Option	Visible When Scheduled

visible_home

Description: Controls visible on Home Tab for all collections in a Defaults file. (Only works with Plex Pass)
Values:

`true`	Visible
`false`	Not Visible
Any `schedule` Option	Visible When Scheduled

visible_home_<<key>>¹

Description: Controls visible on Home Tab of the specified key's collection. (Only works with Plex Pass)
Default: visible_home
Values:

`true`	Visible
`false`	Not Visible
Any `schedule` Option	Visible 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:

`true`	Visible
`false`	Not Visible
Any `schedule` Option	Visible When Scheduled

visible_shared_<<key>>¹

Description: Controls visible on Shared Users' Home Tab of the specified key's collection. (Only works with Plex Pass)
Default: visible_shared
Values:

`true`	Visible
`false`	Not Visible
Any `schedule` Option	Visible 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>>¹ 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>>¹ 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>>¹ 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>>¹ 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>>¹ 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>>¹ 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>>¹ 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>>¹ 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>>¹ 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>>¹ 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>>¹ 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>>¹ 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>>¹ 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>>¹ 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.

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: nfr
        template_variables:
          collection_mode: show_items #(1)!
          collection_order: alpha #(2)!
          radarr_add_missing: true #(3)!
          name_format: National Film Registry <<key_name>> Winners #(4)!
          data: #(5)!
            starting: latest-10
            ending: latest

Shows the collection and all of its items within the Library tab in Plex
Sorts the collection items alphabetically
Adds items from the source list which are not in Plex to Radarr
Change the name of the collections to "National Film Registry yearhere Winners"
Creates collections from 10 award shows back to the latest award show.