@ -94,20 +94,25 @@ All the following attributes update the summary of the collection from various s
| 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 a TMDb Movie/Collection summary for a movie library or a TMDb Show summary for a show library | TMDb Movie/Show/Collection ID |
| TMDb Description | `tmdb_description` | Used to change the collection's summary to a TMDb List Discription | TMDb List ID |
| TMDb Biography | `tmdb_biography` | Used to change the collection's summary to a TMDb Person's biography | TMDb Person ID |
| 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 Attributes
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 a URL | URL of image publicly available on the internet |
| TMDb Poster<sup>2</sup> | `tmdb_poster` | Used to change the collection's poster to a TMDb Movie/Collection poster for a movie library or a 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 a TMDb List poster | TMDb List ID |
| TMDb Profile<sup>2</sup> | `tmdb_profile` | Used to change the collection's poster to a TMDb Person's profile | TMDb Person ID |
| File Poster<sup>2</sup> | `file_poster` | Used to change the collection's poster to an image in the file system | Path to image in the file system |
| 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/Settings-Attributes#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).
@ -115,9 +120,10 @@ All the following attributes update the poster of the collection from various so
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 a URL | URL of image publicly available on the internet |
| TMDb Background<sup>3</sup> | `tmdb_background` | Used to change the collection's background to a TMDb Movie/Collection background for a movie library or a TMDb Show background for a show library | TMDb Movie/Show/Collection ID |
| File Background<sup>3</sup> | `file_background` | Used to change the collection's background to an image in the file system | Path to image in the file system |
| :-- | :-- | :-- | :-- |a
| 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/Settings-Attributes#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).
@ -16,7 +18,6 @@ This wiki should tell you everything you need to know about the script to get it
* To see user submitted Metadata configuration files and you could even add your own go to the [Plex Meta Manager Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs)
* Pull Request are welcome but please submit them to the develop branch
* If you wish to contribute to the Wiki please fork and send a pull request on the [Plex Meta Manager Wiki Repository](https://github.com/meisnate12/Plex-Meta-Manager-Wiki)
* [Buy Me a Pizza](https://www.buymeacoffee.com/meisnate12)
## Table of Contents
- [Home](Home)
@ -30,6 +31,7 @@ This wiki should tell you everything you need to know about the script to get it
You can build different collections using the lists on [Letterboxd.com](https://letterboxd.com/) (Letterboxd).
| Name | Attribute | Description | Works with Movies | Works with Shows |
| :-- | :-- | :-- | :--: | :--: |
| [Letterboxd List](#letterboxd-list) | `letterboxd_list` | Gets every movie in the Letterboxd List | :heavy_check_mark: | :x: |
| [Letterboxd List Details ](#letterboxd-list) | `letterboxd_list_details` | Gets every movie in the Letterboxd List and updates the collection with the description of the Letterboxd list | :heavy_check_mark: | :x: |
## Letterboxd List
Gets 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.
@ -22,6 +22,7 @@ The available attributes for each library are as follows
| Library Type | `library_type` | `movie` (For Movie Libraries)<br>`show` (For Show Libraries) | N/A | :heavy_check_mark: |
| Library Name | `library_name` | Library name (Only needed when trying to use multiple libraries with the same name) | Base Attribute Name | :x: |
| Metadata Path | `metadata_path` | System Location for the Metadata YAML file | Same directory as config YAML file | :x: |
| Mass Genre Update | `mass_genre_update` | Updates every movie/show in the library to the chosen site's genres<br>`tmdb`: Use TMDb for Genres<br>`omdb`: Use IMDb through OMDb for Genres | No Update | :x: |
| Plex Mapping | `plex` | [`plex` mapping details](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Plex-Attributes) | global | :heavy_check_mark: Either here or globally |
| API Key | `apikey` | OMDb API Key | N/A | :heavy_check_mark: |
* The OMDb apikey can be generated [here](http://www.omdbapi.com/apikey.aspx).
* The free apikey is limited to 1000 requests per day so if you hit your limit the program should be able to pick up where it left off the next day as long as the `cache` option is enabled
| `title` | Gets movie/show with the specified text in the title | :heavy_check_mark: | :heavy_check_mark: |
| `actor` | Gets every movie with the specified actor | :heavy_check_mark: | :x: |
| `country` | Gets every movie with the specified country | :heavy_check_mark: | :x: |
| `decade` | Gets every movie from the specified year + the 9 that follow i.e. 1990 will get you 1990-1999 | :heavy_check_mark: | :x: |
@ -85,7 +86,7 @@ Gets every movie/show based on the search parameters provided. The search will r
| `writer` | Gets every movie with the specified writer | :heavy_check_mark: | :x: |
| `year` | Gets every movie/show with the specified year (Put a `-` between two years for a range i.e. `year: 1990-1999` or end with `NOW` to go till current i.e. `year: 2000-NOW`) | :heavy_check_mark: | :heavy_check_mark: |
* You can only use each search option once per `plex_search` but multiple values are supported as either a list or a comma-separated string.
* You can only use each search option once per `plex_search` but multiple values are supported as either a list or a comma-separated string for all attributes except `title`.
* If you want to restrict the search by multiples of the same attribute (i.e. You want every movie that is a Romance and Comedy) try using [Collection Filters](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Collection-Filters).
@ -41,7 +41,9 @@ After the folder has been created you can add a `poster.ext` or `background.ext`
To edit the posters and backgrounds of the movies or shows inside a collection, you have to create a folder inside the collection asset folder called the same name as the folder the actual video file is stored in.
After the folder has been created you can add a `poster.ext` or `background.ext` file to update the poster or background of a movie or show (replacing `.ext` with the image extension).
After the folder has been created you can add a `poster.ext` or `background.ext` file to update the poster or background of a movie or show (replacing `.ext` with the image extension).
If you want to update the posters of a show's seasons, inside the shows' assets folder you can add a `Season##.ext` file to update the poster of the specified season (replacing `##` with the zero padded season number and `.ext` with the image extension).
Here's an example config folder structure with an assets directory.
@ -49,6 +51,7 @@ Here's an example config folder structure with an assets directory.
config
├── config.yml
├── Movies.yml
├── TV Shows.yml
├── assets
│ ├── The Lord of the Rings
│ ├── poster.png
@ -62,4 +65,25 @@ config
│ ├── The Lord of the Rings The Return of the King (2003)
@ -3,8 +3,11 @@ You can build different collections using the features of [TheTVDb.com](https://
| Name | Attribute | Description | Works with Movies | Works with Shows |
| :-- | :-- | :-- | :--: | :--: |
| [TVDb List](#tvdb-list) | `tvdb_list` | Gets every show in a [TVDb List](https://www.thetvdb.com/lists) or [TVDb Userlist](https://www.thetvdb.com/lists/custom) | :heavy_check_mark: | :heavy_check_mark: |
| [TVDb List Details](#tvdb-list) | `tvdb_list_details` | Gets every show in a [TVDb List](https://www.thetvdb.com/lists) or [TVDb Userlist](https://www.thetvdb.com/lists/custom) and updates the collection summary with the TVDb list description | :heavy_check_mark: | :heavy_check_mark: |
| [TVDb Show](#tvdb-show) | `tvdb_show` | Gets the series specified | :x: | :heavy_check_mark: |
| [TVDb Show Details](#tvdb-show) | `tvdb_show_details` | Gets the series specified and updates the collection with the summary, poster, and background from the TVDb series | :x: | :heavy_check_mark: |
| [TVDb Movie](#tvdb-movie) | `tvdb_movie` | Gets the movie specified | :heavy_check_mark: | :x: |
| [TVDb Movie Details](#tvdb-movie) | `tvdb_movie_details` | Gets the movie specified and updates the collection with the summary, poster, and background from the TVDb movie | :heavy_check_mark: | :x: |
## TVDb List
Gets every show in a [TVDb List](https://www.thetvdb.com/lists) or [TVDb Userlist](https://www.thetvdb.com/lists/custom)
@ -22,6 +25,15 @@ collections:
tvdb_list: https://www.thetvdb.com/lists/6957
```
* You can update the collection details with the TVDb list's description by using `tvdb_list_details`.
* You can specify multiple lists in `tvdb_list_details` but it will only use the first one to update the collection details.
* You can update the collection details with the TVDb show's summary, poster, and background by using `tvdb_show_details`.
* You can specify multiple shows in `tvdb_show_details` but it will only use the first one to update the collection details.
* Posters and background in the library's asset directory will be used over the collection details unless `tvdb_poster`/`tvdb_background` is also specified.
```yaml
collections:
Star Wars (Animated Shows):
tvdb_show_details: 83268, 283468
```
## TVDb Movie
Gets the movie specified
@ -48,12 +70,25 @@ The expected input is a TVDb Movie ID or TVDb Movie URL. Multiple values are sup
* You can update the collection details with the TVDb movie's summary, poster, and background by using `tvdb_movie_details`.
* You can specify multiple movies in `tvdb_movie_details` but it will only use the first one to update the collection details.
* Posters and background in the library's asset directory will be used over the collection details unless `tvdb_poster`/`tvdb_background` is also specified.
@ -5,6 +5,7 @@ You can build different collections using the features of [Trakt.tv](https://tra
| Name | Attribute | Description | Works with Movies | Works with Shows |
| :-- | :-- | :-- | :--: | :--: |
| [Trakt List](#trakt-list) | `trakt_list` | Gets every movie/show in the Trakt List | :heavy_check_mark: | :heavy_check_mark: |
| [Trakt List Details](#trakt-list) | `trakt_list_details` | Gets every movie/show in the Trakt List and updates the collection summary with the list description | :heavy_check_mark: | :heavy_check_mark: |
| [Trakt Trending](#trakt-trending) | `trakt_trending` | Gets the movies/shows in Trakt's [Trending Movies](https://trakt.tv/movies/trending)/[Shows](https://trakt.tv/shows/trending) list | :heavy_check_mark: | :heavy_check_mark: |
| [Trakt Watchlist](#tmdb-watchlist) | `trakt_watchlist` | Gets every movie/show in a Users Watchlist | :heavy_check_mark: | :heavy_check_mark: |
meisnate12
3 years ago