mirror of
https://github.com/meisnate12/Plex-Meta-Manager
synced 2024-11-10 06:54:21 +00:00
[78] defaults update
This commit is contained in:
parent
636b129cf7
commit
4c635985a1
40 changed files with 312 additions and 195 deletions
2
VERSION
2
VERSION
|
@ -1 +1 @@
|
|||
1.17.3-develop77
|
||||
1.17.3-develop78
|
||||
|
|
|
@ -23,8 +23,8 @@ To run a defaults metadata file, you can simply add it to your `metadata_path` u
|
|||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: chart/tmdb
|
||||
- pmm: awards/bafta
|
||||
- pmm: tmdb
|
||||
- pmm: bafta
|
||||
```
|
||||
|
||||
A full list of the available metadata files can be found [HERE](LINK NEEDED)
|
||||
|
@ -38,8 +38,8 @@ libraries:
|
|||
Movies:
|
||||
overlay_path:
|
||||
- remove_overlays: false
|
||||
- pmm: overlays/imdb_top_250
|
||||
- pmm: overlays/ratings
|
||||
- pmm: ribbon
|
||||
- pmm: ratings
|
||||
```
|
||||
A full list of the available overlay files can be found [HERE](LINK NEEDED)
|
||||
|
||||
|
@ -56,11 +56,11 @@ libraries:
|
|||
overlay_path:
|
||||
- remove_overlays: false
|
||||
- reapply_overlay: true
|
||||
- pmm: overlays/resolution # 1
|
||||
- pmm: overlays/audio_codec # 2
|
||||
- pmm: overlays/mediastinger # 3
|
||||
- pmm: overlays/special_release # 4
|
||||
- pmm: overlays/ratings # 5,6,7
|
||||
- pmm: resolution # 1
|
||||
- pmm: audio_codec # 2
|
||||
- pmm: mediastinger # 3
|
||||
- pmm: special_release # 4
|
||||
- pmm: ratings # 5, 6, 7
|
||||
template_variables:
|
||||
rating1: user # 5 as this is user and mass_user_rating_update: mdb_tomatoes
|
||||
rating1_image: rt_tomato # 5 as this is user and mass_user_rating_update: mdb_tomatoes
|
||||
|
@ -78,24 +78,10 @@ libraries:
|
|||
rating3_font_size: 70 # 7 adjusted font size to fit rating
|
||||
|
||||
horizontal_position: right # the set of ratings is on the right of the poster
|
||||
- pmm: overlays/streaming # 8
|
||||
- pmm: overlays/video_format # 9
|
||||
- pmm: overlays/audio_language # 10
|
||||
- pmm: overlays/oscars # 11
|
||||
template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied
|
||||
weight: 40 # Weight of 40 applies if more than 1 sash is applied in bottom right
|
||||
- pmm: overlays/imdb_top_250 # 12
|
||||
template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied
|
||||
weight: 30 # Weight of 30 applies if more than 1 sash is applied in bottom right
|
||||
- pmm: overlays/rt_cert_fresh # 13
|
||||
template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied
|
||||
weight: 20 # Weight of 20 applies if more than 1 sash is applied in bottom right
|
||||
- pmm: overlays/mc_must_see # NOT SHOWN, however would apply the "MetaCritic Must See" sash in the bottom right
|
||||
template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied
|
||||
weight: 10 # Weight of 10 applies if more than 1 sash is applied in bottom right
|
||||
- pmm: overlays/commonsense_selection # NOT SHOWN, however would apply the "Commonsense Selected Families" sash in the bottom right
|
||||
template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied
|
||||
weight: 5 # Weight of 5 applies if more than 1 sash is applied in bottom right
|
||||
- pmm: streaming # 8
|
||||
- pmm: video_format # 9
|
||||
- pmm: audio_language # 10
|
||||
- pmm: ribbon # 11, 12 Bottom right sash is used by more than one overlay so a weight for priority can be applied
|
||||
|
||||
operations:
|
||||
mass_user_rating_update: mdb_tomatoes # 5 This operation will update the user rating in plex with Rotten Tomatoes ratings information
|
||||
|
@ -116,10 +102,10 @@ libraries:
|
|||
overlay_path:
|
||||
- remove_overlays: false
|
||||
- reapply_overlay: true
|
||||
- pmm: overlays/resolution # 1
|
||||
- pmm: overlays/audio_codec # 2
|
||||
- pmm: overlays/mediastinger # 3
|
||||
- pmm: overlays/ratings # 4,5,6
|
||||
- pmm: resolution # 1
|
||||
- pmm: audio_codec # 2
|
||||
- pmm: mediastinger # 3
|
||||
- pmm: ratings # 4, 5, 6
|
||||
template_variables:
|
||||
rating1: user # 4 as this is user and mass_user_rating_update: mdb_tomatoes
|
||||
rating1_image: rt_tomato # 4 as this is user and mass_user_rating_update: mdb_tomatoes
|
||||
|
@ -137,20 +123,9 @@ libraries:
|
|||
rating3_font_size: 70 # 6 adjusted font size to fit rating
|
||||
|
||||
horizontal_position: right # the set of ratings is on the right of the poster
|
||||
- pmm: overlays/streaming # 7
|
||||
- pmm: overlays/video_format # 8
|
||||
- pmm: overlays/imdb_top_250 # 9
|
||||
template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied
|
||||
weight: 30 # Weight of 30 applies if more than 1 sash is applied in bottom right
|
||||
- pmm: overlays/rt_cert_fresh # 10
|
||||
template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied
|
||||
weight: 20 # Weight of 20 applies if more than 1 sash is applied in bottom right
|
||||
- pmm: overlays/mc_must_see # NOT SHOWN, however would apply the "MetaCritic Must See" sash in the bottom right
|
||||
template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied
|
||||
weight: 10 # Weight of 10 applies if more than 1 sash is applied in bottom right
|
||||
- pmm: overlays/commonsense_selection # NOT SHOWN, however would apply the "Commonsense Selected Families" sash in the bottom right
|
||||
template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied
|
||||
weight: 5 # Weight of 5 applies if more than 1 sash is applied in bottom right
|
||||
- pmm: overlays/streaming # 7
|
||||
- pmm: overlays/video_format # 8
|
||||
- pmm: ribbon # 10, 11 Bottom right sash is used by more than one overlay so a weight for priority can be applied
|
||||
|
||||
operations:
|
||||
mass_user_rating_update: mdb_tomatoes # 4 This operation will update the user rating in plex with Rotten Tomatoes ratings information
|
||||
|
@ -171,13 +146,13 @@ libraries:
|
|||
overlay_path:
|
||||
- remove_overlays: false
|
||||
- reapply_overlay: true
|
||||
- pmm: overlays/resolution # 1
|
||||
- pmm: resolution # 1
|
||||
template_variables:
|
||||
overlay_level: season
|
||||
- pmm: overlays/audio_codec # 2
|
||||
- pmm: audio_codec # 2
|
||||
template_variables:
|
||||
overlay_level: season
|
||||
- pmm: overlays/video_format # 3
|
||||
- pmm: video_format # 3
|
||||
template_variables:
|
||||
overlay_level: season
|
||||
```
|
||||
|
@ -201,7 +176,7 @@ libraries:
|
|||
- pmm: overlays/audio_codec # 2
|
||||
template_variables:
|
||||
overlay_level: episode
|
||||
- pmm: overlays/ratings # 3,4
|
||||
- pmm: overlays/ratings # 3, 4
|
||||
template_variables:
|
||||
|
||||
rating1: critic # 3 as this is critic and mass_critic_rating_update: imdb
|
||||
|
|
|
@ -1,8 +1,10 @@
|
|||
#############################################################
|
||||
# BAFTA Collections
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro
|
||||
# Credit to pjcob & maxwelldeux for the Trakt Lists
|
||||
#############################################################
|
||||
##############################################################################
|
||||
# BAFTA Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
# Credit to pjcob & maxwelldeux for the Trakt Lists #
|
||||
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
|
||||
# https://metamanager.wiki/en/latest/defaults/chart/bafta.html #
|
||||
##############################################################################
|
||||
|
||||
external_templates:
|
||||
pmm: templates
|
||||
|
@ -34,6 +36,7 @@ dynamic_collections:
|
|||
data:
|
||||
starting: current_year-5
|
||||
ending: current_year
|
||||
title_format: BAFTA <<key_name>>
|
||||
template:
|
||||
- use_year_collections
|
||||
- trakt
|
||||
|
|
|
@ -1,3 +1,11 @@
|
|||
##############################################################################
|
||||
# Cannes Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
# Credit to pjcob & maxwelldeux for the Trakt Lists #
|
||||
# https://metamanager.wiki/en/latest/defaults/chart/cannes.html #
|
||||
##############################################################################
|
||||
|
||||
|
||||
#############################################################
|
||||
# Cannes Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
|
@ -60,6 +68,7 @@ dynamic_collections:
|
|||
data:
|
||||
starting: current_year-5
|
||||
ending: current_year
|
||||
title_format: Cannes <<key_name>>
|
||||
template:
|
||||
- use_year_collections
|
||||
- trakt
|
||||
|
|
|
@ -53,6 +53,7 @@ dynamic_collections:
|
|||
data:
|
||||
starting: current_year-5
|
||||
ending: current_year
|
||||
title_format: Critics Choice Awards <<key_name>>
|
||||
template:
|
||||
- use_year_collections
|
||||
- trakt
|
||||
|
|
|
@ -50,6 +50,7 @@ dynamic_collections:
|
|||
data:
|
||||
starting: current_year-5
|
||||
ending: current_year
|
||||
title_format: Emmys <<key_name>>
|
||||
template:
|
||||
- use_year_collections
|
||||
- imdb
|
||||
|
|
|
@ -65,6 +65,7 @@ dynamic_collections:
|
|||
data:
|
||||
starting: current_year-5
|
||||
ending: current_year
|
||||
title_format: Golden Globe <<key_name>>
|
||||
template:
|
||||
- use_year_collections
|
||||
- imdb
|
||||
|
|
|
@ -71,6 +71,7 @@ dynamic_collections:
|
|||
data:
|
||||
starting: current_year-5
|
||||
ending: current_year
|
||||
title_format: Oscars Winners <<key_name>>
|
||||
template:
|
||||
- use_year_collections
|
||||
- imdb
|
||||
|
|
|
@ -69,7 +69,7 @@ collections:
|
|||
template:
|
||||
- name: shared
|
||||
allowed_libraries: movie
|
||||
image: award/razzie/winner
|
||||
image: award/razzies/winner
|
||||
- name: arr
|
||||
- name: custom
|
||||
- name: translation
|
||||
|
|
31
defaults/award/separator_award.yml
Normal file
31
defaults/award/separator_award.yml
Normal file
|
@ -0,0 +1,31 @@
|
|||
#############################################################
|
||||
# Awards Separator Collection #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
#############################################################
|
||||
# Call this from your config.yml (Movie or Show) #
|
||||
# If nothing is specified these are the defaults #
|
||||
# #
|
||||
# metadata_path: #
|
||||
# - git: PMM/award/separator #
|
||||
# template_variables: #
|
||||
# # Turn the separator collection on/off #
|
||||
# use_separator: true #
|
||||
# # Separator style (red, blue, green, gray, #
|
||||
# purple, stb, orig) #
|
||||
# sep_style: orig #
|
||||
# # Sets the collection mode of the collection #
|
||||
# collection_mode: #
|
||||
# # Sets the value at the start of the sort title #
|
||||
# collection_section: 16 #
|
||||
#############################################################
|
||||
|
||||
external_templates:
|
||||
pmm: templates
|
||||
template_variables:
|
||||
collection_section: "01"
|
||||
|
||||
collections:
|
||||
Chart Collections:
|
||||
template:
|
||||
- name: separator
|
||||
separator: chart
|
|
@ -47,6 +47,7 @@ dynamic_collections:
|
|||
data:
|
||||
depth: 5
|
||||
limit: 25
|
||||
title_format: <<key_name>>
|
||||
template:
|
||||
- smart_filter
|
||||
- translation
|
||||
|
|
|
@ -44,6 +44,7 @@ collections:
|
|||
dynamic_collections:
|
||||
Audio Language:
|
||||
type: audio_language
|
||||
title_format: <<key_name>> Audio
|
||||
other_name: Other Audio
|
||||
template:
|
||||
- smart_filter
|
||||
|
|
|
@ -44,6 +44,7 @@ collections:
|
|||
dynamic_collections:
|
||||
CommonSense Content Rating:
|
||||
type: content_rating
|
||||
title_format: <<key_name>> <<library_typeU>>s
|
||||
other_name: Other Ratings
|
||||
template:
|
||||
- smart_filter
|
||||
|
|
|
@ -44,6 +44,7 @@ collections:
|
|||
dynamic_collections:
|
||||
UK Content Rating:
|
||||
type: content_rating
|
||||
title_format: <<key_name>> <<library_typeU>>s
|
||||
other_name: Other Ratings
|
||||
template:
|
||||
- smart_filter
|
||||
|
|
|
@ -42,6 +42,7 @@ collections:
|
|||
dynamic_collections:
|
||||
Genre:
|
||||
type: genre
|
||||
title_format: <<key_name>> <<library_typeU>>s
|
||||
template:
|
||||
- smart_filter
|
||||
- translation
|
||||
|
|
|
@ -42,6 +42,7 @@ collections:
|
|||
dynamic_collections:
|
||||
Resolution:
|
||||
type: resolution
|
||||
title_format: <<key_name>> <<library_typeU>>s
|
||||
template:
|
||||
- smart_filter
|
||||
- translation
|
||||
|
|
|
@ -44,6 +44,7 @@ collections:
|
|||
dynamic_collections:
|
||||
Resolution Standards:
|
||||
type: resolution
|
||||
title_format: <<key_name>> <<library_typeU>>s
|
||||
other_name: Other Resolutions
|
||||
template:
|
||||
- smart_filter
|
||||
|
|
|
@ -102,6 +102,7 @@ dynamic_collections:
|
|||
paramount: Paramount+
|
||||
peacock: Peacock
|
||||
amazon: Prime Video
|
||||
title_format: <<key_name>> <<library_typeU>>s
|
||||
template:
|
||||
- mdb_smart
|
||||
- translation
|
||||
|
|
|
@ -42,6 +42,7 @@ collections:
|
|||
dynamic_collections:
|
||||
Studio:
|
||||
type: studio
|
||||
title_format: <<key_name>>
|
||||
template:
|
||||
- smart_filter
|
||||
- translation
|
||||
|
|
|
@ -50,6 +50,7 @@ dynamic_collections:
|
|||
data:
|
||||
starting: current_year-10
|
||||
ending: current_year
|
||||
title_format: Best of <<key_name>>
|
||||
template:
|
||||
- smart_filter
|
||||
- translation
|
||||
|
|
|
@ -20,7 +20,7 @@
|
|||
#############################################################
|
||||
|
||||
external_templates:
|
||||
git: PMM/templates
|
||||
pmm: templates
|
||||
template_variables:
|
||||
collection_section: 16
|
||||
|
|
@ -42,6 +42,7 @@ collections:
|
|||
dynamic_collections:
|
||||
US Movie Content Ratings:
|
||||
type: content_rating
|
||||
title_format: <<key_name>> <<library_typeU>>s
|
||||
other_name: Other Ratings
|
||||
template:
|
||||
- smart_filter
|
||||
|
|
|
@ -43,8 +43,9 @@ collections:
|
|||
separator: country
|
||||
|
||||
dynamic_collections:
|
||||
Country Color:
|
||||
Country:
|
||||
type: country
|
||||
title_format: <<key_name>> <<library_typeU>>s
|
||||
other_name: Other Countries
|
||||
template:
|
||||
- smart_filter
|
||||
|
|
|
@ -45,6 +45,7 @@ dynamic_collections:
|
|||
data:
|
||||
depth: 5
|
||||
limit: 25
|
||||
title_format: <<key_name>> (Director)
|
||||
template:
|
||||
- smart_filter
|
||||
- translation
|
||||
|
|
|
@ -32,6 +32,7 @@ external_templates:
|
|||
|
||||
translations:
|
||||
pmm: translations
|
||||
|
||||
collections:
|
||||
Producers Collections:
|
||||
template:
|
||||
|
@ -41,6 +42,7 @@ collections:
|
|||
dynamic_collections:
|
||||
Top Producers:
|
||||
type: producer
|
||||
title_format: <<key_name>> (Producer)
|
||||
data:
|
||||
depth: 5
|
||||
limit: 25
|
||||
|
|
|
@ -116,6 +116,7 @@ dynamic_collections:
|
|||
halloween: Halloween
|
||||
thanksgiving: Thanksgiving
|
||||
christmas: Christmas
|
||||
title_format: <<key_name>> <<library_typeU>>s
|
||||
template:
|
||||
- holiday
|
||||
- translation
|
||||
|
|
|
@ -32,6 +32,7 @@ external_templates:
|
|||
|
||||
translations:
|
||||
pmm: translations
|
||||
|
||||
collections:
|
||||
Writers Collections:
|
||||
template:
|
||||
|
@ -44,6 +45,7 @@ dynamic_collections:
|
|||
data:
|
||||
depth: 5
|
||||
limit: 25
|
||||
title_format: <<key_name>> (Writer)
|
||||
template:
|
||||
- smart_filter
|
||||
- translation
|
||||
|
|
|
@ -55,7 +55,7 @@
|
|||
#############################################################
|
||||
|
||||
external_templates:
|
||||
git: PMM/templates
|
||||
pmm: templates
|
||||
|
||||
templates:
|
||||
playlist:
|
||||
|
|
|
@ -42,6 +42,7 @@ collections:
|
|||
dynamic_collections:
|
||||
US Show Content Rating:
|
||||
type: content_rating
|
||||
title_format: <<key_name>> <<library_typeU>>s
|
||||
other_name: Other Ratings
|
||||
template:
|
||||
- smart_filter
|
||||
|
|
|
@ -43,8 +43,9 @@ collections:
|
|||
separator: country
|
||||
|
||||
dynamic_collections:
|
||||
TMDb Country Color:
|
||||
Country:
|
||||
type: origin_country
|
||||
title_format: <<key_name>> <<library_typeU>>s
|
||||
other_name: Other Countries
|
||||
template:
|
||||
- filter
|
||||
|
|
|
@ -42,6 +42,7 @@ collections:
|
|||
dynamic_collections:
|
||||
Decade:
|
||||
type: decade
|
||||
title_format: Best of <<key_name>>s
|
||||
template:
|
||||
- smart_filter
|
||||
- translation
|
||||
|
|
|
@ -1,3 +1,7 @@
|
|||
1.18.0.1 -> 1.18.0.2
|
||||
|
||||
added `network_name` and `network_summary`
|
||||
|
||||
|
||||
1.18.0 -> 1.18.0.1
|
||||
|
||||
|
@ -5,6 +9,17 @@ added library_type
|
|||
added key_names
|
||||
added comments
|
||||
|
||||
tmdb_air_summary: `activaly` -> `actively`
|
||||
trakt_collected_summary: Added `.`
|
||||
trakt_popular_summary: Added `.`
|
||||
trakt_recommended_summary: Added `.`
|
||||
trakt_trending_summary: Added `.`
|
||||
trakt_watched_summary: Added `.`
|
||||
|
||||
director_summary: `Directed` -> `directed`
|
||||
producer_summary: `Produced` -> `produced`
|
||||
writer_summary: `Written` -> `written`
|
||||
|
||||
imdb_popular_summary: Changed `<<collection_name>>` to `IMDb Popular`
|
||||
imdb_top_summary: Changed `<<collection_name>>` to `IMDb Top 250`
|
||||
imdb_lowest_summary: Changed `<<collection_name>>` to `IMDb Lowest Rated`
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
version: 1.18.0
|
||||
version: 1.18.0.2
|
||||
library_type:
|
||||
# For Movie Libraries
|
||||
movie: movie
|
||||
|
@ -221,6 +221,10 @@ translations:
|
|||
genre_name: <<key_name>> <<library_typeU>>s
|
||||
genre_summary: <<library_typeU>>s that have the genre <<key_name>>.
|
||||
|
||||
# example key_name: NBC
|
||||
network_name: <<key_name>>
|
||||
network_summary: <<library_typeU>>s broadcast on <<key_name>>.
|
||||
|
||||
# example key_name: Robin Williams
|
||||
producer_name: <<key_name>> (Producer)
|
||||
producer_summary: <<library_typeU>>s produced by <<key_name>>.
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
version: 1.18.0
|
||||
version: 1.18.0.1
|
||||
library_type:
|
||||
# For Movie Libraries
|
||||
movie: film
|
||||
|
|
|
@ -8,6 +8,33 @@ These files can generally be used on both Movie and Show library-types, or are p
|
|||
|
||||
These collections are applied by calling the below paths into the `metadata_path:` section of your config.yml
|
||||
|
||||
|
||||
### Chart Collections
|
||||
|
||||
| Source | config.yml entry | Example Collections Created | Works with Movies | Works with Shows |
|
||||
|:------------|:--------------------|---------------------------------------------|:-----------------:|:----------------:|
|
||||
| AniList | `anilist` | AniList Popular, AniList Season | ✅ | ✅ |
|
||||
| Basic | `basic` | Newly Released, New Episodes | ✅ | ✅ |
|
||||
| IMDb | `imdb` | IMDb Popular, IMDb Top 250 | ✅ | ✅ |
|
||||
| MyAnimeList | `myanimelist` | MyAnimeList Popular, MyAnimeList Top Rated | ✅ | ✅ |
|
||||
| Other | `other` | AniDB Popular, Common Sense Selection | ✅ | ✅ |
|
||||
| Tautulli | `tautulli` | Plex Popular, Plex Watched | ✅ | ✅ |
|
||||
| TMDb | `tmdb` | TMDb Popular, TMDb Airing Today | ✅ | ✅ |
|
||||
| Trakt | `trakt` | Trakt Popular, Trakt Trending | ✅ | ✅ |
|
||||
|
||||
### Award Collections
|
||||
|
||||
| Award Show | config.yml entry | Example Collections Created | Works with Movies | Works with Shows |
|
||||
|:---------------|:-----------------|----------------------------------|:-----------------:|:----------------:|
|
||||
| BAFTA | `bafta` | BAFTA Best Films, BAFTA 2021 | ✅ | ❌ |
|
||||
| Cannes | `cannes` | Cannes - Palme d'or, Cannes 2018 | ✅ | ❌ |
|
||||
| Critics Choice | `choice` | Critics Choice Awards 2020 | ✅ | ✅ |
|
||||
| Emmys | `emmy` | Emmys 2021 | ✅ | ✅ |
|
||||
| Golden Globes | `golden` | Best Motion Pictures | ✅ | ✅ |
|
||||
| Oscars | `oscars` | Best Picture Winners | ✅ | ✅ |
|
||||
| Spirit | `spirit` | Independent Spirit Awards 2021 | ✅ | ❌ |
|
||||
| Sundance | `sundance` | Sundance Grand Jury Winners | ✅ | ✅ |
|
||||
|
||||
### General Collections
|
||||
|
||||
| Theme | config.yml entry | Example Collections Created | Works with Movies | Works with Shows |
|
||||
|
@ -32,63 +59,34 @@ These collections are applied by calling the below paths into the `metadata_path
|
|||
| Year | `year` | Best of 2010, Best of 2019 | ✅ | ✅ |
|
||||
| Writer | `writer` | James Cameron (Writer), Lilly Wachowski (Writer) | ✅ | ❌ |
|
||||
|
||||
### Award Show Collections
|
||||
|
||||
| Award Show | config.yml entry | Example Collections Created | Works with Movies | Works with Shows |
|
||||
|:---------------|:-----------------|----------------------------------|:-----------------:|:----------------:|
|
||||
| BAFTA | `bafta` | BAFTA Best Films, BAFTA 2021 | ✅ | ❌ |
|
||||
| Cannes | `cannes` | Cannes - Palme d'or, Cannes 2018 | ✅ | ❌ |
|
||||
| Critics Choice | `choice` | Critics Choice Awards 2020 | ✅ | ✅ |
|
||||
| Emmys | `emmy` | Emmys 2021 | ✅ | ✅ |
|
||||
| Golden Globes | `golden` | Best Motion Pictures | ✅ | ✅ |
|
||||
| Oscars | `oscars` | Best Picture Winners | ✅ | ✅ |
|
||||
| Spirit | `spirit` | Independent Spirit Awards 2021 | ✅ | ❌ |
|
||||
| Sundance | `sundance` | Sundance Grand Jury Winners | ✅ | ✅ |
|
||||
|
||||
|
||||
### Chart Collections
|
||||
|
||||
| Source | config.yml entry | Example Collections Created | Works with Movies | Works with Shows |
|
||||
|:------------|:--------------------|---------------------------------------------|:-----------------:|:----------------:|
|
||||
| AniList | `pmm: anilist` | AniList Popular, AniList Season | ✅ | ✅ |
|
||||
| Basic | `pmm: basic` | Newly Released, New Episodes | ✅ | ✅ |
|
||||
| IMDb | `pmm: imdb` | IMDb Popular, IMDb Top 250 | ✅ | ✅ |
|
||||
| MyAnimeList | `pmm: myanimelist` | MyAnimeList Popular, MyAnimeList Top Rated | ✅ | ✅ |
|
||||
| Other | `pmm: other` | AniDB Popular, Common Sense Selection | ✅ | ✅ |
|
||||
| Tautulli | `pmm: tautulli` | Plex Popular, Plex Watched | ✅ | ✅ |
|
||||
| TMDb | `pmm: tmdb` | TMDb Popular, TMDb Airing Today | ✅ | ✅ |
|
||||
| Trakt | `pmm: trakt` | Trakt Popular, Trakt Trending | ✅ | ✅ |
|
||||
|
||||
|
||||
## Overlays
|
||||
These files apply overlays and can generally be used on both Movie and Show library-types, and often works at the season and episode-level too.
|
||||
|
||||
It should be noted that when an overlay has ❌ for a season or episode, it normally means that whilst the overlay can technically be applied at the level, it wasn't designed for this purpose. For example, a show's season cannot have a resolution since it is not a video file, and an episode cannot have a commonsense age-rating since only Movies and Shows are rated by CommonSense.
|
||||
It should be noted that when an overlay has ❗ for a season or episode, it normally means that whilst the overlay can technically be applied at the level, it wasn't designed for this purpose. For example, a show's season cannot have a resolution since it is not a video file, and an episode cannot have a commonsense age-rating since only Movies and Shows are rated by CommonSense.
|
||||
|
||||
In the scenario where there is missing data such as age ratings for episodes, then generally the highest-level data available will be applied at the lower level (i.e. a Show's CommonSense age rating would apply to all episodes).
|
||||
|
||||
These overlays are applied by calling the below paths into the `overlay_path:` section of your config.yml
|
||||
These overlays are applied by calling the below paths into the `overlay_path:` [section](https://metamanager.wiki/en/nightly/config/libraries.html#overlay-path) of your config.yml
|
||||
|
||||
### Overlay Files
|
||||
|
||||
| Theme | path | Example Overlays | Movies | Shows | Seasons | Episodes |
|
||||
|:-----------------------|:---------------------------|------------------------------------------------|:--------:|:---------:|:---------:|:--------:|
|
||||
| Audio Codec | `pmm: audio_codec` | Dolby Atmos logo, DTS logo | ✅ | ✅ | ✅ | ✅ |
|
||||
| Audio Language | `pmm: audio_language` | French Audio, Korean Audio | ✅ | ✅ | ✅ | ✅ |
|
||||
| CommonSense Age Rating | `pmm: commonsense` | "3+", "16+" | ✅ | ✅ | ❗ | ❗ |
|
||||
| Direct Play | `pmm: direct_play` | "Direct Play Only" | ✅ | ❗ | ❗ | ✅ |
|
||||
| Editions | `pmm: editions` | Director's Cut logo, IMAX logo | ✅ | ❌ | ❌ | ❌ |
|
||||
| Episode Info | `pmm: episode_info` | "S01E01", "S02E09" | ❌ | ❌ | ❌ | ✅ |
|
||||
| Mediastinger | `pmm: mediastinger` | Mediastinger logo | ✅ | ✅ | ❌ | ❌ |
|
||||
| Ratings | `pmm: ratings` | IMDb Audience Rating, Metacritic Critic Rating | ✅ | ✅ | ❌ | ✅ |
|
||||
| Resolution | `pmm: resolution` | 4K Dolby Vision logo, 720P logo | ✅ | ✅ | ❌ | ✅ |
|
||||
| Ribbon | `pmm: ribbon` | IMDb Top 250 Ribbon, RT Fresh Ribbon | ✅ | ✅ | ❌ | ❌ |
|
||||
| Runtimes | `pmm: runtimes` | "Runtime: 1h 30m" | ✅ | ✅ | ❌ | ❌ |
|
||||
| Special Releases | `pmm: special_release` | "Director's Cut", "Criterion Collection" | ✅ | ✅ | ❗ | ❗ |
|
||||
| Streaming | `pmm: streaming` | Netflix logo, Hulu logo | ✅ | ✅ | ❌ | ❌ |
|
||||
| Versions | `pmm: versions` | Multiple Versions logo | ✅ | ✅ | ✅ | ✅ |
|
||||
| Video Format | `pmm: video_format` | "REMUX", "HDTV" | ✅ | ❗ | ❗ | ✅ |
|
||||
|
||||
| Audio Codec | `audio_codec` | Dolby Atmos logo, DTS logo | ✅ | ✅ | ✅ | ✅ |
|
||||
| Audio Language | `audio_language` | French Audio, Korean Audio | ✅ | ✅ | ✅ | ✅ |
|
||||
| CommonSense Age Rating | `commonsense` | "3+", "16+" | ✅ | ✅ | ❗ | ❗ |
|
||||
| Direct Play | `direct_play` | "Direct Play Only" | ✅ | ❗ | ❗ | ✅ |
|
||||
| Editions | `editions` | Director's Cut logo, IMAX logo | ✅ | ❌ | ❌ | ❌ |
|
||||
| Episode Info | `episode_info` | "S01E01", "S02E09" | ❌ | ❌ | ❌ | ✅ |
|
||||
| Mediastinger | `mediastinger` | Mediastinger logo | ✅ | ✅ | ❌ | ❌ |
|
||||
| Ratings | `ratings` | IMDb Audience Rating, Metacritic Critic Rating | ✅ | ✅ | ❌ | ✅ |
|
||||
| Resolution | `resolution` | 4K Dolby Vision logo, 720P logo | ✅ | ✅ | ❌ | ✅ |
|
||||
| Ribbon | `ribbon` | IMDb Top 250 Ribbon, RT Fresh Ribbon | ✅ | ✅ | ❌ | ❌ |
|
||||
| Runtimes | `runtimes` | "Runtime: 1h 30m" | ✅ | ✅ | ❌ | ❌ |
|
||||
| Special Releases | `special_release` | "Director's Cut", "Criterion Collection" | ✅ | ✅ | ❗ | ❗ |
|
||||
| Streaming | `streaming` | Netflix logo, Hulu logo | ✅ | ✅ | ❌ | ❌ |
|
||||
| Versions | `versions` | Multiple Versions logo | ✅ | ✅ | ✅ | ✅ |
|
||||
| Video Format | `video_format` | "REMUX", "HDTV" | ✅ | ❗ | ❗ | ✅ |
|
||||
|
||||
## Playlists
|
||||
These files apply playlists to the "Playlists" section of Plex and are applied by calling the below paths into the `playlist_files:` section of your config.yml
|
||||
|
|
|
@ -48,35 +48,32 @@ libraries:
|
|||
overlay_path:
|
||||
- remove_overlays: false
|
||||
- reapply_overlay: true
|
||||
- pmm: resolution # 1
|
||||
- pmm: audio_codec # 2
|
||||
- pmm: mediastinger # 3
|
||||
- pmm: special_release # 4
|
||||
- pmm: ratings # 5,6,7
|
||||
- pmm: resolution # 1
|
||||
- pmm: audio_codec # 2
|
||||
- pmm: mediastinger # 3
|
||||
- pmm: special_release # 4
|
||||
- pmm: ratings # 5, 6, 7
|
||||
template_variables:
|
||||
rating1: user # 5 as this is user and mass_user_rating_update: mdb_tomatoes
|
||||
rating1_image: rt_tomato # 5 as this is user and mass_user_rating_update: mdb_tomatoes
|
||||
rating1_font: config/metadata/overlays/fonts/Adlib.ttf # 5 local font accessible to PMM
|
||||
rating1_font: config/custom_fonts/Adlib.ttf # 5 local font accessible to PMM
|
||||
rating1_font_size: 63 # 5 adjusted font size to fit rating
|
||||
|
||||
rating2: critic # 6 as this is critic and mass_critic_rating_update: imdb
|
||||
rating2_image: imdb # 6 as this is critic and mass_critic_rating_update: imdb
|
||||
rating2_font: config/metadata/overlays/fonts/Impact.ttf # 6 local font accessible to PMM
|
||||
rating2_font: config/custom_fonts/Impact.ttf # 6 local font accessible to PMM
|
||||
rating2_font_size: 70 # 6 adjusted font size to fit rating
|
||||
|
||||
rating3: audience # 7 as this is audience and mass_audience_rating_update: tmdb
|
||||
rating3_image: tmdb # 7 as this is audience and mass_audience_rating_update: tmdb
|
||||
rating3_font: config/metadata/overlays/fonts/Avenir_95_Black.ttf # 7 local font accessible to PMM
|
||||
rating3_font: config/custom_fonts/Avenir_95_Black.ttf # 7 local font accessible to PMM
|
||||
rating3_font_size: 70 # 7 adjusted font size to fit rating
|
||||
|
||||
horizontal_position: right # the set of ratings is on the right of the poster
|
||||
- pmm: streaming # 8
|
||||
- pmm: video_format # 9
|
||||
- pmm: audio_language # 10
|
||||
- pmm: oscars # 11
|
||||
template_variables: # Bottom right sash is used by more than one overlay so a weight for priority is applied
|
||||
weight: 40 # Weight of 40 applies if more than 1 sash is applied in bottom right
|
||||
- pmm: ribbon # 12 & #13
|
||||
- pmm: streaming # 8
|
||||
- pmm: video_format # 9
|
||||
- pmm: audio_language # 10
|
||||
- pmm: ribbon # 11, 12 Bottom right sash is used by more than one overlay so a weight for priority can be applied
|
||||
operations:
|
||||
mass_user_rating_update: mdb_tomatoes # 5 This operation will update the user rating in plex with Rotten Tomatoes ratings information
|
||||
mass_critic_rating_update: imdb # 6 This operation will update the critic rating in plex with IMDb ratings information
|
||||
|
@ -96,30 +93,30 @@ libraries:
|
|||
overlay_path:
|
||||
- remove_overlays: false
|
||||
- reapply_overlay: true
|
||||
- pmm: resolution # 1
|
||||
- pmm: audio_codec # 2
|
||||
- pmm: mediastinger # 3
|
||||
- pmm: ratings # 4,5,6
|
||||
- pmm: resolution # 1
|
||||
- pmm: audio_codec # 2
|
||||
- pmm: mediastinger # 3
|
||||
- pmm: ratings # 4, 5, 6
|
||||
template_variables:
|
||||
rating1: user # 4 as this is user and mass_user_rating_update: mdb_tomatoes
|
||||
rating1_image: rt_tomato # 4 as this is user and mass_user_rating_update: mdb_tomatoes
|
||||
rating1_font: config/metadata/overlays/fonts/Adlib.ttf # 4 local font accessible to PMM
|
||||
rating1_font: config/custom_fonts/Adlib.ttf # 4 local font accessible to PMM
|
||||
rating1_font_size: 63 # 4 adjusted font size to fit rating
|
||||
|
||||
rating2: critic # 5 as this is critic and mass_critic_rating_update: imdb
|
||||
rating2_image: imdb # 5 as this is critic and mass_critic_rating_update: imdb
|
||||
rating2_font: config/metadata/overlays/fonts/Impact.ttf # 5 local font accessible to PMM
|
||||
rating2_font: config/custom_fonts/Impact.ttf # 5 local font accessible to PMM
|
||||
rating2_font_size: 70 # 5 adjusted font size to fit rating
|
||||
|
||||
rating3: audience # 6 as this is audience and mass_audience_rating_update: tmdb
|
||||
rating3_image: tmdb # 6 as this is audience and mass_audience_rating_update: tmdb
|
||||
rating3_font: config/metadata/overlays/fonts/Avenir_95_Black.ttf # 6 local font accessible to PMM
|
||||
rating3_font: config/custom_fonts/Avenir_95_Black.ttf # 6 local font accessible to PMM
|
||||
rating3_font_size: 70 # 6 adjusted font size to fit rating
|
||||
|
||||
horizontal_position: right # the set of ratings is on the right of the poster
|
||||
- pmm: streaming # 7
|
||||
- pmm: video_format # 8
|
||||
- pmm: ribbon # 9, #10
|
||||
- pmm: streaming # 7
|
||||
- pmm: video_format # 8
|
||||
- pmm: ribbon # 10, 11 Bottom right sash is used by more than one overlay so a weight for priority can be applied
|
||||
operations:
|
||||
mass_user_rating_update: mdb_tomatoes # 4 This operation will update the user rating in plex with Rotten Tomatoes ratings information
|
||||
mass_critic_rating_update: imdb # 5 This operation will update the critic rating in plex with IMDb ratings information
|
||||
|
@ -139,13 +136,13 @@ libraries:
|
|||
overlay_path:
|
||||
- remove_overlays: false
|
||||
- reapply_overlay: true
|
||||
- pmm: resolution # 1
|
||||
- pmm: resolution # 1
|
||||
template_variables:
|
||||
overlay_level: season
|
||||
- pmm: audio_codec # 2
|
||||
- pmm: audio_codec # 2
|
||||
template_variables:
|
||||
overlay_level: season
|
||||
- pmm: video_format # 3
|
||||
- pmm: video_format # 3
|
||||
template_variables:
|
||||
overlay_level: season
|
||||
```
|
||||
|
@ -163,34 +160,34 @@ libraries:
|
|||
overlay_path:
|
||||
- remove_overlays: false
|
||||
- reapply_overlay: true
|
||||
- pmm: resolution # 1
|
||||
- pmm: resolution # 1
|
||||
template_variables:
|
||||
overlay_level: episode
|
||||
- pmm: audio_codec # 2
|
||||
- pmm: audio_codec # 2
|
||||
template_variables:
|
||||
overlay_level: episode
|
||||
- pmm: ratings # 3,4
|
||||
- pmm: ratings # 3, 4
|
||||
template_variables:
|
||||
|
||||
rating1: critic # 3 as this is critic and mass_critic_rating_update: imdb
|
||||
rating1_image: imdb # 3 as this is critic and mass_critic_rating_update: imdb
|
||||
rating1_font: config/metadata/overlays/fonts/Impact.ttf # 3 local font accessible to PMM
|
||||
rating1_font: config/custom_fonts/Impact.ttf # 3 local font accessible to PMM
|
||||
rating1_font_size: 70 # 3 adjusted font size to fit rating
|
||||
|
||||
rating2: audience # 4 as this is audience and mass_audience_rating_update: tmdb
|
||||
rating2_image: tmdb # 4 as this is audience and mass_audience_rating_update: tmdb
|
||||
rating2_font: config/metadata/overlays/fonts/Avenir_95_Black.ttf # 4 local font accessible to PMM
|
||||
rating2_font: config/custom_fonts/Avenir_95_Black.ttf # 4 local font accessible to PMM
|
||||
rating2_font_size: 70 # 4 adjusted font size to fit rating
|
||||
|
||||
horizontal_position: right # the set of ratings is on the right of the poster
|
||||
overlay_level: episode
|
||||
- pmm: video_format # 5
|
||||
- pmm: video_format # 5
|
||||
template_variables:
|
||||
overlay_level: episode
|
||||
- pmm: episode_info # 6
|
||||
- pmm: episode_info # 6
|
||||
template_variables:
|
||||
overlay_level: episode
|
||||
- pmm: runtimes # 7
|
||||
- pmm: runtimes # 7
|
||||
template_variables:
|
||||
overlay_level: episode
|
||||
|
||||
|
@ -211,59 +208,55 @@ By default, most metadata files use separators to denote different sections of c
|
|||
|
||||
</details>
|
||||
|
||||
* Can be turned off by [customizing your config](#customizing-configs)
|
||||
* Can be turned off by [customizing your config](#customizing-configs)
|
||||
|
||||
## Collection Section Order
|
||||
|
||||
Almost every default metadata file has a `collection_section` attribute. These attributes determine the order of the various sections and can be set by [customizing your config](#customizing-configs).
|
||||
|
||||
For example: `collection_section:01` translates to `sort_title: "!<<collection_section>><<pre>><<order_<<key>>>><<sort>>"` and so for `genre.yml` if you have a `Fantasy` collection, plex is going to show `!06_Fantasy`
|
||||
For example: `collection_section: 01` translates to `sort_title: "!<<collection_section>><<pre>><<order_<<key>>>><<sort>>"` and so for `genre.yml` if you have a `Fantasy` collection, plex is going to show `!06_Fantasy`
|
||||
|
||||
This is the default PMM collection ordering:
|
||||
|
||||
|
||||
| Collection | Order |
|
||||
|:----------------------------------|:-----------------------|
|
||||
| `seasonal.yml` | collection_section: 00 |
|
||||
| `anilist.yml` | collection_section: 01 |
|
||||
| `basic.yml` | collection_section: 01 |
|
||||
| `imdb.yml` | collection_section: 01 |
|
||||
| `myanimelist.yml` | collection_section: 01 |
|
||||
| `other_chart.yml` | collection_section: 01 |
|
||||
| `tautulli.yml` | collection_section: 01 |
|
||||
| `tmdb.yml` | collection_section: 01 |
|
||||
| `trakt.yml` | collection_section: 01 |
|
||||
| `universe.yml` | collection_section: 02 |
|
||||
| `streaming.yml` | collection_section: 03 |
|
||||
| `network.yml` | collection_section: 04 |
|
||||
| `genre.yml` | collection_section: 06 |
|
||||
| `studio.yml` | collection_section: 07 |
|
||||
| `country.yml` | collection_section: 09 |
|
||||
| `country.yml` | collection_section: 09 |
|
||||
| `audio_language.yml` | collection_section: 10 |
|
||||
| `subtitle_language.yml` | collection_section: 11 |
|
||||
| `decade.yml` | collection_section: 12 |
|
||||
| `decade.yml` | collection_section: 12 |
|
||||
| `year.yml` | collection_section: 13 |
|
||||
| `content_rating_uk.yml` | collection_section: 14 |
|
||||
| `content_rating_us.yml` | collection_section: 14 |
|
||||
| `content_rating_us.yml` | collection_section: 14 |
|
||||
| `resolution.yml` | collection_section: 15 |
|
||||
| `resolution_standards.yml` | collection_section: 15 |
|
||||
| `bafta.yml` | collection_section: 16 |
|
||||
| `cannes.yml` | collection_section: 16 |
|
||||
| `choice.yml` | collection_section: 16 |
|
||||
| `emmy.yml` | collection_section: 16 |
|
||||
| `golden.yml` | collection_section: 16 |
|
||||
| `oscars.yml` | collection_section: 16 |
|
||||
| `other_awart.yml` | collection_section: 16 |
|
||||
| `separator.yml` | collection_section: 16 |
|
||||
| `spirit.yml` | collection_section: 16 |
|
||||
| `sundance.yml` | collection_section: 16 |
|
||||
| `pmm: actor.yml` | collection_section: 17 |
|
||||
| `director.yml` | collection_section: 18 |
|
||||
| `producer.yml` | collection_section: 19 |
|
||||
| `writer.yml` | collection_section: 20 |
|
||||
| Collection | Collection Section |
|
||||
|:----------------------------------|:-------------------|
|
||||
| `seasonal.yml` | `00` |
|
||||
| `anilist.yml` | `01` |
|
||||
| `basic.yml` | `01` |
|
||||
| `imdb.yml` | `01` |
|
||||
| `myanimelist.yml` | `01` |
|
||||
| `other_chart.yml` | `01` |
|
||||
| `tautulli.yml` | `01` |
|
||||
| `tmdb.yml` | `01` |
|
||||
| `trakt.yml` | `01` |
|
||||
| `universe.yml` | `02` |
|
||||
| `streaming.yml` | `03` |
|
||||
| `network.yml` | `04` |
|
||||
| `genre.yml` | `06` |
|
||||
| `studio.yml` | `07` |
|
||||
| `country.yml` | `09` |
|
||||
| `audio_language.yml` | `10` |
|
||||
| `subtitle_language.yml` | `11` |
|
||||
| `decade.yml` | `12` |
|
||||
| `year.yml` | `13` |
|
||||
| `content_rating_us.yml` | `14` |
|
||||
| `content_rating_uk.yml` | `14` |
|
||||
| `content_rating_cs.yml` | `14` |
|
||||
| `resolution.yml` | `15` |
|
||||
| `resolution_standards.yml` | `15` |
|
||||
| `bafta.yml` | `16` |
|
||||
| `cannes.yml` | `16` |
|
||||
| `choice.yml` | `16` |
|
||||
| `emmy.yml` | `16` |
|
||||
| `golden.yml` | `16` |
|
||||
| `oscars.yml` | `16` |
|
||||
| `other_award.yml` | `16` |
|
||||
| `spirit.yml` | `16` |
|
||||
| `sundance.yml` | `16` |
|
||||
| `actor.yml` | `17` |
|
||||
| `director.yml` | `18` |
|
||||
| `producer.yml` | `19` |
|
||||
| `writer.yml` | `20` |
|
||||
|
||||
## Ratings Overlays
|
||||
|
||||
|
|
|
@ -1,8 +1,8 @@
|
|||
# Separators Default Metadata File
|
||||
# Separators Default Metadata Files
|
||||
|
||||
Separators are a special form of collections which are used similar to index cards in a library, they help to "split up" collections by identifying categories (such as "Studio Collections" and "Holiday Collections").
|
||||
|
||||
These are empty collections which do not contain any movies/shows themselves, but highlight that the the collections which follow it are of a certain category.
|
||||
These are empty collections which do not contain any movies/shows themselves, but highlight that the collections which follow it are of a certain category.
|
||||
|
||||
Below is an example of a separator, which can be seen surrounded by a red square.
|
||||
|
||||
|
@ -30,6 +30,32 @@ libraries:
|
|||
use_separator: false
|
||||
```
|
||||
|
||||
## Separator Files
|
||||
|
||||
These are all the files that contain a separator.
|
||||
|
||||
| Collection Name | Default File | Collection Section |
|
||||
|:----------------------------------|:--------------------|:------------------:|
|
||||
| Seasonal Collections | `seasonal` | `00` |
|
||||
| Chart Collections | `separator_chart` | `01` |
|
||||
| Universe Collections | `universe` | `02` |
|
||||
| Streaming Collections | `streaming` | `03` |
|
||||
| Network Collections | `network` | `04` |
|
||||
| Genre Collections | `genre` | `06` |
|
||||
| Studio Collections | `studio` | `07` |
|
||||
| Country Collections | `country` | `09` |
|
||||
| Audio Language Collections | `audio_language` | `10` |
|
||||
| Subtitle Language Collections | `subtitle_language` | `11` |
|
||||
| Decade Collections | `decade` | `12` |
|
||||
| Year Collections | `year` | `13` |
|
||||
| Ratings Collections | `content_rating*` | `14` |
|
||||
| Resolution Collections | `resolution*` | `15` |
|
||||
| Award Collections | `separator_award` | `16` |
|
||||
| Actors Collections | `actor` | `17` |
|
||||
| Directors Collections | `director` | `18` |
|
||||
| Producers Collections | `producer` | `19` |
|
||||
| Writers Collections | `writer` | `20` |
|
||||
|
||||
## Alternative Styles
|
||||
|
||||
Multiple styles are available for Separators, to match Plex's "categories" feature.
|
||||
|
|
25
docs/defaults/variables.md
Normal file
25
docs/defaults/variables.md
Normal file
|
@ -0,0 +1,25 @@
|
|||
# Shared Template Variables
|
||||
|
||||
There are some `templates_variables` that all of the PMM Defaults expect `franchise` can use to manipulate the file from the default settings which are provided.
|
||||
|
||||
Note that the `templates_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is just ignored.
|
||||
|
||||
Below are the available variables which can be used to customize the file.
|
||||
|
||||
| Attribute | Description & Values |
|
||||
|:--------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_<<key>>`<sup>*</sup> | **Description:** Turns off individual Collections in a Default's file.<br>**Values:** `false` to turn off the collection |
|
||||
| `collection_section` | **Description:** Controls the sort order of the collection sections against other default collection sections.<br>**Values:** Any number |
|
||||
| `order_<<key>>`<sup>*</sup> | **Description:** Controls the sort order of the collections in each collection section.<br>**Values:** Any number |
|
||||
| `collection_mode` | **Description:** Controls the collection mode of these collections.<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`hide`</td><td>Hide Collection</td></tr><tr><td>`hide_items`</td><td>Hide Items in this Collection</td></tr><tr><td>`show_items`</td><td>Show this Collection and its Items</td></tr></table> |
|
||||
| `visible_library_<<key>>`<sup>*</sup> | **Description:** Controls collection visible on Library (Only works with Plex Pass)<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Visible</td></tr><tr><td>`false`</td><td>Not Visible</td></tr><tr><td>[Any `schedule` Option](../metadata/details/schedule)</td><td>Visible When Scheduled</td></tr></table> |
|
||||
| `visible_home_<<key>>`<sup>*</sup> | **Description:** Controls collection visible on Home (Only works with Plex Pass)<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Visible</td></tr><tr><td>`false`</td><td>Not Visible</td></tr><tr><td>[Any `schedule` Option](../metadata/details/schedule)</td><td>Visible When Scheduled</td></tr></table> |
|
||||
| `visible_shared_<<key>>`<sup>*</sup> | **Description:** Controls collection visible on Shared Users' Home (Only works with Plex Pass)<br>**Values:**<table class="clearTable"><tr><td>`true`</td><td>Visible</td></tr><tr><td>`false`</td><td>Not Visible</td></tr><tr><td>[Any `schedule` Option](../metadata/details/schedule)</td><td>Visible When Scheduled</td></tr></table> |
|
||||
| `radarr_add_missing` | **Description:** Override Radarr `add_missing` attribute for these collections<hr>**Values:** `true` or `false` |
|
||||
| `radarr_folder` | **Description:** Override Radarr `root_folder_path` attribute for these collections<hr>**Values:** Folder Path |
|
||||
| `radarr_tag` | **Description:** Override Radarr `tag` attribute for these collections<hr>**Values:** List or comma-separated string of tags |
|
||||
| `item_radarr_tag` | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr for these collections<hr>**Values:** List or comma-separated string of tags |
|
||||
| `sonarr_add_missing` | **Description:** Override Sonarr `add_missing` attribute for these collections<hr>**Values:** `true` or `false` |
|
||||
| `sonarr_folder` | **Description:** Override Sonarr `root_folder_path` attribute for these collections<hr>**Values:** Folder Path |
|
||||
| `sonarr_tag` | **Description:** Override Sonarr `tag` attribute for these collections<hr>**Values:** List or comma-separated string of tags |
|
||||
| `item_sonarr_tag` | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr for these collections<hr>**Values:** List or comma-separated string of tags |
|
|
@ -1,6 +1,6 @@
|
|||
# Metadata Details
|
||||
|
||||
## Collection/Playlist Details
|
||||
## Collection/Playlist Metadata Details
|
||||
|
||||
All the following attributes update various details of the collection/playlist's Metadata.
|
||||
|
||||
|
@ -14,7 +14,7 @@ Only `tmdb_person` works with Playlists.
|
|||
| `label` | **Description:** Appends new labels.<br>**Values:** Comma-separated string of labels to append |
|
||||
| `label.remove` | **Description:** Removes existing labels from the collection.<br>**Values:** Comma-separated string of labels to remove |
|
||||
| `label.sync` | **Description:** Matches the labels of the collection to the labels provided (Leave blank to remove all labels)<br>**Values:** Comma-separated string of labels to sync |
|
||||
| `collection_mode` | **Description:** Changes the Collection Mode<br>**Normal Collections Only**<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`hide`</td><td>Hide Collection</td></tr><tr><td>`hide_items`</td><td>Hide Items in this Collection</td></tr><tr><td>`show_items`</td><td>Show this Collection and its Items</td></tr></table> |
|
||||
| `collection_mode` | **Description:** Changes the Collection Mode<br>**Values:**<table class="clearTable"><tr><td>`default`</td><td>Library default</td></tr><tr><td>`hide`</td><td>Hide Collection</td></tr><tr><td>`hide_items`</td><td>Hide Items in this Collection</td></tr><tr><td>`show_items`</td><td>Show this Collection and its Items</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order<br>**Normal Collections Only**<br>When using `custom` you can only have a single builder in the collection.<br>**Values:**<table class="clearTable"><tr><td>`release`</td><td>Order Collection by Release Dates</td></tr><tr><td>`alpha`</td><td>Order Collection Alphabetically</td></tr><tr><td>`custom`</td><td>Order Collection Via the Builder Order</td></tr><tr><td>[Any `plex_search` Sort Option](../builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_filtering` | **Description:** Changes the Collection Filtering<br>**Smart Collections Only**<br>**Values:**<table class="clearTable"><tr><td>`admin`</td><td>Always the server admin user</td></tr><tr><td>`user`</td><td>User currently viewing the content</td></tr></table> |
|
||||
| `builder_level` | **Description:** Make season, episode, album or track collections/overlays from `plex_all`, `plex_search`, `trakt_list`, or `imdb_list` Builders and Filters<br>**Values:**<table class="clearTable"><tr><td>`season`</td><td>Collection contains seasons</td></tr><tr><td>`episode`</td><td>Collection contains episodes</td></tr><tr><td>`album`</td><td>Collection contains albums</td></tr><tr><td>`track`</td><td>Collection contains tracks</td></tr></table> |
|
||||
|
|
|
@ -134,7 +134,10 @@ class DataFile:
|
|||
content_path = os.path.abspath(f"{file_path}/default.yml" if translation else file_path)
|
||||
dir_path = file_path
|
||||
if not os.path.exists(content_path):
|
||||
raise Failed(f"File Error: File does not exist {content_path}")
|
||||
if file_type == "PMM Default":
|
||||
raise Failed(f"File Error: Default does not exist {file_path}")
|
||||
else:
|
||||
raise Failed(f"File Error: File does not exist {content_path}")
|
||||
yaml = YAML(path=content_path, check_empty=True)
|
||||
if not translation:
|
||||
logger.debug(f"File Loaded From: {content_path}")
|
||||
|
@ -530,12 +533,22 @@ class MetadataFile(DataFile):
|
|||
og_exclude = util.parse("Config", "exclude", self.temp_vars["exclude"], parent="template_variable", datatype="strlist")
|
||||
elif "exclude" in methods:
|
||||
og_exclude = util.parse("Config", "exclude", dynamic, parent=map_name, methods=methods, datatype="strlist")
|
||||
if "append_exclude" in self.temp_vars:
|
||||
og_exclude.extend(util.parse("Config", "append_exclude", self.temp_vars["append_exclude"], parent="template_variable", datatype="strlist"))
|
||||
include = []
|
||||
if "include" in self.temp_vars:
|
||||
include = [i for i in util.parse("Config", "include", self.temp_vars["include"], parent="template_variable", datatype="strlist") if i not in og_exclude]
|
||||
include = util.parse("Config", "include", self.temp_vars["include"], parent="template_variable", datatype="strlist")
|
||||
elif "include" in methods:
|
||||
include = [i for i in util.parse("Config", "include", dynamic, parent=map_name, methods=methods, datatype="strlist") if i not in og_exclude]
|
||||
if "append_include" in self.temp_vars:
|
||||
include.extend(util.parse("Config", "append_include", self.temp_vars["append_include"], parent="template_variable", datatype="strlist"))
|
||||
addons = util.parse("Config", "addons", dynamic, parent=map_name, methods=methods, datatype="dictliststr") if "addons" in methods else {}
|
||||
if "append_addons" in self.temp_vars:
|
||||
append_addons = util.parse("Config", "append_addons", dynamic, parent=map_name, methods=methods, datatype="dictliststr")
|
||||
for k, v in append_addons.items():
|
||||
if k not in addons:
|
||||
addons[k] = []
|
||||
addons[k].extend(v)
|
||||
exclude = [str(e) for e in og_exclude]
|
||||
for k, v in addons.items():
|
||||
if k in v:
|
||||
|
|
Loading…
Reference in a new issue