meisnate12
2 years ago
parent
04a6197d96
commit
5a508a7634
@ -1,107 +0,0 @@
|
||||
You can have the script edit the metadata of Artists, Albums, and Tracks by adding them to the `metadata` mapping of a Metadata File.
|
||||
|
||||
An example of multiple metadata edits in a music library is below:
|
||||
```yaml
|
||||
metadata:
|
||||
"Linkin Park":
|
||||
country: "United States of America"
|
||||
album_sorting: newest
|
||||
albums:
|
||||
"Hybrid Theory":
|
||||
originally_available: "2000-10-24"
|
||||
tracks:
|
||||
1:
|
||||
rating: 5
|
||||
"One Step Closer":
|
||||
rating: 5
|
||||
"Meteora":
|
||||
originally_available: "2003-03-25"
|
||||
album_sorting: newest
|
||||
tracks:
|
||||
9:
|
||||
rating: 5
|
||||
"Numb":
|
||||
rating: 5
|
||||
"Minutes To Midnight":
|
||||
originally_available: "2007-05-14"
|
||||
```
|
||||
|
||||
## Artist
|
||||
|
||||
Each artist is defined by the mapping name which must be the same as the artist name in the library unless an `alt_title` is specified.
|
||||
|
||||
### Albums
|
||||
To edit the metadata of a particular Album for an Artist use the `albums` attribute on its artist.
|
||||
|
||||
The mapping name is the album name.
|
||||
|
||||
### Tracks
|
||||
To edit the metadata of a particular Track on an Album use the `tracks` attribute on its album.
|
||||
|
||||
The mapping name is the track number in that Album or the title of the Track.
|
||||
|
||||
## Metadata Edits
|
||||
|
||||
The available attributes for editing artists, albums, and tracks are as follows
|
||||
|
||||
### Special Attributes
|
||||
|
||||
| Name | Attribute | Allowed Values | Artists | Album | Tracks |
|
||||
| :--- | :--- | :--- | :---: |:---:| :---: |
|
||||
| Alternative Title | `alt_title` | Alternative title to look for | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
||||
| Albums | `albums` | Mapping to define Albums | :heavy_check_mark: | :x: | :x: |
|
||||
| Tracks | `tracks` | Mapping to define Tracks | :x: | :heavy_check_mark: | :x: |
|
||||
|
||||
* If you know of another Title your item might exist under, but you want it titled differently you can use `alt_title` to specify another title to look under and then be changed to the mapping name. For Example the Artist `Kesha` used to be stylized as `Ke$ha`, and might still be found that way in Metadata results.
|
||||
```yaml
|
||||
metadata:
|
||||
"Kesha":
|
||||
alt_title: "Ke$ha"
|
||||
```
|
||||
This would change the name of the default `Ke$ha` to `Kesha` and would not mess up any subsequent runs.
|
||||
``
|
||||
### General Attributes
|
||||
|
||||
| Name | Attribute | Allowed Values | Artists | Album | Tracks |
|
||||
| :--- | :--- | :--- | :---: | :---: | :---: |
|
||||
| Sort Title | `sort_title` | Text to change Sort Title | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
||||
| Rating | `rating` | Number to change Rating | :x:| :heavy_check_mark: | :heavy_check_mark: |
|
||||
| Originally Available | `originally_available` | Date to change Originally Available<br>**Format:** YYYY-MM-DD | :x: | :heavy_check_mark: | :x: |
|
||||
| Record Label | `record_label` | Text to change Record Label | :x: | :heavy_check_mark: | :x: |
|
||||
| Summary | `summary` | Text to change Summary | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
||||
| Track | `track` | Text to change Track | :x: | :x: | :heavy_check_mark: |
|
||||
| Disc | `disc` | Text to change Disc | :x: | :x: | :heavy_check_mark: |
|
||||
| Original Artist | `original_artist` | Text to change Original Artist | :x: | :x: | :heavy_check_mark: |
|
||||
|
||||
### Tag Attributes
|
||||
|
||||
You can add `.remove` to any tag attribute to only remove those tags i.e. `genre.remove`.
|
||||
|
||||
You can add `.sync` to any tag attribute to sync all tags vs just appending the new ones i.e. `genre.sync`.
|
||||
|
||||
| Name | Attribute | Allowed Values | Artists | Album | Tracks |
|
||||
| :--- | :--- | :--- | :---: | :---: | :---: |
|
||||
| Genre | `genre` | List or comma-separated text of each Genre Tag | :heavy_check_mark: | :heavy_check_mark: | :x: |
|
||||
| Collection | `collection` | List or comma-separated text of each Collection Tag | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
||||
| Label | `label` | List or comma-separated text of each Label Tag | :x: | :heavy_check_mark: | :x: |
|
||||
| Style | `style` | List or comma-separated text of each Style Tag | :heavy_check_mark: | :heavy_check_mark: | :x: |
|
||||
| Mood | `mood` | List or comma-separated text of each Mood Tag | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
||||
| Country | `country` | List or comma-separated text of each Country Tag | :heavy_check_mark: | :x: | :x: |
|
||||
| Similar Artist | `similar_artist` | List or comma-separated text of each Similar Artist Tag | :heavy_check_mark: | :x: | :x: |
|
||||
|
||||
## Image Attributes
|
||||
|
||||
| Name | Attribute | Description | Allowed Values | Artists | Album | Tracks |
|
||||
| :--- | :--- | :--- | :--- | :---: | :---: | :---: |
|
||||
| URL Poster | `url_poster` | Used to change the item's poster to the URL | URL of image publicly available on the internet | :heavy_check_mark: | :heavy_check_mark: | :x: |
|
||||
| File Poster | `file_poster` | Used to change the item's poster to the image in the file system | Path to image in the file system | :heavy_check_mark: | :heavy_check_mark: | :x: |
|
||||
| URL Background | `url_background` | Use to change the item's background to the URL | URL of image publicly available on the internet | :heavy_check_mark: | :heavy_check_mark: | :x: |
|
||||
| File Background | `file_background` | Used to change the item's background to the image in the file system | Path to image in the file system | :heavy_check_mark: | :heavy_check_mark: | :x: |
|
||||
|
||||
### Advance Attributes
|
||||
|
||||
All these attributes only work with Artists.
|
||||
|
||||
| Name | Attribute | Allowed Values |
|
||||
| :--- | :--- | :--- |
|
||||
| Album Sorting | `album_sorting` | `default`: Library default<br>`oldest`: Oldest first<br>`newest`: Newest first<br>`name`: Alphabetical |
|
||||
@ -1,41 +0,0 @@
|
||||
|
||||
### Episodes Attributes
|
||||
To edit the metadata of a particular Episode in a show use the `episodes` attribute.
|
||||
|
||||
The mapping name uses the format S##E## to determine what episode to edit (use 0 for specials).
|
||||
|
||||
A simple example is below:
|
||||
```yaml
|
||||
metadata:
|
||||
"Avatar: The Last Airbender":
|
||||
episodes:
|
||||
S01E01:
|
||||
rating: 9.1
|
||||
S03E21:
|
||||
summary: The Epic Series Final of Avatar The Last Airbender
|
||||
```
|
||||
|
||||
The available attributes for each episode are as follows
|
||||
|
||||
### General Attributes
|
||||
|
||||
| Name | Attribute | Allowed Values |
|
||||
| :--- | :--- | :--- |
|
||||
| Title | `title` | Text to change Title |
|
||||
| Sort Title | `sort_title` | Text to change Sort Title |
|
||||
| Originally Available | `originally_available` | Date to change Originally Available<br>**Format:** YYYY-MM-DD |
|
||||
| Rating | `rating` | Number to change Rating |
|
||||
| Summary | `summary` | Text to change Summary |
|
||||
| URL Poster | `url_poster` | URL of image publicly available on the internet |
|
||||
| File Poster | `file_poster` | Path to image in the file system |
|
||||
|
||||
### Tag Attributes
|
||||
|
||||
You can add `.remove` to any tag attribute to only remove those tags i.e. `writer.remove`.
|
||||
|
||||
You can add `.sync` to any tag attribute to sync all tags vs just appending the new ones i.e. `writer.sync`.
|
||||
|
||||
| Name | Attribute | Allowed Values |
|
||||
| :--- | :--- | :--- |
|
||||
| Writer | `writer` | List or comma-separated text of each Writer Tag |
|
||||
| Director | `director` | List or comma-separated text of each Director Tag |
|
||||
@ -0,0 +1,31 @@
|
||||
You can find items using the features of [MdbList.com](https://mdblist.com/) (MdbList).
|
||||
|
||||
| Name | Attribute | Description | Works with Movies | Works with Shows | Works with Playlists and Custom Sort |
|
||||
|:------------------------------|:---------------|:--------------------------------------------------------------------------|:------------------:|:------------------:|:------------------------------------:|
|
||||
| [MdbList List](#mdblist-list) | `mdblist_list` | Gets every movie/show in a [MdbList List](https://mdblist.com/toplists/). | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
||||
|
||||
## MdbList List
|
||||
Finds every item in a [MdbList List](https://mdblist.com/toplists/).
|
||||
|
||||
The expected input is an MdbList List URL. Multiple values are supported as a list only a comma-separated string will not work.
|
||||
|
||||
The `sync_mode: sync` and `collection_order: custom` Details are recommended since the lists are continuously updated and in a specific order.
|
||||
|
||||
```yaml
|
||||
collections:
|
||||
Top Movies of The Week:
|
||||
mdblist_list: https://mdblist.com/lists/linaspurinis/top-watched-movies-of-the-week
|
||||
collection_order: custom
|
||||
sync_mode: sync
|
||||
```
|
||||
You can also limit the number of items to search for by using the `limit` and `url` parameters under `mdblist_list`.
|
||||
|
||||
```yaml
|
||||
collections:
|
||||
Top 10 Movies of The Week:
|
||||
mdblist_list:
|
||||
url: https://mdblist.com/lists/linaspurinis/top-watched-movies-of-the-week
|
||||
limit: 10
|
||||
collection_order: custom
|
||||
sync_mode: sync
|
||||
```
|
||||
@ -0,0 +1,162 @@
|
||||
You can have the script edit the metadata of Movies by adding them to the `metadata` mapping of a Metadata File.
|
||||
|
||||
An example of multiple metadata edits in a movie library is below:
|
||||
```yaml
|
||||
metadata:
|
||||
Godzilla (1954):
|
||||
title: Godzilla
|
||||
year: 1954
|
||||
content_rating: R
|
||||
Godzilla (1998):
|
||||
title: Godzilla
|
||||
year: 1998
|
||||
sort_title: Godzilla 03
|
||||
content_rating: PG-13
|
||||
Shin Godzilla:
|
||||
sort_title: Godzilla 06
|
||||
content_rating: R
|
||||
Godzilla 1985:
|
||||
content_rating: PG
|
||||
"Godzilla 2000: Millennium":
|
||||
originally_available: 1999-08-18
|
||||
Godzilla Against MechaGodzilla:
|
||||
originally_available: 2002-03-23
|
||||
Godzilla Raids Again:
|
||||
content_rating: G
|
||||
originally_available: 1955-05-21
|
||||
Godzilla vs. Biollante:
|
||||
content_rating: PG
|
||||
Godzilla vs. Destoroyah:
|
||||
content_rating: PG
|
||||
originally_available: 1995-01-19
|
||||
Godzilla vs. Gigan:
|
||||
content_rating: G
|
||||
originally_available: 1972-09-14
|
||||
Godzilla vs. Hedorah:
|
||||
content_rating: G
|
||||
originally_available: 1971-04-01
|
||||
Godzilla vs. King Ghidorah:
|
||||
content_rating: PG
|
||||
originally_available: 1991-04-28
|
||||
Godzilla vs. Mechagodzilla:
|
||||
content_rating: G
|
||||
originally_available: 1974-03-24
|
||||
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
|
||||
Godzilla vs. Mothra:
|
||||
content_rating: PG
|
||||
originally_available: 1992-04-28
|
||||
Godzilla vs. SpaceGodzilla:
|
||||
content_rating: PG
|
||||
originally_available: 1994-01-19
|
||||
Godzilla, King of the Monsters!:
|
||||
content_rating: G
|
||||
"Godzilla, Mothra and King Ghidorah: Giant Monsters All-Out Attack":
|
||||
content_rating: PG
|
||||
originally_available: 2001-08-31
|
||||
"Godzilla: Final Wars":
|
||||
content_rating: PG
|
||||
originally_available: 2004-12-13
|
||||
"Godzilla: Tokyo S.O.S.":
|
||||
originally_available: 2003-12-14
|
||||
Halloween (Rob Zombie):
|
||||
alt_title: Halloween
|
||||
year: 2007
|
||||
"Halo 4: Forward Unto Dawn":
|
||||
alt_title: Halo 4 Forward Unto Dawn
|
||||
tmdb_show: 56295
|
||||
content_rating: R
|
||||
```
|
||||
|
||||
## Movies
|
||||
|
||||
Each movie is defined by the mapping name which must be the same as the movie name in the library unless an `alt_title` is specified.
|
||||
|
||||
## Metadata Edits
|
||||
|
||||
The available attributes for editing movies are as follows
|
||||
|
||||
### Special Attributes
|
||||
|
||||
| Name | Attribute | Allowed Values |
|
||||
|:------------------|:-------------|:--------------------------------------------------------------------------------------------------|
|
||||
| Title | `title` | Title if different from the mapping value useful when you have multiple movies with the same name |
|
||||
| Alternative Title | `alt_title` | Alternative title to look for |
|
||||
| Year | `year` | Year of movie for better identification |
|
||||
| TMDb Show ID | `tmdb_show` | TMDb Show ID to use for metadata useful for miniseries that have been compiled into a movie |
|
||||
| TMDb Movie ID | `tmdb_movie` | TMDb Movie ID to use for metadata useful for movies that have been split into segments |
|
||||
|
||||
|
||||
* YAML files cannot have two items with the same mapping name so if you have two movies with the same name you would change the mapping values to whatever you want. Then use the `title` attribute to specify the real title and use the `year` attribute to specify which of the multiple movies to choose.
|
||||
```yaml
|
||||
metadata:
|
||||
Godzilla1:
|
||||
title: Godzilla
|
||||
year: 1954
|
||||
content_rating: R
|
||||
Godzilla2:
|
||||
title: Godzilla
|
||||
year: 1998
|
||||
content_rating: PG-13
|
||||
```
|
||||
|
||||
* If you know of another Title your movie might exist under, but you want it titled differently you can use `alt_title` to specify another title to look under and then be changed to the mapping name. For Example TMDb uses the name `The Legend of Korra`, but I want it as `Avatar: The Legend of Korra` (Which must be surrounded by quotes since it uses the character `:`):
|
||||
```yaml
|
||||
metadata:
|
||||
"Avatar: The Legend of Korra":
|
||||
alt_title: The Legend of Korra
|
||||
```
|
||||
This would change the name of the TMDb default `The Legend of Korra` to `Avatar: The Legend of Korra` and would not mess up any subsequent runs.
|
||||
|
||||
### General Attributes
|
||||
|
||||
| Name | Attribute | Allowed Values |
|
||||
|:---------------------|:-----------------------|:--------------------------------------------------------------|
|
||||
| Sort Title | `sort_title` | Text to change Sort Title |
|
||||
| Original Title | `original_title` | Text to change Original Title |
|
||||
| Originally Available | `originally_available` | Date to change Originally Available<br>**Format:** YYYY-MM-DD |
|
||||
| Content Rating | `content_rating` | Text to change Content Rating |
|
||||
| Rating | `rating` | Number to change Rating |
|
||||
| Studio | `studio` | Text to change Studio |
|
||||
| Tagline | `tagline` | Text to change Tagline |
|
||||
| Summary | `summary` | Text to change Summary |
|
||||
|
||||
### Tag Attributes
|
||||
|
||||
You can add `.remove` to any tag attribute to only remove those tags i.e. `genre.remove`.
|
||||
|
||||
You can add `.sync` to any tag attribute to sync all tags vs just appending the new ones i.e. `genre.sync`.
|
||||
|
||||
| Name | Attribute | Allowed Values |
|
||||
|:-----------|:-------------|:----------------------------------------------------|
|
||||
| Director | `director` | List or comma-separated text of each Director Tag |
|
||||
| Country | `country` | List or comma-separated text of each Country Tag |
|
||||
| Genre | `genre` | List or comma-separated text of each Genre Tag |
|
||||
| Writer | `writer` | List or comma-separated text of each Writer Tag |
|
||||
| Producer | `producer` | List or comma-separated text of each Producer Tag |
|
||||
| Collection | `collection` | List or comma-separated text of each Collection Tag |
|
||||
| Label | `label` | List or comma-separated text of each Label Tag |
|
||||
|
||||
### Advance Attributes
|
||||
|
||||
| Name | Attribute | Allowed Values |
|
||||
|:--------------------|:---------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| Metadata Language* | `metadata_language` | `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` |
|
||||
| Use Original Title* | `use_original_title` | `default`: Library default<br>`no`: No<br>`yes`: Yes |
|
||||
|
||||
\* Must be using the **New Plex Movie Agent*
|
||||
|
||||
## Image Attributes
|
||||
|
||||
| Name | Attribute | Description | Allowed Values |
|
||||
|:----------------|:------------------|:----------------------------------------------------------------------|:------------------------------------------------|
|
||||
| URL Poster | `url_poster` | Used to change the movie's poster to the URL | URL of image publicly available on the internet |
|
||||
| File Poster | `file_poster` | Used to change the movie's poster to the image in the file system | Path to image in the file system |
|
||||
| URL Background | `url_background` | Use to change the movie's background to the URL | URL of image publicly available on the internet |
|
||||
| File Background | `file_background` | Used to change the movie's background to the image in the file system | Path to image in the file system |
|
||||
@ -1,162 +0,0 @@
|
||||
You can have the script edit the metadata of Movies by adding them to the `metadata` mapping of a Metadata File.
|
||||
|
||||
An example of multiple metadata edits in a movie library is below:
|
||||
```yaml
|
||||
metadata:
|
||||
Godzilla (1954):
|
||||
title: Godzilla
|
||||
year: 1954
|
||||
content_rating: R
|
||||
Godzilla (1998):
|
||||
title: Godzilla
|
||||
year: 1998
|
||||
sort_title: Godzilla 03
|
||||
content_rating: PG-13
|
||||
Shin Godzilla:
|
||||
sort_title: Godzilla 06
|
||||
content_rating: R
|
||||
Godzilla 1985:
|
||||
content_rating: PG
|
||||
"Godzilla 2000: Millennium":
|
||||
originally_available: 1999-08-18
|
||||
Godzilla Against MechaGodzilla:
|
||||
originally_available: 2002-03-23
|
||||
Godzilla Raids Again:
|
||||
content_rating: G
|
||||
originally_available: 1955-05-21
|
||||
Godzilla vs. Biollante:
|
||||
content_rating: PG
|
||||
Godzilla vs. Destoroyah:
|
||||
content_rating: PG
|
||||
originally_available: 1995-01-19
|
||||
Godzilla vs. Gigan:
|
||||
content_rating: G
|
||||
originally_available: 1972-09-14
|
||||
Godzilla vs. Hedorah:
|
||||
content_rating: G
|
||||
originally_available: 1971-04-01
|
||||
Godzilla vs. King Ghidorah:
|
||||
content_rating: PG
|
||||
originally_available: 1991-04-28
|
||||
Godzilla vs. Mechagodzilla:
|
||||
content_rating: G
|
||||
originally_available: 1974-03-24
|
||||
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
|
||||
Godzilla vs. Mothra:
|
||||
content_rating: PG
|
||||
originally_available: 1992-04-28
|
||||
Godzilla vs. SpaceGodzilla:
|
||||
content_rating: PG
|
||||
originally_available: 1994-01-19
|
||||
Godzilla, King of the Monsters!:
|
||||
content_rating: G
|
||||
"Godzilla, Mothra and King Ghidorah: Giant Monsters All-Out Attack":
|
||||
content_rating: PG
|
||||
originally_available: 2001-08-31
|
||||
"Godzilla: Final Wars":
|
||||
content_rating: PG
|
||||
originally_available: 2004-12-13
|
||||
"Godzilla: Tokyo S.O.S.":
|
||||
originally_available: 2003-12-14
|
||||
Halloween (Rob Zombie):
|
||||
alt_title: Halloween
|
||||
year: 2007
|
||||
"Halo 4: Forward Unto Dawn":
|
||||
alt_title: Halo 4 Forward Unto Dawn
|
||||
tmdb_show: 56295
|
||||
content_rating: R
|
||||
```
|
||||
|
||||
## Movies
|
||||
|
||||
Each movie is defined by the mapping name which must be the same as the movie name in the library unless an `alt_title` is specified.
|
||||
|
||||
## Metadata Edits
|
||||
|
||||
The available attributes for editing movies are as follows
|
||||
|
||||
### Special Attributes
|
||||
|
||||
| Name | Attribute | Allowed Values |
|
||||
| :--- | :--- | :--- |
|
||||
| Title | `title` | Title if different from the mapping value useful when you have multiple movies with the same name |
|
||||
| Alternative Title | `alt_title` | Alternative title to look for |
|
||||
| Year | `year` | Year of movie for better identification |
|
||||
| TMDb Show ID | `tmdb_show` | TMDb Show ID to use for metadata useful for miniseries that have been compiled into a movie |
|
||||
| TMDb Movie ID | `tmdb_movie` | TMDb Movie ID to use for metadata useful for movies that have been split into segments |
|
||||
|
||||
|
||||
* YAML files cannot have two items with the same mapping name so if you have two movies with the same name you would change the mapping values to whatever you want. Then use the `title` attribute to specify the real title and use the `year` attribute to specify which of the multiple movies to choose.
|
||||
```yaml
|
||||
metadata:
|
||||
Godzilla1:
|
||||
title: Godzilla
|
||||
year: 1954
|
||||
content_rating: R
|
||||
Godzilla2:
|
||||
title: Godzilla
|
||||
year: 1998
|
||||
content_rating: PG-13
|
||||
```
|
||||
|
||||
* If you know of another Title your movie might exist under, but you want it titled differently you can use `alt_title` to specify another title to look under and then be changed to the mapping name. For Example TMDb uses the name `The Legend of Korra`, but I want it as `Avatar: The Legend of Korra` (Which must be surrounded by quotes since it uses the character `:`):
|
||||
```yaml
|
||||
metadata:
|
||||
"Avatar: The Legend of Korra":
|
||||
alt_title: The Legend of Korra
|
||||
```
|
||||
This would change the name of the TMDb default `The Legend of Korra` to `Avatar: The Legend of Korra` and would not mess up any subsequent runs.
|
||||
|
||||
### General Attributes
|
||||
|
||||
| Name | Attribute | Allowed Values |
|
||||
| :--- | :--- | :--- |
|
||||
| Sort Title | `sort_title` | Text to change Sort Title |
|
||||
| Original Title | `original_title` | Text to change Original Title |
|
||||
| Originally Available | `originally_available` | Date to change Originally Available<br>**Format:** YYYY-MM-DD |
|
||||
| Content Rating | `content_rating` | Text to change Content Rating |
|
||||
| Rating | `rating` | Number to change Rating |
|
||||
| Studio | `studio` | Text to change Studio |
|
||||
| Tagline | `tagline` | Text to change Tagline |
|
||||
| Summary | `summary` | Text to change Summary |
|
||||
|
||||
### Tag Attributes
|
||||
|
||||
You can add `.remove` to any tag attribute to only remove those tags i.e. `genre.remove`.
|
||||
|
||||
You can add `.sync` to any tag attribute to sync all tags vs just appending the new ones i.e. `genre.sync`.
|
||||
|
||||
| Name | Attribute | Allowed Values |
|
||||
| :--- | :--- | :--- |
|
||||
| Director | `director` | List or comma-separated text of each Director Tag |
|
||||
| Country | `country` | List or comma-separated text of each Country Tag |
|
||||
| Genre | `genre` | List or comma-separated text of each Genre Tag |
|
||||
| Writer | `writer` | List or comma-separated text of each Writer Tag |
|
||||
| Producer | `producer` | List or comma-separated text of each Producer Tag |
|
||||
| Collection | `collection` | List or comma-separated text of each Collection Tag |
|
||||
| Label | `label` | List or comma-separated text of each Label Tag |
|
||||
|
||||
### Advance Attributes
|
||||
|
||||
| Name | Attribute | Allowed Values |
|
||||
| :--- | :--- | :--- |
|
||||
| Metadata Language* | `metadata_language` | `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` |
|
||||
| Use Original Title* | `use_original_title` | `default`: Library default<br>`no`: No<br>`yes`: Yes |
|
||||
|
||||
\* Must be using the **New Plex Movie Agent*
|
||||
|
||||
## Image Attributes
|
||||
|
||||
| Name | Attribute | Description | Allowed Values |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| URL Poster | `url_poster` | Used to change the movie's poster to the URL | URL of image publicly available on the internet |
|
||||
| File Poster | `file_poster` | Used to change the movie's poster to the image in the file system | Path to image in the file system |
|
||||
| URL Background | `url_background` | Use to change the movie's background to the URL | URL of image publicly available on the internet |
|
||||
| File Background | `file_background` | Used to change the movie's background to the image in the file system | Path to image in the file system |
|
||||
@ -0,0 +1,107 @@
|
||||
You can have the script edit the metadata of Artists, Albums, and Tracks by adding them to the `metadata` mapping of a Metadata File.
|
||||
|
||||
An example of multiple metadata edits in a music library is below:
|
||||
```yaml
|
||||
metadata:
|
||||
"Linkin Park":
|
||||
country: "United States of America"
|
||||
album_sorting: newest
|
||||
albums:
|
||||
"Hybrid Theory":
|
||||
originally_available: "2000-10-24"
|
||||
tracks:
|
||||
1:
|
||||
rating: 5
|
||||
"One Step Closer":
|
||||
rating: 5
|
||||
"Meteora":
|
||||
originally_available: "2003-03-25"
|
||||
album_sorting: newest
|
||||
tracks:
|
||||
9:
|
||||
rating: 5
|
||||
"Numb":
|
||||
rating: 5
|
||||
"Minutes To Midnight":
|
||||
originally_available: "2007-05-14"
|
||||
```
|
||||
|
||||
## Artist
|
||||
|
||||
Each artist is defined by the mapping name which must be the same as the artist name in the library unless an `alt_title` is specified.
|
||||
|
||||
### Albums
|
||||
To edit the metadata of a particular Album for an Artist use the `albums` attribute on its artist.
|
||||
|
||||
The mapping name is the album name.
|
||||
|
||||
### Tracks
|
||||
To edit the metadata of a particular Track on an Album use the `tracks` attribute on its album.
|
||||
|
||||
The mapping name is the track number in that Album or the title of the Track.
|
||||
|
||||
## Metadata Edits
|
||||
|
||||
The available attributes for editing artists, albums, and tracks are as follows
|
||||
|
||||
### Special Attributes
|
||||
|
||||
| Name | Attribute | Allowed Values | Artists | Album | Tracks |
|
||||
|:------------------|:------------|:------------------------------|:------------------:|:------------------:|:------------------:|
|
||||
| Alternative Title | `alt_title` | Alternative title to look for | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
||||
| Albums | `albums` | Mapping to define Albums | :heavy_check_mark: | :x: | :x: |
|
||||
| Tracks | `tracks` | Mapping to define Tracks | :x: | :heavy_check_mark: | :x: |
|
||||
|
||||
* If you know of another Title your item might exist under, but you want it titled differently you can use `alt_title` to specify another title to look under and then be changed to the mapping name. For Example the Artist `Kesha` used to be stylized as `Ke$ha`, and might still be found that way in Metadata results.
|
||||
```yaml
|
||||
metadata:
|
||||
"Kesha":
|
||||
alt_title: "Ke$ha"
|
||||
```
|
||||
This would change the name of the default `Ke$ha` to `Kesha` and would not mess up any subsequent runs.
|
||||
``
|
||||
### General Attributes
|
||||
|
||||
| Name | Attribute | Allowed Values | Artists | Album | Tracks |
|
||||
|:---------------------|:-----------------------|:--------------------------------------------------------------|:------------------:|:------------------:|:------------------:|
|
||||
| Sort Title | `sort_title` | Text to change Sort Title | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
||||
| Rating | `rating` | Number to change Rating | :x: | :heavy_check_mark: | :heavy_check_mark: |
|
||||
| Originally Available | `originally_available` | Date to change Originally Available<br>**Format:** YYYY-MM-DD | :x: | :heavy_check_mark: | :x: |
|
||||
| Record Label | `record_label` | Text to change Record Label | :x: | :heavy_check_mark: | :x: |
|
||||
| Summary | `summary` | Text to change Summary | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
||||
| Track | `track` | Text to change Track | :x: | :x: | :heavy_check_mark: |
|
||||
| Disc | `disc` | Text to change Disc | :x: | :x: | :heavy_check_mark: |
|
||||
| Original Artist | `original_artist` | Text to change Original Artist | :x: | :x: | :heavy_check_mark: |
|
||||
|
||||
### Tag Attributes
|
||||
|
||||
You can add `.remove` to any tag attribute to only remove those tags i.e. `genre.remove`.
|
||||
|
||||
You can add `.sync` to any tag attribute to sync all tags vs just appending the new ones i.e. `genre.sync`.
|
||||
|
||||
| Name | Attribute | Allowed Values | Artists | Album | Tracks |
|
||||
|:---------------|:-----------------|:--------------------------------------------------------|:------------------:|:------------------:|:------------------:|
|
||||
| Genre | `genre` | List or comma-separated text of each Genre Tag | :heavy_check_mark: | :heavy_check_mark: | :x: |
|
||||
| Collection | `collection` | List or comma-separated text of each Collection Tag | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
||||
| Label | `label` | List or comma-separated text of each Label Tag | :x: | :heavy_check_mark: | :x: |
|
||||
| Style | `style` | List or comma-separated text of each Style Tag | :heavy_check_mark: | :heavy_check_mark: | :x: |
|
||||
| Mood | `mood` | List or comma-separated text of each Mood Tag | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
||||
| Country | `country` | List or comma-separated text of each Country Tag | :heavy_check_mark: | :x: | :x: |
|
||||
| Similar Artist | `similar_artist` | List or comma-separated text of each Similar Artist Tag | :heavy_check_mark: | :x: | :x: |
|
||||
|
||||
## Image Attributes
|
||||
|
||||
| Name | Attribute | Description | Allowed Values | Artists | Album | Tracks |
|
||||
|:----------------|:------------------|:---------------------------------------------------------------------|:------------------------------------------------|:------------------:|:------------------:|:------:|
|
||||
| URL Poster | `url_poster` | Used to change the item's poster to the URL | URL of image publicly available on the internet | :heavy_check_mark: | :heavy_check_mark: | :x: |
|
||||
| File Poster | `file_poster` | Used to change the item's poster to the image in the file system | Path to image in the file system | :heavy_check_mark: | :heavy_check_mark: | :x: |
|
||||
| URL Background | `url_background` | Use to change the item's background to the URL | URL of image publicly available on the internet | :heavy_check_mark: | :heavy_check_mark: | :x: |
|
||||
| File Background | `file_background` | Used to change the item's background to the image in the file system | Path to image in the file system | :heavy_check_mark: | :heavy_check_mark: | :x: |
|
||||
|
||||
### Advance Attributes
|
||||
|
||||
All these attributes only work with Artists.
|
||||
|
||||
| Name | Attribute | Allowed Values |
|
||||
|:--------------|:----------------|:-------------------------------------------------------------------------------------------------------|
|
||||
| Album Sorting | `album_sorting` | `default`: Library default<br>`oldest`: Oldest first<br>`newest`: Newest first<br>`name`: Alphabetical |
|
||||
@ -1,27 +1,28 @@
|
||||
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/playlist. | [`template` mapping details](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Templates) | :heavy_check_mark: |
|
||||
| Run Again | `run_again` | Used to try and add all the missing items to the collection/playlist again after the daily run <br>**Default Mode:** `false`| **boolean:** `true` or `false` | :heavy_check_mark: |
|
||||
| Sync Mode | `sync_mode` | Used to change how builders sync with this collection/playlist<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: |
|
||||
| Minimum Items | `minimum_items` | Minimum items that must be found to add to a collection/playlist.<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/playlist 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/playlist 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/playlist 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/Playlist 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/Playlist 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/Playlist 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/Playlist 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/Playlist 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/Playlist 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/Playlist 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/Run-Commands-&-Environmental-Variables#run-tests)) only collections/playlists with `test: true` will be run<br>**Default:** `false` | **boolean:** `true` or `false` | :heavy_check_mark: |
|
||||
| Changes Webhooks | `changes_webhooks` | Used to specify a collection/playlist changes webhook for just this collection/playlist. | List of webhooks | :heavy_check_mark: |
|
||||
| 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/playlist. | [`template` mapping details](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Templates) | :heavy_check_mark: |
|
||||
| Run Again | `run_again` | Used to try and add all the missing items to the collection/playlist again after the daily run <br>**Default Mode:** `false` | **boolean:** `true` or `false` | :heavy_check_mark: |
|
||||
| Sync Mode | `sync_mode` | Used to change how builders sync with this collection/playlist<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: |
|
||||
| Minimum Items | `minimum_items` | Minimum items that must be found to add to a collection/playlist.<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/playlist 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/playlist 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/playlist 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/Playlist 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/Playlist 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/Playlist 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/Playlist 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/Playlist 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/Playlist 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/Playlist 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: |
|
||||
| Custom Repo | `custom_repo` | Defines the custom repo you use with the `repo` attribute when defining metadata_paths and playlist_files<br>**Default:** Nothing | Repo Location | :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/Run-Commands-&-Environmental-Variables#run-tests)) only collections/playlists with `test: true` will be run<br>**Default:** `false` | **boolean:** `true` or `false` | :heavy_check_mark: |
|
||||
| Changes Webhooks | `changes_webhooks` | Used to specify a collection/playlist changes webhook for just this collection/playlist. | List of webhooks | :heavy_check_mark: |
|
||||
|
||||
* **Name Mapping:** If your collection/playlist 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,159 +0,0 @@
|
||||
You can have the script edit the metadata of Shows, Seasons, and Episodes by adding them to the `metadata` mapping of a Metadata File.
|
||||
|
||||
An example of multiple metadata edits in a show library is below:
|
||||
```yaml
|
||||
metadata:
|
||||
"Avatar: The Last Airbender":
|
||||
sort_title: Avatar 01
|
||||
seasons:
|
||||
1:
|
||||
title: "Book One: Water"
|
||||
summary: >-
|
||||
After a lapse of 100 years, the Avatar-spiritual master of the elements-has returned. And just in
|
||||
the nick of time. The Four Nations (Water, Earth, Fire, and Air) have become unbalanced. The Fire
|
||||
Nation wants to rule the world, and its first conquest will be the Northern Water Tribe. It's up to
|
||||
a 12-year-old Airbender named Aang to find a way to stop it. Join Aang, Katara, Sokka, Momo, and
|
||||
Appa as they head north on the adventure of a lifetime.
|
||||
episodes:
|
||||
1:
|
||||
rating: 9.1
|
||||
2:
|
||||
title: "Book Two: Earth"
|
||||
summary: >-
|
||||
Avatar Aang continues his quest to master the four elements before the end of summer. Together with
|
||||
Katara, Sokka, Momo, and Appa, he journeys across the Earth Kingdom in search of an Earthbending
|
||||
mentor. Along the way, he confronts Princess Azula, treacherous daughter of Firelord Ozai and
|
||||
sister to Prince Zuko. More powerful than her brother, Azula will stop nothing to defeat the Avatar.
|
||||
But Aang and the gang find plenty of Earth Kingdom allies to help them along the way. From the swamps
|
||||
of the South to the Earth King's palace, Avatar: Book 2 is an adventure like no other.
|
||||
3:
|
||||
title: "Book Three: Fire"
|
||||
summary: >-
|
||||
Having survived the terrible battle with Azula, Aang faces new challenges as he and his brave
|
||||
friends secretly enter the Fire Nation. Their quest is to find and defeat Firelord Ozai. Along
|
||||
the way, they discover that Ozai has plans of his own. The leader of the Fire Nation intends to
|
||||
use the massive power of Sozin's comet to spread his dominion permanently across the four nations.
|
||||
Short on time, Aang has a lot of bending to learn and no master to help him learn it. However, his
|
||||
friends are there to help, and he finds unexpected allies deep in the heart of the Fire Nation. In
|
||||
the spectacular four-part conclusion, Aang must fulfill his destiny and become a fully realized
|
||||
Avatar, or watch the world go up in smoke.
|
||||
episodes:
|
||||
21:
|
||||
summary: The Epic Series Final of Avatar The Last Airbender
|
||||
"Avatar: The Legend of Korra":
|
||||
sort_title: Avatar 02
|
||||
alt_title: The Legend of Korra
|
||||
original_title: The Legend of Korra
|
||||
seasons:
|
||||
1:
|
||||
title: "Book One: Air"
|
||||
2:
|
||||
title: "Book Two: Spirits"
|
||||
3:
|
||||
title: "Book Three: Change"
|
||||
4:
|
||||
title: "Book Four: Balance"
|
||||
```
|
||||
|
||||
## Shows
|
||||
|
||||
Each show is defined by the mapping name which must be the same as the show name in the library unless an `alt_title` is specified.
|
||||
|
||||
### Seasons
|
||||
To edit the metadata of a particular Season in a Show use the `seasons` attribute on its show.
|
||||
|
||||
The mapping name is the season number (use 0 for specials) or the season name.
|
||||
|
||||
### Episodes
|
||||
To edit the metadata of a particular Episode in a Season use the `episodes` attribute on its season.
|
||||
|
||||
The mapping name is the episode number in that season or the title of the episode.
|
||||
|
||||
## Metadata Edits
|
||||
|
||||
The available attributes for editing shows, seasons, and episodes are as follows
|
||||
|
||||
### Special Attributes
|
||||
|
||||
| Name | Attribute | Allowed Values | Shows | Seasons | Episodes |
|
||||
| :--- | :--- | :--- | :---: | :---: | :---: |
|
||||
| Title | `title` | Title if different from the mapping value useful when you have multiple shows with the same name | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
||||
| Alternative Title | `alt_title` | Alternative title to look for | :heavy_check_mark: | :x: | :x: |
|
||||
| Year | `year` | Year of show for better identification | :heavy_check_mark: | :x: | :x: |
|
||||
| TMDb Show ID | `tmdb_show` | TMDb Show ID to use for metadata useful for miniseries that have been compiled into a movie | :heavy_check_mark: | :x: | :x: |
|
||||
| TMDb Movie ID | `tmdb_movie` | TMDb Movie ID to use for metadata useful for movies that have been split into segments | :heavy_check_mark: | :x: | :x: |
|
||||
| Seasons | `seasons` | Mapping to define Seasons | :heavy_check_mark: | :x: | :x: |
|
||||
| Episodes | `episodes` | Mapping to define Episodes | :x: | :heavy_check_mark: | :x: |
|
||||
|
||||
* YAML files cannot have two items with the same mapping name so if you have two shows with the same name you would change the mapping values to whatever you want. Then use the `title` attribute to specify the real title and use the `year` attribute to specify which of the multiple shows to choose.
|
||||
```yaml
|
||||
metadata:
|
||||
Godzilla1:
|
||||
title: Godzilla
|
||||
year: 1954
|
||||
content_rating: R
|
||||
Godzilla2:
|
||||
title: Godzilla
|
||||
year: 1998
|
||||
content_rating: PG-13
|
||||
```
|
||||
|
||||
* If you know of another Title your show might exist under, but you want it titled differently you can use `alt_title` to specify another title to look under and then be changed to the mapping name. For Example TMDb uses the name `The Legend of Korra`, but I want it as `Avatar: The Legend of Korra` (Which must be surrounded by quotes since it uses the character `:`):
|
||||
```yaml
|
||||
metadata:
|
||||
"Avatar: The Legend of Korra":
|
||||
alt_title: The Legend of Korra
|
||||
```
|
||||
This would change the name of the TMDb default `The Legend of Korra` to `Avatar: The Legend of Korra` and would not mess up any subsequent runs.
|
||||
|
||||
### General Attributes
|
||||
|
||||
| Name | Attribute | Allowed Values | Shows | Seasons | Episodes |
|
||||
| :--- | :--- | :--- | :---: | :---: | :---: |
|
||||
| Sort Title | `sort_title` | Text to change Sort Title | :heavy_check_mark: | :x: | :heavy_check_mark: |
|
||||
| Original Title | `original_title` | Text to change Original Title | :heavy_check_mark: | :x: | :heavy_check_mark: |
|
||||
| Originally Available | `originally_available` | Date to change Originally Available<br>**Format:** YYYY-MM-DD | :heavy_check_mark: | :x: | :heavy_check_mark: |
|
||||
| Content Rating | `content_rating` | Text to change Content Rating | :heavy_check_mark: | :x: | :x: |
|
||||
| Rating | `rating` | Number to change Rating | :heavy_check_mark:| :x: | :heavy_check_mark: |
|
||||
| Studio | `studio` | Text to change Studio | :heavy_check_mark: | :x: | :x: |
|
||||
| Tagline | `tagline` | Text to change Tagline | :heavy_check_mark:| :x: | :x: |
|
||||
| Summary | `summary` | Text to change Summary | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
||||
|
||||
### Tag Attributes
|
||||
|
||||
You can add `.remove` to any tag attribute to only remove those tags i.e. `genre.remove`.
|
||||
|
||||
You can add `.sync` to any tag attribute to sync all tags vs just appending the new ones i.e. `genre.sync`.
|
||||
|
||||
| Name | Attribute | Allowed Values | Shows | Seasons | Episodes |
|
||||
| :--- | :--- | :--- | :---: | :---: | :---: |
|
||||
| Director | `director` | List or comma-separated text of each Director Tag | :x: | :x: | :heavy_check_mark: |
|
||||
| Genre | `genre` | List or comma-separated text of each Genre Tag | :heavy_check_mark: | :x: | :x: |
|
||||
| Writer | `writer` | List or comma-separated text of each Writer Tag | :x: | :x: | :heavy_check_mark: |
|
||||
| Collection | `collection` | List or comma-separated text of each Collection Tag | :heavy_check_mark: | :x: | :x: |
|
||||
| Label | `label` | List or comma-separated text of each Label Tag | :heavy_check_mark: | :x: | :x: |
|
||||
|
||||
## Image Attributes
|
||||
|
||||
| Name | Attribute | Description | Allowed Values | Shows | Seasons | Episodes |
|
||||
| :--- | :--- | :--- | :--- | :---: | :---: | :---: |
|
||||
| URL Poster | `url_poster` | Used to change the show's poster to the URL | URL of image publicly available on the internet | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
||||
| File Poster | `file_poster` | Used to change the show's poster to the image in the file system | Path to image in the file system | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
||||
| URL Background | `url_background` | Use to change the show's background to the URL | URL of image publicly available on the internet | :heavy_check_mark: | :heavy_check_mark: | :x: |
|
||||
| File Background | `file_background` | Used to change the show's background to the image in the file system | Path to image in the file system | :heavy_check_mark: | :heavy_check_mark: | :x: |
|
||||
|
||||
### Advance Attributes
|
||||
|
||||
All these attributes only work with Shows.
|
||||
|
||||
| Name | Attribute | Allowed Values |
|
||||
| :--- | :--- | :--- |
|
||||
| Episode Sorting | `episode_sorting` | `default`: Library default<br>`oldest`: Oldest first<br>`newest`: Newest first |
|
||||
| Keep Episodes | `keep_episodes` | `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 |
|
||||
| Delete Episodes | `delete_episodes` | `never`: Never<br>`day`: After a day<br>`week`: After a week<br>`refresh`: On next refresh |
|
||||
| Season Display | `season_display` | `default`: Library default<br>`show`: Show<br>`hide`: Hide |
|
||||
| Episode Ordering | `episode_ordering` | `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) |
|
||||
| Metadata Language* | `metadata_language` | `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` |
|
||||
| Use Original Title* | `use_original_title` | `default`: Library default<br>`no`: No<br>`yes`: Yes |
|
||||
|
||||
\* Must be using the **New Plex TV Agent**
|
||||
@ -0,0 +1,159 @@
|
||||
You can have the script edit the metadata of Shows, Seasons, and Episodes by adding them to the `metadata` mapping of a Metadata File.
|
||||
|
||||
An example of multiple metadata edits in a show library is below:
|
||||
```yaml
|
||||
metadata:
|
||||
"Avatar: The Last Airbender":
|
||||
sort_title: Avatar 01
|
||||
seasons:
|
||||
1:
|
||||
title: "Book One: Water"
|
||||
summary: >-
|
||||
After a lapse of 100 years, the Avatar-spiritual master of the elements-has returned. And just in
|
||||
the nick of time. The Four Nations (Water, Earth, Fire, and Air) have become unbalanced. The Fire
|
||||
Nation wants to rule the world, and its first conquest will be the Northern Water Tribe. It's up to
|
||||
a 12-year-old Airbender named Aang to find a way to stop it. Join Aang, Katara, Sokka, Momo, and
|
||||
Appa as they head north on the adventure of a lifetime.
|
||||
episodes:
|
||||
1:
|
||||
rating: 9.1
|
||||
2:
|
||||
title: "Book Two: Earth"
|
||||
summary: >-
|
||||
Avatar Aang continues his quest to master the four elements before the end of summer. Together with
|
||||
Katara, Sokka, Momo, and Appa, he journeys across the Earth Kingdom in search of an Earthbending
|
||||
mentor. Along the way, he confronts Princess Azula, treacherous daughter of Firelord Ozai and
|
||||
sister to Prince Zuko. More powerful than her brother, Azula will stop nothing to defeat the Avatar.
|
||||
But Aang and the gang find plenty of Earth Kingdom allies to help them along the way. From the swamps
|
||||
of the South to the Earth King's palace, Avatar: Book 2 is an adventure like no other.
|
||||
3:
|
||||
title: "Book Three: Fire"
|
||||
summary: >-
|
||||
Having survived the terrible battle with Azula, Aang faces new challenges as he and his brave
|
||||
friends secretly enter the Fire Nation. Their quest is to find and defeat Firelord Ozai. Along
|
||||
the way, they discover that Ozai has plans of his own. The leader of the Fire Nation intends to
|
||||
use the massive power of Sozin's comet to spread his dominion permanently across the four nations.
|
||||
Short on time, Aang has a lot of bending to learn and no master to help him learn it. However, his
|
||||
friends are there to help, and he finds unexpected allies deep in the heart of the Fire Nation. In
|
||||
the spectacular four-part conclusion, Aang must fulfill his destiny and become a fully realized
|
||||
Avatar, or watch the world go up in smoke.
|
||||
episodes:
|
||||
21:
|
||||
summary: The Epic Series Final of Avatar The Last Airbender
|
||||
"Avatar: The Legend of Korra":
|
||||
sort_title: Avatar 02
|
||||
alt_title: The Legend of Korra
|
||||
original_title: The Legend of Korra
|
||||
seasons:
|
||||
1:
|
||||
title: "Book One: Air"
|
||||
2:
|
||||
title: "Book Two: Spirits"
|
||||
3:
|
||||
title: "Book Three: Change"
|
||||
4:
|
||||
title: "Book Four: Balance"
|
||||
```
|
||||
|
||||
## Shows
|
||||
|
||||
Each show is defined by the mapping name which must be the same as the show name in the library unless an `alt_title` is specified.
|
||||
|
||||
### Seasons
|
||||
To edit the metadata of a particular Season in a Show use the `seasons` attribute on its show.
|
||||
|
||||
The mapping name is the season number (use 0 for specials) or the season name.
|
||||
|
||||
### Episodes
|
||||
To edit the metadata of a particular Episode in a Season use the `episodes` attribute on its season.
|
||||
|
||||
The mapping name is the episode number in that season or the title of the episode.
|
||||
|
||||
## Metadata Edits
|
||||
|
||||
The available attributes for editing shows, seasons, and episodes are as follows
|
||||
|
||||
### Special Attributes
|
||||
|
||||
| Name | Attribute | Allowed Values | Shows | Seasons | Episodes |
|
||||
|:------------------|:-------------|:-------------------------------------------------------------------------------------------------|:------------------:|:------------------:|:------------------:|
|
||||
| Title | `title` | Title if different from the mapping value useful when you have multiple shows with the same name | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
||||
| Alternative Title | `alt_title` | Alternative title to look for | :heavy_check_mark: | :x: | :x: |
|
||||
| Year | `year` | Year of show for better identification | :heavy_check_mark: | :x: | :x: |
|
||||
| TMDb Show ID | `tmdb_show` | TMDb Show ID to use for metadata useful for miniseries that have been compiled into a movie | :heavy_check_mark: | :x: | :x: |
|
||||
| TMDb Movie ID | `tmdb_movie` | TMDb Movie ID to use for metadata useful for movies that have been split into segments | :heavy_check_mark: | :x: | :x: |
|
||||
| Seasons | `seasons` | Mapping to define Seasons | :heavy_check_mark: | :x: | :x: |
|
||||
| Episodes | `episodes` | Mapping to define Episodes | :x: | :heavy_check_mark: | :x: |
|
||||
|
||||
* YAML files cannot have two items with the same mapping name so if you have two shows with the same name you would change the mapping values to whatever you want. Then use the `title` attribute to specify the real title and use the `year` attribute to specify which of the multiple shows to choose.
|
||||
```yaml
|
||||
metadata:
|
||||
Godzilla1:
|
||||
title: Godzilla
|
||||
year: 1954
|
||||
content_rating: R
|
||||
Godzilla2:
|
||||
title: Godzilla
|
||||
year: 1998
|
||||
content_rating: PG-13
|
||||
```
|
||||
|
||||
* If you know of another Title your show might exist under, but you want it titled differently you can use `alt_title` to specify another title to look under and then be changed to the mapping name. For Example TMDb uses the name `The Legend of Korra`, but I want it as `Avatar: The Legend of Korra` (Which must be surrounded by quotes since it uses the character `:`):
|
||||
```yaml
|
||||
metadata:
|
||||
"Avatar: The Legend of Korra":
|
||||
alt_title: The Legend of Korra
|
||||
```
|
||||
This would change the name of the TMDb default `The Legend of Korra` to `Avatar: The Legend of Korra` and would not mess up any subsequent runs.
|
||||
|
||||
### General Attributes
|
||||
|
||||
| Name | Attribute | Allowed Values | Shows | Seasons | Episodes |
|
||||
|:---------------------|:-----------------------|:--------------------------------------------------------------|:------------------:|:------------------:|:------------------:|
|
||||
| Sort Title | `sort_title` | Text to change Sort Title | :heavy_check_mark: | :x: | :heavy_check_mark: |
|
||||
| Original Title | `original_title` | Text to change Original Title | :heavy_check_mark: | :x: | :heavy_check_mark: |
|
||||
| Originally Available | `originally_available` | Date to change Originally Available<br>**Format:** YYYY-MM-DD | :heavy_check_mark: | :x: | :heavy_check_mark: |
|
||||
| Content Rating | `content_rating` | Text to change Content Rating | :heavy_check_mark: | :x: | :x: |
|
||||
| Rating | `rating` | Number to change Rating | :heavy_check_mark: | :x: | :heavy_check_mark: |
|
||||
| Studio | `studio` | Text to change Studio | :heavy_check_mark: | :x: | :x: |
|
||||
| Tagline | `tagline` | Text to change Tagline | :heavy_check_mark: | :x: | :x: |
|
||||
| Summary | `summary` | Text to change Summary | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
||||
|
||||
### Tag Attributes
|
||||
|
||||
You can add `.remove` to any tag attribute to only remove those tags i.e. `genre.remove`.
|
||||
|
||||
You can add `.sync` to any tag attribute to sync all tags vs just appending the new ones i.e. `genre.sync`.
|
||||
|
||||
| Name | Attribute | Allowed Values | Shows | Seasons | Episodes |
|
||||
|:-----------|:-------------|:----------------------------------------------------|:------------------:|:-------:|:------------------:|
|
||||
| Director | `director` | List or comma-separated text of each Director Tag | :x: | :x: | :heavy_check_mark: |
|
||||
| Genre | `genre` | List or comma-separated text of each Genre Tag | :heavy_check_mark: | :x: | :x: |
|
||||
| Writer | `writer` | List or comma-separated text of each Writer Tag | :x: | :x: | :heavy_check_mark: |
|
||||
| Collection | `collection` | List or comma-separated text of each Collection Tag | :heavy_check_mark: | :x: | :x: |
|
||||
| Label | `label` | List or comma-separated text of each Label Tag | :heavy_check_mark: | :x: | :x: |
|
||||
|
||||
## Image Attributes
|
||||
|
||||
| Name | Attribute | Description | Allowed Values | Shows | Seasons | Episodes |
|
||||
|:----------------|:------------------|:---------------------------------------------------------------------|:------------------------------------------------|:------------------:|:------------------:|:------------------:|
|
||||
| URL Poster | `url_poster` | Used to change the show's poster to the URL | URL of image publicly available on the internet | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
||||
| File Poster | `file_poster` | Used to change the show's poster to the image in the file system | Path to image in the file system | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
||||
| URL Background | `url_background` | Use to change the show's background to the URL | URL of image publicly available on the internet | :heavy_check_mark: | :heavy_check_mark: | :x: |
|
||||
| File Background | `file_background` | Used to change the show's background to the image in the file system | Path to image in the file system | :heavy_check_mark: | :heavy_check_mark: | :x: |
|
||||
|
||||
### Advance Attributes
|
||||
|
||||
All these attributes only work with Shows.
|
||||
|
||||
| Name | Attribute | Allowed Values |
|
||||
|:--------------------|:---------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| Episode Sorting | `episode_sorting` | `default`: Library default<br>`oldest`: Oldest first<br>`newest`: Newest first |
|
||||
| Keep Episodes | `keep_episodes` | `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 |
|
||||
| Delete Episodes | `delete_episodes` | `never`: Never<br>`day`: After a day<br>`week`: After a week<br>`refresh`: On next refresh |
|
||||
| Season Display | `season_display` | `default`: Library default<br>`show`: Show<br>`hide`: Hide |
|
||||
| Episode Ordering | `episode_ordering` | `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) |
|
||||
| Metadata Language* | `metadata_language` | `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` |
|
||||
| Use Original Title* | `use_original_title` | `default`: Library default<br>`no`: No<br>`yes`: Yes |
|
||||
|
||||
\* Must be using the **New Plex TV Agent**
|
||||
Loading…
Reference in new issue