meisnate12
2 years ago
parent
56656e07a6
commit
3653527a2f
@ -0,0 +1,55 @@
|
||||
## Radarr Details
|
||||
All the following attributes can override the global/library [Radarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Radarr-Attributes) attributes which are the default unless otherwise specified.
|
||||
|
||||
| Name | Attribute | Description | Allowed Values | Works with Playlists |
|
||||
| :--- | :--- | :--- | :--- | :---: |
|
||||
| [Radarr Add](#arr-add) | `radarr_add` | Override Radarr `add` attribute | **boolean:** `true` or `false` | :heavy_check_mark: |
|
||||
| [Radarr Add Existing](#arr-add-existing) | `radarr_add_existing` | Override Radarr `add_existing` attribute | **boolean:** `true` or `false` | :heavy_check_mark: |
|
||||
| [Radarr Root Folder](#radarr-add-details) | `radarr_folder` | Override Radarr `root_folder_path` attribute | Folder Path | :heavy_check_mark: |
|
||||
| [Radarr Monitor](#radarr-add-details) | `radarr_monitor` | Override Radarr `monitor` attribute | **boolean:** `true` or `false` | :heavy_check_mark: |
|
||||
| [Radarr Availabilit](#radarr-add-details)y | `radarr_availability` | Override Radarr `availability` attribute | `announced`, `cinemas`, `released`, `db` | :heavy_check_mark: |
|
||||
| [Radarr Quality Profile](#radarr-add-details) | `radarr_quality` | Override Radarr `quality_profile` attribute | Radarr Quality Profile | :heavy_check_mark: |
|
||||
| [Radarr Tag](#radarr-add-details) | `radarr_tag` | Override Radarr `tag` attribute | List or comma-separated string of tags | :heavy_check_mark: |
|
||||
| [Radarr Search](#radarr-add-details) | `radarr_search` | Override Radarr `search` attribute | **boolean:** `true` or `false` | :heavy_check_mark: |
|
||||
| [Item Radarr Tag](#arr-edit-details) | `item_radarr_tag` | Used to append a tag in Radarr for every movie found by the builders that's in Radarr | List or comma-separated string of tags | :heavy_check_mark: |
|
||||
| [Item Radarr Tag Remove](#arr-edit-details) | `item_radarr_tag.remove` | Used to remove existing tags in Radarr for every movie found by the builders that's in Radarr | List or comma-separated string of tags | :heavy_check_mark: |
|
||||
| [Item Radarr Tag Sync](#arr-edit-details) | `item_radarr_tag.sync` | Matches the tags in Radarr for every movie found by the builders that's in Radarr with the provided tags | List or comma-separated string of tags | :heavy_check_mark: |
|
||||
|
||||
## Sonarr Details
|
||||
All the following attributes can override the global/library [Sonarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Sonarr-Attributes) attributes which are the default unless otherwise specified.
|
||||
|
||||
| Name | Attribute | Description | Allowed Values | Works with Playlists |
|
||||
| :--- | :--- | :--- | :--- | :---: |
|
||||
| [Sonarr Add](#arr-add) | `sonarr_add` | Override Sonarr `add` attribute | **boolean:** `true` or `false` | :heavy_check_mark: |
|
||||
| [Sonarr Add Existing](#arr-add-existing) | `sonarr_add_existing` | Override Sonarr `add_existing` attribute | **boolean:** `true` or `false` | :heavy_check_mark: |
|
||||
| [Sonarr Root Folder](#radarr-add-details) | `sonarr_folder` | Override Sonarr `root_folder_path` attribute | Folder Path | :heavy_check_mark: |
|
||||
| [Sonarr Monitor](#radarr-add-details) | `sonarr_monitor` | Override Sonarr `monitor` attribute | `all`, `future`, `missing`, `existing`, `pilot`, `first`, `latest`, `none` | :heavy_check_mark: |
|
||||
| [Sonarr Quality Profile](#radarr-add-details) | `sonarr_quality` | Override Sonarr `quality_profile` attribute | Sonarr Quality Profile | :heavy_check_mark: |
|
||||
| [Sonarr Language Profile](#radarr-add-details) | `sonarr_language` | Override Sonarr `language_profile` attribute | Sonarr Language Profile | :heavy_check_mark: |
|
||||
| [Sonarr Series Type](#radarr-add-details) | `sonarr_series` | Override Sonarr `series_type` attribute | `standard`, `daily`, `anime` | :heavy_check_mark: |
|
||||
| [Sonarr Season Folder](#radarr-add-details) | `sonarr_season` | Override Sonarr `season_folder` attribute | **boolean:** `true` or `false` | :heavy_check_mark: |
|
||||
| [Sonarr Tag](#radarr-add-details) | `sonarr_tag` | Override Sonarr `tag` attribute | List or comma-separated string of tags | :heavy_check_mark: |
|
||||
| [Sonarr Search](#radarr-add-details) | `sonarr_search` | Override Sonarr `search` attribute | **boolean:** `true` or `false` | :heavy_check_mark: |
|
||||
| [Sonarr Cutoff Search](#radarr-add-details) | `sonarr_cutoff_search` | Override Sonarr `cutoff_search` attribute | **boolean:** `true` or `false` | :heavy_check_mark: |
|
||||
| [Item Sonarr Tag](#arr-edit-details) | `item_sonarr_tag` | Used to append a tag in Sonarr for every series found by the builders that's in Sonarr | List or comma-separated string of tags | :heavy_check_mark: |
|
||||
| [Item Sonarr Tag Remove](#arr-edit-details) | `item_sonarr_tag.remove` | Used to remove existing tags in Sonarr for every series found by the builders that's in Sonarr | List or comma-separated string of tags | :heavy_check_mark: |
|
||||
| [Item Sonarr Tag Sync](#arr-edit-details) | `item_sonarr_tag.sync` | Matches the tags in Sonarr for every series found by the builders that's in Sonarr with the provided tags | List or comma-separated string of tags | :heavy_check_mark: |
|
||||
|
||||
### Arr Add
|
||||
When `radarr_add`/`sonarr_add` are true the items missing from the collection/playlist will be added to Radarr/Sonarr.
|
||||
|
||||
### Arr Add Existing
|
||||
When `radarr_add`/`sonarr_add` are true the items that exist in the collection/playlist will be added to Radarr/Sonarr.
|
||||
|
||||
### Radarr Add Details
|
||||
When adding a movie in Radarr you get the screen below to set these options use `radarr_folder`, `radarr_monitor`, `radarr_availability`, `radarr_quality`, `radarr_tag`, and `radarr_search`.
|
||||
|
||||
|
||||
|
||||
### Sonarr Add Details
|
||||
When adding a movie in Sonarr you get the screen below to set these options use `sonarr_folder`, `sonarr_monitor`, `sonarr_quality`, `sonarr_language`, `sonarr_series`, `sonarr_season`, `sonarr_tag`, `sonarr_search`, and `sonarr_cutoff_search`.
|
||||
|
||||
|
||||
|
||||
### Arr Edit Details
|
||||
When editing the details of items that exist in the collection/playlist and in Radarr/Sonarr use `item_radarr_tag` and `item_sonarr_tag`
|
||||
@ -1,8 +0,0 @@
|
||||
The script can automatically build collections, edit collection metadata, and change collection images using the `collections` attribute.
|
||||
|
||||
Each collection is defined by the mapping name which becomes the name of the Plex collection.
|
||||
|
||||
There are three types of attributes in collections
|
||||
1. **[Collection Builders](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Collection-Builders):** attribute that adds items to the collection
|
||||
2. **[Collection Details](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Collection-Details):** attribute that changes a collections details
|
||||
3. **[Collection Filters](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Collection-Filters):** attributes that filters items added to all collection builders
|
||||
@ -1,19 +0,0 @@
|
||||
Collection builders all add movies/shows to collections.
|
||||
|
||||
Multiple collection builders can be used in the same collection.
|
||||
|
||||
There are multiple different sources you can build collections from listed below
|
||||
* [Plex Builders](Plex-Builders)
|
||||
* [Smart Builders](Smart-Builders)
|
||||
* [TMDb Builders](TMDb-Builders)
|
||||
* [TVDb Builders](TVDb-Builders)
|
||||
* [IMDb Builders](IMDb-Builders)
|
||||
* [Trakt Builders](Trakt-Builders)
|
||||
* [Tautulli Builders](Tautulli-Builders)
|
||||
* [Letterboxd Builders](Letterboxd-Builders)
|
||||
* [ICheckMovies Builders](ICheckMovies-Builders)
|
||||
* [FlixPatrol Builders](FlixPatrol-Builders)
|
||||
* [StevenLu Builders](StevenLu-Builders)
|
||||
* [AniDB Builders](AniDB-Builders)
|
||||
* [AniList Builders](AniList-Builders)
|
||||
* [MyAnimeList Builders](MyAnimeList-Builders)
|
||||
@ -1,210 +0,0 @@
|
||||
Here is an example with multiple details being set:
|
||||
```yaml
|
||||
collections:
|
||||
IMDb Top 250:
|
||||
imdb_list: https://www.imdb.com/search/title/?groups=top_250&count=25
|
||||
sort_title: "+100"
|
||||
sync_mode: sync
|
||||
radarr_add: true
|
||||
show_filtered: true
|
||||
filters:
|
||||
original_language: en
|
||||
Reddit Top 250:
|
||||
trakt_list: https://trakt.tv/users/jay-greene/lists/reddit-top-250-2019-edition
|
||||
sort_title: "+101"
|
||||
sync_mode: sync
|
||||
Star Wars:
|
||||
tmdb_collection: 10
|
||||
tmdb_summary: 10
|
||||
tmdb_poster: 10
|
||||
tmdb_background: 10
|
||||
Pixar:
|
||||
studio: Pixar
|
||||
content_rating: PG
|
||||
url_poster: https://theposterdb.com/api/assets/29378/view?
|
||||
url_background: https://wallpaperaccess.com/full/331622.jpg
|
||||
summary: A collection of Pixar movies
|
||||
collection_order: alpha
|
||||
Robin Williams:
|
||||
actor: Robin Williams
|
||||
tmdb_biography: 2157
|
||||
tmdb_profile: 2157
|
||||
collection_mode: show_items
|
||||
collection_order: alpha
|
||||
Samuel L. Jackson:
|
||||
actor: tmdb
|
||||
tmdb_person: 2231
|
||||
collection_mode: show_items
|
||||
collection_order: alpha
|
||||
Marvel Cinematic Universe:
|
||||
tmdb_list: 7069903
|
||||
tmdb_description: 7069903
|
||||
tmdb_list_poster: 7069903
|
||||
28 Days/Weeks Later:
|
||||
tmdb_collection_details: 1565
|
||||
name_mapping: 28 Days-Weeks Later
|
||||
```
|
||||
|
||||
The available collection details for each collection are split into different sections
|
||||
|
||||
* [Settings Details](#setting-details)
|
||||
* [Radarr Details](#radarr-details)
|
||||
* [Sonarr Details](#sonarr-details)
|
||||
* [Metadata Details](#metadata-details)
|
||||
* [Item Metadata Details](#item-metadata-details)
|
||||
* [Summary Details](#summary-details)
|
||||
* [Poster Details](#poster-details)
|
||||
* [Background Details](#background-details)
|
||||
|
||||
## Setting Details
|
||||
All the following attributes serve various functions as how the collection functions inside of Plex Meta Manager.
|
||||
|
||||
| Name | Attribute | Description | Allowed Values |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| Collection Name | `collection_name` | Used to specify the name off the collection in Plex as different then the mapping name. | Any String |
|
||||
| Schedule | `schedule` | Used to schedule this collection | [`schedule` mapping details](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Schedule-Detail) |
|
||||
| Template | `template` | Used to specify a template and template variables to use for this collection | [`template` mapping details](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Template-Attributes) |
|
||||
| Run Again | `run_again` | Used to try and add all the items missing from the collection to the collection again after the daily run <br>**Default Mode:** `false`| **boolean:** `true` or `false` |
|
||||
| Sync Mode | `sync_mode` | Used to change how collection builders sync with this collection<br>**Default Mode:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | `append`: Only Add Items to the Collection<br>`sync`: Add & Remove Items from the Collection |
|
||||
| Collection Minimum | `collection_minimum` | Minimum items that must be found to add to a collection.<br>**Default:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | number greater then 0 |
|
||||
| Delete Below Minimum | `delete_below_minimum` | Deletes the collection if below the minimum.<br>**Default:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | **boolean:** `true` or `false` |
|
||||
| Delete Not Scheduled | `delete_not_scheduled` | Deletes the collection if its skipped because its not scheduled.<br>**Default:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | **boolean:** `true` or `false` |
|
||||
| Validate Builders | `validate_builders` | When set to false the collection will not fail if one builder fails<br>**Default Mode:** `true` | **boolean:** `true` or `false` |
|
||||
| Build Collection | `build_collection` | When set to false the collection won't be created but items can still be added to Radarr/Sonarr<br>**Default Mode:** `true` | **boolean:** `true` or `false` |
|
||||
| Server Pre-Roll | `server_preroll` | Used to set the `Movie pre-roll video` Text box in Plex under Settings -> Extras | Any String |
|
||||
| Missing Only Released | `missing_only_released` | Collection Level `missing_only_released` toggle<br>**Default:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | **boolean:** `true` or `false` |
|
||||
| Only Filter Missing | `only_filter_missing` | Collection Level `only_filter_missing` toggle<br>**Default:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | **boolean:** `true` or `false` |
|
||||
| Show Filtered Collections | `show_filtered` | Collection level `show_filtered` toggle<br>**Default:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | **boolean:** `true` or `false` |
|
||||
| Show Missing Collections | `show_missing` | Collection level `show_missing` toggle<br>**Default:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | **boolean:** `true` or `false` |
|
||||
| Save Missing Collections | `save_missing` | Collection level `save_missing` toggle<br>**Default:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | **boolean:** `true` or `false` |
|
||||
| Ignore IDs | `ignore_ids` | Collection level `ignore_ids` which is combined with the library and global `ignore_ids`<br>**Default:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | List or comma-separated String of TMDb/TVDb IDs |
|
||||
| Ignore IMDb IDs | `ignore_imdb_ids` | Collection level `ignore_imdb_ids` which is combined with the library and global `ignore_imdb_ids`<br>**Default:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | List or comma-separated String of IMDb IDs |
|
||||
| Name Mapping | `name_mapping` | Used to specify the folder name in the [Image Assets Directory](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Image-Asset-Directory) | Folder Name In Assets Directory |
|
||||
| Test Mode | `test` | When running in Test Mode (`--run-tests` [option](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Local-Installation#run-tests)) only collections with `test: true` will be run<br>**Default:** `false` | **boolean:** `true` or `false` |
|
||||
| Collection Changes Webhooks | `collection_changes_webhooks` | Used to specify a collection changes webhook for just this collection | List of webhooks |
|
||||
|
||||
* **Name Mapping:** If your collection name contains characters that are not allowed in file paths (i.e. for windows `<`, `>`, `:`, `"`, `/`, `\`, `|`, `?`, `*` cannot be in the file path), but you want them in your collection name you can use the `name_mapping` attribute to specific this collection's name in the file system.
|
||||
* **Server Pre-Roll:** You can run this with a [schedule](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Schedule-Detail) to change the pre-rolls automatically.
|
||||
|
||||
## Radarr Details
|
||||
All the following attributes can override the global [Radarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Radarr-Attributes) attributes.
|
||||
|
||||
| Name | Attribute | Description | Allowed Values |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| Radarr Add | `radarr_add` | Collection level `add` toggle for Radarr<br>**Default:** [Radarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Radarr-Attributes) library value | **boolean:** `true` or `false` |
|
||||
| Radarr Add Existing | `radarr_add_existing` | Collection level `add_existing` toggle for Radarr<br>**Default:** [Radarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Radarr-Attributes) library value | **boolean:** `true` or `false` |
|
||||
| Radarr Root Folder | `radarr_folder` | Collection level `root_folder_path` attribute override for Radarr<br>**Default:** [Radarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Radarr-Attributes) library value | Folder Path |
|
||||
| Radarr Monitor | `radarr_monitor` | Collection level `monitor` attribute override for Radarr<br>**Default:** [Radarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Radarr-Attributes) library value | **boolean:** `true` or `false` |
|
||||
| Radarr Availability | `radarr_availability` | Collection level `availability` attribute override for Radarr<br>**Default:** [Radarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Radarr-Attributes) library value | `announced`, `cinemas`, `released`, `db` |
|
||||
| Radarr Quality Profile | `radarr_quality` | Collection level `quality_profile` attribute override for Radarr<br>**Default:** [Radarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Radarr-Attributes) library value | Radarr Quality Profile |
|
||||
| Radarr Tag | `radarr_tag` | Collection level `tag` attribute override for Radarr<br>**Default:** [Radarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Radarr-Attributes) library value | List or comma-separated string of tags |
|
||||
| Radarr Search | `radarr_search` | Collection level `search` attribute override for Radarr<br>**Default:** [Radarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Radarr-Attributes) library value | **boolean:** `true` or `false` |
|
||||
| Item Radarr Tag | `item_radarr_tag` | Used to append a tag in Radarr for every movie found by the builders that's in Radarr | List or comma-separated string of tags |
|
||||
| Item Radarr Tag Remove | `item_radarr_tag.remove` | Used to remove existing tags in Radarr for every movie found by the builders that's in Radarr | List or comma-separated string of tags |
|
||||
| Item Radarr Tag Sync | `item_radarr_tag.sync` | Matches the tags in Radarr for every movie found by the builders that's in Radarr with the provided tags | List or comma-separated string of tags |
|
||||
|
||||
## Sonarr Details
|
||||
All the following attributes can override the global [Sonarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Sonarr-Attributes) attributes.
|
||||
|
||||
| Name | Attribute | Description | Allowed Values |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| Sonarr Add | `sonarr_add` | Collection level `add` toggle for Sonarr<br>**Default:** [Sonarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Sonarr-Attributes) library value | **boolean:** `true` or `false` |
|
||||
| Sonarr Add Existing | `sonarr_add_existing` | Collection level `add_existing` toggle for Sonarr<br>**Default:** [Sonarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Sonarr-Attributes) library value | **boolean:** `true` or `false` |
|
||||
| Sonarr Root Folder | `sonarr_folder` | Collection level `root_folder_path` attribute override for Sonarr<br>**Default:** [Sonarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Sonarr-Attributes) library value | Folder Path |
|
||||
| Sonarr Monitor | `sonarr_monitor` | Collection level `monitor` attribute override for Sonarr<br>**Default:** [Sonarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Sonarr-Attributes) library value | `all`, `future`, `missing`, `existing`, `pilot`, `first`, `latest`, `none` |
|
||||
| Sonarr Quality Profile | `sonarr_quality` | Collection level `quality_profile` attribute override for Sonarr<br>**Default:** [Sonarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Sonarr-Attributes) library value | Sonarr Quality Profile |
|
||||
| Sonarr Language Profile | `sonarr_language` | Collection level `language_profile` attribute override for Sonarr<br>**Default:** [Sonarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Sonarr-Attributes) library value | Sonarr Language Profile |
|
||||
| Sonarr Series Type | `sonarr_series` | Collection level `series_type` attribute override for Sonarr<br>**Default:** [Sonarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Sonarr-Attributes) library value | `standard`, `daily`, `anime` |
|
||||
| Sonarr Season Folder | `sonarr_season` | Collection level `season_folder` attribute override for Sonarr<br>**Default:** [Sonarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Sonarr-Attributes) library value | **boolean:** `true` or `false` |
|
||||
| Sonarr Tag | `sonarr_tag` | Collection level `tag` attribute override for Sonarr<br>**Default:** [Sonarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Sonarr-Attributes) library value | List or comma-separated string of tags |
|
||||
| Sonarr Search | `sonarr_search` | Collection level `search` attribute override for Sonarr<br>**Default:** [Sonarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Sonarr-Attributes) library value | **boolean:** `true` or `false` |
|
||||
| Sonarr Cutoff Search | `sonarr_cutoff_search` | Collection level `cutoff_search` attribute override for Sonarr<br>**Default:** [Sonarr](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Sonarr-Attributes) library value | **boolean:** `true` or `false` |
|
||||
| Item Sonarr Tag | `item_sonarr_tag` | Used to append a tag in Sonarr for every series found by the builders that's in Sonarr | List or comma-separated string of tags |
|
||||
| Item Sonarr Tag Remove | `item_sonarr_tag.remove` | Used to remove existing tags in Sonarr for every series found by the builders that's in Sonarr | List or comma-separated string of tags |
|
||||
| Item Sonarr Tag Sync | `item_sonarr_tag.sync` | Matches the tags in Sonarr for every series found by the builders that's in Sonarr with the provided tags | List or comma-separated string of tags |
|
||||
|
||||
## Metadata Details
|
||||
All the following attributes update various details of the collection's Metadata.
|
||||
|
||||
| Name | Attribute | Description | Allowed Values |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| TMDb Person | `tmdb_person` | Used to change the collection's summary and poster to a TMDb Person's biography and profile as well as allow the people specified to be used in [Plex Searches](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Plex-Builders#plex-search) | TMDb Person ID (List or Comma-separated string) |
|
||||
| Sort Title | `sort_title` | Used to change the collection's sort title | Text to change Sort Title |
|
||||
| Content Rating | `content_rating` | Used to change the collection's content rating | Text to change Content Rating |
|
||||
| Label | `label` | Used to append new labels to the collection | Comma-separated string of labels to append |
|
||||
| Label Remove | `label.remove` | Used to remove existing labels from the collection | Comma-separated string of labels to remove |
|
||||
| Label Sync | `label.sync` | Matches the labels of the collection to the labels provided (Leave blank to remove all labels) | Comma-separated string of labels to sync |
|
||||
| Collection Mode | `collection_mode` | Used to change the Collection Mode | `default`: Library default<br>`hide`: Hide Collection<br>`hide_items`: Hide Items in this Collection<br>`show_items`: Show this Collection and its Items |
|
||||
| Collection Order | `collection_order` | Used to change the Collection Order | `release`: Order Collection by Release Dates<br>`alpha`: Order Collection Alphabetically<br>`custom`: Order Collection Via the Builder Order | :heavy_check_mark: | :heavy_check_mark: |
|
||||
| Collection Level | `collection_level` | Used to make episode or season collections from `plex_search` or `trakt_list` Builders | `season`: Collection contains seasons<br>`episode`: Collection contains episodes }
|
||||
| Visible on Library | `visible_library` | Used to change collection visible on Library | `true`: Visible<br>`false`: Not Visible |
|
||||
| Visible on Home | `visible_home` | Used to change collection visible on Home | `true`: Visible<br>`false`: Not Visible |
|
||||
| Visible on Shared | `visible_shared` | Used to change collection visible on Shared Users' Home | `true`: Visible<br>`false`: Not Visible |
|
||||
|
||||
* **Sort Title:** You can use `sort_title` to "promote" certain collections to the top of a library by creating a sort title starting with a `+` or "demote" certain collections to the bottom of a library by creating a sort title starting with a `~`.
|
||||
* **Custom Collection Order:** When using `collection_order: custom` you can only have a single builder in the collection.
|
||||
|
||||
## Item Metadata Details
|
||||
All the following attributes update various details of the metadata for every item in the collection.
|
||||
|
||||
| Name | Attribute | Description | Allowed Values | Works with Movies | Works with Shows |
|
||||
| :--- | :--- | :--- | :--- | :---: | :---: |
|
||||
| Label | `item_label` | Used to append new labels to every movie/show in the collection | Comma-separated string of labels to append | :heavy_check_mark: | :heavy_check_mark: |
|
||||
| Label Remove | `item_label.remove` | Used to remove existing labels from every movie/show in the collection | Comma-separated string of labels to remove | :heavy_check_mark: | :heavy_check_mark: |
|
||||
| Label Sync | `item_label.sync` | Matches the labels of every movie/show in the collection to the labels provided (Leave blank to remove all labels) | Comma-separated string of labels to sync | :heavy_check_mark: | :heavy_check_mark: |
|
||||
| Lock Posters | `item_lock_poster` | Locks the poster of every movie/show in the collection | `true` or `false`<br>**Default:** false | :heavy_check_mark: | :heavy_check_mark: |
|
||||
| Lock Backgrounds | `item_lock_background` | Locks the background of every movie/show in the collection | `true` or `false`<br>**Default:** false | :heavy_check_mark: | :heavy_check_mark: |
|
||||
| Lock Titles | `item_lock_title` | Locks the title of every movie/show in the collection | `true` or `false`<br>**Default:** false | :heavy_check_mark: | :heavy_check_mark: |
|
||||
| Image Overlay | `item_overlay` | Adds and overlay image to the poster of every movie/show in the collection | [`item_overlay` details](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Image-Overlay-Attribute) | :heavy_check_mark: | :heavy_check_mark: |
|
||||
| Check For Assets | `item_assets` | Checks your assets folders for assets of every movie/show in the collection | `true` or `false`<br>**Default:** false | :heavy_check_mark: | :heavy_check_mark: |
|
||||
| Refresh Item | `item_refresh` | Refreshes the metadata of every movie/show in the collection | `true` or `false`<br>**Default:** false | :heavy_check_mark: | :heavy_check_mark: |
|
||||
| TMDb Season Titles | `item_tmdb_season_titles` | Changes the season titles of every show in the collection to match TMDb | `true` or `false`<br>**Default:** false | :x: | :heavy_check_mark: |
|
||||
| Episode Sorting | `item_episode_sorting` | Changes the episode sorting of every show in the collection | `default`: Library default<br>`oldest`: Oldest first<br>`newest`: Newest first | :x: | :heavy_check_mark: |
|
||||
| Keep Episodes | `item_keep_episodes` | Changes the keep episodes of every show in the collection | `all`: All episodes<br>`5_latest`: 5 latest episodes<br>`3_latest`: 3 latest episodes<br>`latest`: Latest episodes<br>`past_3`: Episodes added in the past 3 days<br>`past_7`: Episodes added in the past 7 days<br>`past_30`: Episodes added in the past 30 days | :x: | :heavy_check_mark: |
|
||||
| Delete Episodes | `item_delete_episodes` | Changes the delete episodes of every show in the collection | `never`: Never<br>`day`: After a day<br>`week`: After a week<br>`refresh`: On next refresh | :x: | :heavy_check_mark: |
|
||||
| Season Display | `item_season_display` | Changes the season display of every show in the collection | `default`: Library default<br>`show`: Show<br>`hide`: Hide | :x: | :heavy_check_mark: |
|
||||
| Episode Ordering | `item_episode_ordering` | Changes the episode ordering of every show in the collection | `default`: Library default<br>`tmdb_aired`*: The Movie Database (Aired)<br>`tvdb_aired`: TheTVDB (Aired)<br>`tvdb_dvd`: TheTVDB (DVD)<br>`tvdb_absolute`: TheTVDB (Absolute) | :x: | :heavy_check_mark: |
|
||||
| Metadata Language* | `item_metadata_language` | Changes the metadata language of every movie/show in the collection | `default`, `ar-SA`, `ca-ES`, `cs-CZ`, `da-DK`, `de-DE`, `el-GR`, `en-AU`, `en-CA`, `en-GB`, `en-US`, `es-ES`, `es-MX`, `et-EE`, `fa-IR`, `fi-FI`, `fr-CA`, `fr-FR`, `he-IL`, `hi-IN`, `hu-HU`, `id-ID`, `it-IT`, `ja-JP`, `ko-KR`, `lt-LT`, `lv-LV`, `nb-NO`, `nl-NL`, `pl-PL`, `pt-BR`, `pt-PT`, `ro-RO`, `ru-RU`, `sk-SK`, `sv-SE`, `th-TH`, `tr-TR`, `uk-UA`, `vi-VN`, `zh-CN`, `zh-HK`, `zh-TW` | :heavy_check_mark: | :heavy_check_mark: |
|
||||
| Use Original Title* | `item_use_original_title` | Changes the use original title of every movie/show in the collection | `default`: Library default<br>`no`: No<br>`yes`: Yes | :heavy_check_mark: | :heavy_check_mark: |
|
||||
|
||||
\* Must be using the **New Plex Movie Agent** or the **New Plex TV Agent**
|
||||
|
||||
## Summary Details
|
||||
All the following attributes update the summary of the collection from various sources.
|
||||
|
||||
| Name | Attribute | Description | Allowed Values |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| Summary | `summary` | Used to change the collection's summary | Text to change Summary |
|
||||
| TMDb Summary | `tmdb_summary` | Used to change the collection's summary to the TMDb Movie/Collection summary for a movie library or the TMDb Show summary for a show library | TMDb Movie/Show/Collection ID |
|
||||
| TMDb Description | `tmdb_description` | Used to change the collection's summary to the TMDb List Description | TMDb List ID |
|
||||
| TMDb Biography | `tmdb_biography` | Used to change the collection's summary to the TMDb Person's biography | TMDb Person ID |
|
||||
| TVDb Summary | `tvdb_summary` | Used to change the collection's summary to the TVDb Movie summary for a movie library or the TVDb Show summary for a show library | TVDb Movie/Show ID or URL |
|
||||
| TVDb Description | `tvdb_description` | Used to change the collection's summary to the TVDb List Description | TVDb List URL |
|
||||
| Trakt Description | `trakt_description` | Used to change the collection's summary to the Trakt List Description | Trakt List URL |
|
||||
| Letterboxd Description | `letterboxd_description` | Used to change the collection's summary to the Letterboxd List Description | Letterboxd List URL |
|
||||
|
||||
## Poster Details
|
||||
All the following attributes update the poster of the collection from various sources.
|
||||
|
||||
| Name | Attribute | Description | Allowed Values |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| URL Poster<sup>2</sup> | `url_poster` | Used to change the collection's poster to the URL | URL of image publicly available on the internet |
|
||||
| TMDb Poster<sup>2</sup> | `tmdb_poster` | Used to change the collection's poster to the TMDb Movie/Collection poster for a movie library or the TMDb Show poster for a show library | TMDb Movie/Show/Collection ID |
|
||||
| TMDb List Poster<sup>2</sup> | `tmdb_list_poster` | Used to change the collection's poster to the TMDb List poster | TMDb List ID |
|
||||
| TMDb Profile<sup>2</sup> | `tmdb_profile` | Used to change the collection's poster to the TMDb Person's profile | TMDb Person ID |
|
||||
| TVDb Poster<sup>2</sup> | `tvdb_poster` | Used to change the collection's poster to the TVDb Movie poster for a movie library or the TVDb Show poster for a show library | TVDb Movie/Show ID or URL |
|
||||
| File Poster<sup>2</sup> | `file_poster` | Used to change the collection's poster to the image in the file system | Path to image in the file system |
|
||||
|
||||
* If no poster is specified the script will look in the library's [Image Asset Directories](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Image-Asset-Directory) for a folder named either the collection name or the `name_mapping` if specified and look for a `poster.ext` file in that folder (replacing .ext with the image extension).
|
||||
|
||||
## Background Details
|
||||
All the following attributes update the background of the collection from various sources.
|
||||
|
||||
| Name | Attribute | Description | Allowed Values |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| URL Background<sup>3</sup> | `url_background` | Use to change the collection's background to the URL | URL of image publicly available on the internet |
|
||||
| TMDb Background<sup>3</sup> | `tmdb_background` | Used to change the collection's background to the TMDb Movie/Collection background for a movie library or the TMDb Show background for a show library | TMDb Movie/Show/Collection ID |
|
||||
| TVDb Background<sup>3</sup> | `tvdb_background` | Used to change the collection's background to the TVDb Movie background for a movie library or the TVDb Show background for a show library | TVDb Movie/Show ID or URL |
|
||||
| File Background<sup>3</sup> | `file_background` | Used to change the collection's background to the image in the file system | Path to image in the file system |
|
||||
|
||||
* If no background is specified the script will look in the library's [Image Asset Directories](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Image-Asset-Directory) for a folder named either the collection name or the `name_mapping` if specified and look for a `background.ext` file in that folder (replacing .ext with the image extension).
|
||||
@ -0,0 +1,321 @@
|
||||
## Local Installation
|
||||
|
||||
Testing has been done only on Python 3.6, 3.7, 3.8, and 3.9 on Linux and Windows. Dependencies must be installed by running:
|
||||
|
||||
```shell
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
If there are issues installing dependencies try:
|
||||
|
||||
```shell
|
||||
pip install -r requirements.txt --ignore-installed
|
||||
```
|
||||
|
||||
To run the script in an interactive terminal run:
|
||||
|
||||
```shell
|
||||
python plex_meta_manager.py
|
||||
```
|
||||
|
||||
## Docker Installation
|
||||
|
||||
A simple `Dockerfile` is available in this repo if you'd like to build it yourself. The official build is also available from dockerhub here: https://hub.docker.com/r/meisnate12/plex-meta-manager
|
||||
|
||||
```shell
|
||||
docker run -it -v <PATH_TO_CONFIG>:/config:rw meisnate12/plex-meta-manager
|
||||
```
|
||||
* The `-it` allows you to interact with the script when needed.
|
||||
* For example, it's required in order to go through the OAuth flow while connecting to Trakt or MyAnimeList.
|
||||
* The `-v <PATH_TO_CONFIG>:/config:rw` mounts the location you choose as a persistent volume to store your files.
|
||||
* Change `<PATH_TO_CONFIG>` to a folder where your config.yml and other files are.
|
||||
* The docker image defaults to running the config named `config.yml` in your persistent volume.
|
||||
* Use quotes around the whole thing if your path has spaces i.e. `-v "<PATH_TO_CONFIG>:/config:rw"`
|
||||
|
||||
Example
|
||||
|
||||
```shell
|
||||
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager
|
||||
```
|
||||
|
||||
## Run Commands
|
||||
|
||||
| Name | Shell Command | Environmental<br>Variable | Allowed Values | Default Value |
|
||||
| :--- | :--- | :--- | :--- | :--- |
|
||||
| [Config](#config) | `-c` or `--config` | `PMM_CONFIG` | Path to YAML config file | `config/config.yml` alongside<br>`plex_meta_manager.py` |
|
||||
| [Time to Run](#time-to-run) | `-t` or `--time` | `PMM_TIME` | comma-separated list of times to update each day<br>**Format:** HH:MM | `03:00` |
|
||||
| [Run](#run) | `-r` or `--run` | `PMM_RUN` | Run without the scheduler | `False` |
|
||||
| [Run Tests](#run-tests) | `-rt`, `--tests`, or `--run-tests` | `PMM_TEST` | Run in debug mode with only collections that have `test: true` | `False` |
|
||||
| [Run Collections Only](#collections-only) | `-co` or `--collections-only` | `PMM_COLLECTIONS_ONLY` | Process only collections during the run | `False` |
|
||||
| [Run Libraries Only](#libraries-only) | `-lo` or `--libraries-only` | `PMM_LIBRARIES_ONLY` | Process everything but collections during the run | `False` |
|
||||
| [Run Collections](#run-collections) | `-rc` or `--run-collections` | `PMM_COLLECTIONS` | comma-separated list of collection names to process | All Collections |
|
||||
| [Run Libraries](#run-libraries) | `-rl` or `--run-libraries` | `PMM_LIBRARIES` | comma-separated list of library names to process | All libraries |
|
||||
| [Resume Run](#resume-run) | `-re` or `--resume` | `PMM_RESUME` | Name of the Collection you want to resume the run at | ` ` |
|
||||
| [No Countdown](#no-countdown) | `-nc` or `--no-countdown` | `PMM_NO_COUNTDOWN` | Run without displaying the countdown | `False` |
|
||||
| [No Missing](#no-missing) | `-nm` or `--no-missing` | `PMM_NO_MISSING` | Run without any of the missing movie/show functions | `False` |
|
||||
| [Read Only Config](#read-only-config) | `-ro` or `--read-only-config` | `PMM_READ_ONLY_CONFIG` | Run without writing to the config | `False` |
|
||||
| [Divider Character](#divider-character--screen-width) | `-d` or `--divider` | `PMM_DIVIDER` | Character that divides the sections | `=` |
|
||||
| [Screen Width](#divider-character--screen-width) | `-w` or `--width` | `PMM_WIDTH` | Integer between 90 and 300 | `100` |
|
||||
|
||||
* Environmental Variable values are used over Shell Command values
|
||||
|
||||
### Config
|
||||
To choose the location of the YAML config file use the `--config` option
|
||||
|
||||
<details>
|
||||
<summary>Local</summary>
|
||||
|
||||
```shell
|
||||
python plex_meta_manager.py --config <path_to_config>
|
||||
```
|
||||
|
||||
</details>
|
||||
<details>
|
||||
<summary>Docker</summary>
|
||||
|
||||
```shell
|
||||
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --config <path_to_config>
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### Time to Run
|
||||
To choose the times when the script will run each day use a comma-separated list with the `--time` option
|
||||
|
||||
<details>
|
||||
<summary>Local</summary>
|
||||
|
||||
```shell
|
||||
python plex_meta_manager.py --time 22:00,03:00
|
||||
```
|
||||
|
||||
</details>
|
||||
<details>
|
||||
<summary>Docker</summary>
|
||||
|
||||
```shell
|
||||
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --time 22:00,03:00
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### Run
|
||||
To just run the script without having it continuously run use the `--run` option
|
||||
|
||||
<details>
|
||||
<summary>Local</summary>
|
||||
|
||||
```shell
|
||||
python plex_meta_manager.py --run
|
||||
```
|
||||
|
||||
</details>
|
||||
<details>
|
||||
<summary>Docker</summary>
|
||||
|
||||
```shell
|
||||
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --run
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### Run Tests
|
||||
To run the script in debug mode while only running collections that have `test: true` use the `--run-tests` option
|
||||
|
||||
<details>
|
||||
<summary>Local</summary>
|
||||
|
||||
```shell
|
||||
python plex_meta_manager.py --run-tests
|
||||
```
|
||||
|
||||
</details>
|
||||
<details>
|
||||
<summary>Docker</summary>
|
||||
|
||||
```shell
|
||||
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --run-tests
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### Collections Only
|
||||
To have the script run only collections and not any library operations use the `--collections-only` option
|
||||
|
||||
<details>
|
||||
<summary>Local</summary>
|
||||
|
||||
```shell
|
||||
python plex_meta_manager.py --collections-only
|
||||
```
|
||||
|
||||
</details>
|
||||
<details>
|
||||
<summary>Docker</summary>
|
||||
|
||||
```shell
|
||||
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --collections-only
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### Libraries Only
|
||||
To have the script run only library operations and not any collections use the `--libraries-only` option
|
||||
|
||||
<details>
|
||||
<summary>Local</summary>
|
||||
|
||||
```shell
|
||||
python plex_meta_manager.py --libraries-only
|
||||
```
|
||||
|
||||
</details>
|
||||
<details>
|
||||
<summary>Docker</summary>
|
||||
|
||||
```shell
|
||||
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --libraries-only
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### Run Collections
|
||||
To have the script run only using the collections in the comma-separated list use the `--run-collections` option
|
||||
|
||||
<details>
|
||||
<summary>Local</summary>
|
||||
|
||||
```shell
|
||||
python plex_meta_manager.py --run-collections "Harry Potter, Star Wars"
|
||||
```
|
||||
|
||||
</details>
|
||||
<details>
|
||||
<summary>Docker</summary>
|
||||
|
||||
```shell
|
||||
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --run-collections "Harry Potter, Star Wars"
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### Run Libraries
|
||||
To have the script run only the libraries in the comma-separated list use the `--run-libraries` option
|
||||
|
||||
<details>
|
||||
<summary>Local</summary>
|
||||
|
||||
```shell
|
||||
python plex_meta_manager.py --run-libraries "TV Shows"
|
||||
```
|
||||
|
||||
</details>
|
||||
<details>
|
||||
<summary>Docker</summary>
|
||||
|
||||
```shell
|
||||
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --run-libraries "TV Shows"
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### Resume Run
|
||||
To have the script resume a run from a specific collection use the `--resume` option
|
||||
|
||||
<details>
|
||||
<summary>Local</summary>
|
||||
|
||||
```shell
|
||||
python plex_meta_manager.py --resume "Star Wars"
|
||||
```
|
||||
|
||||
</details>
|
||||
<details>
|
||||
<summary>Docker</summary>
|
||||
|
||||
```shell
|
||||
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --resume "Star Wars"
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### No Countdown
|
||||
To have the script run without displaying a countdown use the `--no-countdown` option
|
||||
|
||||
<details>
|
||||
<summary>Local</summary>
|
||||
|
||||
```shell
|
||||
python plex_meta_manager.py --no-countdown
|
||||
```
|
||||
|
||||
</details>
|
||||
<details>
|
||||
<summary>Docker</summary>
|
||||
|
||||
```shell
|
||||
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --no-countdown
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### No Missing
|
||||
To have the script run without any of the missing movie/show functions use the `--no-missing` option
|
||||
|
||||
<details>
|
||||
<summary>Local</summary>
|
||||
|
||||
```shell
|
||||
python plex_meta_manager.py --no-missing
|
||||
```
|
||||
|
||||
</details>
|
||||
<details>
|
||||
<summary>Docker</summary>
|
||||
|
||||
```shell
|
||||
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --no-missing
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### Read Only Config
|
||||
To have the script run without writing to the config use the `--read-only-config` option
|
||||
|
||||
<details>
|
||||
<summary>Local</summary>
|
||||
|
||||
```shell
|
||||
python plex_meta_manager.py --read-only-config
|
||||
```
|
||||
|
||||
</details>
|
||||
<details>
|
||||
<summary>Docker</summary>
|
||||
|
||||
```shell
|
||||
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --read-only-config
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
### Divider Character & Screen Width
|
||||
To change the terminal output divider character or width use `--divider` and `--width`
|
||||
|
||||
<details>
|
||||
<summary>Local</summary>
|
||||
|
||||
```shell
|
||||
python plex_meta_manager.py --divider * --width 200
|
||||
```
|
||||
|
||||
</details>
|
||||
<details>
|
||||
<summary>Docker</summary>
|
||||
|
||||
```shell
|
||||
docker run -it -v "X:\Media\Plex Meta Manager\config:/config:rw" meisnate12/plex-meta-manager --divider * --width 200
|
||||
```
|
||||
|
||||
</details>
|
||||
@ -1,121 +0,0 @@
|
||||
Testing has been done only on Python 3.6, 3.7, 3.8, and 3.9 on Linux and Windows. Dependencies must be installed by running:
|
||||
|
||||
```shell
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
If there are issues installing dependencies try:
|
||||
|
||||
```shell
|
||||
pip install -r requirements.txt --ignore-installed
|
||||
```
|
||||
|
||||
To run the script in an interactive terminal run:
|
||||
|
||||
```shell
|
||||
python plex_meta_manager.py
|
||||
```
|
||||
|
||||
### Commands
|
||||
|
||||
| Name | Shell Command | Environmental<br>Variable | Allowed Values | Default Value |
|
||||
| :--- | :--- | :--- | :--- | :--- |
|
||||
| [Config](#config) | `-c` or `--config` | `PMM_CONFIG` | Path to YAML config file | `config/config.yml` alongside<br>`plex_meta_manager.py` |
|
||||
| [Time to Run](#time-to-run) | `-t` or `--time` | `PMM_TIME` | comma-separated list of times to update each day<br>**Format:** HH:MM | `03:00` |
|
||||
| [Run](#run) | `-r` or `--run` | `PMM_RUN` | Run without the scheduler | `False` |
|
||||
| [Run Tests](#run-tests) | `-rt`, `--tests`, or `--run-tests` | `PMM_TEST` | Run in debug mode with only collections that have `test: true` | `False` |
|
||||
| [Run Collections Only](#collections-only) | `-co` or `--collections-only` | `PMM_COLLECTIONS_ONLY` | Process only collections during the run | `False` |
|
||||
| [Run Libraries Only](#libraries-only) | `-lo` or `--libraries-only` | `PMM_LIBRARIES_ONLY` | Process everything but collections during the run | `False` |
|
||||
| [Run Collections](#run-collections) | `-rc` or `--run-collections` | `PMM_COLLECTIONS` | comma-separated list of collection names to process | All Collections |
|
||||
| [Run Libraries](#run-libraries) | `-rl` or `--run-libraries` | `PMM_LIBRARIES` | comma-separated list of library names to process | All libraries |
|
||||
| [Resume Run](#resume-run) | `-re` or `--resume` | `PMM_RESUME` | Name of the Collection you want to resume the run at | ` ` |
|
||||
| [No Countdown](#no-countdown) | `-nc` or `--no-countdown` | `PMM_NO_COUNTDOWN` | Run without displaying the countdown | `False` |
|
||||
| [No Missing](#no-missing) | `-nm` or `--no-missing` | `PMM_NO_MISSING` | Run without any of the missing movie/show functions | `False` |
|
||||
| [Divider Character](#divider-character--screen-width) | `-d` or `--divider` | `PMM_DIVIDER` | Character that divides the sections | `=` |
|
||||
| [Screen Width](#divider-character--screen-width) | `-w` or `--width` | `PMM_WIDTH` | Integer between 90 and 300 | `100` |
|
||||
|
||||
* Environmental Variable values are used over Shell Command values
|
||||
|
||||
## Config
|
||||
To choose the location of the YAML config file use the `--config` option
|
||||
|
||||
```shell
|
||||
python plex_meta_manager.py --config <path_to_config>
|
||||
```
|
||||
|
||||
## Time to Run
|
||||
To choose the times when the script will run each day use a comma-separated list with the `--time` option
|
||||
|
||||
```shell
|
||||
python plex_meta_manager.py --config /configs/config.yml --time 22:00,03:00
|
||||
```
|
||||
|
||||
## Run
|
||||
To just run the script without having it continuously run use the `--run` option
|
||||
|
||||
```shell
|
||||
python plex_meta_manager.py --config /configs/config.yml --run
|
||||
```
|
||||
|
||||
## Run Tests
|
||||
To run the script in debug mode while only running collections that have `test: true` use the `--run-tests` option
|
||||
|
||||
```shell
|
||||
python plex_meta_manager.py --config /configs/config.yml --run-tests
|
||||
```
|
||||
|
||||
## Collections Only
|
||||
To have the script run only collections and not any library operations use the `--collections-only` option
|
||||
|
||||
```shell
|
||||
python plex_meta_manager.py --config /configs/config.yml --collections-only
|
||||
```
|
||||
|
||||
## Libraries Only
|
||||
To have the script run only library operations and not any collections use the `--libraries-only` option
|
||||
|
||||
```shell
|
||||
python plex_meta_manager.py --config /configs/config.yml --libraries-only
|
||||
```
|
||||
|
||||
## Run Collections
|
||||
To have the script run only using the collections in the comma-separated list use the `--run-collections` option
|
||||
|
||||
```shell
|
||||
python plex_meta_manager.py --config /configs/config.yml --run-collections "Harry Potter, Star Wars"
|
||||
```
|
||||
|
||||
## Run Libraries
|
||||
To have the script run only the libraries in the comma-separated list use the `--run-libraries` option
|
||||
|
||||
```shell
|
||||
python plex_meta_manager.py --config /configs/config.yml --run-libraries "TV Shows"
|
||||
```
|
||||
|
||||
## Resume Run
|
||||
To have the script resume a run from a specific collection use the `--resume` option
|
||||
|
||||
```shell
|
||||
python plex_meta_manager.py --config /configs/config.yml --resume "Star Wars"
|
||||
```
|
||||
|
||||
## No Countdown
|
||||
To have the script run without displaying a countdown use the `--no-countdown` option
|
||||
|
||||
```shell
|
||||
python plex_meta_manager.py --config /configs/config.yml --no-countdown
|
||||
```
|
||||
|
||||
## No Missing
|
||||
To have the script run without any of the missing movie/show functions use the `--no-missing` option
|
||||
|
||||
```shell
|
||||
python plex_meta_manager.py --config /configs/config.yml --no-missing
|
||||
```
|
||||
|
||||
## Divider Character & Screen Width
|
||||
To change the terminal output divider character or width use `--divider` and `--width`
|
||||
|
||||
```shell
|
||||
python plex_meta_manager.py --divider * --width 200
|
||||
```
|
||||
@ -0,0 +1,85 @@
|
||||
## Metadata Details
|
||||
All the following attributes update various details of the collection/playlist's Metadata.
|
||||
|
||||
| Name | Attribute | Description | Allowed Values | Works with Playlists |
|
||||
| :--- | :--- | :--- | :--- | :---: |
|
||||
| TMDb Person | `tmdb_person` | Used to change the collection/playlist's summary and poster to a TMDb Person's biography and profile as well as allow the people specified to be used in [Plex Searches](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Plex-Builders#plex-search) | TMDb Person ID (List or Comma-separated string) | :heavy_check_mark: |
|
||||
| Sort Title | `sort_title` | Used to change the collection's sort title | Text to change Sort Title | :x: |
|
||||
| Content Rating | `content_rating` | Used to change the collection's content rating | Text to change Content Rating | :x: |
|
||||
| Label | `label` | Used to append new labels to the collection | Comma-separated string of labels to append | :x: |
|
||||
| Label Remove | `label.remove` | Used to remove existing labels from the collection | Comma-separated string of labels to remove | :x: |
|
||||
| Label Sync | `label.sync` | Matches the labels of the collection to the labels provided (Leave blank to remove all labels) | Comma-separated string of labels to sync | :x: |
|
||||
| Collection Mode | `collection_mode` | Used to change the Collection Mode | `default`: Library default<br>`hide`: Hide Collection<br>`hide_items`: Hide Items in this Collection<br>`show_items`: Show this Collection and its Items | :x: |
|
||||
| Collection Order | `collection_order` | Used to change the Collection Order | `release`: Order Collection by Release Dates<br>`alpha`: Order Collection Alphabetically<br>`custom`: Order Collection Via the Builder Order | :heavy_check_mark: | :heavy_check_mark: | :x: |
|
||||
| Collection Level | `collection_level` | Used to make episode or season collections from `plex_search`, `trakt_list`, or `imdb_list` Builders | `season`: Collection contains seasons<br>`episode`: Collection contains episodes } :x: |
|
||||
| Visible on Library | `visible_library` | Used to change collection visible on Library | `true`: Visible<br>`false`: Not Visible<br>Any [`schedule`](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Schedule-Detail) | :x: |
|
||||
| Visible on Home | `visible_home` | Used to change collection visible on Home | `true`: Visible<br>`false`: Not Visible<br>Any [`schedule`](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Schedule-Detail) | :x: |
|
||||
| Visible on Shared | `visible_shared` | Used to change collection visible on Shared Users' Home | `true`: Visible<br>`false`: Not Visible<br>Any [`schedule`](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Schedule-Detail) | :x: |
|
||||
|
||||
* **Sort Title:** You can use `sort_title` to "promote" certain collections to the top of a library by creating a sort title starting with a `+` or "demote" certain collections to the bottom of a library by creating a sort title starting with a `~`.
|
||||
* **Custom Collection Order:** When using `collection_order: custom` you can only have a single builder in the collection.
|
||||
|
||||
## Item Metadata Details
|
||||
All the following attributes update various details of the metadata for every item in the collection/playlist.
|
||||
|
||||
| Name | Attribute | Description | Allowed Values | Works with Movies | Works with Shows | Works with Playlists |
|
||||
| :--- | :--- | :--- | :--- | :---: | :---: | :---: |
|
||||
| Label | `item_label` | Used to append new labels to every movie/show in the collection | Comma-separated string of labels to append | :heavy_check_mark: | :heavy_check_mark: | :x: |
|
||||
| Label Remove | `item_label.remove` | Used to remove existing labels from every movie/show in the collection | Comma-separated string of labels to remove | :heavy_check_mark: | :heavy_check_mark: | :x: |
|
||||
| Label Sync | `item_label.sync` | Matches the labels of every movie/show in the collection to the labels provided (Leave blank to remove all labels) | Comma-separated string of labels to sync | :heavy_check_mark: | :heavy_check_mark: | :x: |
|
||||
| Lock Posters | `item_lock_poster` | Locks the poster of every movie/show in the collection | `true` or `false`<br>**Default:** false | :heavy_check_mark: | :heavy_check_mark: | :x: |
|
||||
| Lock Backgrounds | `item_lock_background` | Locks the background of every movie/show in the collection | `true` or `false`<br>**Default:** false | :heavy_check_mark: | :heavy_check_mark: | :x: |
|
||||
| Lock Titles | `item_lock_title` | Locks the title of every movie/show in the collection | `true` or `false`<br>**Default:** false | :heavy_check_mark: | :heavy_check_mark: | :x: |
|
||||
| Image Overlay | `item_overlay` | Adds and overlay image to the poster of every movie/show in the collection | [`item_overlay` details](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Image-Overlay-Attribute) | :heavy_check_mark: | :heavy_check_mark: | :x: |
|
||||
| Check For Assets | `item_assets` | Checks your assets folders for assets of every movie/show in the collection | `true` or `false`<br>**Default:** false | :heavy_check_mark: | :heavy_check_mark: | :x: |
|
||||
| Refresh Item | `item_refresh` | Refreshes the metadata of every movie/show in the collection | `true` or `false`<br>**Default:** false | :heavy_check_mark: | :heavy_check_mark: | :x: |
|
||||
| TMDb Season Titles | `item_tmdb_season_titles` | Changes the season titles of every show in the collection to match TMDb | `true` or `false`<br>**Default:** false | :x: | :heavy_check_mark: | :x: |
|
||||
| Episode Sorting | `item_episode_sorting` | Changes the episode sorting of every show in the collection | `default`: Library default<br>`oldest`: Oldest first<br>`newest`: Newest first | :x: | :heavy_check_mark: | :x: |
|
||||
| Keep Episodes | `item_keep_episodes` | Changes the keep episodes of every show in the collection | `all`: All episodes<br>`5_latest`: 5 latest episodes<br>`3_latest`: 3 latest episodes<br>`latest`: Latest episodes<br>`past_3`: Episodes added in the past 3 days<br>`past_7`: Episodes added in the past 7 days<br>`past_30`: Episodes added in the past 30 days | :x: | :heavy_check_mark: | :x: |
|
||||
| Delete Episodes | `item_delete_episodes` | Changes the delete episodes of every show in the collection | `never`: Never<br>`day`: After a day<br>`week`: After a week<br>`refresh`: On next refresh | :x: | :heavy_check_mark: | :x: |
|
||||
| Season Display | `item_season_display` | Changes the season display of every show in the collection | `default`: Library default<br>`show`: Show<br>`hide`: Hide | :x: | :heavy_check_mark: | :x: |
|
||||
| Episode Ordering | `item_episode_ordering` | Changes the episode ordering of every show in the collection | `default`: Library default<br>`tmdb_aired`*: The Movie Database (Aired)<br>`tvdb_aired`: TheTVDB (Aired)<br>`tvdb_dvd`: TheTVDB (DVD)<br>`tvdb_absolute`: TheTVDB (Absolute) | :x: | :heavy_check_mark: | :x: |
|
||||
| Metadata Language* | `item_metadata_language` | Changes the metadata language of every movie/show in the collection | `default`, `ar-SA`, `ca-ES`, `cs-CZ`, `da-DK`, `de-DE`, `el-GR`, `en-AU`, `en-CA`, `en-GB`, `en-US`, `es-ES`, `es-MX`, `et-EE`, `fa-IR`, `fi-FI`, `fr-CA`, `fr-FR`, `he-IL`, `hi-IN`, `hu-HU`, `id-ID`, `it-IT`, `ja-JP`, `ko-KR`, `lt-LT`, `lv-LV`, `nb-NO`, `nl-NL`, `pl-PL`, `pt-BR`, `pt-PT`, `ro-RO`, `ru-RU`, `sk-SK`, `sv-SE`, `th-TH`, `tr-TR`, `uk-UA`, `vi-VN`, `zh-CN`, `zh-HK`, `zh-TW` | :heavy_check_mark: | :heavy_check_mark: | :x: |
|
||||
| Use Original Title* | `item_use_original_title` | Changes the use original title of every movie/show in the collection | `default`: Library default<br>`no`: No<br>`yes`: Yes | :heavy_check_mark: | :heavy_check_mark: | :x: |
|
||||
|
||||
\* Must be using the **New Plex Movie Agent** or the **New Plex TV Agent**
|
||||
|
||||
## Summary Details
|
||||
All the following attributes update the summary of the collection/playlist from various sources.
|
||||
|
||||
| Name | Attribute | Description | Allowed Values | Works with Playlists |
|
||||
| :--- | :--- | :--- | :--- | :---: |
|
||||
| Summary | `summary` | Used to change the collection/playlist's summary | Text to change Summary | :heavy_check_mark: |
|
||||
| TMDb Summary | `tmdb_summary` | Used to change the collection/playlist's summary to the TMDb Movie/Collection summary for a movie library or the TMDb Show summary for a show library | TMDb Movie/Show/Collection ID | :heavy_check_mark: |
|
||||
| TMDb Description | `tmdb_description` | Used to change the collection/playlist's summary to the TMDb List Description | TMDb List ID | :heavy_check_mark: |
|
||||
| TMDb Biography | `tmdb_biography` | Used to change the collection/playlist's summary to the TMDb Person's biography | TMDb Person ID | :heavy_check_mark: |
|
||||
| TVDb Summary | `tvdb_summary` | Used to change the collection/playlist's summary to the TVDb Movie summary for a movie library or the TVDb Show summary for a show library | TVDb Movie/Show ID or URL | :heavy_check_mark: |
|
||||
| TVDb Description | `tvdb_description` | Used to change the collection/playlist's summary to the TVDb List Description | TVDb List URL | :heavy_check_mark: |
|
||||
| Trakt Description | `trakt_description` | Used to change the collection/playlist's summary to the Trakt List Description | Trakt List URL | :heavy_check_mark: |
|
||||
| Letterboxd Description | `letterboxd_description` | Used to change the collection/playlist's summary to the Letterboxd List Description | Letterboxd List URL | :heavy_check_mark: |
|
||||
|
||||
## Poster Details
|
||||
All the following attributes update the poster of the collection/playlist from various sources.
|
||||
|
||||
| Name | Attribute | Description | Allowed Values | Works with Playlists |
|
||||
| :--- | :--- | :--- | :--- | :---: |
|
||||
| URL Poster<sup>2</sup> | `url_poster` | Used to change the collection/playlist's poster to the URL | URL of image publicly available on the internet | :heavy_check_mark: |
|
||||
| TMDb Poster<sup>2</sup> | `tmdb_poster` | Used to change the collection/playlist's poster to the TMDb Movie/Collection poster for a movie library or the TMDb Show poster for a show library | TMDb Movie/Show/Collection ID | :heavy_check_mark: |
|
||||
| TMDb List Poster<sup>2</sup> | `tmdb_list_poster` | Used to change the collection/playlist's poster to the TMDb List poster | TMDb List ID | :heavy_check_mark: |
|
||||
| TMDb Profile<sup>2</sup> | `tmdb_profile` | Used to change the collection/playlist's poster to the TMDb Person's profile | TMDb Person ID | :heavy_check_mark: |
|
||||
| TVDb Poster<sup>2</sup> | `tvdb_poster` | Used to change the collection/playlist's poster to the TVDb Movie poster for a movie library or the TVDb Show poster for a show library | TVDb Movie/Show ID or URL | :heavy_check_mark: |
|
||||
| File Poster<sup>2</sup> | `file_poster` | Used to change the collection/playlist's poster to the image in the file system | Path to image in the file system | :heavy_check_mark: |
|
||||
|
||||
* If no poster is specified the script will look in the library's [Image Asset Directories](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Image-Asset-Directory) for a folder named either the collection/playlist name or the `name_mapping` if specified and look for a `poster.ext` file in that folder (replacing .ext with the image extension).
|
||||
|
||||
## Background Details
|
||||
All the following attributes update the background of the collection/playlist from various sources.
|
||||
|
||||
| Name | Attribute | Description | Allowed Values | Works with Playlists |
|
||||
| :--- | :--- | :--- | :--- | :---: |
|
||||
| URL Background<sup>3</sup> | `url_background` | Used to change the collection/playlist's background to the URL | URL of image publicly available on the internet | :x: |
|
||||
| TMDb Background<sup>3</sup> | `tmdb_background` | Used to change the collection/playlist's background to the TMDb Movie/Collection background for a movie library or the TMDb Show background for a show library | TMDb Movie/Show/Collection ID | :x: |
|
||||
| TVDb Background<sup>3</sup> | `tvdb_background` | Used to change the collection/playlist's background to the TVDb Movie background for a movie library or the TVDb Show background for a show library | TVDb Movie/Show ID or URL | :x: |
|
||||
| File Background<sup>3</sup> | `file_background` | Used to change the collection/playlist's background to the image in the file system | Path to image in the file system | :x: |
|
||||
|
||||
* If no background is specified the script will look in the library's [Image Asset Directories](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Image-Asset-Directory) for a folder named either the collection/playlist name or the `name_mapping` if specified and look for a `background.ext` file in that folder (replacing .ext with the image extension).
|
||||
@ -1,16 +0,0 @@
|
||||
The main goal of the script is to allow a complete recreation of your library just from the Metadata File and to dynamically build and maintain collections.
|
||||
|
||||
To do that you have to specify the metadata and collections in a Metadata File that is defined by the [Libraries attribute](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Libraries-Attributes) in the Configuration File.
|
||||
|
||||
You must have at least one Metadata file per Library.
|
||||
|
||||
There are three mappings allowed in the Metadata File's root:
|
||||
|
||||
| Name | Attribute | Description |
|
||||
| :--- | :--- | :--- |
|
||||
| [Metadata](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Metadata-Attributes) | `metadata` | mapping where metadata changes go |
|
||||
| [Templates](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Template-Attributes) | `templates` | mapping where templates for automatic collections go |
|
||||
| [Collections](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Collection-Attributes) | `collections` | mapping where automatic collections and collection metadata go |
|
||||
|
||||
* Either `metadata` or `collections` is required in order to run.
|
||||
* You can find example Metadata Files in the [Plex Meta Manager Configs Repository](https://github.com/meisnate12/Plex-Meta-Manager-Configs)
|
||||
@ -0,0 +1,81 @@
|
||||
The main goal of the script is to allow a complete recreation of your library just from the Metadata File and to dynamically build and maintain collections and playlists.
|
||||
|
||||
You specify the metadata and collections in a Metadata File that is defined by the [Libraries Attribute](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Libraries-Attributes) in the Configuration File.
|
||||
|
||||
While you specify playlists in a Playlist File that is defined by the [Playlist Files Attribute](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Playlist-Files-Attributes) in the Configuration File.
|
||||
|
||||
## Metadata Files
|
||||
|
||||
There are three mappings allowed in the Metadata File's root:
|
||||
|
||||
| Name | Attribute | Description |
|
||||
| :--- | :--- | :--- |
|
||||
| [Metadata](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Metadata-Attributes) | `metadata` | mapping where metadata changes go |
|
||||
| [Templates](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Template-Attributes) | `templates` | mapping where templates for automatic collections go |
|
||||
| [Collections](#collections-and-playlists-mappings) | `collections` | mapping where automatic collections and collection metadata go |
|
||||
|
||||
* Either `metadata` or `collections` is required in order to run the Metadata File.
|
||||
* You can find example Metadata Files in the [Plex Meta Manager Configs Repository](https://github.com/meisnate12/Plex-Meta-Manager-Configs)
|
||||
|
||||
## Playlist Files
|
||||
|
||||
There are two mappings allowed in the Playlist File's root:
|
||||
|
||||
| Name | Attribute | Description |
|
||||
| :--- | :--- | :--- |
|
||||
| [Templates](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Template-Attributes) | `templates` | mapping where templates for automatic collections go |
|
||||
| [Playlists](#playlist-mapping-additional-requirements) | `playlists` | mapping where automatic playlists and playlist metadata go |
|
||||
|
||||
* `playlists` is required in order to run the Playlist File.
|
||||
* You can find example Playlist Files in the [Plex Meta Manager Configs Repository](https://github.com/meisnate12/Plex-Meta-Manager-Configs)
|
||||
|
||||
## Collections and Playlists Mappings
|
||||
The script can run different collection/playlist operations like automatically build collections/playlists, send missing movies/series to radarr/sonarr, and even refresh item's added within the last 30 days in order to update their metadata all using the `collections`/`platlists` attributes.
|
||||
|
||||
Each collection/playlist operation is defined by the mapping name which becomes the name of the Plex collection/playlist if it's created.
|
||||
|
||||
There are three types of attributes in a collection/playlist
|
||||
1. **Builders:** an attribute that finds items to be added to the collection/playlist. Multiple builders can be used in the same collection/playlist from a variety of sources listed below.
|
||||
|
||||
* [Plex Builders](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Plex-Builders)
|
||||
* [Smart Builders](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Smart-Builders)
|
||||
* [TMDb Builders](https://github.com/meisnate12/Plex-Meta-Manager/wiki/TMDb-Builders)
|
||||
* [TVDb Builders](https://github.com/meisnate12/Plex-Meta-Manager/wiki/TVDb-Builders)
|
||||
* [IMDb Builders](https://github.com/meisnate12/Plex-Meta-Manager/wiki/IMDb-Builders)
|
||||
* [Trakt Builders](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Trakt-Builders)
|
||||
* [Tautulli Builders](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Tautulli-Builders)
|
||||
* [Letterboxd Builders](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Letterboxd-Builders)
|
||||
* [ICheckMovies Builders](https://github.com/meisnate12/Plex-Meta-Manager/wiki/ICheckMovies-Builders)
|
||||
* [FlixPatrol Builders](https://github.com/meisnate12/Plex-Meta-Manager/wiki/FlixPatrol-Builders)
|
||||
* [StevenLu Builders](https://github.com/meisnate12/Plex-Meta-Manager/wiki/StevenLu-Builders)
|
||||
* [AniDB Builders](https://github.com/meisnate12/Plex-Meta-Manager/wiki/AniDB-Builders)
|
||||
* [AniList Builders](https://github.com/meisnate12/Plex-Meta-Manager/wiki/AniList-Builders)
|
||||
* [MyAnimeList Builders](https://github.com/meisnate12/Plex-Meta-Manager/wiki/MyAnimeList-Builders)
|
||||
|
||||
2. **Details:** an attribute that changes anything about the metadata of the item or about how the script functions for th collection/playlist
|
||||
|
||||
* [Setting Details](Setting-Details)
|
||||
* [Schedule Detail](Schedule-Detail)
|
||||
* [Image Overlay Detail](Image-Overlay-Detail)
|
||||
* [Metadata Details](Metadata-Details)
|
||||
* [Arr Details](Arr-Details)
|
||||
|
||||
3. **[Filters](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Filters):** attributes that filters items added to all Builders
|
||||
|
||||
## Playlist Mapping Additional Requirements
|
||||
|
||||
Each playlist operation requires the `libraries` attribute. Which is how the script knows which libraries to search for items in.
|
||||
|
||||
The names can either be a list or comma-separated string of names that match the mapping names defined in your Configuration File.
|
||||
|
||||
```yaml
|
||||
plalists:
|
||||
Marvel Cinematic Universe:
|
||||
sync_mode: sync
|
||||
libraries: Movies, TV Shows
|
||||
trakt_list: https://trakt.tv/users/donxy/lists/marvel-cinematic-universe?sort=rank,asc
|
||||
summary: Marvel Cinematic Universe In Chronological Order
|
||||
```
|
||||
|
||||
**Note: For a library to be able to be used with the playlist it must be defined in the Configuration File's `libraries` attribute.**
|
||||
**Note: Playlists can only have a max of one Builder because they are all inherently ordered.**
|
||||
@ -0,0 +1,34 @@
|
||||
Since playlists are not specific to one library they will need their own special [Playlist File](Metadata-and-Playlist-File) to work.
|
||||
|
||||
You can define Playlist Files by using `playlist_files`. They can either be on the local system, online at an url, or directly from the [Plex Meta Manager Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs) repository.
|
||||
|
||||
By default, when `playlist_files` is missing the script will look in your config directory for `playlists.yml`.
|
||||
|
||||
To use a local Playlist File add `file` under playlist_files set to the system path of the yaml file.
|
||||
```yaml
|
||||
playlist_files:
|
||||
file: /config/My Movies Playlists.yml
|
||||
```
|
||||
To use all yaml files in a particular folder add `folder` under playlist_files set to the system path of the folder containing the yaml files.
|
||||
```yaml
|
||||
playlist_files:
|
||||
folder: /config/Movie Playlists/
|
||||
```
|
||||
To use a Playlist File online add `url` under playlist_files set to the url of the yaml file.
|
||||
```yaml
|
||||
playlist_files:
|
||||
url: http://somesite.com/playlist_file.yml
|
||||
```
|
||||
To use a Playlist File from the [Plex Meta Manager Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs) repository add `git` under playlist_files set to the path in the repository.
|
||||
```yaml
|
||||
playlist_files:
|
||||
git: meisnate12/Playlists
|
||||
```
|
||||
You can specify multiple paths of any type using a list like below.
|
||||
```yaml
|
||||
playlist_files:
|
||||
- file: /config/My Movies Playlists.yml
|
||||
- file: /config/My Shows Playlists.yml
|
||||
- url: http://somesite.com/playlist_file.yml
|
||||
- git: meisnate12/Playlists
|
||||
```
|
||||
@ -0,0 +1,27 @@
|
||||
All the following attributes serve various functions as how the collection/playlist functions inside of Plex Meta Manager.
|
||||
|
||||
| Name | Attribute | Description | Allowed Values | Works with Playlists |
|
||||
| :--- | :--- | :--- | :--- | :---: |
|
||||
| Collection/Playlist Name | `name` | Used to specify the name off the collection/playlist in Plex as different then the mapping name. | Any String | :heavy_check_mark: |
|
||||
| Template | `template` | Used to specify a template and template variables to use for this collection | [`template` mapping details](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Template-Attributes) | :heavy_check_mark: |
|
||||
| Run Again | `run_again` | Used to try and add all the items missing from the collection to the collection again after the daily run <br>**Default Mode:** `false`| **boolean:** `true` or `false` | :heavy_check_mark: |
|
||||
| Sync Mode | `sync_mode` | Used to change how collection builders sync with this collection<br>**Default Mode:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | `append`: Only Add Items to the Collection<br>`sync`: Add & Remove Items from the Collection | :heavy_check_mark: |
|
||||
| Collection Minimum | `collection_minimum` | Minimum items that must be found to add to a collection.<br>**Default:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | number greater then 0 | :heavy_check_mark: |
|
||||
| Delete Below Minimum | `delete_below_minimum` | Deletes the collection if below the minimum.<br>**Default:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | **boolean:** `true` or `false` | :heavy_check_mark: |
|
||||
| Delete Not Scheduled | `delete_not_scheduled` | Deletes the collection if its skipped because its not scheduled.<br>**Default:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | **boolean:** `true` or `false` | :heavy_check_mark: |
|
||||
| Validate Builders | `validate_builders` | When set to false the collection will not fail if one builder fails<br>**Default Mode:** `true` | **boolean:** `true` or `false` | :heavy_check_mark: |
|
||||
| Build Collection | `build_collection` | When set to false the collection won't be created but items can still be added to Radarr/Sonarr<br>**Default Mode:** `true` | **boolean:** `true` or `false` | :x: |
|
||||
| Server Pre-Roll | `server_preroll` | Used to set the `Movie pre-roll video` Text box in Plex under Settings -> Extras | Any String | :heavy_check_mark: |
|
||||
| Missing Only Released | `missing_only_released` | Collection Level `missing_only_released` toggle<br>**Default:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | **boolean:** `true` or `false` |
|
||||
| Only Filter Missing | `only_filter_missing` | Collection Level `only_filter_missing` toggle<br>**Default:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | **boolean:** `true` or `false` | :heavy_check_mark: |
|
||||
| Show Filtered Items | `show_filtered` | Collection level `show_filtered` toggle<br>**Default:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | **boolean:** `true` or `false` | :heavy_check_mark: |
|
||||
| Show Missing Items | `show_missing` | Collection level `show_missing` toggle<br>**Default:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | **boolean:** `true` or `false` | :heavy_check_mark: |
|
||||
| Save Missing Items | `save_missing` | Collection level `save_missing` toggle<br>**Default:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | **boolean:** `true` or `false` | :heavy_check_mark: |
|
||||
| Ignore IDs | `ignore_ids` | Collection level `ignore_ids` which is combined with the library and global `ignore_ids`<br>**Default:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | List or comma-separated String of TMDb/TVDb IDs | :heavy_check_mark: |
|
||||
| Ignore IMDb IDs | `ignore_imdb_ids` | Collection level `ignore_imdb_ids` which is combined with the library and global `ignore_imdb_ids`<br>**Default:** [settings library value](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | List or comma-separated String of IMDb IDs | :heavy_check_mark: |
|
||||
| Name Mapping | `name_mapping` | Used to specify the folder name in the [Image Assets Directory](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Image-Asset-Directory) | Folder Name In Assets Directory | :heavy_check_mark: |
|
||||
| Test Mode | `test` | When running in Test Mode (`--run-tests` [option](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Installation#run-tests)) only collections with `test: true` will be run<br>**Default:** `false` | **boolean:** `true` or `false` | :heavy_check_mark: |
|
||||
| Collection/Playlist Changes Webhooks | `collection_changes_webhooks` | Used to specify a collection changes webhook for just this collection | List of webhooks | :heavy_check_mark: |
|
||||
|
||||
* **Name Mapping:** If your collection name contains characters that are not allowed in file paths (i.e. for windows `<`, `>`, `:`, `"`, `/`, `\`, `|`, `?`, `*` cannot be in the file path), but you want them in your collection name you can use the `name_mapping` attribute to specific this collection's name in the file system.
|
||||
* **Server Pre-Roll:** You can run this with a [schedule](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Schedule-Detail) to change the pre-rolls automatically.
|
||||
@ -1,18 +1,22 @@
|
||||
You can build a collection using StevenLu's Popular Movies list on [StevenLu.com](https://movies.stevenlu.com/) (StevenLu).
|
||||
You can find items using StevenLu's Popular Movies list on [StevenLu.com](https://movies.stevenlu.com/) (StevenLu).
|
||||
|
||||
No configuration is required for this builder.
|
||||
|
||||
| Name | Attribute | Description | Works with Movies | Works with Shows |
|
||||
| :--- | :--- | :--- | :---: | :---: |
|
||||
| [StevenLu's Popular Movies List](#stevenlus-popular-movies-list) | `stevenlu_popular` | Gets every movie on [StevenLu's Popular Movies List](https://movies.stevenlu.com/). | :heavy_check_mark: | :x: |
|
||||
| Name | Attribute | Description | Works with Movies | Works with Shows | Works with Playlists and Custom Sort |
|
||||
| :--- | :--- | :--- | :---: | :---: | :---: |
|
||||
| [StevenLu's Popular Movies List](#stevenlus-popular-movies-list) | `stevenlu_popular` | Finds every movie on [StevenLu's Popular Movies List](https://movies.stevenlu.com/). | :heavy_check_mark: | :x: | :heavy_check_mark: |
|
||||
|
||||
## StevenLu's Popular Movies List
|
||||
Gets every movie on [StevenLu's Popular Movies List](https://movies.stevenlu.com/).
|
||||
Finds every movie on [StevenLu's Popular Movies List](https://movies.stevenlu.com/).
|
||||
|
||||
The expected input is `true`.
|
||||
|
||||
The `sync_mode: sync` and `collection_order: custom` Details are recommended since the lists are continuously updated and in a specific order.
|
||||
|
||||
```yaml
|
||||
collections:
|
||||
StevenLu's Popular Movies:
|
||||
stevenlu_popular: true
|
||||
collection_order: custom
|
||||
sync_mode: sync
|
||||
```
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 156 KiB |
|
After Width: | Height: | Size: 158 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 145 KiB |
|
After Width: | Height: | Size: 147 KiB |
Loading…
Reference in new issue