Plex-Meta-Manager/docs/metadata/builders/letterboxd.md

55 lines
3 KiB
Markdown
Raw Normal View History

2022-03-08 08:06:22 +00:00
# Letterboxd Builders
You can find items using the lists on [Letterboxd.com](https://letterboxd.com/) (Letterboxd).
No configuration is required for these builders.
| Attribute | Description | Works with Movies | Works with Shows | Works with Playlists and Custom Sort |
|:----------------------------------------------|:----------------------------------------------------------------------------------------------------------------|:-----------------:|:-----------------:|:------------------------------------:|
| [`letterboxd_list`](#letterboxd-list) | Finds every movie in the Letterboxd List | ✅ | ❌ | ✅ |
| [`letterboxd_list_details`](#letterboxd-list) | Finds every movie in the Letterboxd List and updates the collection with the description of the Letterboxd list | ✅ | ❌ | ✅ |
## Letterboxd List
Finds every movie in the Letterboxd List.
The expected input is a Letterboxd List URL. Multiple values are supported as either a list or a comma-separated string.
The `sync_mode: sync` and `collection_order: custom` Details are recommended since the lists are continuously updated and in a specific order.
```yaml
collections:
Vultures 101 Best Movie Endings:
letterboxd_list: https://letterboxd.com/brianformo/list/vultures-101-best-movie-endings/
collection_order: custom
sync_mode: sync
```
* You can update the collection details with the Letterboxd List's description by using `letterboxd_list_details`.
* You can specify multiple collections in `letterboxd_list_details` but it will only use the first one to update the collection summary.
```yaml
collections:
Vultures 101 Best Movie Endings:
letterboxd_list_details: https://letterboxd.com/brianformo/list/vultures-101-best-movie-endings/
collection_order: custom
sync_mode: sync
```
2022-03-31 06:23:48 +00:00
You can add 3 different filters directly to this builder.
| Filter Attribute | Description |
|:-----------------|:---------------------------------------------------------------------------------------------------|
| `rating` | **Description:** Search for the specified rating range<br>**Values:** range of int i.e. `80-100` |
| `year` | **Description:** Search for the specified year range<br>**Values:** range of int i.e. `1990-1999` |
| `note` | **Description:** Search for the specified value in the note<br>**Values:** Any String |
```yaml
collections:
Vultures 101 Best Movie Endings From the 90s:
letterboxd_list_details:
url: https://letterboxd.com/brianformo/list/vultures-101-best-movie-endings/
year: 1990-1999
collection_order: custom
sync_mode: sync
```