meisnate12
3 years ago
parent
2aaf27c0ac
commit
e01787405d
@ -0,0 +1,215 @@
|
||||
# Plex Meta Manager Default Collections & Overlays
|
||||
|
||||
There is a default set of Metadata and Overlay Files located in the [PMM Folder](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/PMM) in the [Plex Meta Manager Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs) Repository.
|
||||
|
||||
The intention of this directory is to offer easy to use and slightly customizable (using [`template_variables`](../../config/paths.md#template-variables)) Metadata and Overlay Files for a general user who wants nice collections but doesn't want to learn all of Plex Meta Manager.
|
||||
|
||||
All posters defined in the Metadata Files are stored in the [Plex Meta Manager Images](https://github.com/meisnate12/Plex-Meta-Manager-Images) Repository and all Overlay images are in the [Configs](https://github.com/meisnate12/Plex-Meta-Manager-Configs) Repository at [PMM/overlays/images](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/sohjiro/PMM/overlays/images), which allows for changes to be made in one central location that will deploy to all users of this setup when they next run PMM.
|
||||
|
||||
Credits to Bullmoose20 and Yozora for helping drive this entire Default Set of Configs through the concept, design and implementation.
|
||||
|
||||
Special thanks to Magic815 for the overlay image inspiration and base template.
|
||||
|
||||
## Configurations
|
||||
|
||||
To run a file in git you can simply add it to your `metadata_path` (For Metadata Files) or `overlay_path` (For Overlay Files) using `git` like so:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- git: PMM/actor
|
||||
- git: PMM/genre
|
||||
overlay_path:
|
||||
- remove_overlays: false
|
||||
- git: PMM/overlays/imdb_top_250
|
||||
- git: PMM/overlays/ratings
|
||||
```
|
||||
|
||||
## Customizing Configs
|
||||
|
||||
Configs can be customized using the `template_variables` attribute when calling the file. These `template_variables` will be given to every template call in the file so they can effect how that file runs.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
TV Shows:
|
||||
overlay_path:
|
||||
- git: PMM/overlays/ratings
|
||||
template_variables:
|
||||
overlay_level: episode
|
||||
```
|
||||
|
||||
Each file has a comment block at the top showing the available `template_variables` for each file. For example the [`PMM/genre`](https://github.com/meisnate12/Plex-Meta-Manager-Configs/blob/master/PMM/genre.yml) has this:
|
||||
|
||||
```yaml
|
||||
#############################################################
|
||||
# Dynamic Genre Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
#############################################################
|
||||
# Call this from your config.yml (Movie or Show) #
|
||||
# metadata_path: #
|
||||
# - git: PMM/genre #
|
||||
# template_variables: #
|
||||
# # Turn the separator collection on/off #
|
||||
# use_separator: true #
|
||||
# # Sets how the collection is sorted #
|
||||
# sort_by: release.desc #
|
||||
# # Sets the collection mode of the collection #
|
||||
# collection_mode: #
|
||||
# # Sets the value at the start of the sort title #
|
||||
# collection_section: "06" #
|
||||
#############################################################
|
||||
|
||||
```
|
||||
|
||||
Each of these when passed will change how the collection runs slightly.
|
||||
* `use_separator` Turn the separator collection on/off
|
||||
* `sort_by` Sets how the collection is sorted
|
||||
* `collection_mode` Sets the collection mode of the collection
|
||||
* `collection_section` Sets the value at the start of the sort title
|
||||
|
||||
|
||||
**In addition to the defined `template_variables` each file in the PMM Folder has access to the `radarr_add_missing` and `sonarr_add_missing` template variables and for dynamic collections most attributes can be passed as template variables**
|
||||
|
||||
For example if you want yearly oscar collections that go back 10 years instead of 5 all of which gets sent to radarr use the `data` and `radarr_add_missing` template variables.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- git: PMM/award/oscars
|
||||
template_variables:
|
||||
radarr_add_missing: true
|
||||
data:
|
||||
starting: current_year-10
|
||||
ending: current_year
|
||||
```
|
||||
|
||||
### Example
|
||||
|
||||
<details>
|
||||
<summary>Click to expand sample config.yml file:</summary>
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- git: PMM/award/bafta
|
||||
- git: PMM/award/cannes
|
||||
- git: PMM/award/choice
|
||||
- git: PMM/award/golden
|
||||
- git: PMM/award/oscars
|
||||
- git: PMM/award/other
|
||||
- git: PMM/award/spirit
|
||||
- git: PMM/award/sundance
|
||||
- git: PMM/chart/old_movie_chart
|
||||
- git: PMM/actor
|
||||
- git: PMM/audio_language
|
||||
- git: PMM/movie/content_rating_us # Choose content_rating_uk or content_rating_us
|
||||
- git: PMM/genre
|
||||
- git: PMM/resolution_standards # Choose resolution_standards or resolution
|
||||
- git: PMM/studio
|
||||
- git: PMM/subtitle_language
|
||||
- git: PMM/year
|
||||
- git: PMM/movie/country_color # Choose country_color or country_white
|
||||
- git: PMM/movie/decade
|
||||
- git: PMM/movie/director
|
||||
- git: PMM/movie/franchise
|
||||
- git: PMM/movie/multi-franchise
|
||||
- git: PMM/movie/producer
|
||||
- git: PMM/movie/seasonal_section # Choose seasonal or seasonal_section
|
||||
- git: PMM/movie/streaming
|
||||
- git: PMM/movie/writer
|
||||
overlay_path:
|
||||
- remove_overlays: false
|
||||
- git: PMM/overlays/audio_codec
|
||||
- git: PMM/overlays/audio_language
|
||||
- git: PMM/overlays/direct_play
|
||||
- git: PMM/overlays/imdb_top_250
|
||||
- git: PMM/overlays/ratings
|
||||
- git: PMM/overlays/resolution
|
||||
- git: PMM/overlays/special_release
|
||||
- git: PMM/overlays/streaming
|
||||
- git: PMM/overlays/video_format
|
||||
TV Shows:
|
||||
missing_path: config/missing/TV_missing
|
||||
metadata_path:
|
||||
- git: PMM/award/choice
|
||||
- git: PMM/award/golden
|
||||
- git: PMM/award/emmy
|
||||
- git: PMM/award/golden
|
||||
- git: PMM/chart/old_show_chart
|
||||
- git: PMM/actor
|
||||
- git: PMM/audio_language
|
||||
- git: PMM/show/content_rating_us # Choose content_rating_uk or content_rating_us
|
||||
- git: PMM/genre
|
||||
- git: PMM/resolution_standards # Choose resolution_standards or resolution
|
||||
- git: PMM/studio
|
||||
- git: PMM/subtitle_language
|
||||
- git: PMM/year
|
||||
- git: PMM/show/country_color # Choose country_color or country_white
|
||||
- git: PMM/show/decade
|
||||
- git: PMM/show/network
|
||||
- git: PMM/show/streaming
|
||||
overlay_path:
|
||||
- remove_overlays: false
|
||||
- git: PMM/overlays/audio_codec
|
||||
- git: PMM/overlays/audio_codec
|
||||
template_variables:
|
||||
overlay_level: episode
|
||||
- git: PMM/overlays/audio_codec
|
||||
template_variables:
|
||||
overlay_level: season
|
||||
- git: PMM/overlays/audio_language
|
||||
- git: PMM/overlays/audio_language
|
||||
template_variables:
|
||||
overlay_level: episode
|
||||
- git: PMM/overlays/audio_language
|
||||
template_variables:
|
||||
overlay_level: season
|
||||
- git: PMM/overlays/direct_play
|
||||
- git: PMM/overlays/direct_play
|
||||
template_variables:
|
||||
overlay_level: episode
|
||||
- git: PMM/overlays/direct_play
|
||||
template_variables:
|
||||
overlay_level: season
|
||||
- git: PMM/overlays/ratings
|
||||
- git: PMM/overlays/ratings
|
||||
template_variables:
|
||||
overlay_level: episode
|
||||
- git: PMM/overlays/ratings
|
||||
template_variables:
|
||||
overlay_level: season
|
||||
- git: PMM/overlays/resolution
|
||||
- git: PMM/overlays/resolution
|
||||
template_variables:
|
||||
overlay_level: episode
|
||||
- git: PMM/overlays/resolution
|
||||
template_variables:
|
||||
overlay_level: season
|
||||
- git: PMM/overlays/special_release
|
||||
- git: PMM/overlays/special_release
|
||||
template_variables:
|
||||
overlay_level: episode
|
||||
- git: PMM/overlays/special_release
|
||||
template_variables:
|
||||
overlay_level: season
|
||||
- git: PMM/overlays/streaming
|
||||
- git: PMM/overlays/streaming
|
||||
template_variables:
|
||||
overlay_level: episode
|
||||
- git: PMM/overlays/streaming
|
||||
template_variables:
|
||||
overlay_level: season
|
||||
- git: PMM/overlays/video_format
|
||||
- git: PMM/overlays/video_format
|
||||
template_variables:
|
||||
overlay_level: episode
|
||||
- git: PMM/overlays/video_format
|
||||
template_variables:
|
||||
overlay_level: season
|
||||
playlist_files:
|
||||
- git: PMM/playlist
|
||||
```
|
||||
</details>
|
||||
@ -0,0 +1,117 @@
|
||||
# Log files and where to find them
|
||||
|
||||
Plex-Meta-Manager's log files can be found in `config/logs`:
|
||||
|
||||
```
|
||||
config/logs
|
||||
├── Movies
|
||||
│ ├── collections
|
||||
│ │ ├── Action
|
||||
│ │ │ ├── collection.log
|
||||
│ │ │ └── collection.log.1
|
||||
│ │ ├── Best of 2022
|
||||
│ │ │ ├── collection.log
|
||||
│ │ │ └── collection.log.1
|
||||
│ │ ├── Top Rated
|
||||
│ │ │ ├── collection.log
|
||||
│ │ │ └── collection.log.1
|
||||
│ │ └── Trending
|
||||
│ │ ├── collection.log
|
||||
│ │ └── collection.log.1
|
||||
│ ├── library.log
|
||||
│ └── library.log.1
|
||||
├── TV
|
||||
│ ├── collections
|
||||
│ │ ├── Reality
|
||||
│ │ │ ├── collection.log
|
||||
│ │ │ └── collection.log.1
|
||||
│ │ └── Game Shows
|
||||
│ │ ├── collection.log
|
||||
│ │ └── collection.log.1
|
||||
│ ├── library.log
|
||||
│ └── library.log.1
|
||||
├── meta.log
|
||||
├── meta.log.1
|
||||
└── playlists
|
||||
├── playlists.log
|
||||
└── playlists.log.1
|
||||
```
|
||||
|
||||
You will find a `meta.log`, which the the full log of the entire run.
|
||||
|
||||
The subfolders provide more limited logs at the library, collection, and playlist levels.
|
||||
|
||||
As new log files are created, the old ones get a numeric suffix added: `meta.log.1`. The most recent is always the one without a number at the end.
|
||||
|
||||
These files will contain a great deal of detail about what exactly is happening and why. Generally speaking, if you're having a problem with PMM the answer will be found here. These logs can of course be quite technical, but often the error can be relatively clear:
|
||||
|
||||
|
||||
Something's missing from the format of the file:
|
||||
```
|
||||
| Loading Metadata File: config/TV Shows.yml |
|
||||
| |
|
||||
| YAML Error: metadata, collections, or dynamic_collections attribute is required |
|
||||
```
|
||||
|
||||
The problem in that case was:
|
||||
|
||||
```yaml
|
||||
templates:
|
||||
Collection:
|
||||
cache_builders: 30
|
||||
sync_mode: sync
|
||||
sort_title: ZZZ-<<source>>-<<collection_name>>
|
||||
|
||||
collections: <<< THIS LINE WAS MISSING
|
||||
Cached for 30 Days:
|
||||
template: {name: Collection, source: Looper}
|
||||
summary: ""
|
||||
trakt_list:
|
||||
- https://trakt.tv/users/kesleyalfa/lists/year-2011
|
||||
```
|
||||
|
||||
|
||||
YAML doesn't allow duplicate keys:
|
||||
```
|
||||
| Loading Metadata File: config/Anime.yml |
|
||||
| |
|
||||
| YAML Error: while constructing a mapping
|
||||
| in "<unicode string>", line 27, column 5:
|
||||
| mal_favorite: 50
|
||||
| ^ (line: 27)
|
||||
| found duplicate key "collection_order" with value "custom" (original value: "custom")
|
||||
| in "<unicode string>", line 32, column 5:
|
||||
| collection_order: custom
|
||||
| ^ (line: 32)
|
||||
```
|
||||
|
||||
The problem there was something like this:
|
||||
```yaml
|
||||
templates:
|
||||
Collection:
|
||||
cache_builders: 30
|
||||
sync_mode: sync
|
||||
sort_title: ZZZ-<<source>>-<<collection_name>>
|
||||
|
||||
collections: <<< THIS LINE WAS MISSING
|
||||
Cached for 30 Days:
|
||||
template: {name: Collection, source: Looper}
|
||||
collection_order: custom <<<< THIS KEY
|
||||
summary: ""
|
||||
collection_order: custom <<<< DUPLICATED HERE
|
||||
trakt_list:
|
||||
- https://trakt.tv/users/kesleyalfa/lists/year-2011
|
||||
```
|
||||
|
||||
File isn't where PMM expects it:
|
||||
```
|
||||
| Loading Metadata File: config/Movies.yml |
|
||||
| YAML Error: File Error: File does not exist /Users/Lucky/Plex-Meta-Manager/config/Movies.yml |
|
||||
```
|
||||
|
||||
## Providing Log Files
|
||||
|
||||
You can drag-and-drop your meta.log file directly into Discord, you do not need to upload it to a third-party site unless it exceeds the 50mb size limit.
|
||||
|
||||
Please DO NOT manually extract, copy and paste text from your log files directly into Discord as the formatting can be difficult to read and can often redact parts of the log file that are important for full context.
|
||||
|
||||
Loading…
Reference in new issue