Plex
/
Plex-Meta-Manager
mirror of https://github.com/meisnate12/Plex-Meta-Manager.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

wiki fixes

master
meisnate12 2 years ago
parent d7b91c29dc
commit 8adf2bbe88
6 changed files with 42 additions and 40 deletions
Show Stats Download Patch File Download Diff File

12
Filters.md
Unescape

@ -117,12 +117,12 @@ The `tmdb_vote_count` and `tmdb_year` filters will also filter out movies/shows
### Modifier
| Number Modifier | Description | Format |
|:----------------|:----------------------------------------------------------------------------------------------|:-------------------------------------------------:|
| `.gt` | Matches every item where the number attribute<br>is greater then the given number | **Format:** number<br>e.g. `30`, `1995`, or `7.5` |
| `.gte` | Matches every item where the number attribute<br>is greater then or equal to the given number | **Format:** number<br>e.g. `30`, `1995`, or `7.5` |
| `.lt` | Matches every item where the number attribute<br>is less then the given number | **Format:** number<br>e.g. `30`, `1995`, or `7.5` |
| `.lte` | Matches every item where the number attribute<br>is less then or equal to the given number | **Format:** number<br>e.g. `30`, `1995`, or `7.5` |
| Number Modifier | Description | Format |
|:----------------|:-------------------------------------------------------------------------------------------|:-------------------------------------------------:|
| `.gt` | Matches every item where the number attribute is greater then the given number | **Format:** number<br>e.g. `30`, `1995`, or `7.5` |
| `.gte` | Matches every item where the number attribute is greater then or equal to the given number | **Format:** number<br>e.g. `30`, `1995`, or `7.5` |
| `.lt` | Matches every item where the number attribute is less then the given number | **Format:** number<br>e.g. `30`, `1995`, or `7.5` |
| `.lte` | Matches every item where the number attribute is less then or equal to the given number | **Format:** number<br>e.g. `30`, `1995`, or `7.5` |
### Attribute

32
Libraries-Attributes.md
Unescape

@ -57,16 +57,17 @@ radarr:
The available attributes for each library are as follows
| Name | Attribute | Allowed Values | Default | Required |
|:--------------------------------|:----------------|:-----------------------------------------------------------------------------------------------------------|:----------------------------------:|:------------------------------------------:|
| [Library Name](#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) | `metadata_path` | Location for your Metadata YAML files | Same directory as config YAML file | :x: |
| Operations Mapping | `operations` | [`operations` mapping details](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Operations-Attributes) | N/A | :x: |
| Settings Mapping | `settings` | [`settings` mapping details](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | global | :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 |
| Radarr Mapping | `radarr` | [`radarr` mapping details](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Radarr-Attributes) | global | :x: |
| Sonarr Mapping | `sonarr` | [`sonarr` mapping details](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Sonarr-Attributes) | global | :x: |
| Tautulli Mapping | `tautulli` | [`tautulli` mapping details](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Tautulli-Attributes) | global | :x: |
| Name | Attribute | Allowed Values | Default | Required |
|:--------------------------------|:----------------|:-----------------------------------------------------------------------------------------------------------|:--------------------------------------:|:------------------------------------------:|
| [Library Name](#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) | `metadata_path` | Location for your Metadata YAML files | `/config/<<MAPPING_NAME>>.yml` | :x: |
| [Missing Path](#missing-path) | `missing_path` | Path to missing YAML file for the library | `/config/<<MAPPING_NAME>>_missing.yml` | :x: |
| Operations Mapping | `operations` | [`operations` mapping details](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Operations-Attributes) | N/A | :x: |
| Settings Mapping | `settings` | [`settings` mapping details](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Settings-Attributes) | global | :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 |
| Radarr Mapping | `radarr` | [`radarr` mapping details](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Radarr-Attributes) | global | :x: |
| Sonarr Mapping | `sonarr` | [`sonarr` mapping details](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Sonarr-Attributes) | global | :x: |
| Tautulli Mapping | `tautulli` | [`tautulli` mapping details](https://github.com/meisnate12/Plex-Meta-Manager/wiki/Tautulli-Attributes) | global | :x: |
* Library mappings must have a colon `:` placed after them
@ -145,4 +146,13 @@ libraries:
- url: http://somesite.com/people_collections.yml
- git: meisnate12/Charts
- git: meisnate12/Studios
```
```
## Missing Path
Path where to save the missing YAML File. Default is `/config/<<MAPPING_NAME>>_missing.yml` where `<<MAPPING_NAME>>` is the mapping name for the library.
```yaml
libraries:
Movies:
missing_path: /config/Missing/Movies.yml
```

4
Movie-Library-Metadata.md
Unescape

@ -122,7 +122,9 @@ The available attributes for editing movies are as follows
| 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 |
| User Rating | `user_rating` | Number to change User Rating |
| Audience Rating | `audience_rating` | Number to change Audience Rating |
| Critic Rating | `critic_rating` | Number to change Critic Rating |
| Studio | `studio` | Text to change Studio |
| Tagline | `tagline` | Text to change Tagline |
| Summary | `summary` | Text to change Summary |

14
Music-Library-Metadata.md
Unescape

@ -11,23 +11,22 @@ metadata:
originally_available: "2000-10-24"
tracks:
1:
rating: 5
user_rating: 5
"One Step Closer":
rating: 5
user_rating: 5
"Meteora":
originally_available: "2003-03-25"
album_sorting: newest
tracks:
9:
rating: 5
user_rating: 5
"Numb":
rating: 5
user_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
@ -41,7 +40,6 @@ To edit the metadata of a particular Track on an Album use the `tracks` attribut
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
@ -64,8 +62,10 @@ The available attributes for editing artists, albums, and tracks are as follows
| Name | Attribute | Allowed Values | Artists | Album | Tracks |
|:---------------------|:-----------------------|:--------------------------------------------------------------|:------------------:|:------------------:|:------------------:|
| Title | `title` | Text to change Title | :x: | :x: | :heavy_check_mark: |
| 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: |
| User Rating | `user_rating` | Number to change User Rating | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| Critic Rating | `critic_rating` | Number to change Critic Rating | :x: | :heavy_check_mark: | :x: |
| 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: |

13
Settings-Attributes.md
Unescape

@ -71,7 +71,6 @@ settings:
| [Playlist Sync to Users](#playlist-sync-to-users) | `playlist_sync_to_users` | `all` or List or comma-separated String of Users to sync the playlist to.<br>**default: `all`** | :heavy_check_mark: | :x: | :heavy_check_mark: |
| [Custom Repo](#custom-repo) | `custom_repo` | Defines the custom repo you use with the `repo` attribute when defining metadata_paths and playlist_files | :heavy_check_mark: | :x: | :x: |
| [Verify SSL](#verify-ssl) | `verify_ssl` | Turn SSL Verification on or off. | :heavy_check_mark: | :x: | :x: |
| [Missing Path](#missing-path) | `missing_path` | Path to missing YAML file for the library | :x: | :heavy_check_mark: | :x: |
## Cache
Will use a cached database for faster processing. The cache file is created in the same location as your config file.
@ -176,15 +175,3 @@ Defines the custom repo you use with the `repo` attribute when defining `metadat
## Verify SSL
Turn SSl Verification on or off.
## Missing Path
Path where to save the missing YAML File. Default is `/config/<<library_name>>_missing.yml` where `<<library_name>>` is your library name.
* This setting can only be set under setting for each particular library.
```yaml
libraries:
Movies:
settings:
missing_path: /config/Missing/Movies.yml
```

7
TV-Show-Library-Metadata.md
Unescape

@ -16,7 +16,7 @@ metadata:
Appa as they head north on the adventure of a lifetime.
episodes:
1:
rating: 9.1
user_rating: 9.1
2:
title: "Book Two: Earth"
summary: >-
@ -110,11 +110,14 @@ The available attributes for editing shows, seasons, and episodes are as follows
| Name | Attribute | Allowed Values | Shows | Seasons | Episodes |
|:---------------------|:-----------------------|:--------------------------------------------------------------|:------------------:|:------------------:|:------------------:|
| Title | `title` | Text to change Title | :x: | :heavy_check_mark: | :heavy_check_mark: |
| 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: |
| User Rating | `user_rating` | Number to change User Rating | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| Audience Rating | `audience_rating` | Number to change Audience Rating | :heavy_check_mark: | :x: | :heavy_check_mark: |
| Critic Rating | `critic_rating` | Number to change Critic 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: |

Write Preview
Loading…
Cancel
Save