Letterboxd Chart Collections¶

The letterboxd Default Collection File is used to create collections based on lists from Letterboxd.

Requirements & Recommendations¶

Supported Library Types: Movie

Recommendations: Users might consider increasing the value set for the Template Variable cache_builders: as several lists are in excess of 1,000 items and are not updated daily.

The collections IMDb Top 250 (Letterboxd), Oscar Best Picture Winners, and Cannes Palme d'Or Winners are turned off by default as these collections already exist within other defaults. Refer to the examples below for turning the collections on within the Letterboxd defaults using Template Variables.

Collections Section 020¶

Collection	Key	Description
`1,001 To See Before You Die`	`1001_movies`	Collection of 1,001 Movies You Must See Before You Die.
`AFI 100 Years 100 Movies`	`afi_100`	Collection of AFI's 100 Years...100 Movies.
`Box Office Mojo All Time 100`	`boxofficemojo_100`	Collection of Box Office Mojo's all-time top 100 films.
`Cannes Palme d'Or Winners`	`cannes`	Collection of films that have won the Palme d'Or at the Cannes Film Festival.
`Edgar Wright's 1,000 Favorites`	`edgarwright`	Collection of Edgar Wright's 1,000 Favorite Movies.
`IMDb Top 250 (Letterboxd)`	`imdb_top_250`	Collection of the Top 250 Movies on IMDb, from Letterboxd.
`Letterboxd Top 250`	`top_250`	Collection of the Top 250 films on Letterboxd.
`Oscar Best Picture Winners`	`oscars`	Collection of films that have won the Academy Award for Best Picture.
`Roger Ebert's Great Movies`	`rogerebert`	Collection of films from Roger Ebert's "Great Movies" essays.
`Sight & Sound Greatest Films`	`sight_sound`	Collection of Sight and Sound's Greatest Films of All Time.
`Top 100 Animation`	`animation`	Collection of the Top 100 animated films on Letterboxd.
`Top 100 Black-Directed`	`black_directors`	Collection of the Top 100 Black-Directed films on Letterboxd.
`Top 250 Documentaries`	`documentaries`	Collection of the Top 250 documentary films on Letterboxd.
`Top 250 Horror`	`horror`	Collection of the Top 250 horror films on Letterboxd.
`Top 250 Most Fans`	`most_fans`	Collection of the Top 250 films with the most fans on Letterboxd.
`Top 250 Women-Directed`	`women_directors`	Collection of the Top 250 Women-Directed films on Letterboxd.

White Style¶

Below is a screenshot of the alternative White (white) style which can be set via the style Template Variable.

White Style takes the base logos and white's them out.

Config¶

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

libraries:
  Movies:
    collection_files:
      - default: letterboxd

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.

Example Template Variable Amendments (Click to Expand)

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: letterboxd
        template_variables:
          use_imdb_top_250: true #(1)!
          use_oscars: true #(2)!
          use_cannes: true #(3)!
          visible_library_top_250: true #(4)!
          visible_home_top_250: true #(5)!
          visible_shared_top_250: true #(6)!
          cache_builders: 7 #(7)!
          cache_builders_1001_movies: 30 #(8)!
          cache_builders_edgarwright: 30 #(9)!

Create the "IMDb Top 250 (Letterboxd)" collection
Create the "Oscar Best Picture Winners" collection
Create the "Cannes Palme d'Or Winners" collection
Pin the "Letterboxd Top 250" collection to the Recommended tab of the library
Pin the "Letterboxd Top 250" collection to the home screen of the server owner
Pin the "Letterboxd Top 250" collection to the home screen of other users of the server
Set the value for cache_builders for all collections (except those explicity defined with cache_builders_<<key>>) to 7 days
Set the value for cache_builders for the "1,001 To See Before You Die" collection to 30 days
Set the value for cache_builders for the "Edgar Wright's 1,000 Favorites" collection to 30 days

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

cache_builders Description: Changes the Builder Cache for all collections in a Defaults File.
Default: 1
Values: number 0 or greater

cache_builders_<<key>> Description: Changes the Builder Cache of the key's collection.
Default: 1
Values: number 0 or greater

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 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

limit Description: Changes the Builder Limit for all collections in a Defaults File.
Values: Number Greater than 0

limit_<<key>>¹ Description: Changes the Builder Limit of the key's collection.
Default: limit
Values: Number Greater than 0

style Description: Controls the visual theme of the collections created.
Default: color
Values: color or white

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 key's collection.
Default: sync_mode
Values:

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

Each default collection has a key that you must replace <<key>> with when using this Template Variable. These keys are found in the table at the top of this page.

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

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

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

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

file_background_<<key>>¹ Description: Sets the background filepath of the key's collection.
Values: Filepath directly to the Image

file_background Description: Sets the background filepath for all collections.
Values: Filepath directly to the Image

file_poster_<<key>>¹ Description: Sets the poster filepath of the key's collection.
Values: Filepath directly to the Image

file_poster Description: Sets the poster filepath for all collections.
Values: Filepath directly to the Image

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

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 key's collection.
Default: item_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_sonarr_tag_<<key>>¹ Description: Used to append a tag in Sonarr for every series found by the builders that's in Sonarr of the key's collection.
Default: item_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

language Description: Set the language of Collection Names and Summaries
Default: default
Values: default (English), fr (French), or de (German)

minimum_items_<<key>>¹ Description: Set the number of minimum items for a collection to be created for the key's collection.
Values: Any number greater than 0

minimum_items Description: Set the number of minimum items for a collection to be created for all collections.
Values: Any number greater than 0

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

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

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 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 key's collection.
Default: radarr_folder
Values: Folder Path

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 key's collection.
Values: true or false

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 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 key's collection.
Default: radarr_tag
Values: List or comma-separated string of tags

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 key's collection.
Values: true or false

schedule_<<key>> Description: Set the schedule for a specific key's collection.
Values: Any Scheduling Option

schedule Description: Set the schedule for all of the collections in a Defaults File.
Values: Any Scheduling Option

sonarr_add_missing_<<key>>¹ Description: Override Sonarr add_missing attribute of the key's collection.
Default: sonarr_add_missing
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_folder_<<key>>¹ Description: Override Sonarr root_folder_path attribute of the key's collection.
Default: sonarr_folder
Values: Folder Path

sonarr_folder Description: Override Sonarr root_folder_path attribute for all collections in a Defaults File.
Values: Folder Path

sonarr_monitor_existing_<<key>>¹ Description: Override Sonarr monitor_existing attribute of the 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_search_<<key>>¹ Description: Override Sonarr search attribute of the key's collection.
Default: sonarr_search
Values: true or false

sonarr_search Description: Override Sonarr search attribute or all collections in a Defaults File.
Values: true or false

sonarr_tag_<<key>>¹ Description: Override Sonarr tag attribute of the key's collection.
Default: sonarr_tag
Values: List or comma-separated string of tags

sonarr_tag Description: Override Sonarr tag attribute for all collections in a Defaults File.
Values: List or comma-separated string of tags

sonarr_upgrade_existing_<<key>>¹ Description: Override Sonarr upgrade_existing attribute of the key's collection.
Values: true or false

sonarr_upgrade_existing Description: Override Sonarr upgrade_existing attribute for all collections in a Defaults File.
Values: true or false

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

summary_<<key>>¹ Description: Changes the summary of the key's collection.
Values: New Collection Summary

url_background_<<key>>¹ Description: Sets the background url of the key's collection.
Values: URL directly to the Image

url_background Description: Sets the background url for all collections.
Values: URL directly to the Image

url_poster_<<key>>¹ Description: Changes the poster url of the key's collection.
Values: URL directly to the Image

url_poster Description: Changes the poster url for all collections.
Values: URL directly to the Image

use_<<key>>¹ Description: Turns off individual Collections in a Defaults File.
Values: false to turn off the collection

use_all Description: Turns off all Collections in a Defaults File.
Values: false to turn off the collection

visible_home_<<key>>¹

Description: Controls visible on Home Tab of the key's collection. (Only works with Plex Pass)
Default: visible_home
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_library_<<key>>¹

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

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

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_shared_<<key>>¹

Description: Controls visible on Shared Users' Home Tab of the key's collection. (Only works with Plex Pass)
Default: visible_shared
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

Each default collection has a key that when calling to effect a specific collection you must replace <<key>> with when calling.

Default Value Source¶

This is a reference showing the source of the data used in this Defaults File.

Nothing in this section is required for using the Defaults File, but it can be useful for understanding where the data comes from.

Nothing in this section is directly useful for customizing this Defaults File.

Nothing here is a code example for end user use. It all looks like code, since it is taken directly from the Kometa source code to ensure it is up-to-date and accurate, but it is not intended for end user use, and is expressed in a different format to the way you would customize the defaults via Template Variables.

I want to customize this default

To learn how to customize any Defaults File using Template Variables see the Defaults Usage Guide.

Each Defaults File has its own set of Template Variables, which are used to control the behavior of that default. The Template Variables for this file can be found here.

I want to know what's behind the defaults

The lists provided here are for reference to show what values will be in use if no customization is done.

These do not show how to customize the defaults.

Nothing here is a code example for end user use. It all looks like code, since it is taken directly from the Kometa source code to ensure it is up-to-date and accurate, but it is not intended for end user use.

These lists are provided for reference only.

If you want to customize these collections, refer to the Defaults Usage Guide to learn how to use Template Variables.

Letterboxd Chart Collections

The Letterboxd Chart collections use Letterboxd Builders to create the collections.