Kometa Wiki

Plex ID¶

The plex_id builder finds items already in Plex using their Plex metadata ID. It accepts a single ID or a list of IDs. Each value can be either a bare 24-character metadata ID or a complete plex:// GUID.

collections:
  Selected Plex Movies:
    plex_id:
      - 5d7768243c3c2a001fbca85b
      - plex://movie/5d776824880197001ec901ab

For show-part collections, episode GUIDs such as plex://episode/63e3eedd166819851638a317 are also supported. Values that do not exist in the configured library are skipped with a warning.

This builder does not guarantee that the resulting collection follows the order of the configured IDs.

YAML Lists Explained

YAML supports different ways to define lists. Below are some common methods:

1. List Within a Mapping

fruits:
  - apple
  - banana
  - cherry

2. Inline Style

fruits: [ apple, banana, cherry ]

Each style can be used depending on your needs. The block style is typically more readable for longer lists, while the inline style is compact and useful for short lists.

YAML Dictionaries Explained

Dictionaries are used to associate key/value pairs that are unordered. Dictionaries can be nested by increasing the indentation, or new dictionaries can be created at the same level by resolving the previous one.

cache: true
cache_expiration: 60

The "keys" are cache and cache_expiration and the "values" are true and 60 respectively.

These filters only work if the URL is to the List View of the Letterboxd list (i.e. it should have /detail/ in the URL) or to an account's Reviews (i.e. it should have /USERNAME/films/reviews/ in the URL).

This filter only works if the URL is to the List View of the Letterboxd list (i.e. it should have /detail/ in the URL).

When title is not provided and the mapping name was not specified as an ID, the default behaviour is to use the mapping name as title for matching.

When mapping_id is not provided and the mapping name was specified as an ID, the default behaviour is to use the mapping name as mapping_id for matching.

When the server does not have a Plex Pass then the Edition Field is not accessible. In this scenario, Kometa will check the movie's filepath for {edition-...} to determine what the edition is.

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

You can use current_year to have Kometa use the current year's value. This can be combined with a -# at the end to subtract that number of years. i.e. current_year-2