Plex-Meta-Manager/docs/defaults/chart/imdb.md

77 lines
5.5 KiB
Markdown
Raw Normal View History

2022-10-10 07:10:05 +00:00
# IMDb Charts Collections
The `imdb` Default Collection File is used to create collections based on IMDb Charts.
2022-10-10 07:10:05 +00:00
![](../images/imdb.png)
## Requirements & Recommendations
Supported Library Types: Movie, Show
Recommendations: The `IMDb Lowest Rated` Collection only works with Movie Libraries
2023-02-08 10:18:02 +00:00
## Collections Section 020
2022-10-10 07:10:05 +00:00
2022-11-16 14:30:04 +00:00
| Collection | Key | Description |
|:--------------------|:----------|:-----------------------------------------------------|
2022-10-10 07:10:05 +00:00
| `IMDb Popular` | `popular` | Collection of the most Popular Movies/Shows on IMDb. |
2022-11-16 14:30:04 +00:00
| `IMDb Top 250` | `top` | Collection of Top 250 Movies/Shows on IMDb. |
2022-10-10 07:10:05 +00:00
| `IMDb Lowest Rated` | `lowest` | Collection of the lowest Rated Movies on IMDb. |
## Config
The below YAML in your config.yml will create the collections:
2022-10-08 16:31:06 +00:00
```yaml
libraries:
Movies:
collection_files:
2022-10-06 17:34:41 +00:00
- pmm: imdb
2022-10-08 16:31:06 +00:00
TV Shows:
collection_files:
2022-10-08 16:31:06 +00:00
- pmm: imdb
```
## Template Variable Default Values
2022-10-08 16:31:06 +00:00
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.
2023-12-13 21:44:44 +00:00
| Variable | Description & Values |
|:---------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
2022-10-17 12:13:48 +00:00
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
{%
include-markdown "../collection_variables.md"
%}
### Example Template Variable Amendments
2022-10-08 16:31:06 +00:00
The below is an example config.yml extract with some Template Variables added in to change how the file works.
???+ tip
Anywhere you see this icon:
> :fontawesome-solid-circle-plus:
That's a tooltip, you can press them to get more information.
```yaml
libraries:
Movies:
collection_files:
- pmm: imdb
template_variables:
use_lowest: false #(1)!
visible_library_top: true #(2)!
visible_home_top: true #(3)!
visible_shared_top: true #(4)!
```
1. Do not create the "IMDb Lowest Rated" collection
2. Pin the "AniList Popular" collection to the Recommended tab of the library
3. Pin the "AniList Popular" collection to the home screen of the server owner
4. Pin the "AniList Popular" collection to the home screen of other users of the server