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.
173 lines
8.9 KiB
173 lines
8.9 KiB
2 years ago
|
# Library Attributes & Metadata Paths
|
||
|
|
|
||
|
|
## Overview
|
||
|
|
|
||
|
|
Within the [Configuration File](configuration), the `libraries:` attribute specifies the Plex libraries that the user wants Plex Meta Manager to act on.
|
||
|
|
|
||
|
|
Attributes are used to instruct Plex Meta Manager what actions to take, such as "load the following libraries" or "execute the following Collection Definition files". These attributes can be specified individually per library, or can be inherited from the global value if it has been set. If an attribute is specified at both the library and global level, then the library level attribute will take priority.
|
||
|
|
|
||
|
|
## Example
|
||
|
|
|
||
|
|
This example is an advanced version of the library mappings which highlights some attributes being set at the global level, and some being set at the library level:
|
||
|
|
|
||
|
|
<details>
|
||
|
|
<summary>Click to Expand</summary>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
In this example, the `"TV Shows On Second Plex"` library has a library-level `plex` configuration, which takes priority over the `plex` configuration set at the global level. <br>
|
||
|
|
|
||
|
|
The `"Anime"` library also has a library-level `radarr` configuration, which takes priority over the `radarr` configuration set at the global level.
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
libraries:
|
||
|
|
Movies:
|
||
|
|
metadata_path:
|
||
|
|
- file: config/Movies.yml
|
||
|
|
- git: meisnate12/MovieCharts
|
||
|
|
- git: meisnate12/Studios
|
||
|
|
- git: meisnate12/IMDBGenres
|
||
|
|
- git: meisnate12/People
|
||
|
|
operations:
|
||
|
|
mass_critic_rating_update: tmdb
|
||
|
|
split_duplicates: true
|
||
|
|
TV Shows:
|
||
|
|
metadata_path:
|
||
|
|
- file: config/TV Shows.yml
|
||
|
|
- git: meisnate12/ShowCharts
|
||
|
|
- git: meisnate12/Networks
|
||
|
|
TV Shows On Second Plex:
|
||
|
|
library_name: TV Shows
|
||
|
|
plex:
|
||
|
|
url: http://192.168.1.98:32400
|
||
|
|
token: ####################
|
||
|
|
metadata_path:
|
||
|
|
- file: config/TV Shows.yml
|
||
|
|
- git: meisnate12/ShowCharts
|
||
|
|
- git: meisnate12/Networks
|
||
|
|
Anime:
|
||
|
|
metadata_path:
|
||
|
|
- file: config/Anime.yml
|
||
|
|
- git: meisnate12/AnimeCharts
|
||
|
|
radarr:
|
||
|
|
url: http://192.168.1.45:7878
|
||
|
|
token: ################################
|
||
|
|
root_folder_path: S:/Anime
|
||
|
|
settings:
|
||
|
|
asset_directory:
|
||
|
|
config/assets/anime
|
||
|
|
plex:
|
||
|
|
url: http://192.168.1.12:32400
|
||
|
|
token: ####################
|
||
|
|
radarr:
|
||
|
|
url: http://192.168.1.12:7878
|
||
|
|
token: ################################
|
||
|
|
add: true
|
||
|
|
root_folder_path: S:/Movies
|
||
|
|
monitor: true
|
||
|
|
availability: announced
|
||
|
|
quality_profile: HD-1080p
|
||
|
|
tag: pmm
|
||
|
|
search: false
|
||
|
|
```
|
||
|
|
</details>
|
||
|
|
|
||
|
|
## Attributes
|
||
|
|
|
||
|
|
The available attributes for each library are as follows:
|
||
|
|
|
||
|
|
| Attribute | Values | Default | Required |
|
||
|
|
|:----------------------------------|:--------------------------------------------------------------------------------------|:--------------------------------------:|:-------------------------------:|
|
||
|
|
| [`library_name`](#library-name) | Library name (required only when trying to use multiple libraries with the same name) | Base Attribute Name | ❌ |
|
||
|
|
| [`metadata_path`](#metadata-path) | Location of Metadata YAML files | `/config/<<MAPPING_NAME>>.yml` | ❌ |
|
||
|
|
| [`missing_path`](#missing-path) | Location to create the YAML file listing missing items for this library | `/config/<<MAPPING_NAME>>_missing.yml` | ❌ |
|
||
|
|
| [`operations`](operations) | Library Operations to run | N/A | ❌ |
|
||
|
|
| [`settings`](settings) | Any `setting` attribute that overrides a global value | global | ❌ |
|
||
|
|
| [`plex`](plex) | Any `plex` attribute that overrides a global value | global | ✅ Either here or globally |
|
||
|
|
| [`radarr`](radarr) | Any `radarr` attribute that overrides a global value | global | ❌ |
|
||
|
|
| [`sonarr`](sonarr) | Any `sonarr` attribute that overrides a global value | global | ❌ |
|
||
|
|
| [`tautulli`](tautulli) | Any `tautulli` attribute that overrides a global value | global | ❌ |
|
||
|
|
|
||
|
|
## Library Name
|
||
|
|
|
||
|
|
Each library that the user wants Plex Meta Manager to interact with must be documented with a library attribute. A library attribute is represented by the mapping name (i.e. `Movies` or `TV Shows`), this must have a unique name that correlates with a library of the same name within the Plex Media Server. In the situation that two servers are being connected to which both have libraries of the same name, the `library_name` attribute can be utilized to specify the real Library Name, whilst the library attribute's mapping name can be made into a placeholder. This is showcased below:
|
||
|
|
<details>
|
||
|
|
<summary>Click to Expand</summary>
|
||
|
|
<br />
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
libraries:
|
||
|
|
Movies01:
|
||
|
|
library_name: Movies
|
||
|
|
Movies02:
|
||
|
|
library_name: Movies
|
||
|
|
plex:
|
||
|
|
url: http://192.168.1.35:32400
|
||
|
|
token: ####################
|
||
|
|
TV Shows:
|
||
|
|
Anime:
|
||
|
|
plex:
|
||
|
|
url: http://192.168.1.12:32400
|
||
|
|
token: ####################
|
||
|
|
```
|
||
|
|
|
||
|
|
* In this example, `"Movies01"`, `"TV Shows"`, and `"Anime"` will all use the global plex server (http://192.168.1.12:32400) which is defined using the global `plex` mapping. `"Movies02"` will use the plex server http://192.168.1.35:32400 which is defined under its `plex` mapping over the global mapping.
|
||
|
|
</details>
|
||
|
|
|
||
|
|
## Metadata Path
|
||
|
|
|
||
|
|
### Overview
|
||
|
|
|
||
|
|
The `metadata_path` attribute is used to define the metadata (aka YAML) files that will be executed against the parent library.
|
||
|
|
|
||
|
|
By default, when `metadata_path` is missing the script will look within the root PMM directory for a metadata file called `<MAPPING_NAME>.yml`. In this example, Plex Meta Manager will look for a file named `TV Shows.yml`.
|
||
|
|
```yaml
|
||
|
|
libraries:
|
||
|
|
TV Shows:
|
||
|
|
```
|
||
|
|
|
||
|
|
### Path Types
|
||
|
|
|
||
|
|
In this example, four metadata file path types are defined for the `"TV Shows"` library:
|
||
|
|
```yaml
|
||
|
|
TV Shows:
|
||
|
|
metadata_path:
|
||
|
|
- file: config/TVShows.yml
|
||
|
|
- folder: config/TV Shows/
|
||
|
|
- git: meisnate12/ShowCharts
|
||
|
|
- url: https://somewhere.com/PopularTV.yml
|
||
|
|
```
|
||
|
|
The four path types are outlined as follows:
|
||
|
|
|
||
|
|
* `- file:` refers to a metadata file which is located within the system that PMM is being run from.
|
||
|
|
* `- folder:` refers to a directory containing metadata files which is located within the system that PMM is being run from.
|
||
|
|
* `- git:` refers to a metadata file which is hosted on GitHub. This file is assumed to be in the [Configs Repo](https://github.com/meisnate12/Plex-Meta-Manager-Configs) unless the user has specified a custom repository with the [`custom-repo` Setting Attribute](settings.md#custom-repo).
|
||
|
|
* `- url:` refers to a metadata file which is hosted publicly on the internet.
|
||
|
|
|
||
|
|
Within the above example, PMM will:
|
||
|
|
|
||
|
|
* First, look within the root of the PMM directory (also known as `config/`) for a metadata file named `TVShows.yml`. If this file does not exist, PMM will skip the entry and move to the next one in the list.
|
||
|
|
* Then, look within the root of the PMM directory (also known as `config/`) for a directory called `TV Shows`, and then load any metadata files within that directory.
|
||
|
|
* Then, look at the [meisnate12 folder](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/meisnate12) within the GitHub Configs Repo for a file called `MovieCharts.yml` which it finds [here](https://github.com/meisnate12/Plex-Meta-Manager-Configs/blob/master/meisnate12/MovieCharts.yml).
|
||
|
|
* Finally, load the metadata file located at `https://somewhere.com/PopularTV.yml`
|
||
|
|
|
||
|
|
## Missing Path
|
||
|
|
|
||
|
|
The `missing_path` attribute is used to define where to save the "missing items" YAML file. This file is used to store information about media which is missing from the Plex library compared to what is expected from the Metadata file.
|
||
|
|
|
||
|
|
If your Metadata file creates a collection with `Movie 1`, `Movie 2` and `Movie 3` but your Plex library only has `Movie 1` and `Movie 3`, then the missing YAML file will be updated to inform the user that `Movie 2` was missing from the library.
|
||
|
|
|
||
|
|
The default and recommended path is `/config/<<MAPPING_NAME>>_missing.yml` where `<<MAPPING_NAME>>` is the name of the library attribute, as showcased below:
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
libraries:
|
||
|
|
Movies:
|
||
|
|
missing_path: /config/Movies_movies.yml
|
||
|
|
```
|
||
|
|
|
||
|
|
Alternatively, "missing items" YAML files can be placed in their own directory, as below:
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
libraries:
|
||
|
|
Movies:
|
||
|
|
missing_path: /config/missing/Movies.yml
|
||
|
|
```
|