You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
199 lines
7.9 KiB
199 lines
7.9 KiB
## Metadata Files
|
|
|
|
Metadata files are used to create and maintain collections and metadata within the Plex libraries on the server.
|
|
|
|
If utilized to their fullest, these files can be used to maintain the entire server's collections and metadata, and can be used as a backup for these in the event of a restore requirement.
|
|
|
|
Collections, templates, metadata, and dynamic collections are defined within one or more Metadata files, which are linked to libraries in the [Libraries Attribute](../config/libraries.md#metadata-path) within the [Configuration File](../config/configuration.md).
|
|
|
|
These are the attributes which can be used within the Metadata File:
|
|
|
|
| Attribute | Description |
|
|
|:--------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| [`templates`](templates) | contains definitions of templates that can be leveraged by multiple collections |
|
|
| [`external_templates`](templates.md#external-templates) | contains [path types](../config/paths) that point to external templates that can be leveraged by multiple collections |
|
|
| [`collections`](#collection-attributes) | contains definitions of collections you wish to add to one or more libraries |
|
|
| [`dynamic_collections`](#dynamic-collection-attributes) | contains definitions of [dynamic collections](dynamic) you wish to create |
|
|
| [`metadata`](#metadata-attributes) | contains definitions of metadata changes to [movie](metadata/movie), [show](metadata/show), or [music](metadata/music) library's items [movie titles, episode descriptions, etc.] |
|
|
|
|
* One of `metadata`, `collections` or `dynamic_collections` must be present for the Metadata File to execute.
|
|
* Example Metadata Files can be found in the [Plex Meta Manager Configs Repository](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/PMM)
|
|
|
|
## Collection Attributes
|
|
|
|
Plex Meta Manager can run a number of different operations within `collections` and such as:
|
|
|
|
* Automatically build and update collections and playlists
|
|
* Sync the collection with the source list if one is used
|
|
* Send missing media to Sonarr/Radarr (Lidarr not supported at this time)
|
|
* Show and Hide collections at set intervals (i.e. show Christmas collections in December only)
|
|
|
|
Each collection requires its own section within the `collections` attribute and unlike playlists, collections can be built using as many Builders as needed.
|
|
|
|
```yaml
|
|
collections:
|
|
Trending Movies:
|
|
# ... builders, details, and filters for this collection
|
|
Popular Movies:
|
|
# ... builders, details, and filters for this collection
|
|
etc:
|
|
# ... builders, details, and filters for this collection
|
|
```
|
|
|
|
There are three types of attributes that can be utilized within a collection:
|
|
|
|
### Builders
|
|
|
|
Builders use third-party services to source items to be added to the collection. Multiple builders can be used in the same collection from a variety of sources listed below.
|
|
|
|
* [Plex Builders](builders/plex)
|
|
* [Smart Builders](builders/smart) (Collections Only)
|
|
* [TMDb Builders](builders/tmdb)
|
|
* [TVDb Builders](builders/tvdb)
|
|
* [IMDb Builders](builders/imdb)
|
|
* [Trakt Builders](builders/trakt)
|
|
* [Tautulli Builders](builders/tautulli)
|
|
* [Radarr Builders](builders/radarr)
|
|
* [Sonarr Builders](builders/sonarr)
|
|
* [MdbList Builders](builders/mdblist)
|
|
* [Letterboxd Builders](builders/letterboxd)
|
|
* [ICheckMovies Builders](builders/icheckmovies)
|
|
* [FlixPatrol Builders](builders/flixpatrol)
|
|
* [Reciperr Builders](builders/reciperr)
|
|
* [StevenLu Builders](builders/stevenlu)
|
|
* [AniDB Builders](builders/anidb)
|
|
* [AniList Builders](builders/anilist)
|
|
* [MyAnimeList Builders](builders/myanimelist)
|
|
|
|
### Details
|
|
|
|
These can alter any aspect of the collection or the media items within them.
|
|
|
|
* [Setting Details](details/setting)
|
|
* [Schedule Detail](details/schedule)
|
|
* [Metadata Details](details/metadata)
|
|
* [Arr Details](details/arr)
|
|
|
|
### Filters
|
|
|
|
These filter media items added to the collection by any of the Builders.
|
|
|
|
* [Filters](filters)
|
|
|
|
### Example
|
|
|
|
```yaml
|
|
collections:
|
|
Trending:
|
|
trakt_trending: 10
|
|
tmdb_trending_daily: 10
|
|
tmdb_trending_weekly: 10
|
|
sort_title: +1_Trending
|
|
sync_mode: sync
|
|
smart_label: random
|
|
summary: Movies Trending across the internet
|
|
Popular:
|
|
tmdb_popular: 40
|
|
imdb_list:
|
|
url: https://www.imdb.com/search/title/?title_type=feature,tv_movie,documentary,short
|
|
limit: 40
|
|
sort_title: +2_Popular
|
|
sync_mode: sync
|
|
smart_label: random
|
|
summary: Popular Movies across the internet
|
|
```
|
|
|
|
## Dynamic Collection Attributes
|
|
|
|
Plex Meta Manager can dynamically create collections based on a verity of different criteria, such as
|
|
|
|
* Collections for the top `X` popular people on TMDb (Bruce Willis, Tom Hanks etc.)
|
|
* Collections for each decade represented in the library (Best of 1990s, Best of 2000s etc.)
|
|
* Collections for each of the moods/styles within a Music library (A Cappella, Pop Rock etc.)
|
|
* Collections for each of a Trakt Users Lists.
|
|
|
|
Below is an example dynamic collection which will create a collection for each of the decades represented within the library:
|
|
|
|
```yaml
|
|
dynamic_collections:
|
|
Decades:
|
|
type: decade
|
|
```
|
|
|
|
## Metadata Attributes
|
|
|
|
Plex Meta Manager can automatically update items in Plex based on what's defined within the `metadata` attribute.
|
|
|
|
Each metadata requires its own section within the `metadata` attribute. Each item is defined by the mapping name which must be the same as the item name in the library unless an `alt_title` is specified.
|
|
|
|
```yaml
|
|
metadata:
|
|
Godzilla vs. Mechagodzilla II:
|
|
# ... details to change for this itwm
|
|
Godzilla vs. Megaguirus:
|
|
# ... details to change for this itwm
|
|
Godzilla vs. Megalon:
|
|
# ... details to change for this itwm
|
|
Halloween (Rob Zombie):
|
|
# ... details to change for this itwm
|
|
etc:
|
|
# ... details to change for this itwm
|
|
```
|
|
|
|
### Title & Year
|
|
|
|
YAML files cannot have two items with the same mapping name so if you have two movies with the same name you define each one with a name of your choosing. Then use the `title` attribute to specify the real title and the `year` attribute to specify which of the multiple movies is for this mapping.
|
|
|
|
```yaml
|
|
metadata:
|
|
Godzilla1:
|
|
title: Godzilla
|
|
year: 1954
|
|
content_rating: R
|
|
Godzilla2:
|
|
title: Godzilla
|
|
year: 1998
|
|
content_rating: PG-13
|
|
```
|
|
|
|
### Alt Title
|
|
|
|
To define an alternative title that the item may be called when searching use `alt_title`. When a title is found matching `alt_title` then the name of the itme will be changed to match the mapping name or `title` if specified.
|
|
|
|
For Example, the 2007 movie Halloween shares a name with another movie in the Halloween franchise so this changes the title to `Halloween (Rob Zombie)` if the title is currently Halloween.
|
|
|
|
```yaml
|
|
metadata:
|
|
Halloween (Rob Zombie):
|
|
alt_title: Halloween
|
|
year: 2007
|
|
```
|
|
|
|
### Example
|
|
|
|
```yaml
|
|
metadata:
|
|
Godzilla1:
|
|
title: Godzilla
|
|
year: 1954
|
|
content_rating: R
|
|
Godzilla2:
|
|
title: Godzilla
|
|
year: 1998
|
|
content_rating: PG-13
|
|
Godzilla vs. Mechagodzilla II:
|
|
content_rating: PG
|
|
Godzilla vs. Megaguirus:
|
|
content_rating: PG
|
|
originally_available: 2000-08-31
|
|
Godzilla vs. Megalon:
|
|
content_rating: G
|
|
originally_available: 1973-03-17
|
|
Halloween (Rob Zombie):
|
|
alt_title: Halloween
|
|
year: 2007
|
|
```
|
|
|
|
|
|
|