mirror of
https://github.com/meisnate12/Plex-Meta-Manager
synced 2024-11-10 06:54:21 +00:00
[84] award default update
This commit is contained in:
meisnate12
parent
cd5ef5157f
commit
6b8751f6da
124 changed files with 3524 additions and 2089 deletions
2
VERSION
2
VERSION
|
|
@ -1 +1 @@
|
|||
1.19.1-develop83
|
||||
1.19.1-develop84
|
||||
|
|
|
|||
58
defaults/award/berlinale.yml
Normal file
58
defaults/award/berlinale.yml
Normal file
|
|
@ -0,0 +1,58 @@
|
|||
##############################################################################
|
||||
# Berlinale Awards Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
|
||||
# https://metamanager.wiki/en/latest/defaults/award/berlinale #
|
||||
##############################################################################
|
||||
|
||||
external_templates:
|
||||
pmm: templates
|
||||
template_variables:
|
||||
collection_section: 130
|
||||
|
||||
collections:
|
||||
Berlinale Golden Bears:
|
||||
variables:
|
||||
key: golden
|
||||
template:
|
||||
- name: shared
|
||||
sort: Berlinale !
|
||||
allowed_libraries: movie
|
||||
image: award/berlinale/winner
|
||||
translation_key: berlinale_best
|
||||
- name: arr
|
||||
- name: custom
|
||||
imdb_award:
|
||||
event_id: ev0000091
|
||||
event_year: all
|
||||
award_filter: golden berlin bear
|
||||
winning: true
|
||||
|
||||
dynamic_collections:
|
||||
Berlinale Awards:
|
||||
type: imdb_awards
|
||||
sync: true
|
||||
data:
|
||||
event_id: ev0000091
|
||||
starting: latest-5
|
||||
ending: latest
|
||||
title_format: Berlinale <<key_name>>
|
||||
template:
|
||||
- use_year_collections
|
||||
- imdb_award
|
||||
- shared
|
||||
- arr
|
||||
- custom
|
||||
template_variables:
|
||||
winning:
|
||||
default: true
|
||||
collection_order:
|
||||
default: release
|
||||
allowed_libraries:
|
||||
default: movie
|
||||
image:
|
||||
default: award/berlinale/<<key>>
|
||||
translation_key:
|
||||
default: berlinale_year
|
||||
dynamic:
|
||||
default: true
|
||||
59
defaults/award/cesar.yml
Normal file
59
defaults/award/cesar.yml
Normal file
|
|
@ -0,0 +1,59 @@
|
|||
##############################################################################
|
||||
# Cesar Awards Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
|
||||
# https://metamanager.wiki/en/latest/defaults/award/cesar #
|
||||
##############################################################################
|
||||
|
||||
external_templates:
|
||||
pmm: templates
|
||||
template_variables:
|
||||
collection_section: 130
|
||||
|
||||
collections:
|
||||
César Best Film Winners:
|
||||
variables:
|
||||
key: best
|
||||
template:
|
||||
- name: shared
|
||||
sort: Cesar !
|
||||
allowed_libraries: movie
|
||||
image: award/cesar/winner
|
||||
translation_key: cesar_best
|
||||
- name: arr
|
||||
- name: custom
|
||||
imdb_award:
|
||||
event_id: ev0000157
|
||||
event_year: all
|
||||
award_filter: César
|
||||
category_filter: best film (meilleur film)
|
||||
winning: true
|
||||
|
||||
dynamic_collections:
|
||||
Cesar Awards:
|
||||
type: imdb_awards
|
||||
sync: true
|
||||
data:
|
||||
event_id: ev0000157
|
||||
starting: latest-5
|
||||
ending: latest
|
||||
title_format: Cesar <<key_name>>
|
||||
template:
|
||||
- use_year_collections
|
||||
- imdb_award
|
||||
- shared
|
||||
- arr
|
||||
- custom
|
||||
template_variables:
|
||||
winning:
|
||||
default: true
|
||||
collection_order:
|
||||
default: release
|
||||
allowed_libraries:
|
||||
default: movie
|
||||
image:
|
||||
default: award/cesar/<<key>>
|
||||
translation_key:
|
||||
default: cesar_year
|
||||
dynamic:
|
||||
default: true
|
||||
|
|
@ -10,6 +10,48 @@ external_templates:
|
|||
template_variables:
|
||||
collection_section: 130
|
||||
|
||||
collections:
|
||||
Emmys Best in Category Winners:
|
||||
variables:
|
||||
key: best
|
||||
template:
|
||||
- name: shared
|
||||
sort: Emmys !
|
||||
allowed_libraries: show
|
||||
image: award/emmys/winner
|
||||
translation_key: emmy_best
|
||||
- name: arr
|
||||
- name: custom
|
||||
imdb_award:
|
||||
event_id: ev0000223
|
||||
event_year: all
|
||||
category_filter:
|
||||
- best comedy series
|
||||
- best comedy show
|
||||
- best dramatic anthology series
|
||||
- best dramatic program
|
||||
- best dramatic series
|
||||
- best dramatic series - less than one hour
|
||||
- best dramatic series - one hour or longer
|
||||
- best series - half hour or less
|
||||
- best series - one hour or more
|
||||
- outstanding animated program
|
||||
- outstanding animated program (for programming less than one hour)
|
||||
- outstanding animated program (for programming more than one hour)
|
||||
- outstanding animated program (for programming one hour or less)
|
||||
- outstanding animated program (for programming one hour or more)
|
||||
- outstanding animated programming
|
||||
- outstanding comedy series
|
||||
- outstanding drama series
|
||||
- outstanding drama series - continuing
|
||||
- outstanding drama/comedy - limited episodes
|
||||
- outstanding dramatic program
|
||||
- outstanding dramatic series
|
||||
- outstanding miniseries
|
||||
- outstanding series - comedy
|
||||
- outstanding series - drama
|
||||
winning: true
|
||||
|
||||
dynamic_collections:
|
||||
Emmy Awards:
|
||||
type: imdb_awards
|
||||
|
|
|
|||
57
defaults/award/nfr.yml
Normal file
57
defaults/award/nfr.yml
Normal file
|
|
@ -0,0 +1,57 @@
|
|||
##############################################################################
|
||||
# National Film Registry Awards Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
|
||||
# https://metamanager.wiki/en/latest/defaults/award/nfr #
|
||||
##############################################################################
|
||||
|
||||
external_templates:
|
||||
pmm: templates
|
||||
template_variables:
|
||||
collection_section: 130
|
||||
|
||||
collections:
|
||||
National Film Registry All Time:
|
||||
variables:
|
||||
key: all_time
|
||||
template:
|
||||
- name: shared
|
||||
sort: National Film Registry !
|
||||
allowed_libraries: movie
|
||||
image: award/nfr/all_time
|
||||
translation_key: nfr_best
|
||||
- name: arr
|
||||
- name: custom
|
||||
imdb_award:
|
||||
event_id: ev0000468
|
||||
event_year: all
|
||||
winning: true
|
||||
|
||||
dynamic_collections:
|
||||
National Film Registry Awards:
|
||||
type: imdb_awards
|
||||
sync: true
|
||||
data:
|
||||
event_id: ev0000468
|
||||
starting: latest-5
|
||||
ending: latest
|
||||
title_format: National Film Registry <<key_name>>
|
||||
template:
|
||||
- use_year_collections
|
||||
- imdb_award
|
||||
- shared
|
||||
- arr
|
||||
- custom
|
||||
template_variables:
|
||||
winning:
|
||||
default: true
|
||||
collection_order:
|
||||
default: release
|
||||
allowed_libraries:
|
||||
default: movie
|
||||
image:
|
||||
default: award/nfr/<<key>>
|
||||
translation_key:
|
||||
default: nfr_year
|
||||
dynamic:
|
||||
default: true
|
||||
|
|
@ -1,76 +0,0 @@
|
|||
##############################################################################
|
||||
# Other Awards Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
|
||||
# https://metamanager.wiki/en/latest/defaults/award/other #
|
||||
##############################################################################
|
||||
|
||||
external_templates:
|
||||
pmm: templates
|
||||
template_variables:
|
||||
collection_section: 130
|
||||
|
||||
collections:
|
||||
Berlinale Golden Bears:
|
||||
variables:
|
||||
key: berlinale
|
||||
template:
|
||||
- name: shared
|
||||
allowed_libraries: movie
|
||||
image: award/berlinale/winner
|
||||
translation_key: berlinale_best
|
||||
- name: arr
|
||||
- name: custom
|
||||
imdb_award:
|
||||
event_id: ev0000091
|
||||
event_year: all
|
||||
category_filter: best film
|
||||
winning: true
|
||||
|
||||
César Best Film Winners:
|
||||
variables:
|
||||
key: cesar
|
||||
template:
|
||||
- name: shared
|
||||
allowed_libraries: movie
|
||||
image: award/cesar/winner
|
||||
translation_key: cesar_best
|
||||
- name: arr
|
||||
- name: custom
|
||||
imdb_award:
|
||||
event_id: ev0000157
|
||||
event_year: all
|
||||
category_filter: best film (meilleur film)
|
||||
winning: true
|
||||
|
||||
Razzies Golden Raspberry Winners:
|
||||
variables:
|
||||
key: razzie
|
||||
template:
|
||||
- name: shared
|
||||
allowed_libraries: movie
|
||||
image: award/razzie/winner
|
||||
translation_key: razzie_worst
|
||||
- name: arr
|
||||
- name: custom
|
||||
imdb_award:
|
||||
event_id: ev0000558
|
||||
event_year: all
|
||||
category_filter: worst picture
|
||||
winning: true
|
||||
|
||||
Venice Golden Lions:
|
||||
variables:
|
||||
key: venice
|
||||
template:
|
||||
- name: shared
|
||||
allowed_libraries: movie
|
||||
image: award/venice/winner
|
||||
translation_key: venice_best
|
||||
- name: arr
|
||||
- name: custom
|
||||
imdb_award:
|
||||
event_id: ev0000681
|
||||
event_year: all
|
||||
award_filter: golden lion
|
||||
winning: true
|
||||
64
defaults/award/pca.yml
Normal file
64
defaults/award/pca.yml
Normal file
|
|
@ -0,0 +1,64 @@
|
|||
##############################################################################
|
||||
# People's Choice Awards Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
|
||||
# https://metamanager.wiki/en/latest/defaults/award/pca #
|
||||
##############################################################################
|
||||
|
||||
external_templates:
|
||||
pmm: templates
|
||||
template_variables:
|
||||
collection_section: 130
|
||||
|
||||
collections:
|
||||
Peoples Choice Award Winners:
|
||||
variables:
|
||||
key: best
|
||||
template:
|
||||
- name: shared
|
||||
sort: People's Choice Awards !
|
||||
image: award/pca/winner
|
||||
translation_key: pca_best
|
||||
- name: arr
|
||||
- name: custom
|
||||
imdb_award:
|
||||
event_id: ev0000530
|
||||
event_year: all
|
||||
category_filter:
|
||||
- all-time favorite tv program
|
||||
- favorite all-time motion picture
|
||||
- favorite motion picture
|
||||
- favorite movie
|
||||
- favorite non-musical motion picture
|
||||
- favorite overall motion picture
|
||||
- favorite tv show
|
||||
- the movie of 2022
|
||||
- the show of 2021
|
||||
winning: true
|
||||
|
||||
dynamic_collections:
|
||||
Peoples Choice Awards:
|
||||
type: imdb_awards
|
||||
sync: true
|
||||
data:
|
||||
event_id: ev0000530
|
||||
starting: latest-5
|
||||
ending: latest
|
||||
title_format: People's Choice Awards <<key_name>>
|
||||
template:
|
||||
- use_year_collections
|
||||
- imdb_award
|
||||
- shared
|
||||
- arr
|
||||
- custom
|
||||
template_variables:
|
||||
winning:
|
||||
default: true
|
||||
collection_order:
|
||||
default: release
|
||||
image:
|
||||
default: award/pca/<<key>>
|
||||
translation_key:
|
||||
default: pca_year
|
||||
dynamic:
|
||||
default: true
|
||||
58
defaults/award/razzie.yml
Normal file
58
defaults/award/razzie.yml
Normal file
|
|
@ -0,0 +1,58 @@
|
|||
##############################################################################
|
||||
# Razzie Awards Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
|
||||
# https://metamanager.wiki/en/latest/defaults/award/razzie #
|
||||
##############################################################################
|
||||
|
||||
external_templates:
|
||||
pmm: templates
|
||||
template_variables:
|
||||
collection_section: 130
|
||||
|
||||
collections:
|
||||
Razzies Golden Raspberry Winners:
|
||||
variables:
|
||||
key: golden
|
||||
template:
|
||||
- name: shared
|
||||
sort: Razzie !
|
||||
allowed_libraries: movie
|
||||
image: award/razzie/winner
|
||||
translation_key: razzie_worst
|
||||
- name: arr
|
||||
- name: custom
|
||||
imdb_award:
|
||||
event_id: ev0000558
|
||||
event_year: all
|
||||
category_filter: worst picture
|
||||
winning: true
|
||||
|
||||
dynamic_collections:
|
||||
Razzie Awards:
|
||||
type: imdb_awards
|
||||
sync: true
|
||||
data:
|
||||
event_id: ev0000558
|
||||
starting: latest-5
|
||||
ending: latest
|
||||
title_format: Razzie <<key_name>>
|
||||
template:
|
||||
- use_year_collections
|
||||
- imdb_award
|
||||
- shared
|
||||
- arr
|
||||
- custom
|
||||
template_variables:
|
||||
winning:
|
||||
default: true
|
||||
collection_order:
|
||||
default: release
|
||||
allowed_libraries:
|
||||
default: movie
|
||||
image:
|
||||
default: award/razzie/<<key>>
|
||||
translation_key:
|
||||
default: razzie_year
|
||||
dynamic:
|
||||
default: true
|
||||
61
defaults/award/sag.yml
Normal file
61
defaults/award/sag.yml
Normal file
|
|
@ -0,0 +1,61 @@
|
|||
##############################################################################
|
||||
# Screen Actors Guild Awards Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
|
||||
# https://metamanager.wiki/en/latest/defaults/award/sag #
|
||||
##############################################################################
|
||||
|
||||
external_templates:
|
||||
pmm: templates
|
||||
template_variables:
|
||||
collection_section: 130
|
||||
|
||||
collections:
|
||||
Screen Actors Guild Award Winners:
|
||||
variables:
|
||||
key: best
|
||||
template:
|
||||
- name: shared
|
||||
sort: Screen Actors Guild !
|
||||
image: award/sag/winner
|
||||
translation_key: sag_best
|
||||
- name: arr
|
||||
- name: custom
|
||||
imdb_award:
|
||||
event_id: ev0000598
|
||||
event_year: all
|
||||
category_filter:
|
||||
- outstanding performance by a cast
|
||||
- outstanding performance by a cast in a motion picture
|
||||
- outstanding performance by a cast in a theatrical motion picture
|
||||
- outstanding performance by an ensemble in a comedy series
|
||||
- outstanding performance by an ensemble in a drama series
|
||||
- outstanding performance by the cast of a theatrical motion picture
|
||||
winning: true
|
||||
|
||||
dynamic_collections:
|
||||
Screen Actors Guild Awards:
|
||||
type: imdb_awards
|
||||
sync: true
|
||||
data:
|
||||
event_id: ev0000598
|
||||
starting: latest-5
|
||||
ending: latest
|
||||
title_format: Screen Actors Guild <<key_name>>
|
||||
template:
|
||||
- use_year_collections
|
||||
- imdb_award
|
||||
- shared
|
||||
- arr
|
||||
- custom
|
||||
template_variables:
|
||||
winning:
|
||||
default: true
|
||||
collection_order:
|
||||
default: release
|
||||
image:
|
||||
default: award/sag/<<key>>
|
||||
translation_key:
|
||||
default: sag_year
|
||||
dynamic:
|
||||
default: true
|
||||
65
defaults/award/tiff.yml
Normal file
65
defaults/award/tiff.yml
Normal file
|
|
@ -0,0 +1,65 @@
|
|||
##############################################################################
|
||||
# Toronto International Film Festival Awards Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
|
||||
# https://metamanager.wiki/en/latest/defaults/award/tiff #
|
||||
##############################################################################
|
||||
|
||||
external_templates:
|
||||
pmm: templates
|
||||
template_variables:
|
||||
collection_section: 130
|
||||
|
||||
collections:
|
||||
Toronto People's Choice Award Winners:
|
||||
variables:
|
||||
key: best
|
||||
template:
|
||||
- name: shared
|
||||
sort: Toronto International Film Festival !
|
||||
allowed_libraries: movie
|
||||
image: award/tiff/winner
|
||||
translation_key: tiff_best
|
||||
- name: arr
|
||||
- name: custom
|
||||
imdb_award:
|
||||
event_id: ev0000659
|
||||
event_year: all
|
||||
award_filter:
|
||||
- people's choice award
|
||||
- grolsch people's choice award
|
||||
category_filter:
|
||||
- best film
|
||||
- people's choice award
|
||||
- grolsch people's choice award
|
||||
- gala or special presentations
|
||||
winning: true
|
||||
|
||||
dynamic_collections:
|
||||
Toronto International Film Festival Awards:
|
||||
type: imdb_awards
|
||||
sync: true
|
||||
data:
|
||||
event_id: ev0000659
|
||||
starting: latest-5
|
||||
ending: latest
|
||||
title_format: Toronto International Film Festival <<key_name>>
|
||||
template:
|
||||
- use_year_collections
|
||||
- imdb_award
|
||||
- shared
|
||||
- arr
|
||||
- custom
|
||||
template_variables:
|
||||
winning:
|
||||
default: true
|
||||
collection_order:
|
||||
default: release
|
||||
allowed_libraries:
|
||||
default: movie
|
||||
image:
|
||||
default: award/tiff/<<key>>
|
||||
translation_key:
|
||||
default: tiff_year
|
||||
dynamic:
|
||||
default: true
|
||||
66
defaults/award/venice.yml
Normal file
66
defaults/award/venice.yml
Normal file
|
|
@ -0,0 +1,66 @@
|
|||
##############################################################################
|
||||
# Venice Awards Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
|
||||
# https://metamanager.wiki/en/latest/defaults/award/venice #
|
||||
##############################################################################
|
||||
|
||||
external_templates:
|
||||
pmm: templates
|
||||
template_variables:
|
||||
collection_section: 130
|
||||
|
||||
collections:
|
||||
Venice Golden Lions:
|
||||
variables:
|
||||
key: golden
|
||||
template:
|
||||
- name: shared
|
||||
sort: Venice !
|
||||
allowed_libraries: movie
|
||||
image: award/venice/winner
|
||||
translation_key: venice_best
|
||||
- name: arr
|
||||
- name: custom
|
||||
imdb_award:
|
||||
event_id: ev0000681
|
||||
event_year: all
|
||||
award_filter:
|
||||
- golden lion
|
||||
- international critics award
|
||||
- grand international award
|
||||
category_filter:
|
||||
- golden lion
|
||||
- best feature film
|
||||
- best film
|
||||
- grand international award
|
||||
winning: true
|
||||
|
||||
dynamic_collections:
|
||||
Venice Awards:
|
||||
type: imdb_awards
|
||||
sync: true
|
||||
data:
|
||||
event_id: ev0000681
|
||||
starting: latest-5
|
||||
ending: latest
|
||||
title_format: Venice <<key_name>>
|
||||
template:
|
||||
- use_year_collections
|
||||
- imdb_award
|
||||
- shared
|
||||
- arr
|
||||
- custom
|
||||
template_variables:
|
||||
winning:
|
||||
default: true
|
||||
collection_order:
|
||||
default: release
|
||||
allowed_libraries:
|
||||
default: movie
|
||||
image:
|
||||
default: award/venice/<<key>>
|
||||
translation_key:
|
||||
default: venice_year
|
||||
dynamic:
|
||||
default: true
|
||||
|
|
@ -8,9 +8,11 @@
|
|||
templates:
|
||||
collectionless:
|
||||
default:
|
||||
# check1
|
||||
exclude_prefix:
|
||||
- "!"
|
||||
- "~"
|
||||
# check2
|
||||
sort_title: ~_Collectionless
|
||||
collection_order: alpha
|
||||
url_poster: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager-Images/master/collectionless.jpg
|
||||
|
|
|
|||
|
|
@ -81,13 +81,13 @@ dynamic_collections:
|
|||
fast: movie
|
||||
rocky: movie
|
||||
mummy: movie
|
||||
trakt_url:
|
||||
# check1
|
||||
trakt_url:
|
||||
mcu: https://trakt.tv/users/donxy/lists/marvel-cinematic-universe
|
||||
trek: https://trakt.tv/users/wdvhucb/lists/star-trek
|
||||
middle: https://trakt.tv/users/oya-kesh/lists/middle-earth
|
||||
mdblist_url:
|
||||
# check2
|
||||
mdblist_url:
|
||||
avp: https://mdblist.com/lists/plexmetamanager/external/16872
|
||||
arrow: https://mdblist.com/lists/plexmetamanager/external/15113
|
||||
dca: https://mdblist.com/lists/plexmetamanager/external/15405
|
||||
|
|
@ -100,5 +100,6 @@ dynamic_collections:
|
|||
askew: https://mdblist.com/lists/plexmetamanager/external/15362
|
||||
wizard: https://mdblist.com/lists/plexmetamanager/external/23683
|
||||
xmen: https://mdblist.com/lists/plexmetamanager/external/9244
|
||||
# check3
|
||||
image:
|
||||
default: universe/<<key>>
|
||||
|
|
|
|||
|
|
@ -22,12 +22,12 @@ templates:
|
|||
season:
|
||||
default:
|
||||
limit: 100
|
||||
limit_trending: <<limit>>
|
||||
limit_season: <<limit>>
|
||||
anilist_search:
|
||||
season: current
|
||||
year:
|
||||
sort_by: popular
|
||||
limit: <<limit_trending>>
|
||||
limit: <<limit_season>>
|
||||
|
||||
collections:
|
||||
AniList Popular:
|
||||
|
|
|
|||
|
|
@ -97,8 +97,8 @@ dynamic_collections:
|
|||
535313: Godzilla (MonsterVerse)
|
||||
535790: Godzilla (Anime)
|
||||
template_variables:
|
||||
# check1
|
||||
movie:
|
||||
# check1
|
||||
105995: 336560 # Anaconda: Lake Placid vs. Anaconda
|
||||
176097: 14177 # Barbershop: Beauty Shop
|
||||
448150: 567604 # Deadpool: Once Upon a Deadpool
|
||||
|
|
@ -125,8 +125,8 @@ dynamic_collections:
|
|||
10194: 130925 # Toy Story: Partysaurus Rex
|
||||
63043: 73362 # TRON: TRON: The Next Day
|
||||
748: 567604 # X-Men: Once Upon a Deadpool
|
||||
# check2
|
||||
name_mapping:
|
||||
# check2
|
||||
1565: 28 Days-Weeks Later
|
||||
508334: Angels in the
|
||||
115838: Escape From
|
||||
|
|
|
|||
|
|
@ -101,8 +101,8 @@ dynamic_collections:
|
|||
- shared
|
||||
- arr
|
||||
template_variables:
|
||||
# check1
|
||||
emoji:
|
||||
# check1
|
||||
years: "🎊 "
|
||||
valentine: "💘 "
|
||||
patrick: "☘ "
|
||||
|
|
@ -122,8 +122,8 @@ dynamic_collections:
|
|||
latinx: "🪅 "
|
||||
women: "🚺 "
|
||||
black_history: "✊ 🏿 "
|
||||
# check2
|
||||
schedule:
|
||||
# check2
|
||||
years: range(12/26-01/04)
|
||||
valentine: range(02/01-02/29)
|
||||
patrick: range(03/01-03/18)
|
||||
|
|
@ -143,8 +143,8 @@ dynamic_collections:
|
|||
lgbtq: range(05/31-06/30)
|
||||
latinx: range(09/15-10/15)
|
||||
women: range(02/28-03/31)
|
||||
# check3
|
||||
imdb_list:
|
||||
# check3
|
||||
years: https://www.imdb.com/list/ls066838460/
|
||||
valentine:
|
||||
- https://www.imdb.com/list/ls000094398/
|
||||
|
|
@ -170,14 +170,14 @@ dynamic_collections:
|
|||
- https://www.imdb.com/list/ls000835734/
|
||||
- https://www.imdb.com/list/ls091597850/
|
||||
christmas: https://www.imdb.com/list/ls000096828/
|
||||
# check4
|
||||
imdb_search:
|
||||
# check4
|
||||
women:
|
||||
keyword.any: women in film, womens rights, womens suffrage
|
||||
sort_by: rating.desc
|
||||
limit: 500
|
||||
# check5
|
||||
tmdb_collection:
|
||||
# check5
|
||||
halloween:
|
||||
- 185103 # Hotel Transylvania
|
||||
- 11716 # Addams Family
|
||||
|
|
@ -189,12 +189,12 @@ dynamic_collections:
|
|||
- 8091 # Alien Collection
|
||||
- 2980 # Ghostbusters
|
||||
- 751156 # Hocus Pocus
|
||||
# check6
|
||||
tmdb_movie:
|
||||
# check6
|
||||
halloween:
|
||||
- 23437 # A Nightmare on Elm Street (2010)
|
||||
# check7
|
||||
mdblist_list:
|
||||
# check7
|
||||
aapi:
|
||||
- https://mdblist.com/lists/plexmetamanager/asian-american-pacific-islander-heritage-month
|
||||
disabilities:
|
||||
|
|
@ -203,11 +203,12 @@ dynamic_collections:
|
|||
- https://mdblist.com/lists/plexmetamanager/lgbtq-pride-month
|
||||
latinx:
|
||||
- https://mdblist.com/lists/plexmetamanager/latinx-heritage-month
|
||||
# check8
|
||||
trakt_list:
|
||||
# check8
|
||||
black_history:
|
||||
- https://trakt.tv/users/hoochzilla/lists/black-cinema?display=movie&sort=title,asc
|
||||
- https://trakt.tv/users/bluephi8/lists/black-history?display=movie&sort=title,asc
|
||||
# check9
|
||||
visible_home:
|
||||
default: true
|
||||
visible_shared:
|
||||
|
|
|
|||
|
|
@ -152,9 +152,35 @@ overlays:
|
|||
Emmys Winner:
|
||||
variables: {key: emmys, weight: 90}
|
||||
template: [name: standard, name: ribbon]
|
||||
imdb_search:
|
||||
event.winning: emmy
|
||||
limit: 1000
|
||||
imdb_award:
|
||||
event_id: ev0000223
|
||||
event_year: all
|
||||
category_filter:
|
||||
- best comedy series
|
||||
- best comedy show
|
||||
- best dramatic anthology series
|
||||
- best dramatic program
|
||||
- best dramatic series
|
||||
- best dramatic series - less than one hour
|
||||
- best dramatic series - one hour or longer
|
||||
- best series - half hour or less
|
||||
- best series - one hour or more
|
||||
- outstanding animated program
|
||||
- outstanding animated program (for programming less than one hour)
|
||||
- outstanding animated program (for programming more than one hour)
|
||||
- outstanding animated program (for programming one hour or less)
|
||||
- outstanding animated program (for programming one hour or more)
|
||||
- outstanding animated programming
|
||||
- outstanding comedy series
|
||||
- outstanding drama series
|
||||
- outstanding drama series - continuing
|
||||
- outstanding drama/comedy - limited episodes
|
||||
- outstanding dramatic program
|
||||
- outstanding dramatic series
|
||||
- outstanding miniseries
|
||||
- outstanding series - comedy
|
||||
- outstanding series - drama
|
||||
winning: true
|
||||
|
||||
Critics Choice Winners:
|
||||
variables: {key: choice, weight: 80}
|
||||
|
|
|
|||
|
|
@ -71,8 +71,9 @@ templates:
|
|||
order: ""
|
||||
order_<<key>>: <<order>>
|
||||
schedule_<<key>>: <<schedule>>
|
||||
sort: <<title>>
|
||||
sort_prefix: "!"
|
||||
sort_title: <<sort_prefix>><<collection_section>><<pre>><<order_<<key>>>><<title>>
|
||||
sort_title: <<sort_prefix>><<collection_section>><<pre>><<order_<<key>>>><<sort>>
|
||||
item_radarr_tag_<<key>>: <<item_radarr_tag>>
|
||||
item_sonarr_tag_<<key>>: <<item_sonarr_tag>>
|
||||
url_poster: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager-Images/master/<<image>>.jpg
|
||||
|
|
|
|||
|
|
@ -147,8 +147,8 @@ You can create individual blocks of operations by using a list under `operations
|
|||
|
||||
<table class="clearTable">
|
||||
<tr><td>`mdb`</td><td>Use MdbList for Content Ratings</td></tr>
|
||||
<tr><td>`mdb_commonsense`</td><td>Use Commonsense Rating through MDbList for Content Ratings</td></tr>
|
||||
<tr><td>`mdb_commonsense0`</td><td>Use Commonsense Rating with Zero Padding through MDbList for Content Ratings</td></tr>
|
||||
<tr><td>`mdb_commonsense`</td><td>Use Common Sense Rating through MDbList for Content Ratings</td></tr>
|
||||
<tr><td>`mdb_commonsense0`</td><td>Use Common Sense Rating with Zero Padding through MDbList for Content Ratings</td></tr>
|
||||
<tr><td>`omdb`</td><td>Use IMDb through OMDb for Content Ratings</td></tr>
|
||||
<tr><td>`mal`</td><td>Use MyAnimeList for Content Ratings</td></tr>
|
||||
<tr><td>`lock`</td><td>Lock Content Rating Field</td></tr>
|
||||
|
|
|
|||
|
|
@ -9,8 +9,6 @@ Arts Awards.
|
|||
|
||||
Supported Library Types: Movie
|
||||
|
||||
Requirements: [Trakt Authentication](../../config/trakt.md)
|
||||
|
||||
## Collections Section 130
|
||||
|
||||
| Collection | Key | Description |
|
||||
|
|
@ -37,26 +35,26 @@ make your own local copy.
|
|||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `BAFTA <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> BAFTA Awards.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `BAFTA <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> BAFTA Awards.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
|
@ -67,30 +65,29 @@ work. Any value not specified will use its default value if it has one if not it
|
|||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
collection_files:
|
||||
- pmm: bafta
|
||||
template_variables:
|
||||
collection_mode: show_items #(1)!
|
||||
collection_order: alpha #(2)!
|
||||
radarr_add_missing: true #(3)!
|
||||
name_format: BAFTA <<key_name>> Winners #(4)!
|
||||
data:
|
||||
starting: latest-10 #(5)!
|
||||
ending: latest #(6)!
|
||||
```
|
||||
|
||||
1. Shows the collection and all of its items within the Library tab in Plex
|
||||
2. Sorts the collection items alphabetically
|
||||
3. Adds items from the source list which are not in Plex to Radarr
|
||||
4. Change the name of the collections to "BAFTA yearhere Winners"
|
||||
5. If today is 2024, then create collections for BAFTA 2014 onwards
|
||||
6. If today is 2024, then the final collection is BAFTA 2024
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
collection_files:
|
||||
- pmm: bafta
|
||||
template_variables:
|
||||
collection_mode: show_items #(1)!
|
||||
collection_order: alpha #(2)!
|
||||
radarr_add_missing: true #(3)!
|
||||
name_format: BAFTA <<key_name>> Winners #(4)!
|
||||
data: #(5)!
|
||||
starting: latest-10
|
||||
ending: latest
|
||||
```
|
||||
|
||||
1. Shows the collection and all of its items within the Library tab in Plex
|
||||
2. Sorts the collection items alphabetically
|
||||
3. Adds items from the source list which are not in Plex to Radarr
|
||||
4. Change the name of the collections to "BAFTA yearhere Winners"
|
||||
5. Creates collections from 10 award shows back to the latest award show.
|
||||
|
|
|
|||
92
docs/defaults/award/berlinale.md
Normal file
92
docs/defaults/award/berlinale.md
Normal file
|
|
@ -0,0 +1,92 @@
|
|||
# Berlin International Film Festival Awards Collections
|
||||
|
||||
The `berlinale` Default Collection File is used to create collections based on the Berlin International Film Festival Awards.
|
||||
|
||||
|
||||
|
||||
## Requirements & Recommendations
|
||||
|
||||
Supported Library Types: Movie
|
||||
|
||||
## Collections Section 130
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:------------------------------------------------------|:----------------------------------|:-----------------------------------------------------------------------------------|
|
||||
| `Berlinale Golden Bears` | `golden` | Collection of Berlin International Film Festival Golden Bear Award Winners. |
|
||||
| `Berlinale <<year>>`<br>**Example:** `Berlinale 2022` | `<<year>>`<br>**Example:** `2022` | Collection of Berlin International Film Festival Award Winners for the given year. |
|
||||
|
||||
## Config
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
collection_files:
|
||||
- pmm: berlinale
|
||||
```
|
||||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Berlinale <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Berlinale Award Winners.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
collection_files:
|
||||
- pmm: berlinale
|
||||
template_variables:
|
||||
collection_mode: show_items #(1)!
|
||||
collection_order: alpha #(2)!
|
||||
radarr_add_missing: true #(3)!
|
||||
name_format: Berlinale <<key_name>> Winners #(4)!
|
||||
data: #(5)!
|
||||
starting: latest-10
|
||||
ending: latest
|
||||
```
|
||||
|
||||
1. Shows the collection and all of its items within the Library tab in Plex
|
||||
2. Sorts the collection items alphabetically
|
||||
3. Adds items from the source list which are not in Plex to Radarr
|
||||
4. Change the name of the collections to "Berlinale yearhere Winners"
|
||||
5. Creates collections from 10 award shows back to the latest award show.
|
||||
|
|
@ -8,8 +8,6 @@ The `cannes` Default Collection File is used to create collections based on the
|
|||
|
||||
Supported Library Types: Movie
|
||||
|
||||
Requirements: [Trakt Authentication](../../config/trakt.md)
|
||||
|
||||
## Collections Section 130
|
||||
|
||||
| Collection | Key | Description |
|
||||
|
|
@ -30,32 +28,35 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Cannes <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Cannes Awards.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Cannes <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Cannes Awards.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
|
|
@ -63,17 +64,11 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
@ -85,14 +80,13 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
collection_order: alpha #(2)!
|
||||
radarr_add_missing: true #(3)!
|
||||
name_format: Cannes <<key_name>> Winners #(4)!
|
||||
data:
|
||||
starting: latest-10 #(5)!
|
||||
ending: latest #(6)!
|
||||
data: #(5)!
|
||||
starting: latest-10
|
||||
ending: latest
|
||||
```
|
||||
|
||||
1. Shows the collection and all of its items within the Library tab in Plex
|
||||
2. Sorts the collection items alphabetically
|
||||
3. Adds items from the source list which are not in Plex to Radarr
|
||||
4. Change the name of the collections to "Cannes yearhere Winners"
|
||||
5. If today is 2024, then create collections for Cannes 2014 onwards
|
||||
6. If today is 2024, then the final collection is Cannes 2024
|
||||
5. Creates collections from 10 award shows back to the latest award show.
|
||||
|
|
|
|||
92
docs/defaults/award/cesar.md
Normal file
92
docs/defaults/award/cesar.md
Normal file
|
|
@ -0,0 +1,92 @@
|
|||
# César Awards Collections
|
||||
|
||||
The `cesar` Default Collection File is used to create collections based on the César Awards.
|
||||
|
||||
|
||||
|
||||
## Requirements & Recommendations
|
||||
|
||||
Supported Library Types: Movie
|
||||
|
||||
## Collections Section 130
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:----------------------------------------------|:----------------------------------|:------------------------------------------------------|
|
||||
| `César Best Film Winners` | `best` | Collection of César Award Winners. |
|
||||
| `Cesar <<year>>`<br>**Example:** `Cesar 2022` | `<<year>>`<br>**Example:** `2022` | Collection of César Award Winners for the given year. |
|
||||
|
||||
## Config
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
collection_files:
|
||||
- pmm: cesar
|
||||
```
|
||||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `César <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> César Award Winners.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
collection_files:
|
||||
- pmm: cesar
|
||||
template_variables:
|
||||
collection_mode: show_items #(1)!
|
||||
collection_order: alpha #(2)!
|
||||
radarr_add_missing: true #(3)!
|
||||
name_format: César <<key_name>> Winners #(4)!
|
||||
data: #(5)!
|
||||
starting: latest-10
|
||||
ending: latest
|
||||
```
|
||||
|
||||
1. Shows the collection and all of its items within the Library tab in Plex
|
||||
2. Sorts the collection items alphabetically
|
||||
3. Adds items from the source list which are not in Plex to Radarr
|
||||
4. Change the name of the collections to "César yearhere Winners"
|
||||
5. Creates collections from 10 award shows back to the latest award show.
|
||||
|
|
@ -8,8 +8,6 @@ The `choice` Default Collection File is used to create collections based on the
|
|||
|
||||
Supported Library Types: Movie, Show
|
||||
|
||||
Requirements: [Trakt Authentication](../../config/trakt.md)
|
||||
|
||||
## Collections Section 130
|
||||
|
||||
| Collection | Key | Description |
|
||||
|
|
@ -37,26 +35,26 @@ Template Variables can be used to manipulate the file in various ways to slightl
|
|||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Critics Choice <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Critics Choice Awards.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Critics Choice <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Critics Choice Awards.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
|
||||
|
|
@ -66,19 +64,12 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
@ -89,15 +80,13 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
collection_order: alpha #(2)!
|
||||
radarr_add_missing: true #(3)!
|
||||
name_format: Critics Choice Awards <<key_name>> Winners #(4)!
|
||||
data:
|
||||
starting: latest-10 #(5)!
|
||||
ending: latest #(6)!
|
||||
data: #(5)!
|
||||
starting: latest-10
|
||||
ending: latest
|
||||
```
|
||||
|
||||
1. Shows the collection and all of its items within the Library tab in Plex
|
||||
2. Sorts the collection items alphabetically
|
||||
3. Adds items from the source list which are not in Plex to Radarr
|
||||
4. Change the name of the collections to "Critics Choice Awards yearhere Winners"
|
||||
5. If today is 2024, then create collections for Critics Choice Awards 2014 onwards
|
||||
6. If today is 2024, then the final collection is Critics Choice Awards 2024
|
||||
|
||||
5. Creates collections from 10 award shows back to the latest award show.
|
||||
|
|
|
|||
|
|
@ -10,8 +10,9 @@ Supported Library Types: Movie, Show
|
|||
|
||||
## Collections Section 130
|
||||
|
||||
| Collection | Key | Description |
|
||||
| Collection | Key | |
|
||||
|:----------------------------------------------|:----------------------------------|:------------------------------------------------------|
|
||||
| `Emmys Best in Category Winners` | `best` | Collection of Emmys Best in Category Award Winners. |
|
||||
| `Emmys <<year>>`<br>**Example:** `Emmys 2022` | `<<year>>`<br>**Example:** `2022` | Collection of Emmys Award Winners for the given year. |
|
||||
|
||||
## Config
|
||||
|
|
@ -34,26 +35,26 @@ Template Variables can be used to manipulate the file in various ways to slightl
|
|||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn off the collections |
|
||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn off the collections |
|
||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Emmys <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Emmy Winners.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Emmys <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Emmy Winners.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
|
||||
|
|
@ -63,17 +64,11 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
@ -85,14 +80,13 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
collection_order: alpha #(2)!
|
||||
radarr_add_missing: true #(3)!
|
||||
name_format: Emmys <<key_name>> Winners #(4)!
|
||||
data:
|
||||
starting: latest-10 #(5)!
|
||||
ending: latest #(6)!
|
||||
data: #(5)!
|
||||
starting: latest-10
|
||||
ending: latest
|
||||
```
|
||||
|
||||
1. Shows the collection and all of its items within the Library tab in Plex
|
||||
2. Sorts the collection items alphabetically
|
||||
3. Adds items from the source list which are not in Plex to Radarr
|
||||
4. Change the name of the collections to "Emmys yearhere Winners"
|
||||
5. If today is 2024, then create collections for Emmys 2014 onwards
|
||||
6. If today is 2024, then the final collection is Emmys 2024
|
||||
5. Creates collections from 10 award shows back to the latest award show.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,8 @@ The `golden` Default Collection File is used to create collections based on the
|
|||
|
||||
Supported Library Types: Movie, Show
|
||||
|
||||
Recommendations: The `Golden Globe Best Motion Pictures` Collection only works with Movie Libraries
|
||||
Recommendations: The `Golden Globe Best Motion Pictures` and `Golden Globes Best Director Winners` Collections only work
|
||||
with Movie Libraries.
|
||||
|
||||
## Collections Section 130
|
||||
|
||||
|
|
@ -34,32 +35,35 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Golden Globe <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Golden Globe Winners.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Golden Globe <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Golden Globe Winners.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
|
|
@ -67,17 +71,11 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
@ -89,14 +87,13 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
collection_order: alpha #(2)!
|
||||
radarr_add_missing: true #(3)!
|
||||
name_format: Emmys <<key_name>> Winners #(4)!
|
||||
data:
|
||||
starting: latest-10 #(5)!
|
||||
ending: latest #(6)!
|
||||
data: #(5)!
|
||||
starting: latest-10
|
||||
ending: latest
|
||||
```
|
||||
|
||||
1. Shows the collection and all of its items within the Library tab in Plex
|
||||
2. Sorts the collection items alphabetically
|
||||
3. Adds items from the source list which are not in Plex to Radarr
|
||||
4. Change the name of the collections to "Golden Globes yearhere Winners"
|
||||
5. If today is 2024, then create collections for Golden Globes 2014 onwards
|
||||
6. If today is 2024, then the final collection is Golden Globes 2024
|
||||
5. Creates collections from 10 award shows back to the latest award show.
|
||||
|
|
|
|||
92
docs/defaults/award/nfr.md
Normal file
92
docs/defaults/award/nfr.md
Normal file
|
|
@ -0,0 +1,92 @@
|
|||
# National Film Registry Collections
|
||||
|
||||
The `nfr` Default Collection File is used to create collections based on the National Film Registry.
|
||||
|
||||
|
||||
|
||||
## Requirements & Recommendations
|
||||
|
||||
Supported Library Types: Movie
|
||||
|
||||
## Collections Section 130
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:--------------------------------------------------------------------------------|:----------------------------------|:----------------------------------------------------------------------------|
|
||||
| `National Film Registry All Time` | `all_time` | Collection of Films added to the National Film Registry. |
|
||||
| `National Film Registry <<year>>`<br>**Example:** `National Film Registry 2022` | `<<year>>`<br>**Example:** `2022` | Collection of Films added to the National Film Registry for the given year. |
|
||||
|
||||
## Config
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
collection_files:
|
||||
- pmm: nfr
|
||||
```
|
||||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `National Film Registry <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> National Film Registry.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
collection_files:
|
||||
- pmm: nfr
|
||||
template_variables:
|
||||
collection_mode: show_items #(1)!
|
||||
collection_order: alpha #(2)!
|
||||
radarr_add_missing: true #(3)!
|
||||
name_format: National Film Registry <<key_name>> Winners #(4)!
|
||||
data: #(5)!
|
||||
starting: latest-10
|
||||
ending: latest
|
||||
```
|
||||
|
||||
1. Shows the collection and all of its items within the Library tab in Plex
|
||||
2. Sorts the collection items alphabetically
|
||||
3. Adds items from the source list which are not in Plex to Radarr
|
||||
4. Change the name of the collections to "National Film Registry yearhere Winners"
|
||||
5. Creates collections from 10 award shows back to the latest award show.
|
||||
|
|
@ -29,32 +29,35 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-6<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest-1<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Oscars Winners <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `Academy Awards (Oscars) Winners for <<key_name>>.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Oscars Winners <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `Academy Awards (Oscars) Winners for <<key_name>>.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
|
|
@ -62,18 +65,11 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
@ -84,15 +80,14 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
collection_mode: show_items #(1)!
|
||||
collection_order: alpha #(2)!
|
||||
radarr_add_missing: true #(3)!
|
||||
name_format: Emmys <<key_name>> Winners #(4)!
|
||||
data:
|
||||
starting: latest-10 #(5)!
|
||||
ending: latest #(6)!
|
||||
name_format: Oscars <<key_name>> Winners #(4)!
|
||||
data: #(5)!
|
||||
starting: latest-10
|
||||
ending: latest
|
||||
```
|
||||
|
||||
1. Shows the collection and all of its items within the Library tab in Plex
|
||||
2. Sorts the collection items alphabetically
|
||||
3. Adds items from the source list which are not in Plex to Radarr
|
||||
4. Change the name of the collections to "Oscars YEAR_HERE Winners"
|
||||
5. If today is 2024, then create collections for Oscars 2014 onwards
|
||||
7. If today is 2024, then the final collection is Oscars 2024
|
||||
5. Creates collections from 10 award shows back to the latest award show.
|
||||
|
|
|
|||
|
|
@ -1,89 +0,0 @@
|
|||
# Other Awards Collections
|
||||
|
||||
The `other_award` Default Collection File is used to create collections based on numerous other awards.
|
||||
|
||||
|
||||
|
||||
## Requirements & Recommendations
|
||||
|
||||
Supported Library Types: Movie, Show
|
||||
|
||||
Requirements: [Trakt Authentication](../../config/trakt.md)
|
||||
|
||||
## Collections Section 130
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:-----------------------------------|:------------|:--------------------------------------------------------------|
|
||||
| `Berlinale Golden Bears` | `berlinale` | Collection of Berlinale Golden Bears Award Winners. |
|
||||
| `César Best Film Winners` | `cesar` | Collection of César Best Film Winners Award Winners. |
|
||||
| `Razzies Golden Raspberry Winners` | `razzie` | Collection of Razzies Golden Raspberry Winners Award Winners. |
|
||||
| `Venice Golden Lions` | `venice` | Collection of Venice Golden Lions Award Winners. |
|
||||
|
||||
## Config
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
collection_files:
|
||||
- pmm: other_award
|
||||
```
|
||||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
collection_files:
|
||||
- pmm: other_award
|
||||
template_variables:
|
||||
use_berlinale: false #(1)!
|
||||
collection_order: alpha #(2)!
|
||||
radarr_add_missing: true #(3)!
|
||||
```
|
||||
|
||||
1. Do not create the "Berlinale Golden Bears" collection
|
||||
2. Sorts the collection items alphabetically
|
||||
3. Adds items from the source list which are not in Plex to Radarr
|
||||
92
docs/defaults/award/pca.md
Normal file
92
docs/defaults/award/pca.md
Normal file
|
|
@ -0,0 +1,92 @@
|
|||
# People's Choice Awards Collections
|
||||
|
||||
The `pca` Default Collection File is used to create collections based on the People's Choice Awards.
|
||||
|
||||
|
||||
|
||||
## Requirements & Recommendations
|
||||
|
||||
Supported Library Types: Movie, Show
|
||||
|
||||
## Collections Section 130
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:--------------------------------------------------------------------------------|:----------------------------------|:----------------------------------------------------------------|
|
||||
| `People's Choice Award Winners` | `pca` | Collection of People's Choice Award Winners. |
|
||||
| `People's Choice Awards <<year>>`<br>**Example:** `People's Choice Awards 2022` | `<<year>>`<br>**Example:** `2022` | Collection of People's Choice Award Winners for the given year. |
|
||||
|
||||
## Config
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
collection_files:
|
||||
- pmm: pca
|
||||
```
|
||||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `People's Choice Awards <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> People's Choice Award Winners.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
collection_files:
|
||||
- pmm: pca
|
||||
template_variables:
|
||||
collection_mode: show_items #(1)!
|
||||
collection_order: alpha #(2)!
|
||||
radarr_add_missing: true #(3)!
|
||||
name_format: People's Choice <<key_name>> Winners #(4)!
|
||||
data: #(5)!
|
||||
starting: latest-10
|
||||
ending: latest
|
||||
```
|
||||
|
||||
1. Shows the collection and all of its items within the Library tab in Plex
|
||||
2. Sorts the collection items alphabetically
|
||||
3. Adds items from the source list which are not in Plex to Radarr
|
||||
4. Change the name of the collections to "People's Choice yearhere Winners"
|
||||
5. Creates collections from 10 award shows back to the latest award show.
|
||||
92
docs/defaults/award/razzie.md
Normal file
92
docs/defaults/award/razzie.md
Normal file
|
|
@ -0,0 +1,92 @@
|
|||
# Razzie Awards Collections
|
||||
|
||||
The `razzie` Default Collection File is used to create collections based on the Razzie Awards.
|
||||
|
||||
|
||||
|
||||
## Requirements & Recommendations
|
||||
|
||||
Supported Library Types: Movie
|
||||
|
||||
## Collections Section 130
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:------------------------------------------------|:----------------------------------|:-------------------------------------------------------|
|
||||
| `Razzies Golden Raspberry Winners` | `golden` | Collection of Razzie Golden Raspberry Award Winners. |
|
||||
| `Razzie <<year>>`<br>**Example:** `Razzie 2022` | `<<year>>`<br>**Example:** `2022` | Collection of Razzie Award Winners for the given year. |
|
||||
|
||||
## Config
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
collection_files:
|
||||
- pmm: razzie
|
||||
```
|
||||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Razzie <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Razzie Award Winners.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
collection_files:
|
||||
- pmm: razzie
|
||||
template_variables:
|
||||
collection_mode: show_items #(1)!
|
||||
collection_order: alpha #(2)!
|
||||
radarr_add_missing: true #(3)!
|
||||
name_format: Razzie <<key_name>> Winners #(4)!
|
||||
data: #(5)!
|
||||
starting: latest-10
|
||||
ending: latest
|
||||
```
|
||||
|
||||
1. Shows the collection and all of its items within the Library tab in Plex
|
||||
2. Sorts the collection items alphabetically
|
||||
3. Adds items from the source list which are not in Plex to Radarr
|
||||
4. Change the name of the collections to "Razzie yearhere Winners"
|
||||
5. Creates collections from 10 award shows back to the latest award show.
|
||||
92
docs/defaults/award/sag.md
Normal file
92
docs/defaults/award/sag.md
Normal file
|
|
@ -0,0 +1,92 @@
|
|||
# Screen Actors Guild Awards Collections
|
||||
|
||||
The `sag` Default Collection File is used to create collections based on the Screen Actors Guild Awards.
|
||||
|
||||
|
||||
|
||||
## Requirements & Recommendations
|
||||
|
||||
Supported Library Types: Movie
|
||||
|
||||
## Collections Section 130
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:--------------------------------------------------------------------------|:----------------------------------|:--------------------------------------------------------------------|
|
||||
| `Screen Actors Guild Award Winners` | `golden` | Collection of Screen Actors Guild Award Winners. |
|
||||
| `Screen Actors Guild <<year>>`<br>**Example:** `Screen Actors Guild 2022` | `<<year>>`<br>**Example:** `2022` | Collection of Screen Actors Guild Award Winners for the given year. |
|
||||
|
||||
## Config
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
collection_files:
|
||||
- pmm: sag
|
||||
```
|
||||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Screen Actors Guild <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Screen Actors Guild Award Winners.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
collection_files:
|
||||
- pmm: sag
|
||||
template_variables:
|
||||
collection_mode: show_items #(1)!
|
||||
collection_order: alpha #(2)!
|
||||
radarr_add_missing: true #(3)!
|
||||
name_format: Screen Actors Guild <<key_name>> Winners #(4)!
|
||||
data: #(5)!
|
||||
starting: latest-10
|
||||
ending: latest
|
||||
```
|
||||
|
||||
1. Shows the collection and all of its items within the Library tab in Plex
|
||||
2. Sorts the collection items alphabetically
|
||||
3. Adds items from the source list which are not in Plex to Radarr
|
||||
4. Change the name of the collections to "Screen Actors Guild yearhere Winners"
|
||||
5. Creates collections from 10 award shows back to the latest award show.
|
||||
|
|
@ -30,35 +30,36 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
**[Shared Collection Variables](../collection_variables.md) are NOT available to this default file.**
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
This file contains only a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available.
|
||||
* **Shared Separator Variables** are additional variables available since this Default contains a
|
||||
[Separator](../separators.md).
|
||||
|
||||
### Example Template Variable Amendments
|
||||
=== "Shared Separator Variables"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
{%
|
||||
include-markdown "../separator_variables.md"
|
||||
%}
|
||||
|
||||
???+ tip
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
collection_files:
|
||||
- pmm: separator_award
|
||||
template_variables:
|
||||
sep_style: purple #(1)!
|
||||
```
|
||||
|
||||
1. Use the purple [Separator Style](../separators.md#separator-styles)
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
collection_files:
|
||||
- pmm: separator_award
|
||||
template_variables:
|
||||
sep_style: purple #(1)!
|
||||
```
|
||||
|
||||
1. Use the purple [Separator Style](../separators.md#separator-styles)
|
||||
|
|
|
|||
|
|
@ -8,8 +8,6 @@ The `spirit` Default Collection File is used to create collections based on the
|
|||
|
||||
Supported Library Types: Movie
|
||||
|
||||
Requirements: [Trakt Authentication](../../config/trakt.md)
|
||||
|
||||
## Collections Section 130
|
||||
|
||||
| Collection | Key | Description |
|
||||
|
|
@ -30,32 +28,35 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Independent Spirit Awards <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Independent Spirit Awards.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Independent Spirit Awards <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Independent Spirit Awards.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
|
|
@ -63,17 +64,11 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
@ -85,14 +80,13 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
collection_order: alpha #(2)!
|
||||
radarr_add_missing: true #(3)!
|
||||
name_format: Independent Spirit Awards <<key_name>> Winners #(4)!
|
||||
data:
|
||||
starting: latest-10 #(5)!
|
||||
ending: latest #(6)!
|
||||
data: #(5)!
|
||||
starting: latest-10
|
||||
ending: latest
|
||||
```
|
||||
|
||||
1. Shows the collection and all of its items within the Library tab in Plex
|
||||
2. Sorts the collection items alphabetically
|
||||
3. Adds items from the source list which are not in Plex to Radarr
|
||||
4. Change the name of the collections to "Independent Spirit Awards yearhere Winners"
|
||||
5. If today is 2024, then create collections for Independent Spirit Awards 2014 onwards
|
||||
6. If today is 2024, then the final collection is Independent Spirit Awards 2024
|
||||
5. Creates collections from 10 award shows back to the latest award show.
|
||||
|
|
|
|||
|
|
@ -8,8 +8,6 @@ The `sundance` Default Collection File is used to create collections based on t
|
|||
|
||||
Supported Library Types: Movie
|
||||
|
||||
Requirements: [Trakt Authentication](../../config/trakt.md)
|
||||
|
||||
## Collections Section 130
|
||||
|
||||
| Collection | Key | Description |
|
||||
|
|
@ -30,32 +28,35 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Sundance Film Festival <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `Sundance Film Festival of <<key_name>>.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Sundance Film Festival <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `Sundance Film Festival of <<key_name>>.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
|
|
@ -63,18 +64,11 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
@ -86,14 +80,13 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
collection_order: alpha #(2)!
|
||||
radarr_add_missing: true #(3)!
|
||||
name_format: Sundance Film Festival <<key_name>> Winners #(4)!
|
||||
data:
|
||||
starting: latest-10 #(5)!
|
||||
ending: latest #(6)!
|
||||
data: #(5)!
|
||||
starting: latest-10
|
||||
ending: latest
|
||||
```
|
||||
|
||||
1. Shows the collection and all of its items within the Library tab in Plex
|
||||
2. Sorts the collection items alphabetically
|
||||
3. Adds items from the source list which are not in Plex to Radarr
|
||||
4. Change the name of the collections to "Sundance Film Festival yearhere Winners"
|
||||
5. If today is 2024, then create collections for Sundance Film Festival 2014 onwards
|
||||
6. If today is 2024, then the final collection is Sundance Film Festival 2024
|
||||
5. Creates collections from 10 award shows back to the latest award show.
|
||||
|
|
|
|||
93
docs/defaults/award/tiff.md
Normal file
93
docs/defaults/award/tiff.md
Normal file
|
|
@ -0,0 +1,93 @@
|
|||
# Toronto International Film Festival Awards Collections
|
||||
|
||||
The `tiff` Default Collection File is used to create collections based on the Toronto International Film Festival
|
||||
Awards.
|
||||
|
||||
|
||||
|
||||
## Requirements & Recommendations
|
||||
|
||||
Supported Library Types: Movie
|
||||
|
||||
## Collections Section 130
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:----------------------------------------------------------------------------------------------------------|:----------------------------------|:------------------------------------------------------------------------------------|
|
||||
| `Toronto People's Choice Award Winners` | `best` | Collection of Toronto International Film Festival People's Choice Award Winners. |
|
||||
| `Toronto International Film Festival <<year>>`<br>**Example:** `Toronto International Film Festival 2022` | `<<year>>`<br>**Example:** `2022` | Collection of Toronto International Film Festival Award Winners for the given year. |
|
||||
|
||||
## Config
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
collection_files:
|
||||
- pmm: tiff
|
||||
```
|
||||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Toronto International Film Festival <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Toronto International Film Festival Award Winners.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
collection_files:
|
||||
- pmm: tiff
|
||||
template_variables:
|
||||
collection_mode: show_items #(1)!
|
||||
collection_order: alpha #(2)!
|
||||
radarr_add_missing: true #(3)!
|
||||
name_format: Toronto International Film Festival <<key_name>> Winners #(4)!
|
||||
data: #(5)!
|
||||
starting: latest-10
|
||||
ending: latest
|
||||
```
|
||||
|
||||
1. Shows the collection and all of its items within the Library tab in Plex
|
||||
2. Sorts the collection items alphabetically
|
||||
3. Adds items from the source list which are not in Plex to Radarr
|
||||
4. Change the name of the collections to "Toronto International Film Festival yearhere Winners"
|
||||
5. Creates collections from 10 award shows back to the latest award show.
|
||||
92
docs/defaults/award/venice.md
Normal file
92
docs/defaults/award/venice.md
Normal file
|
|
@ -0,0 +1,92 @@
|
|||
# Venice Film Festival Awards Collections
|
||||
|
||||
The `venice` Default Collection File is used to create collections based on the Venice Film Festival Awards.
|
||||
|
||||
|
||||
|
||||
## Requirements & Recommendations
|
||||
|
||||
Supported Library Types: Movie
|
||||
|
||||
## Collections Section 130
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:------------------------------------------------|:----------------------------------|:---------------------------------------------------------------------|
|
||||
| `Venice Golden Lions` | `golden` | Collection of Venice Film Festival Golden Lions Award Winners. |
|
||||
| `Venice <<year>>`<br>**Example:** `Venice 2022` | `<<year>>`<br>**Example:** `2022` | Collection of Venice Film Festival Award Winners for the given year. |
|
||||
|
||||
## Config
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
collection_files:
|
||||
- pmm: venice
|
||||
```
|
||||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_year_collections` | **Description:** Turn the individual year collections off.<br>**Values:** `false` to turn of the collections |
|
||||
| `year_collection_section` | **Description:** Change the collection section for year collections only. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> latest-5<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> latest<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>latest</code></strong></li><li><strong>You can also use a value relative to the <code>latest</code> by doing <code>latest-5</code></strong></li></ul> |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Venice <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<key_name>> Venice Award Winners.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
collection_files:
|
||||
- pmm: venice
|
||||
template_variables:
|
||||
collection_mode: show_items #(1)!
|
||||
collection_order: alpha #(2)!
|
||||
radarr_add_missing: true #(3)!
|
||||
name_format: Venice <<key_name>> Winners #(4)!
|
||||
data: #(5)!
|
||||
starting: latest-10
|
||||
ending: latest
|
||||
```
|
||||
|
||||
1. Shows the collection and all of its items within the Library tab in Plex
|
||||
2. Sorts the collection items alphabetically
|
||||
3. Adds items from the source list which are not in Plex to Radarr
|
||||
4. Change the name of the collections to "Venice yearhere Winners"
|
||||
5. Creates collections from 10 award shows back to the latest award show.
|
||||
|
|
@ -1,6 +1,7 @@
|
|||
# Actor Collections
|
||||
|
||||
The `actor` Default Collection File is used to dynamically create collections based on the most popular actors/actresses in your library.
|
||||
The `actor` Default Collection File is used to dynamically create collections based on the most popular actors/actresses
|
||||
in your library.
|
||||
|
||||
## Requirements & Recommendations
|
||||
|
||||
|
|
@ -14,7 +15,7 @@ Supported Library Types: Movie, Show
|
|||
| `<<actor_name>>`<br>**Example:** `Frank Welker` | `<<actor_name>>`<br>**Example:** `Frank Welker` | Collection of Movies/Shows the actor is top billing in. |
|
||||
|
||||
{%
|
||||
include-markdown "../people.md"
|
||||
include-markdown "../people.md"
|
||||
%}
|
||||
|
||||
## Config
|
||||
|
|
@ -31,23 +32,25 @@ libraries:
|
|||
- pmm: actor
|
||||
```
|
||||
|
||||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
* **Shared Separator Variables** are additional variables available since this Default contains a
|
||||
[Separator](../separators.md).
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
|
||||
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `style` | **Description:** Controls the visual theme of the collections created.<br>**Default:** `bw`<br>**Values:** `bw`, `rainier`, `signature`, `diiivoy`, or `diiivoycolor` |
|
||||
|
|
@ -62,26 +65,21 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s with <<key_name>>.`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `tmdb_birthday` | **Description:** Controls if the Definition is run based on `tmdb_person`'s Birthday. Has 3 possible attributes `this_month`, `before` and `after`.<br>**Values:**<table class="clearTable"><tr><td>`this_month`</td><td>Run's if Birthday is in current Month</td><td>`true`/`false`</td></tr><tr><td>`before`</td><td>Run if X Number of Days before the Birthday</td><td>Number 0 or greater</td></tr><tr><td>`after`</td><td>Run if X Number of Days after the Birthday</td><td>Number 0 or greater</td></tr></table> |
|
||||
| `tmdb_person_offset_<<key>>`<sup>1</sup> | **Description:** Changes the summary tmdb_person_offset for the specific key.<br>**Default:** `0`<br>**Values:** Dictionary of Actor Name as the keys and the tmdb_person_offset as the value. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
@ -102,4 +100,5 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
2. Create 20 collections maximum
|
||||
3. use the [diiivoy Color Style](#diiivoy-color-style)
|
||||
4. Do not create an "Actors Collections" separator
|
||||
5. There are two Richard Brooks, so use the 2nd [Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb
|
||||
5. There are two Richard Brooks, so use the 2nd
|
||||
[Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb
|
||||
|
|
|
|||
|
|
@ -38,20 +38,23 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
* **Shared Separator Variables** are additional variables available since this Default contains a
|
||||
[Separator](../separators.md).
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:--------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
|
|
@ -64,26 +67,27 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Based on a <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s based on or inspired by <<translated_key_name>>s.`<br>**Values:** Any string. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
=== "Shared Separator Variables"
|
||||
|
||||
### Example Template Variable Amendments
|
||||
{%
|
||||
include-markdown "../separator_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
@ -95,4 +99,4 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
```
|
||||
|
||||
1. Do not create a "1.65 - Early Widescreen" collection
|
||||
2. Use the plum [Separator Style](../separators.md#separator-styles)
|
||||
2. Use the plum [Separator Style](../separators.md#separator-styles)
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
# Audio Language Collections
|
||||
|
||||
The `audio_language` Default Collection File is used to dynamically create collections based on the audio languages available in your library.
|
||||
The `audio_language` Default Collection File is used to dynamically create collections based on the audio languages
|
||||
available in your library.
|
||||
|
||||
|
||||
|
||||
|
|
@ -32,20 +33,23 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
* **Shared Separator Variables** are additional variables available since this Default contains a
|
||||
[Separator](../separators.md).
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
|
|
@ -60,26 +64,27 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> Audio`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s filmed in the <<key_name>> Language.`<br>**Values:** Any string. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
=== "Shared Separator Variables"
|
||||
|
||||
### Example Template Variable Amendments
|
||||
{%
|
||||
include-markdown "../separator_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
@ -99,7 +104,8 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
|
||||
## Default Values
|
||||
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.**
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
||||
show how to change a name or a list.**
|
||||
|
||||
If you want to customize these values, use the methods described above.
|
||||
|
||||
|
|
@ -128,4 +134,4 @@ If you want to customize these values, use the methods described above.
|
|||
preserve-includer-indent=false
|
||||
start="key_name_override:"
|
||||
%}
|
||||
```
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
# Based On... Collections
|
||||
|
||||
The `based` Default Collection File is used to create collections with items that are based on or inspired by various media outlets (such as Books or Video Games).
|
||||
The `based` Default Collection File is used to create collections with items that are based on or inspired by various
|
||||
media outlets (such as Books or Video Games).
|
||||
|
||||
|
||||
|
||||
|
|
@ -34,20 +35,23 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
* **Shared Separator Variables** are additional variables available since this Default contains a
|
||||
[Separator](../separators.md).
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:--------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
|
|
@ -60,20 +64,27 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Based on a <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s based on or inspired by <<translated_key_name>>s.`<br>**Values:** Any string. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
### Example Template Variable Amendments
|
||||
{%
|
||||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
=== "Shared Separator Variables"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
{%
|
||||
include-markdown "../separator_variables.md"
|
||||
%}
|
||||
|
||||
???+ tip
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
@ -90,7 +101,8 @@ The below is an example config.yml extract with some Template Variables added in
|
|||
|
||||
1. Use the navy [Separator Style](../separators.md#separator-styles)
|
||||
2. Do not create a "Based on a Comic" collection
|
||||
3. Make the "Based on a True Story" collection appear in the collection list before the other collections in this file
|
||||
3. Make the "Based on a True Story" collection appear in the collection list before the other collections in this
|
||||
file
|
||||
4. Pin the "Based on a Video Game" collection to the Recommended tab of the library
|
||||
5. Pin the "Based on a Video Game" collection to the home screen of the server owner
|
||||
6. Pin the "Based on a Video Game" collection to the home screen of other users of the server
|
||||
|
|
|
|||
|
|
@ -1,6 +1,8 @@
|
|||
# Collectionless Collection
|
||||
|
||||
The `collectionless` Default Collection File is used to create a [Collectionless collection](../../files/builders/plex.md#plex-collectionless) to help Show/Hide Movies/Shows properly in your library.
|
||||
The `collectionless` Default Collection File is used to create a
|
||||
[Collectionless collection](../../files/builders/plex.md#plex-collectionless) to help Show/Hide Movies/Shows properly in
|
||||
your library.
|
||||
|
||||
|
||||
|
||||
|
|
@ -8,7 +10,14 @@ The `collectionless` Default Collection File is used to create a [Collectionless
|
|||
|
||||
Supported Library Types: Movie, Show
|
||||
|
||||
Requirements: For this file to work it needs to run last under `collection_files` and all other normal collections must use `collection_mode: hide_items`
|
||||
Requirements:
|
||||
|
||||
* This file needs to run last under `collection_files`.
|
||||
|
||||
* All other normal collections must use `collection_mode: hide_items`.
|
||||
|
||||
* Disable the `Minimum automatic collection size` option when using the `Plex Movie` Agent. (Use the
|
||||
[`franchise` Default](../movie/franchise.md) for automatic collections)
|
||||
|
||||
## Collection
|
||||
|
||||
|
|
@ -36,51 +45,69 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
**[Shared Collection Variables](../collection_variables.md) are NOT available to this default file.**
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `name_collectionless` | **Description:** Changes the name of the collection.<br>**Values:** New Collection Name |
|
||||
| `summary_collectionless` | **Description:** Changes the summary of the collection.<br>**Values:** New Collection Summary |
|
||||
| `sort_title` | **Description:** Sets the sort title for the collection.<br>**Default:** `~_Collectionless`<br>**Values:** Any String |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in this file.<br>**Default:** `alpha`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `url_poster` | **Description:** Changes the poster url of the collection.<br>**Values:** URL directly to the Image |
|
||||
| `exclude` | **Description:** Exclude these Collections from being considered for collectionless.<br>**Values:** List of Collections |
|
||||
| `exclude_prefix` | **Description:** Overrides the [default exclude_prefix list](#default-exclude_prefix). Exclude Collections with one of these prefixes from being considered for collectionless.<br>**Default:** [default exclude_prefix list](#default-exclude_prefix)<br>**Values:** List of Prefixes | |
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
### Example Template Variable Amendments
|
||||
???+ warning
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
[Shared Collection Variables](../collection_variables.md) are NOT available to this default file.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
template_variables:
|
||||
collection_mode: hide_items
|
||||
collection_files:
|
||||
- pmm: collectionless
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `name_collectionless` | **Description:** Changes the name of the collection.<br>**Values:** New Collection Name |
|
||||
| `summary_collectionless` | **Description:** Changes the summary of the collection.<br>**Values:** New Collection Summary |
|
||||
| `sort_title` | **Description:** Sets the sort title for the collection.<br>**Default:** `~_Collectionless`<br>**Values:** Any String |
|
||||
| `collection_order` | **Description:** Changes the Collection Order for all collections in this file.<br>**Default:** `alpha`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `url_poster` | **Description:** Changes the poster url of the collection.<br>**Values:** URL directly to the Image |
|
||||
| `exclude` | **Description:** Exclude these Collections from being considered for collectionless.<br>**Values:** List of Collections |
|
||||
| `exclude_prefix` | **Description:** Overrides the [default exclude_prefix list](#exclude-prefix). Exclude Collections with one of these prefixes from being considered for collectionless.<br>**Default:** [default exclude_prefix list](#default-exclude_prefix)<br>**Values:** List of Prefixes | |
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
template_variables:
|
||||
exclude:
|
||||
- Marvel Cinematic Universe
|
||||
collection_order: release
|
||||
```
|
||||
collection_mode: hide_items
|
||||
collection_files:
|
||||
- pmm: collectionless
|
||||
template_variables:
|
||||
exclude:
|
||||
- Marvel Cinematic Universe
|
||||
collection_order: release
|
||||
```
|
||||
|
||||
## Default Values
|
||||
|
||||
???+ tip
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
||||
show how to change a name or a list.**
|
||||
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.**
|
||||
If you want to customize these values, use the methods described above.
|
||||
|
||||
If you want to customize these values, use the methods described above.
|
||||
??? example "Default `exclude_prefix` (click to expand) <a class="headerlink" href="#exclude-prefix" title="Permanent link">¶</a>"
|
||||
|
||||
### Default `exclude_prefix`
|
||||
<div id="exclude-prefix" />
|
||||
|
||||
```yaml
|
||||
exclude_prefix:
|
||||
- "!"
|
||||
- "~"
|
||||
```
|
||||
```yaml
|
||||
{%
|
||||
include-markdown "../../../defaults/both/collectionless.yml"
|
||||
comments=false
|
||||
preserve-includer-indent=true
|
||||
dedent=true
|
||||
start="# check1"
|
||||
end="# check2"
|
||||
%}
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,8 +1,10 @@
|
|||
# Common Sense Media Content Rating Collections
|
||||
|
||||
The `content_rating_cs` Default Collection File is used to dynamically create collections based on the content ratings available in your library.
|
||||
The `content_rating_cs` Default Collection File is used to dynamically create collections based on the content ratings
|
||||
available in your library.
|
||||
|
||||
If you do not use the Common Sense-based rating system within Plex, this file will attempt to match the ratings in your library to the respective rating system.
|
||||
If you do not use the Common Sense-based rating system within Plex, this file will attempt to match the ratings in your
|
||||
library to the respective rating system.
|
||||
|
||||
|
||||
|
||||
|
|
@ -10,15 +12,17 @@ If you do not use the Common Sense-based rating system within Plex, this file wi
|
|||
|
||||
Supported Library Types: Movie, Show
|
||||
|
||||
Recommendations: Use the [Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with either `mdb_commonsense` or `mdb_commonsense0` to update Plex to the Common Sense Rating.
|
||||
Recommendations: Use the
|
||||
[Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with either
|
||||
`mdb_commonsense` or `mdb_commonsense0` to update Plex to the Common Sense Rating.
|
||||
|
||||
## Collections Section 110
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:------------------------------------------------------------------|:---------------------------------|:----------------------------------------------------------------------------------------|
|
||||
| `Ratings Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. |
|
||||
| `<<Content Rating>> Movies/Shows`<br>**Example:** `Age 5+ Movies` | `<<Number>>`<br>**Example:** `5` | Collection of Movies/Shows that have this Content Rating. |
|
||||
| `Not Rated Movies/Shows` | `other` | Collection of Movies/Shows that are Unrated, Not Rated or any other uncommon Ratings. |
|
||||
| Collection | Key | Description |
|
||||
|:------------------------------------------------------------------|:---------------------------------|:--------------------------------------------------------------------------------------|
|
||||
| `Ratings Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. |
|
||||
| `<<Content Rating>> Movies/Shows`<br>**Example:** `Age 5+ Movies` | `<<Number>>`<br>**Example:** `5` | Collection of Movies/Shows that have this Content Rating. |
|
||||
| `Not Rated Movies/Shows` | `other` | Collection of Movies/Shows that are Unrated, Not Rated or any other uncommon Ratings. |
|
||||
|
||||
## Config
|
||||
|
||||
|
|
@ -36,20 +40,23 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
* **Shared Separator Variables** are additional variables available since this Default contains a
|
||||
[Separator](../separators.md).
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
|
|
@ -66,26 +73,27 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Age <<key_name>>+ <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>> accorfing to the Common Sense Rating System.`<br>**Values:** Any string. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
=== "Shared Separator Variables"
|
||||
|
||||
### Example Template Variable Amendments
|
||||
{%
|
||||
include-markdown "../separator_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
@ -100,15 +108,16 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
sort_by: title.asc
|
||||
```
|
||||
|
||||
|
||||
1. Use the blue [Separator Style](../separators.md#separator-styles)
|
||||
2. Do not create a "Not Rated Movies/Shows" collection
|
||||
3. Defines a collection which will be called "German 18", this does not need to already exist in your library
|
||||
4. Adds the "de/18" content rating to the "German 18" addon list, "de/18" must exist in your library if the "German 18" content rating does not
|
||||
4. Adds the "de/18" content rating to the "German 18" addon list, "de/18" must exist in your library if the "German
|
||||
18" content rating does not
|
||||
|
||||
## Default Values
|
||||
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.**
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
||||
show how to change a name or a list.**
|
||||
|
||||
If you want to customize these values, use the methods described above.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,10 @@
|
|||
# DE Content Rating Collections
|
||||
|
||||
The `content_rating_de` Default Collection File is used to dynamically create collections based on the content ratings available in your library.
|
||||
The `content_rating_de` Default Collection File is used to dynamically create collections based on the content ratings
|
||||
available in your library.
|
||||
|
||||
If you do not use the German-based rating system within Plex, this file will attempt to match the ratings in your library to the respective rating system.
|
||||
If you do not use the German-based rating system within Plex, this file will attempt to match the ratings in your
|
||||
library to the respective rating system.
|
||||
|
||||
|
||||
|
||||
|
|
@ -14,11 +16,11 @@ Recommendation: Set the Certification Country within your library's advanced set
|
|||
|
||||
## Collections Section 110
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:------------------------------------------------------------------|:--------------------------------------------|:----------------------------------------------------------------------------------------|
|
||||
| `Ratings Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. |
|
||||
| `<<Content Rating>> Movies/Shows`<br>**Example:** `BPjM Movies` | `<<Content Rating>>`<br>**Example:** `BPjM` | Collection of Movies/Shows that have this Content Rating. |
|
||||
| `Not Rated Movies/Shows` | `other` | Collection of Movies/Shows that are Unrated, Not Rated or any other uncommon Ratings. |
|
||||
| Collection | Key | Description |
|
||||
|:----------------------------------------------------------------|:--------------------------------------------|:--------------------------------------------------------------------------------------|
|
||||
| `Ratings Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. |
|
||||
| `<<Content Rating>> Movies/Shows`<br>**Example:** `BPjM Movies` | `<<Content Rating>>`<br>**Example:** `BPjM` | Collection of Movies/Shows that have this Content Rating. |
|
||||
| `Not Rated Movies/Shows` | `other` | Collection of Movies/Shows that are Unrated, Not Rated or any other uncommon Ratings. |
|
||||
|
||||
## Config
|
||||
|
||||
|
|
@ -36,21 +38,23 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
* **Shared Separator Variables** are additional variables available since this Default contains a
|
||||
[Separator](../separators.md).
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
|
||||
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
|
|
@ -67,26 +71,27 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>>.`<br>**Values:** Any string. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
=== "Shared Separator Variables"
|
||||
|
||||
### Example Template Variable Amendments
|
||||
{%
|
||||
include-markdown "../separator_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
@ -104,11 +109,13 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
1. Use the stb [Separator Style](../separators.md#separator-styles)
|
||||
2. Do not create a "Not Rated Movies/Shows" collection
|
||||
3. Defines a collection which will be called "BPjM", this does not need to already exist in your library
|
||||
4. Adds the "X" content rating to the "BPjM" addon list, "X" must exist in your library if the "BPjM" content rating does not
|
||||
4. Adds the "X" content rating to the "BPjM" addon list, "X" must exist in your library if the "BPjM" content
|
||||
rating does not
|
||||
|
||||
## Default Values
|
||||
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.**
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
||||
show how to change a name or a list.**
|
||||
|
||||
If you want to customize these values, use the methods described above.
|
||||
|
||||
|
|
@ -137,4 +144,4 @@ If you want to customize these values, use the methods described above.
|
|||
preserve-includer-indent=false
|
||||
start="addons:"
|
||||
%}
|
||||
```
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,8 +1,10 @@
|
|||
# MAL Content Rating Collections
|
||||
|
||||
The `content_rating_mal` Default Collection File is used to dynamically create collections based on the content ratings available in your library.
|
||||
The `content_rating_mal` Default Collection File is used to dynamically create collections based on the content ratings
|
||||
available in your library.
|
||||
|
||||
If you do not use the MAL-based rating system within Plex, this file will attempt to match the ratings in your library to the respective rating system.
|
||||
If you do not use the MAL-based rating system within Plex, this file will attempt to match the ratings in your library
|
||||
to the respective rating system.
|
||||
|
||||
|
||||
|
||||
|
|
@ -10,15 +12,17 @@ If you do not use the MAL-based rating system within Plex, this file will attemp
|
|||
|
||||
Supported Library Types: Movie, Show
|
||||
|
||||
Recommendations: Use the [Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with `mal` to update Plex to the MyAnimeList Content Rating.
|
||||
Recommendations: Use the
|
||||
[Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with `mal` to
|
||||
update Plex to the MyAnimeList Content Rating.
|
||||
|
||||
## Collections Section 110
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:----------------------------------------------------------------|:---------------------------------------------|:---------------------------------------------------------------------------------|
|
||||
| `Ratings Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. |
|
||||
| `<<Content Rating>> Movies/Shows`<br>**Example:** `PG-13 Shows` | `<<Content Rating>>`<br>**Example:** `PG-13` | Collection of Shows that have this Content Rating. |
|
||||
| `Not Rated Movies/Shows` | `other` | Collection of Shows that are Unrated, Not Rated or any other uncommon Ratings. |
|
||||
| Collection | Key | Description |
|
||||
|:----------------------------------------------------------------|:---------------------------------------------|:-------------------------------------------------------------------------------|
|
||||
| `Ratings Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. |
|
||||
| `<<Content Rating>> Movies/Shows`<br>**Example:** `PG-13 Shows` | `<<Content Rating>>`<br>**Example:** `PG-13` | Collection of Shows that have this Content Rating. |
|
||||
| `Not Rated Movies/Shows` | `other` | Collection of Shows that are Unrated, Not Rated or any other uncommon Ratings. |
|
||||
|
||||
## Config
|
||||
|
||||
|
|
@ -40,16 +44,25 @@ Template Variables can be used to manipulate the file in various ways to slightl
|
|||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
* **Shared Separator Variables** are additional variables available since this Default contains a
|
||||
[Separator](../separators.md).
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
|
|
@ -66,25 +79,26 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>>.`<br>**Values:** Any string. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
=== "Shared Separator Variables"
|
||||
|
||||
### Example Template Variable Amendments
|
||||
{%
|
||||
include-markdown "../separator_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
|
|
@ -102,12 +116,15 @@ The below is an example config.yml extract with some Template Variables added in
|
|||
|
||||
1. Use the tan [Separator Style](../separators.md#separator-styles)
|
||||
2. Do not create a "Not Rated Movies/Shows" collection
|
||||
3. Defines a collection which will be called "R+ - Mild Nudity", this does not need to already exist in your library
|
||||
4. Adds the "de/18" content rating to the "R+ - Mild Nudity" addon list, "de/18" must exist in your library if the "R+ - Mild Nudity" content rating does not
|
||||
3. Defines a collection which will be called "R+ - Mild Nudity", this does not need to already exist in your
|
||||
library
|
||||
4. Adds the "de/18" content rating to the "R+ - Mild Nudity" addon list, "de/18" must exist in your library if the
|
||||
"R+ - Mild Nudity" content rating does not
|
||||
|
||||
## Default Values
|
||||
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.**
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
||||
show how to change a name or a list.**
|
||||
|
||||
If you want to customize these values, use the methods described above.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,10 @@
|
|||
# UK Content Rating Collections
|
||||
|
||||
The `content_rating_uk` Default Collection File is used to dynamically create collections based on the content ratings available in your library.
|
||||
The `content_rating_uk` Default Collection File is used to dynamically create collections based on the content ratings
|
||||
available in your library.
|
||||
|
||||
If you do not use the UK-based rating system within Plex, this file will attempt to match the ratings in your library to the respective rating system.
|
||||
If you do not use the UK-based rating system within Plex, this file will attempt to match the ratings in your library to
|
||||
the respective rating system.
|
||||
|
||||
|
||||
|
||||
|
|
@ -14,11 +16,11 @@ Recommendation: Set the Certification Country within your library's advanced set
|
|||
|
||||
## Collections Section 110
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:--------------------------------------------------------------|:------------------------------------------|:----------------------------------------------------------------------------------------|
|
||||
| `Ratings Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. |
|
||||
| `<<Content Rating>> Movies/Shows`<br>**Example:** `15 Movies` | `<<Content Rating>>`<br>**Example:** `15` | Collection of Movies/Shows that have this Content Rating. |
|
||||
| `Not Rated Movies/Shows` | `other` | Collection of Movies/Shows that are Unrated, Not Rated or any other uncommon Ratings. |
|
||||
| Collection | Key | Description |
|
||||
|:--------------------------------------------------------------|:------------------------------------------|:--------------------------------------------------------------------------------------|
|
||||
| `Ratings Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. |
|
||||
| `<<Content Rating>> Movies/Shows`<br>**Example:** `15 Movies` | `<<Content Rating>>`<br>**Example:** `15` | Collection of Movies/Shows that have this Content Rating. |
|
||||
| `Not Rated Movies/Shows` | `other` | Collection of Movies/Shows that are Unrated, Not Rated or any other uncommon Ratings. |
|
||||
|
||||
## Config
|
||||
|
||||
|
|
@ -36,20 +38,23 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
* **Shared Separator Variables** are additional variables available since this Default contains a
|
||||
[Separator](../separators.md).
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
|
|
@ -66,26 +71,27 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>>.`<br>**Values:** Any string. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
=== "Shared Separator Variables"
|
||||
|
||||
### Example Template Variable Amendments
|
||||
{%
|
||||
include-markdown "../separator_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
@ -103,11 +109,13 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
1. Use the stb [Separator Style](../separators.md#separator-styles)
|
||||
2. Do not create a "Not Rated Movies/Shows" collection
|
||||
3. Defines a collection which will be called "15", this does not need to already exist in your library
|
||||
4. Adds the "de/15" content rating to the "15" addon list, "de/18" must exist in your library if the "15" content rating does not
|
||||
4. Adds the "de/15" content rating to the "15" addon list, "de/18" must exist in your library if the "15" content
|
||||
rating does not
|
||||
|
||||
## Default Values
|
||||
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.**
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
||||
show how to change a name or a list.**
|
||||
|
||||
If you want to customize these values, use the methods described above.
|
||||
|
||||
|
|
|
|||
|
|
@ -33,20 +33,23 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
* **Shared Separator Variables** are additional variables available since this Default contains a
|
||||
[Separator](../separators.md).
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
|
|
@ -60,7 +63,8 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that have the genre <<key_name>>.`<br>**Values:** Any string. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
|
|
@ -68,18 +72,18 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
=== "Shared Separator Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../separator_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
@ -96,14 +100,18 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
```
|
||||
|
||||
1. Use the red [Separator Style](../separators.md#separator-styles)
|
||||
2. Do not create a "Politics" collection, and do not include it in any other collections that it may be in as part of an "include"
|
||||
3. Do not create a "News" collection, and do not include it in any other collections that it may be in as part of an "include"
|
||||
2. Do not create a "Politics" collection, and do not include it in any other collections that it may be in as part
|
||||
of an "include"
|
||||
3. Do not create a "News" collection, and do not include it in any other collections that it may be in as part of
|
||||
an "include"
|
||||
4. Create a "Horror" collection, this genre does not need to exist in your library
|
||||
5. Include the "Thriller" genre in the "Horror" collection, the "Thriller" genre must exist in your library if the "Horror" genre does not
|
||||
5. Include the "Thriller" genre in the "Horror" collection, the "Thriller" genre must exist in your library if the
|
||||
"Horror" genre does not
|
||||
|
||||
## Default Values
|
||||
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.**
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
||||
show how to change a name or a list.**
|
||||
|
||||
If you want to customize these values, use the methods described above.
|
||||
|
||||
|
|
@ -117,4 +125,5 @@ If you want to customize these values, use the methods described above.
|
|||
comments=false
|
||||
preserve-includer-indent=false
|
||||
start="addons:"
|
||||
%}
|
||||
%}
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
# Resolution Collections
|
||||
|
||||
The `resolution` Default Collection File is used to dynamically create collections based on the resolutions available in your library.
|
||||
The `resolution` Default Collection File is used to dynamically create collections based on the resolutions available in
|
||||
your library.
|
||||
|
||||
|
||||
|
||||
|
|
@ -17,9 +18,11 @@ Supported Library Types: Movie, Show
|
|||
|
||||
### Standards Style
|
||||
|
||||
Below is a screenshot of the alternative Standards (`standards`) style which can be set via the `style` template variable.
|
||||
Below is a screenshot of the alternative Standards (`standards`) style which can be set via the `style` template
|
||||
variable.
|
||||
|
||||
Standards Style takes the base resolutions ("4K" and "720p") and turns them into the commonly-known standards name ("Ultra HD" and "HD Ready")
|
||||
Standards Style takes the base resolutions ("4K" and "720p") and turns them into the commonly-known standards name
|
||||
("Ultra HD" and "HD Ready")
|
||||
|
||||
|
||||
|
||||
|
|
@ -39,20 +42,23 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
* **Shared Separator Variables** are additional variables available since this Default contains a
|
||||
[Separator](../separators.md).
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `style` | **Description:** Controls the visual theme of the collections created.<table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>default</code></td><td>Default Theme</td></tr><tr><td><code>standards</code></td><td>Standards Theme</td></tr></table> |
|
||||
|
|
@ -70,26 +76,27 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that have the resolution <<key_name>>.`<br>**Values:** Any string. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
=== "Shared Separator Variables"
|
||||
|
||||
### Example Template Variable Amendments
|
||||
{%
|
||||
include-markdown "../separator_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
@ -107,7 +114,8 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
|
||||
## Default Values
|
||||
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.**
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
||||
show how to change a name or a list.**
|
||||
|
||||
If you want to customize these values, use the methods described above.
|
||||
|
||||
|
|
@ -136,4 +144,4 @@ If you want to customize these values, use the methods described above.
|
|||
preserve-includer-indent=false
|
||||
start="addons:"
|
||||
%}
|
||||
```
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
# Streaming Collections
|
||||
|
||||
The `streaming` Default Collection File is used to dynamically create collections based on the streaming Services that your media is available on.
|
||||
The `streaming` Default Collection File is used to dynamically create collections based on the streaming Services that
|
||||
your media is available on.
|
||||
|
||||
|
||||
|
||||
|
|
@ -31,6 +32,18 @@ Supported Library Types: Movie, Show
|
|||
| `Prime Video Movies/Shows` | `amazon` | Collection of Movies/Shows Streaming on Prime Video. |
|
||||
| `Showtime Movies/Shows` | `showtime` | Collection of Movies/Shows Streaming on Showtime. |
|
||||
|
||||
## Regional Variants
|
||||
|
||||
Some logic is applied to allow for regional streaming service lists to be available to users depending on where they
|
||||
are, as detailed below:
|
||||
|
||||
| Region | Key | Description |
|
||||
|:-----------------|:---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| any besides `us` | `amazon`, `disney`, `netflix` | These collections will use regional variant lists to ensure the lists populate with what is available in the region specified |
|
||||
| any besides `uk` | `all4`, `britbox`, `hayu`, `now` | These collections will not be created if the region is not `uk` as these streaming services are UK-focused |
|
||||
| any besides `ca` | `crave` | These collections will not be created if the region is not `ca` as these streaming services are Canada-focused |
|
||||
| `ca` | `max`, `showtime` | These collections will not be created if the region is `ca` as these streaming services are part of the Crave streaming service in Canada |
|
||||
|
||||
## Config
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
|
|
@ -47,20 +60,23 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
* **Shared Separator Variables** are additional variables available since this Default contains a
|
||||
[Separator](../separators.md).
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:--------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
|
|
@ -75,7 +91,8 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s streaming on <<key_name>>.`<br>**Values:** Any string. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
|
|
@ -83,30 +100,18 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
## Regional Variants
|
||||
=== "Shared Separator Variables"
|
||||
|
||||
Some logic is applied to allow for regional streaming service lists to be available to users depending on where they are, as detailed below:
|
||||
{%
|
||||
include-markdown "../separator_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
| Region | Key | Description |
|
||||
|:-----------------|:---------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| any besides `us` | `amazon`, `disney`, `netflix` | These collections will use regional variant lists to ensure the lists populate with what is available in the region specified |
|
||||
| any besides `uk` | `all4`, `britbox`, `hayu`, `now` | These collections will not be created if the region is not `uk` as these streaming services are UK-focused |
|
||||
| any besides `ca` | `crave` | These collections will not be created if the region is not `ca` as these streaming services are Canada-focused |
|
||||
| `ca` | `max`, `showtime` | These collections will not be created if the region is `ca` as these streaming services are part of the Crave streaming service in Canada |
|
||||
|
||||
|
||||
### Example Template Variable Amendments
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
@ -130,4 +135,4 @@ The below is an example config.yml extract with some Template Variables added in
|
|||
5. Pin the "Disney+ Movies/Shows" collection to the home screen of other users of the server
|
||||
6. Add missing shows in your library from the "Hulu Shows" list to your Sonarr
|
||||
7. Add missing movies in your library from the "Prime Video Movies" list to your Radarr
|
||||
8. Sort all the collections created by this file randomly
|
||||
8. Sort all the collections created by this file randomly
|
||||
|
|
|
|||
|
|
@ -1,8 +1,10 @@
|
|||
# Studio Collections
|
||||
|
||||
The `studio` Default Collection File is used to dynamically create collections based on the studios available in your library.
|
||||
The `studio` Default Collection File is used to dynamically create collections based on the studios available in your
|
||||
library.
|
||||
|
||||
This file also merges similarly named studios (such as "20th Century Fox" and "20th Century Animation") into one ("20th Century Studios")
|
||||
This file also merges similarly named studios (such as "20th Century Fox" and "20th Century Animation") into one ("20th
|
||||
Century Studios")
|
||||
|
||||
|
||||
|
||||
|
|
@ -33,20 +35,23 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
* **Shared Separator Variables** are additional variables available since this Default contains a
|
||||
[Separator](../separators.md).
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
|
|
@ -63,7 +68,8 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that have the resolution <<key_name>>.`<br>**Values:** Any string. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
|
|
@ -71,18 +77,18 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
=== "Shared Separator Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../separator_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
@ -102,7 +108,8 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
|
||||
## Default Values
|
||||
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.**
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
||||
show how to change a name or a list.**
|
||||
|
||||
If you want to customize these values, use the methods described above.
|
||||
|
||||
|
|
@ -131,4 +138,4 @@ If you want to customize these values, use the methods described above.
|
|||
preserve-includer-indent=false
|
||||
start="addons:"
|
||||
%}
|
||||
```
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
# Subtitle Language Collections
|
||||
|
||||
The `subtitle_language` Default Collection File is used to dynamically create collections based on the subtitle languages available in your library.
|
||||
The `subtitle_language` Default Collection File is used to dynamically create collections based on the subtitle
|
||||
languages available in your library.
|
||||
|
||||
|
||||
|
||||
|
|
@ -32,20 +33,23 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
* **Shared Separator Variables** are additional variables available since this Default contains a
|
||||
[Separator](../separators.md).
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
|
|
@ -60,7 +64,8 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> Subtitles`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s with <<key_name>> Subtitles.`<br>**Values:** Any string. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
|
|
@ -68,19 +73,18 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
=== "Shared Separator Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../separator_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
@ -100,7 +104,8 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
|
||||
## Default Values
|
||||
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.**
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
||||
show how to change a name or a list.**
|
||||
|
||||
If you want to customize these values, use the methods described above.
|
||||
|
||||
|
|
@ -129,4 +134,4 @@ If you want to customize these values, use the methods described above.
|
|||
preserve-includer-indent=false
|
||||
start="key_name_override:"
|
||||
%}
|
||||
```
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
# Universe Collections
|
||||
|
||||
The `universe` Default Collection File is used to create collections based on popular Movie universes (such as the Marvel Cinematic Universe or Wizarding World).
|
||||
The `universe` Default Collection File is used to create collections based on popular Movie universes (such as the
|
||||
Marvel Cinematic Universe or Wizarding World).
|
||||
|
||||
|
||||
|
||||
|
|
@ -45,20 +46,23 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
* **Shared Separator Variables** are additional variables available since this Default contains a
|
||||
[Separator](../separators.md).
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
|
|
@ -75,7 +79,8 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `remove_data` | **Description:** Removes from the [default data dictionary](#data).<br>**Values:** List of keys to remove |
|
||||
| `exclude` | **Description:** Exclude these Universes from creating a Dynamic Collection.<br>**Values:** List of Universes |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
|
|
@ -83,19 +88,18 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
=== "Shared Separator Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../separator_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
@ -118,7 +122,8 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
|
||||
## Default Values
|
||||
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.**
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
||||
show how to change a name or a list.**
|
||||
|
||||
If you want to customize these values, use the methods described above.
|
||||
|
||||
|
|
@ -141,12 +146,13 @@ If you want to customize these values, use the methods described above.
|
|||
<div id="trakt-url" />
|
||||
|
||||
```yaml
|
||||
trakt_url: {%
|
||||
{%
|
||||
include-markdown "../../../defaults/both/universe.yml"
|
||||
comments=false
|
||||
preserve-includer-indent=false
|
||||
preserve-includer-indent=true
|
||||
dedent=true
|
||||
start="# check1"
|
||||
end="mdblist_url:"
|
||||
end="# check2"
|
||||
%}
|
||||
```
|
||||
|
||||
|
|
@ -155,11 +161,12 @@ If you want to customize these values, use the methods described above.
|
|||
<div id="mdblist-url" />
|
||||
|
||||
```yaml
|
||||
mdblist_url: {%
|
||||
{%
|
||||
include-markdown "../../../defaults/both/universe.yml"
|
||||
comments=false
|
||||
preserve-includer-indent=false
|
||||
preserve-includer-indent=true
|
||||
dedent=true
|
||||
start="# check2"
|
||||
end="image:"
|
||||
end="# check3"
|
||||
%}
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
# Year Collections
|
||||
|
||||
The `year` Default Collection File is used to dynamically create collections based on the years available in your library, sorted by critic rating to create a "best of <year>"
|
||||
The `year` Default Collection File is used to dynamically create collections based on the years available in your
|
||||
library, sorted by critic rating to create a "best of <year>"
|
||||
|
||||
|
||||
|
||||
|
|
@ -31,20 +32,23 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
* **Shared Separator Variables** are additional variables available since this Default contains a
|
||||
[Separator](../separators.md).
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `10`<br>**Values:** Number Greater than 0 |
|
||||
|
|
@ -54,7 +58,8 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `data` | **Description:** Replaces the `data` dynamic collection value.<br><table class="clearTable"><tr><th>Attribute</th><th>Description & Values</th></tr><tr><td><code>starting</code></td><td>Controls the starting year for collections<br><strong>Default:</strong> current_year-10<br><strong>Values:</strong> Number greater than 0</td></tr><tr><td><code>ending</code></td><td>Controls the ending year for collections<br><strong>Default:</strong> current_year<br><strong>Values:</strong> Number greater than 1</td></tr><tr><td><code>increment</code></td><td>Controls the increment (i.e. every 5th year)<br><strong>Default:</strong> 1<br><strong>Values:</strong> Number greater than 0</td><td></td></tr></table><ul><li><strong><code>starting</code> and <code>ending</code> can also have the value <code>current_year</code></strong></li><li><strong>You can also use a value relative to the <code>current_year</code> by doing <code>current_year-5</code></strong></li></ul> |
|
||||
| `exclude` | **Description:** Exclude these Years from creating a Dynamic Collection.<br>**Values:** List of Years |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
|
|
@ -62,35 +67,18 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
=== "Shared Separator Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../collection_variables.md"
|
||||
include-markdown "../separator_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
@ -104,4 +92,3 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
|
||||
1. Use the purple [Separator Style](../separators.md#separator-styles)
|
||||
2. Set the sort order for "Best of 2022" to release date descending
|
||||
|
||||
|
|
|
|||
|
|
@ -33,18 +33,20 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the number of items in a collection for all collections in a Defaults file.<br>**Default:** `100`<br>**Values:** Number greater than 0 |
|
||||
|
|
@ -54,26 +56,21 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
@ -88,10 +85,11 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
visible_home_popular: true #(6)!
|
||||
visible_shared_popular: true #(7)!
|
||||
```
|
||||
|
||||
1. Do not create the "AniList Season" collection
|
||||
2. Change the order of "AniList Top Rated" to appear before other collections created by this file
|
||||
3. Amend the summary of the "AniList Top Rated" collection
|
||||
4. Only allow a maximum of 10 items to appear in the "AniList Top Rated" collection
|
||||
5. Pin the "AniList Popular" collection to the Recommended tab of the library
|
||||
6. Pin the "AniList Popular" collection to the home screen of the server owner
|
||||
7. Pin the "AniList Popular" collection to the home screen of other users of the server
|
||||
7. Pin the "AniList Popular" collection to the home screen of other users of the server
|
||||
|
|
|
|||
|
|
@ -31,18 +31,20 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:----------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Smart Filter Limit for all collections in a Defaults file.<br>**Values:** Number greater than 0 |
|
||||
|
|
@ -51,26 +53,21 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../files/builders/smart.md#sort-options) |
|
||||
| `in_the_last_<<key>>`<sup>1</sup> | **Description:** Changes how far back the Smart Filter looks.<table class="clearTable"><tr><td>**Default:**</td></tr><tr><td>`released`</td><td>`90`</td></tr><tr><td>`episodes`</td><td>`7`</td></tr></table>**Values:** Number greater than 0 |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
@ -86,4 +83,4 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
1. Change the Smart Filter to look at episodes in the last 14 days.
|
||||
2. Pin the "Newly Released" collection to the Recommended tab of the library
|
||||
3. Pin the "Newly Released" collection to the home screen of the server owner
|
||||
4. Pin the "Newly Released" collection to the home screen of other users of the server
|
||||
4. Pin the "Newly Released" collection to the home screen of other users of the server
|
||||
|
|
|
|||
|
|
@ -36,22 +36,24 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
???+ warning
|
||||
|
||||
Due to Flixpatrol data limitations, Apple TV only works with the `world` location. If you set a country-specific location, Apple TV will fall-back to using the `world` location.
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `10`<br>**Values:** Any Number 1-10 |
|
||||
|
|
@ -65,26 +67,21 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
|
|||
|
|
@ -34,18 +34,20 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
|
|
@ -53,26 +55,21 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
@ -84,7 +81,8 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
visible_home_top: true #(3)!
|
||||
visible_shared_top: true #(4)!
|
||||
```
|
||||
|
||||
1. Do not create the "IMDb Lowest Rated" collection
|
||||
2. Pin the "AniList Popular" collection to the Recommended tab of the library
|
||||
3. Pin the "AniList Popular" collection to the home screen of the server owner
|
||||
4. Pin the "AniList Popular" collection to the home screen of other users of the server
|
||||
4. Pin the "AniList Popular" collection to the home screen of other users of the server
|
||||
|
|
|
|||
|
|
@ -34,18 +34,20 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `100`<br>**Values:** Number greater than 0 |
|
||||
|
|
@ -55,26 +57,21 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
@ -94,4 +91,4 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
3. Limit the "MyAnimeList Popular" collection to 20 items.
|
||||
4. Pin the "MyAnimeList Popular" collection to the Recommended tab of the library
|
||||
5. Pin the "MyAnimeList Popular" collection to the home screen of the server owner
|
||||
6. Pin the "MyAnimeList Popular" collection to the home screen of other users of the server
|
||||
6. Pin the "MyAnimeList Popular" collection to the home screen of other users of the server
|
||||
|
|
|
|||
|
|
@ -35,18 +35,20 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit_anidb` | **Description:** Changes the Builder Limit of the AniDB Popular Collection.<br>**Default:** `30`<br>**Values:** Number greater than 0 |
|
||||
|
|
@ -55,26 +57,21 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
@ -86,7 +83,8 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
visible_home_commonsense: true #(3)!
|
||||
visible_shared_commonsense: true #(4)!
|
||||
```
|
||||
|
||||
1. Do not create the "AniDB Popular" collection
|
||||
2. Pin the "Common Sense Selection" collection to the Recommended tab of the library
|
||||
3. Pin the "Common Sense Selection" collection to the home screen of the server owner
|
||||
4. Pin the "Common Sense Selection" collection to the home screen of other users of the server
|
||||
4. Pin the "Common Sense Selection" collection to the home screen of other users of the server
|
||||
|
|
|
|||
|
|
@ -30,33 +30,36 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
**[Shared Collection Variables](../collection_variables.md) are NOT available to this default file.**
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
This file contains only a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available.
|
||||
* **Shared Separator Variables** are additional variables available since this Default contains a
|
||||
[Separator](../separators.md).
|
||||
|
||||
### Example Template Variable Amendments
|
||||
=== "Shared Separator Variables"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
{%
|
||||
include-markdown "../separator_variables.md"
|
||||
%}
|
||||
|
||||
???+ tip
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
collection_files:
|
||||
- pmm: separator_chart
|
||||
template_variables:
|
||||
sep_style: purple #(1)!
|
||||
```
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
1. Use the purple [Separator Style](../separators.md#separator-styles)
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
collection_files:
|
||||
- pmm: separator_chart
|
||||
template_variables:
|
||||
sep_style: purple #(1)!
|
||||
```
|
||||
|
||||
1. Use the purple [Separator Style](../separators.md#separator-styles)
|
||||
|
|
|
|||
|
|
@ -33,18 +33,20 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `list_days` | **Description:** Changes the `list_days` attribute of the builder for all collections in a Defaults file.<br>**Values:** Number greater than 0 |
|
||||
|
|
@ -63,19 +65,13 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
{%
|
||||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
|
|||
|
|
@ -36,18 +36,20 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `100`<br>**Values:** Number greater than 0 |
|
||||
|
|
@ -57,26 +59,21 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `collection_order` | **Description:** Changes the Collection Order for all collections in a Defaults file.<br>**Default:** `custom`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
| `collection_order_<<key>>`<sup>1</sup> | **Description:** Changes the Collection Order of the specified key's collection.<br>**Default:** `collection_order`<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](../../files/builders/plex.md#sort-options)</td><td>Order Collection by any `plex_search` Sort Option</td></tr></table> |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
@ -94,4 +91,4 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
2. Change "TMDb Popular" to have a maximum of 20 items
|
||||
3. Pin the "TMDb Popular" collection to the Recommended tab of the library
|
||||
4. Pin the "TMDb Popular" collection to the home screen of the server owner
|
||||
5. Pin the "TMDb Popular" collection to the home screen of other users of the server
|
||||
5. Pin the "TMDb Popular" collection to the home screen of other users of the server
|
||||
|
|
|
|||
|
|
@ -37,18 +37,20 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `100`<br>**Values:** Number Greater than 0 |
|
||||
|
|
@ -65,19 +67,13 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
{%
|
||||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
|
|||
|
|
@ -1,107 +1,109 @@
|
|||
## Collections
|
||||
|
||||
These files can generally be used on both Movie and Show library-types, or are part of a category of collection (such as Award Shows.)
|
||||
These files can generally be used on both Movie and Show library-types, or are part of a category of collection (such as
|
||||
Award Shows.)
|
||||
|
||||
These collections are applied by calling the below paths into the `collection_files` section of your config.yml
|
||||
|
||||
### Award Collections
|
||||
|
||||
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|
||||
|:---------------------------------------------------|:------------------|:--------------------------------------------|:------------------------------------------------------:|:------------------------------------------------------:|
|
||||
| [Award Separator](award/separator.md) | `separator_award` | Award Collections | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Academy Awards (Oscars)](award/oscars.md) | `oscars` | Best Picture Winners | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
| [British Academy of Film Awards](award/bafta.md) | `bafta` | BAFTA Best Films, BAFTA 2021 | :fontawesome-solid-circle-check:{ .green }<sup>1</sup> | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
| [Cannes Film Festival Awards](award/cannes.md) | `cannes` | Cannes - Palme d'or, Cannes 2018 | :fontawesome-solid-circle-check:{ .green }<sup>1</sup> | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
| [Critics Choice Awards](award/choice.md) | `choice` | Critics Choice Awards 2020 | :fontawesome-solid-circle-check:{ .green }<sup>1</sup> | :fontawesome-solid-circle-check:{ .green }<sup>1</sup> |
|
||||
| [Emmy Awards](award/emmy.md) | `emmy` | Emmys 2021 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Golden Globe Awards](award/golden.md) | `golden` | Best Motion Pictures | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Independent Spirit Awards](award/spirit.md) | `spirit` | Independent Spirit Awards 2021 | :fontawesome-solid-circle-check:{ .green }<sup>1</sup> | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
| [Sundance Film Festival Awards](award/sundance.md) | `sundance` | Sundance Grand Jury Winners | :fontawesome-solid-circle-check:{ .green }<sup>1</sup> | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
| [Other Awards](award/other.md) | `other_award` | Berlinale Golden Bears, Venice Golden Lions | :fontawesome-solid-circle-check:{ .green }<sup>1</sup> | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
|
||||
<sup>1</sup> Requires [Trakt Authentication](../config/trakt.md)
|
||||
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|
||||
|:----------------------------------------------------------------|:------------------|:-------------------------------------------------------------------------------------------|:------------------------------------------:|:------------------------------------------:|
|
||||
| [Award Separator](award/separator.md) | `separator_award` | Award Collections | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Academy Awards (Oscars)](award/oscars.md) | `oscars` | Oscars Best Picture Winners, Oscars Best Director Winners, Oscars 2022 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
| [Berlin International Film Festival Awards](award/berlinale.md) | `berlinale` | Berlinale Golden Bears, Berlinale 2021 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
| [British Academy of Film Awards](award/bafta.md) | `bafta` | BAFTA Best Films, BAFTA 2021 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
| [Cannes Film Festival Awards](award/cannes.md) | `cannes` | Cannes Golden Palm Winners, Cannes 2018 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
| [César Awards](award/cesar.md) | `cesar` | César Best Film Winners, César 2018 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
| [Critics Choice Awards](award/choice.md) | `choice` | Critics Choice Best Picture Winners, Critics Choice Awards 2020 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Emmy Awards](award/emmy.md) | `emmy` | Emmys Best in Category Winners, Emmys 2021 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Golden Globe Awards](award/golden.md) | `golden` | Golden Globes Best Picture Winners, Golden Globes Best Director Winners, Golden Globe 2019 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Independent Spirit Awards](award/spirit.md) | `spirit` | Spirit Best Feature Winners, Independent Spirit Awards 2021 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
| [National Film Registry](award/nfr.md) | `nfr` | National Film Registry All Time, National Film Registry 2021 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
| [People's Choice Awards](award/pca.md) | `pca` | People's Choice Award Winners, People's Choice Awards 2022 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Razzie Awards](award/razzie.md) | `razzie` | Razzies Golden Raspberry Winners, Razzie 2023 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
| [Screen Actors Guild Awards](award/sag.md) | `sag` | Screen Actors Guild Award Winners, Screen Actors Guild 2021 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Sundance Film Festival Awards](award/sundance.md) | `sundance` | Sundance Grand Jury Winners, Sundance Film Festival 2017 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
| [Toronto International Film Festival Awards](award/tiff.md) | `tiff` | Toronto People's Choice Award, Toronto International Film Festival 2020 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
| [Venice Film Festival Awards](award/venice.md) | `venice` | Venice Golden Lions, Venice 2023 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
|
||||
### Chart Collections
|
||||
|
||||
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|
||||
|:-------------------------------------------|:------------------|:-------------------------------------------|:------------------------------------------------------:|:------------------------------------------------------:|
|
||||
| [Chart Separator](chart/separator.md) | `separator_chart` | Chart Collections | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Basic Charts](chart/basic.md) | `basic` | Newly Released, New Episodes | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Tautulli Charts](chart/tautulli.md) | `tautulli` | Plex Popular, Plex Watched | :fontawesome-solid-circle-check:{ .green }<sup>2</sup> | :fontawesome-solid-circle-check:{ .green }<sup>2</sup> |
|
||||
| [IMDb Charts](chart/imdb.md) | `imdb` | IMDb Popular, IMDb Top 250 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [TMDb Charts](chart/tmdb.md) | `tmdb` | TMDb Popular, TMDb Airing Today | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Trakt Charts](chart/trakt.md) | `trakt` | Trakt Popular, Trakt Trending | :fontawesome-solid-circle-check:{ .green }<sup>1</sup> | :fontawesome-solid-circle-check:{ .green }<sup>1</sup> |
|
||||
| [FlixPatrol Charts](chart/flixpatrol.md) | `flixpatrol` | Top Disney, Top Max, Top Hulu, Top Netflix | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [AniList Charts](chart/anilist.md) | `anilist` | AniList Popular, AniList Season | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [MyAnimeList Charts](chart/myanimelist.md) | `myanimelist` | MyAnimeList Popular, MyAnimeList Top Rated | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Other Charts](chart/other.md) | `other_chart` | AniDB Popular, Common Sense Selection | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|
||||
|:-------------------------------------------------|:------------------|:-------------------------------------------|:------------------------------------------:|:------------------------------------------:|
|
||||
| [Chart Separator](chart/separator.md) | `separator_chart` | Chart Collections | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Basic Charts](chart/basic.md) | `basic` | Newly Released, New Episodes | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Tautulli Charts](chart/tautulli.md)<sup>1</sup> | `tautulli` | Plex Popular, Plex Watched | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [IMDb Charts](chart/imdb.md) | `imdb` | IMDb Popular, IMDb Top 250 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [TMDb Charts](chart/tmdb.md) | `tmdb` | TMDb Popular, TMDb Airing Today | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Trakt Charts](chart/trakt.md)<sup>2</sup> | `trakt` | Trakt Popular, Trakt Trending | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [FlixPatrol Charts](chart/flixpatrol.md) | `flixpatrol` | Top Disney, Top Max, Top Hulu, Top Netflix | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [AniList Charts](chart/anilist.md) | `anilist` | AniList Popular, AniList Season | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [MyAnimeList Charts](chart/myanimelist.md) | `myanimelist` | MyAnimeList Popular, MyAnimeList Top Rated | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Other Charts](chart/other.md) | `other_chart` | AniDB Popular, Common Sense Selection | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
|
||||
<sup>1</sup> Requires [Trakt Authentication](../config/trakt.md)
|
||||
<sup>1</sup> Requires [Tautulli Authentication](../config/tautulli.md)
|
||||
|
||||
<sup>2</sup> Requires [Tautulli Authentication](../config/tautulli.md)
|
||||
<sup>2</sup> Requires [Trakt Authentication](../config/trakt.md)
|
||||
|
||||
### Content Collections
|
||||
|
||||
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|
||||
|:-----------------------------------------------------------------|:------------|:--------------------------------------------|:---------------------------------------------------:|:--------------------------------------------------:|
|
||||
| [Genres](both/genre.md) | `genre` | Action, Drama, Science Fiction | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| Franchises [Movie](movie/franchise.md)/[Show](show/franchise.md) | `franchise` | Star Wars: Skywalker Saga, Godzilla (Anime) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Universes](both/universe.md) | `universe` | Marvel Cinematic Universal, Wizarding World | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Based On...](both/based.md) | `based` | Based on a Book, Based on a True Story | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|
||||
|:-----------------------------------------------------------------|:-----------------|:--------------------------------------------|:------------------------------------------:|:------------------------------------------:|
|
||||
| [Genres](both/genre.md) | `genre` | Action, Drama, Science Fiction | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| Franchises [Movie](movie/franchise.md)/[Show](show/franchise.md) | `franchise` | Star Wars: Skywalker Saga, Godzilla (Anime) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Universes](both/universe.md) | `universe` | Marvel Cinematic Universal, Wizarding World | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Based On...](both/based.md) | `based` | Based on a Book, Based on a True Story | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Collectionless](both/collectionless.md) | `collectionless` | Collectionless | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
|
||||
### Content Rating Collections
|
||||
|
||||
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|
||||
|:-----------------------------------------------------------------------------------------|:---------------------|:---------------------------------|:---------------------------------------------------:|:--------------------------------------------------:|
|
||||
| US Content Ratings [Movie](movie/content_rating_us.md)/[Show](show/content_rating_us.md) | `content_rating_us` | G, PG, NC-17 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [UK Content Ratings](both/content_rating_uk.md) | `content_rating_uk` | U, PG, 12A | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [MyAnimeList Content Ratings](both/content_rating_mal.md) | `content_rating_mal` | G, PG, PG-13, R, R+, Rx | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Common Sense Media Content Ratings](both/content_rating_cs.md) | `content_rating_cs` | 1, 2, 3, 4, 5, 6, 15, 16, 17, 18 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|
||||
|:-----------------------------------------------------------------------------------------|:---------------------|:---------------------------------|:------------------------------------------:|:------------------------------------------:|
|
||||
| US Content Ratings [Movie](movie/content_rating_us.md)/[Show](show/content_rating_us.md) | `content_rating_us` | G, PG, NC-17 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [UK Content Ratings](both/content_rating_uk.md) | `content_rating_uk` | U, PG, 12A | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [DE Content Ratings](both/content_rating_de.md) | `content_rating_de` | Films 12, Films 16, Films 18 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [MyAnimeList Content Ratings](both/content_rating_mal.md) | `content_rating_mal` | G, PG, PG-13, R, R+, Rx | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Common Sense Media Content Ratings](both/content_rating_cs.md) | `content_rating_cs` | 1, 2, 3, 4, 5, 6, 15, 16, 17, 18 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
|
||||
### Location Collections
|
||||
|
||||
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|
||||
|:-----------------------------------------------------------------|:------------|:----------------------|:---------------------------------------------------:|:--------------------------------------------------:|
|
||||
| Countries [Movie](movie/country.md)/[Show](show/country.md) | `country` | Belgium, India | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| Regions [Movie](movie/region.md)/[Show](show/region.md) | `region` | Iberia, Balkans | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| Continents [Movie](movie/continent.md)/[Show](show/continent.md) | `continent` | Asia, North America | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|
||||
|:-----------------------------------------------------------------|:------------|:----------------------|:------------------------------------------:|:------------------------------------------:|
|
||||
| Countries [Movie](movie/country.md)/[Show](show/country.md) | `country` | Belgium, India | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| Regions [Movie](movie/region.md)/[Show](show/region.md) | `region` | Iberia, Balkans | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| Continents [Movie](movie/continent.md)/[Show](show/continent.md) | `continent` | Asia, North America | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
|
||||
### Media Collections
|
||||
|
||||
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|
||||
|:------------------------------------------------|:--------------------|:-------------------------------------|:---------------------------------------------------:|:--------------------------------------------------:|
|
||||
| [Aspect Ratios](both/aspect.md) | `aspect` | 1.33, 1.65, 1.78, 1.85, 2.77 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Resolutions](both/resolution.md) | `resolution` | 4K Movies, 1080p Movies, 720p Movies | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Audio Languages](both/audio_language.md) | `audio_language` | French Audio, Korean Audio | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Subtitle Languages](both/subtitle_language.md) | `subtitle_language` | German Subtitles, Swedish Subtitles | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|
||||
|:------------------------------------------------|:--------------------|:-------------------------------------|:------------------------------------------:|:------------------------------------------:|
|
||||
| [Aspect Ratios](both/aspect.md) | `aspect` | 1.33, 1.65, 1.78, 1.85, 2.77 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Resolutions](both/resolution.md) | `resolution` | 4K Movies, 1080p Movies, 720p Movies | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Audio Languages](both/audio_language.md) | `audio_language` | French Audio, Korean Audio | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Subtitle Languages](both/subtitle_language.md) | `subtitle_language` | German Subtitles, Swedish Subtitles | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
|
||||
### Production Collections
|
||||
|
||||
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|
||||
|:-------------------------------|:------------|:-----------------------------------------|:---------------------------------------------------:|:--------------------------------------------------:|
|
||||
| [Networks](show/network.md) | `network` | Disney Channel, Lifetime | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Streaming](both/streaming.md) | `streaming` | Disney+ Movies, Max Shows | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Studios](both/studio.md) | `studio` | DreamWorks Studios, Walt Disney Pictures | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|
||||
|:-------------------------------|:------------|:-----------------------------------------|:------------------------------------------:|:------------------------------------------:|
|
||||
| [Networks](show/network.md) | `network` | Disney Channel, Lifetime | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Streaming](both/streaming.md) | `streaming` | Disney+ Movies, Max Shows | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Studios](both/studio.md) | `studio` | DreamWorks Studios, Walt Disney Pictures | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
|
||||
### People Collections
|
||||
|
||||
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|
||||
|:-------------------------------|:-----------|:-------------------------------------------------------|:---------------------------------------------------:|:--------------------------------------------------:|
|
||||
| [Actors](both/actor.md) | `actor` | Chris Hemsworth, Margot Robbie | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Directors](movie/director.md) | `director` | Steven Spielberg (Director), Olivia Wilde (Director) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
| [Producers](movie/producer.md) | `producer` | James Cameron (Producer), Reese Witherspoon (Producer) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
| [Writers](movie/writer.md) | `writer` | James Cameron (Writer), Lilly Wachowski (Writer) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|
||||
|:-------------------------------|:-----------|:-------------------------------------------------------|:------------------------------------------:|:------------------------------------------:|
|
||||
| [Actors](both/actor.md) | `actor` | Chris Hemsworth, Margot Robbie | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Directors](movie/director.md) | `director` | Steven Spielberg (Director), Olivia Wilde (Director) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
| [Producers](movie/producer.md) | `producer` | James Cameron (Producer), Reese Witherspoon (Producer) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
| [Writers](movie/writer.md) | `writer` | James Cameron (Writer), Lilly Wachowski (Writer) | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
|
||||
### Time Collections
|
||||
|
||||
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|
||||
|:--------------------------------------------------------|:-----------|:---------------------------|:---------------------------------------------------:|:--------------------------------------------------:|
|
||||
| [Seasonal](movie/seasonal.md) | `seasonal` | Easter, Christmas | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
| [Years](both/year.md) | `year` | Best of 2010, Best of 2019 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| Decades [Movie](movie/decade.md)/[Show](show/decade.md) | `decade` | Best of 2012, Best of 2022 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
|
||||
### Utility Collections
|
||||
|
||||
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|
||||
|:-----------------------------------------|:-----------------|:-------------------------|:---------------------------------------------------:|:--------------------------------------------------:|
|
||||
| [Collectionless](both/collectionless.md) | `collectionless` | Collectionless | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| Default | Path | Example Collections | Works with Movies | Works with Shows |
|
||||
|:--------------------------------------------------------|:-----------|:---------------------------|:------------------------------------------:|:------------------------------------------:|
|
||||
| [Seasonal](movie/seasonal.md) | `seasonal` | Easter, Christmas | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
| [Years](both/year.md) | `year` | Best of 2010, Best of 2019 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| Decades [Movie](movie/decade.md)/[Show](show/decade.md) | `decade` | Best of 2012, Best of 2022 | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
The below shared template variables are available for this file.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
|
|
@ -54,4 +53,5 @@ The below shared template variables are available for this file.
|
|||
| `item_sonarr_tag` | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
||||
| `item_sonarr_tag_<<key>>`<sup>1</sup> | **Description:** Used to append a tag in Sonarr for every series found by the builders that's in Sonarr of the specified key's collection.<br>**Default:** `item_sonarr_tag`<br>**Values:** List or comma-separated string of tags |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with
|
||||
when calling.
|
||||
BIN
docs/defaults/images/berlinale.png
Normal file
BIN
docs/defaults/images/berlinale.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 80 KiB |
BIN
docs/defaults/images/cesar.png
Normal file
BIN
docs/defaults/images/cesar.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 123 KiB |
BIN
docs/defaults/images/nfr.png
Normal file
BIN
docs/defaults/images/nfr.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 80 KiB |
BIN
docs/defaults/images/pca.png
Normal file
BIN
docs/defaults/images/pca.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 107 KiB |
BIN
docs/defaults/images/razzie.png
Normal file
BIN
docs/defaults/images/razzie.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 95 KiB |
BIN
docs/defaults/images/sag.png
Normal file
BIN
docs/defaults/images/sag.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 88 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 99 KiB |
BIN
docs/defaults/images/tiff.png
Normal file
BIN
docs/defaults/images/tiff.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 88 KiB |
BIN
docs/defaults/images/venice.png
Normal file
BIN
docs/defaults/images/venice.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 77 KiB |
|
|
@ -1,10 +1,12 @@
|
|||
# US Content Rating Collections
|
||||
|
||||
The `content_rating_us` Default Collection File is used to dynamically create collections based on the content ratings available in your library.
|
||||
The `content_rating_us` Default Collection File is used to dynamically create collections based on the content ratings
|
||||
available in your library.
|
||||
|
||||
If you do not use the US-based rating system within Plex, this file will attempt to match the ratings in your library to the respective rating system.
|
||||
If you do not use the US-based rating system within Plex, this file will attempt to match the ratings in your library to
|
||||
the respective rating system.
|
||||
|
||||
**This file has a Show Library [Counterpart](../show/content_rating_us.md).**
|
||||
**[This file has a Show Library Counterpart.](../show/content_rating_us.md)**
|
||||
|
||||
|
||||
|
||||
|
|
@ -16,11 +18,11 @@ Recommendation: Set the Certification Country within your library's advanced set
|
|||
|
||||
## Collections Section 110
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:-------------------------------------------------------|:-----------------------------------------|:----------------------------------------------------------------------------------|
|
||||
| `Country Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. |
|
||||
| `<<Content Rating>> Movies`<br>**Example:** `R Movies` | `<<Content Rating>>`<br>**Example:** `R` | Collection of Movies that have this Content Rating. |
|
||||
| `Not Rated Movies` | `other` | Collection of Movies that are Unrated, Not Rated or any other uncommon Ratings. |
|
||||
| Collection | Key | Description |
|
||||
|:-------------------------------------------------------|:-----------------------------------------|:--------------------------------------------------------------------------------|
|
||||
| `Country Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. |
|
||||
| `<<Content Rating>> Movies`<br>**Example:** `R Movies` | `<<Content Rating>>`<br>**Example:** `R` | Collection of Movies that have this Content Rating. |
|
||||
| `Not Rated Movies` | `other` | Collection of Movies that are Unrated, Not Rated or any other uncommon Ratings. |
|
||||
|
||||
## Config
|
||||
|
||||
|
|
@ -35,20 +37,23 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
* **Shared Separator Variables** are additional variables available since this Default contains a
|
||||
[Separator](../separators.md).
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater than 0 |
|
||||
|
|
@ -65,7 +70,8 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s that are rated <<key_name>>.`<br>**Values:** Any string. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
|
|
@ -73,18 +79,18 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
=== "Shared Separator Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../separator_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
@ -102,11 +108,13 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
1. Use the blue [Separator Style](../separators.md#separator-styles)
|
||||
2. Do not create a "Not Rated Movies" collection
|
||||
3. Defines a collection which will be called "R", this does not need to already exist in your library
|
||||
4. Adds the "de/18" content rating to the "R" addon list, "de/18" must exist in your library if the "R" content rating does not
|
||||
4. Adds the "de/18" content rating to the "R" addon list, "de/18" must exist in your library if the "R" content
|
||||
rating does not
|
||||
|
||||
## Default Values
|
||||
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.**
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
||||
show how to change a name or a list.**
|
||||
|
||||
If you want to customize these values, use the methods described above.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,9 @@
|
|||
# Continent Collections
|
||||
|
||||
The `continent` Default Collection File is used to dynamically create collections based on the countries within your library. The collection aims to be inclusive, with all 230 countries incorporated into seven continents.
|
||||
The `continent` Default Collection File is used to dynamically create collections based on the countries within your
|
||||
library. The collection aims to be inclusive, with all 230 countries incorporated into seven continents.
|
||||
|
||||
**This file has a Show Library [Counterpart](../show/continent.md).**
|
||||
**[This file has a Show Library Counterpart.](../show/continent.md)**
|
||||
|
||||
|
||||
|
||||
|
|
@ -37,20 +38,23 @@ Below is a screenshot of the alternative Color (`color`) style which can be set
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
* **Shared Separator Variables** are additional variables available since this Default contains a
|
||||
[Separator](../separators.md).
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `style` | **Description:** Controls the visual theme of the collections created<table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>white</code></td><td>White Theme</td></tr><tr><td><code>color</code></td><td>Color Theme</td></tr></table> |
|
||||
|
|
@ -69,7 +73,8 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s filmed in <<key_name>>.`<br>**Values:** Any string. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
|
|
@ -77,18 +82,18 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
=== "Shared Separator Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../separator_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
@ -110,7 +115,8 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
|
||||
## Default Values
|
||||
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.**
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
||||
show how to change a name or a list.**
|
||||
|
||||
If you want to customize these values, use the methods described above.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,9 @@
|
|||
# Country Collections
|
||||
|
||||
The `country` Default Collection File is used to dynamically create collections based on the countries available in your library.
|
||||
The `country` Default Collection File is used to dynamically create collections based on the countries available in your
|
||||
library.
|
||||
|
||||
**This file has a Show Library [Counterpart](../show/country.md).**
|
||||
**[This file has a Show Library Counterpart.](../show/country.md)**
|
||||
|
||||
|
||||
|
||||
|
|
@ -37,20 +38,23 @@ Below is a screenshot of the alternative Color (`color`) style which can be set
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
* **Shared Separator Variables** are additional variables available since this Default contains a
|
||||
[Separator](../separators.md).
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `style` | **Description:** Controls the visual theme of the collections created<table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>white</code></td><td>White Theme</td></tr><tr><td><code>color</code></td><td>Color Theme</td></tr></table> |
|
||||
|
|
@ -69,7 +73,8 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s filmed in <<key_name>>.`<br>**Values:** Any string. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
|
|
@ -77,18 +82,18 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
=== "Shared Separator Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../separator_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
@ -110,7 +115,8 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
|
||||
## Default Values
|
||||
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.**
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
||||
show how to change a name or a list.**
|
||||
|
||||
If you want to customize these values, use the methods described above.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,9 @@
|
|||
# Decade Collections
|
||||
|
||||
The `decade` Default Collection File is used to dynamically create collections based on the decades available in your library, sorted by critic rating to create a "best of <decade>"
|
||||
The `decade` Default Collection File is used to dynamically create collections based on the decades available in your
|
||||
library, sorted by critic rating to create a "best of <decade>"
|
||||
|
||||
**This file works has a Show Library [Counterpart](../show/decade.md).**
|
||||
**[This file has a Show Library Counterpart.](../show/decade.md)**
|
||||
|
||||
|
||||
|
||||
|
|
@ -30,20 +31,23 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
* **Shared Separator Variables** are additional variables available since this Default contains a
|
||||
[Separator](../separators.md).
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Default:** `100`<br>**Values:** Number Greater than 0 |
|
||||
|
|
@ -54,7 +58,8 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Best of <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `Top <<limit>> <<library_translation>>s of the <<key_name>>.`<br>**Values:** Any string. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
|
|
@ -62,18 +67,18 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
=== "Shared Separator Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../separator_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
@ -86,4 +91,4 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
```
|
||||
|
||||
1. Use the purple [Separator Style](../separators.md#separator-styles)
|
||||
2. Set the sort order for "Best of 2020s" to release date descending
|
||||
2. Set the sort order for "Best of 2020s" to release date descending
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
# Director Collections
|
||||
|
||||
The `director` Default Collection File is used to dynamically create collections based on the most popular directors in your library.
|
||||
The `director` Default Collection File is used to dynamically create collections based on the most popular directors in
|
||||
your library.
|
||||
|
||||
## Requirements & Recommendations
|
||||
|
||||
|
|
@ -14,7 +15,7 @@ Supported Library Types: Movie
|
|||
| `<<director_name>>`<br>**Example:** `Frank Welker` | `<<director_name>>`<br>**Example:** `Frank Welker` | Collection of Movies by the Director. |
|
||||
|
||||
{%
|
||||
include-markdown "../people.md"
|
||||
include-markdown "../people.md"
|
||||
%}
|
||||
|
||||
## Config
|
||||
|
|
@ -30,20 +31,23 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
* **Shared Separator Variables** are additional variables available since this Default contains a
|
||||
[Separator](../separators.md).
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `style` | **Description:** Controls the visual theme of the collections created.<br>**Default:** `bw`<br>**Values:** `bw`, `rainier`, `signature`, `diiivoy`, or `diiivoycolor` |
|
||||
|
|
@ -59,7 +63,8 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `tmdb_birthday` | **Description:** Controls if the Definition is run based on `tmdb_person`'s Birthday. Has 3 possible attributes `this_month`, `before` and `after`.<br>**Values:**<table class="clearTable"><tr><td>`this_month`</td><td>Run's if Birthday is in current Month</td><td>`true`/`false`</td></tr><tr><td>`before`</td><td>Run if X Number of Days before the Birthday</td><td>Number 0 or greater</td></tr><tr><td>`after`</td><td>Run if X Number of Days after the Birthday</td><td>Number 0 or greater</td></tr></table> |
|
||||
| `tmdb_person_offset_<<key>>`<sup>1</sup> | **Description:** Changes the summary tmdb_person_offset for the specific key.<br>**Default:** `0`<br>**Values:** Dictionary of Actor Name as the keys and the tmdb_person_offset as the value. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
|
|
@ -67,18 +72,18 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
=== "Shared Separator Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../separator_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
@ -98,4 +103,5 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
2. Create 20 collections maximum
|
||||
3. use the [rainier Style](#rainier-style)
|
||||
4. Do not create a "Directors Collections" separator
|
||||
5. There are two Richard Brooks, so use the 2nd [Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb
|
||||
5. There are two Richard Brooks, so use the 2nd
|
||||
[Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb
|
||||
|
|
|
|||
|
|
@ -1,10 +1,13 @@
|
|||
# Franchise Collections
|
||||
|
||||
The `franchise` Default Collection File is used to create collections based on popular Movie franchises, and can be used as a replacement to the TMDb Collections that Plex creates out-of-the-box.
|
||||
The `franchise` Default Collection File is used to create collections based on popular Movie franchises, and can be used
|
||||
as a replacement to the TMDb Collections that Plex creates out-of-the-box.
|
||||
|
||||
Unlike most Default Collection Files, Franchise works by placing collections inline with the main library items if your library allows it. For example, the "Iron Man" franchise collection will appear next to the "Iron Man" movies within your library.
|
||||
Unlike most Default Collection Files, Franchise works by placing collections inline with the main library items if your
|
||||
library allows it. For example, the "Iron Man" franchise collection will appear next to the "Iron Man" movies within
|
||||
your library.
|
||||
|
||||
**This file has a Show Library [Counterpart](../show/franchise.md).**
|
||||
**[This file has a Show Library Counterpart.](../show/franchise.md)**
|
||||
|
||||
|
||||
|
||||
|
|
@ -31,17 +34,21 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
=== "Template Variables"
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
???+ warning
|
||||
|
||||
**[Shared Collection Variables](../collection_variables.md) are NOT available to this default file.**
|
||||
[Shared Collection Variables](../collection_variables.md) are NOT available to this default file.
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-----------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
|
|
@ -73,21 +80,15 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `item_radarr_tag` | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr for all collections in a Defaults file.<br>**Values:** List or comma-separated string of tags |
|
||||
| `item_radarr_tag_<<key>>`<sup>1</sup> | **Description:** Used to append a tag in Radarr for every movie found by the builders that's in Radarr of the specified key's collection.<br>**Default:** `item_radarr_tag`<br>**Values:** List or comma-separated string of tags |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
|
||||
|
||||
### Example Template Variable Amendments
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
@ -99,13 +100,17 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
radarr_add_missing: true #(3)!
|
||||
```
|
||||
|
||||
1. Do not create any physical collections in Plex (normally used when you want to perform an "operation" instead, see the third tooltip for the example)
|
||||
2. Add [TMDb Movie 336560](https://www.themoviedb.org/movie/336560-lake-placid-vs-anaconda) to [TMDb Collection 105995](https://www.themoviedb.org/collection/105995-anaconda-collection)
|
||||
3. Add items missing from your library in Plex to Radarr. When used in this particular file, hundreds if not thousands of items may be sent to Radarr - proceed with caution!
|
||||
1. Do not create any physical collections in Plex (normally used when you want to perform an "operation" instead,
|
||||
see the third tooltip for the example)
|
||||
2. Add [TMDb Movie 336560](https://www.themoviedb.org/movie/336560-lake-placid-vs-anaconda) to
|
||||
[TMDb Collection 105995](https://www.themoviedb.org/collection/105995-anaconda-collection)
|
||||
3. Add items missing from your library in Plex to Radarr. When used in this particular file, hundreds if not
|
||||
thousands of items may be sent to Radarr - proceed with caution!
|
||||
|
||||
## Default Values
|
||||
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.**
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
||||
show how to change a name or a list.**
|
||||
|
||||
If you want to customize these values, use the methods described above.
|
||||
|
||||
|
|
@ -127,8 +132,6 @@ If you want to customize these values, use the methods described above.
|
|||
|
||||
<div id="title-override" />
|
||||
|
||||
**Default `title_override`**:
|
||||
|
||||
```yaml
|
||||
title_override: {%
|
||||
include-markdown "../../../defaults/movie/franchise.yml"
|
||||
|
|
@ -148,11 +151,13 @@ If you want to customize these values, use the methods described above.
|
|||
Pass `movie_<<key>>` to the file as template variables to change this value per collection.
|
||||
|
||||
```yaml
|
||||
movie: {%
|
||||
{%
|
||||
include-markdown "../../../defaults/movie/franchise.yml"
|
||||
comments=false
|
||||
preserve-includer-indent=true
|
||||
dedent=true
|
||||
start="# check1"
|
||||
end="name_mapping:"
|
||||
end="# check2"
|
||||
%}
|
||||
```
|
||||
|
||||
|
|
@ -165,10 +170,11 @@ If you want to customize these values, use the methods described above.
|
|||
Pass `name_mapping_<<key>>` to the file as template variables to change this value per collection.
|
||||
|
||||
```yaml
|
||||
name_mapping: {%
|
||||
{%
|
||||
include-markdown "../../../defaults/movie/franchise.yml"
|
||||
comments=false
|
||||
preserve-includer-indent=false
|
||||
preserve-includer-indent=true
|
||||
dedent=true
|
||||
start="# check2"
|
||||
%}
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
# Producer Collections
|
||||
|
||||
The `producer` Default Collection File is used to dynamically create collections based on the most popular producers in your library.
|
||||
The `producer` Default Collection File is used to dynamically create collections based on the most popular producers in
|
||||
your library.
|
||||
|
||||
## Requirements & Recommendations
|
||||
|
||||
|
|
@ -14,7 +15,7 @@ Supported Library Types: Movie
|
|||
| `<<producer_name>>`<br>**Example:** `Frank Welker` | `<<producer_name>>`<br>**Example:** `Frank Welker` | Collection of Movies by th Producer. |
|
||||
|
||||
{%
|
||||
include-markdown "../people.md"
|
||||
include-markdown "../people.md"
|
||||
%}
|
||||
|
||||
## Config
|
||||
|
|
@ -30,20 +31,23 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
* **Shared Separator Variables** are additional variables available since this Default contains a
|
||||
[Separator](../separators.md).
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `style` | **Description:** Controls the visual theme of the collections created.<br>**Default:** `bw`<br>**Values:** `bw`, `rainier`, `signature`, `diiivoy`, or `diiivoycolor` |
|
||||
|
|
@ -59,7 +63,8 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `tmdb_birthday` | **Description:** Controls if the Definition is run based on `tmdb_person`'s Birthday. Has 3 possible attributes `this_month`, `before` and `after`.<br>**Values:**<table class="clearTable"><tr><td>`this_month`</td><td>Run's if Birthday is in current Month</td><td>`true`/`false`</td></tr><tr><td>`before`</td><td>Run if X Number of Days before the Birthday</td><td>Number 0 or greater</td></tr><tr><td>`after`</td><td>Run if X Number of Days after the Birthday</td><td>Number 0 or greater</td></tr></table> |
|
||||
| `tmdb_person_offset_<<key>>`<sup>1</sup> | **Description:** Changes the summary tmdb_person_offset for the specific key.<br>**Default:** `0`<br>**Values:** Dictionary of Actor Name as the keys and the tmdb_person_offset as the value. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
|
|
@ -67,18 +72,18 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
=== "Shared Separator Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../separator_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
@ -98,4 +103,5 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
2. Create 5 collections maximum
|
||||
3. use the [rainier Style](#signature-style)
|
||||
4. Do not create a "Producers Collections" separator
|
||||
5. There are two Richard Brooks, so use the 2nd [Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb
|
||||
5. There are two Richard Brooks, so use the 2nd
|
||||
[Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb
|
||||
|
|
|
|||
|
|
@ -1,8 +1,13 @@
|
|||
# Region Collections
|
||||
|
||||
The `region` Default Collection File is used to dynamically create collections based on the countries within your library. The collection aims to be inclusive, with all 230 countries incorporated into 39 countries or collections of countries. Some care has been taken to ensure all countries are included, and the groupings won't fit well with everyone's collections. Western and Southern Europe, Oceania, and North America could be useful groupings for those libraries with more of an Asian focus, for instance. Please see the comments in the yml below where a decision point might be seen as controversial. You are welcome to edit this to fit your own audience's needs.
|
||||
The `region` Default Collection File is used to dynamically create collections based on the countries within your
|
||||
library. The collection aims to be inclusive, with all 230 countries incorporated into 39 countries or collections of
|
||||
countries. Some care has been taken to ensure all countries are included, and the groupings won't fit well with
|
||||
everyone's collections. Western and Southern Europe, Oceania, and North America could be useful groupings for those
|
||||
libraries with more of an Asian focus, for instance. Please see the comments in the yml below where a decision point
|
||||
might be seen as controversial. You are welcome to edit this to fit your own audience's needs.
|
||||
|
||||
**This file has a Show Library [Counterpart](../show/region.md).**
|
||||
**[This file has a Show Library Counterpart.](../show/region.md)**
|
||||
|
||||
|
||||
|
||||
|
|
@ -12,11 +17,11 @@ Supported Library Types: Movie
|
|||
|
||||
## Collections Section 081
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:--------------------------------------|:----------------------------------------|:-------------------------------------------------------------------------------|
|
||||
| `Region Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. |
|
||||
| `<<Region>>`<br>**Example:** `Nordic` | `<<Region>>`<br>**Example:** `Nordic` | Collection of Movies that have been tagged with countries in this region. |
|
||||
| `Other Regions` | `other` | Collection of Movies that are in other uncommon Regions. |
|
||||
| Collection | Key | Description |
|
||||
|:--------------------------------------|:--------------------------------------|:-------------------------------------------------------------------------------|
|
||||
| `Region Collections` | `separator` | [Separator Collection](../separators.md) to denote the Section of Collections. |
|
||||
| `<<Region>>`<br>**Example:** `Nordic` | `<<Region>>`<br>**Example:** `Nordic` | Collection of Movies that have been tagged with countries in this region. |
|
||||
| `Other Regions` | `other` | Collection of Movies that are in other uncommon Regions. |
|
||||
|
||||
## Config
|
||||
|
||||
|
|
@ -37,20 +42,23 @@ Below is a screenshot of the alternative Color (`color`) style which can be set
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
* **Shared Separator Variables** are additional variables available since this Default contains a
|
||||
[Separator](../separators.md).
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `style` | **Description:** Controls the visual theme of the collections created<table class="clearTable"><tr><th>Values:</th></tr><tr><td><code>white</code></td><td>White Theme</td></tr><tr><td><code>color</code></td><td>Color Theme</td></tr></table> |
|
||||
|
|
@ -69,7 +77,8 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s filmed in <<key_name>>.`<br>**Values:** Any string. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
|
|
@ -77,18 +86,18 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
=== "Shared Separator Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../separator_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
@ -110,7 +119,8 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
|
||||
## Default Values
|
||||
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.**
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
||||
show how to change a name or a list.**
|
||||
|
||||
If you want to customize these values, use the methods described above.
|
||||
|
||||
|
|
|
|||
|
|
@ -46,20 +46,23 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
* **Shared Separator Variables** are additional variables available since this Default contains a
|
||||
[Separator](../separators.md).
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:--------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `tmdb_collection_<<key>>`<sup>1</sup> | **Description:** Adds the TMDb Collection IDs given to the specified key's collection. Overrides the [default tmdb_collection](#tmdb-collection) for that collection if used.<br>**Values:** List of TMDb Collection IDs |
|
||||
|
|
@ -85,7 +88,8 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `<<key_name>> <<library_translationU>>s`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `A collection of <<key_name>> <<library_translation>>s that may relate to the season.`<br>**Values:** Any string. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
=== "Shared Template Variables"
|
||||
|
||||
|
|
@ -93,18 +97,18 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
=== "Shared Separator Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../separator_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
@ -127,11 +131,13 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
4. Create a new Seasonal collection called "Planet of the Apes Day", and set the key for this collection to `apes`
|
||||
5. Set a scheduled range for the "Planet of the Apes Day" collection. Planet Of The Apes Day is 11/25.
|
||||
6. Add an IMDb List to be used for the "Planet of the Apes Day" collection
|
||||
7. Add the 🐵 emoji to the "Planet of the Apes Day" collection so that the title in Plex is "🐵 Planet of the Apes Day Movies"
|
||||
7. Add the 🐵 emoji to the "Planet of the Apes Day" collection so that the title in Plex is "🐵 Planet of the Apes
|
||||
Day Movies"
|
||||
|
||||
## Default Values
|
||||
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not show how to change a name or a list.**
|
||||
These are lists provided for reference to show what values will be in use if you do no customization. **These do not
|
||||
show how to change a name or a list.**
|
||||
|
||||
If you want to customize these values, use the methods described above.
|
||||
|
||||
|
|
@ -158,12 +164,13 @@ If you want to customize these values, use the methods described above.
|
|||
Pass `emoji_<<key>>` to the file as template variables to change this value per collection.
|
||||
|
||||
```yaml
|
||||
emoji: {%
|
||||
{%
|
||||
include-markdown "../../../defaults/movie/seasonal.yml"
|
||||
comments=false
|
||||
preserve-includer-indent=false
|
||||
preserve-includer-indent=true
|
||||
dedent=true
|
||||
start="# check1"
|
||||
end="schedule:"
|
||||
end="# check2"
|
||||
%}
|
||||
```
|
||||
|
||||
|
|
@ -176,12 +183,13 @@ If you want to customize these values, use the methods described above.
|
|||
Pass `schedule_<<key>>` to the file as template variables to change this value per collection.
|
||||
|
||||
```yaml
|
||||
schedule: {%
|
||||
{%
|
||||
include-markdown "../../../defaults/movie/seasonal.yml"
|
||||
comments=false
|
||||
preserve-includer-indent=false
|
||||
preserve-includer-indent=true
|
||||
dedent=true
|
||||
start="# check2"
|
||||
end="imdb_list:"
|
||||
end="# check3"
|
||||
%}
|
||||
```
|
||||
|
||||
|
|
@ -194,12 +202,13 @@ If you want to customize these values, use the methods described above.
|
|||
Pass `imdb_list_<<key>>` to the file as template variables to change this value per collection.
|
||||
|
||||
```yaml
|
||||
imdb_list: {%
|
||||
{%
|
||||
include-markdown "../../../defaults/movie/seasonal.yml"
|
||||
comments=false
|
||||
preserve-includer-indent=false
|
||||
preserve-includer-indent=true
|
||||
dedent=true
|
||||
start="# check3"
|
||||
end="imdb_search:"
|
||||
end="# check4"
|
||||
%}
|
||||
```
|
||||
|
||||
|
|
@ -212,12 +221,13 @@ If you want to customize these values, use the methods described above.
|
|||
Pass `imdb_search_<<key>>` to the file as template variables to change this value per collection.
|
||||
|
||||
```yaml
|
||||
imdb_search: {%
|
||||
{%
|
||||
include-markdown "../../../defaults/movie/seasonal.yml"
|
||||
comments=false
|
||||
preserve-includer-indent=false
|
||||
preserve-includer-indent=true
|
||||
dedent=true
|
||||
start="# check4"
|
||||
end="tmdb_collection:"
|
||||
end="# check5"
|
||||
%}
|
||||
```
|
||||
|
||||
|
|
@ -230,12 +240,13 @@ If you want to customize these values, use the methods described above.
|
|||
Pass `tmdb_collection_<<key>>` to the file as template variables to change this value per collection.
|
||||
|
||||
```yaml
|
||||
tmdb_collection: {%
|
||||
{%
|
||||
include-markdown "../../../defaults/movie/seasonal.yml"
|
||||
comments=false
|
||||
preserve-includer-indent=false
|
||||
preserve-includer-indent=true
|
||||
dedent=true
|
||||
start="# check5"
|
||||
end="tmdb_movie:"
|
||||
end="# check6"
|
||||
%}
|
||||
```
|
||||
|
||||
|
|
@ -248,12 +259,13 @@ If you want to customize these values, use the methods described above.
|
|||
Pass `tmdb_movie_<<key>>` to the file as template variables to change this value per collection.
|
||||
|
||||
```yaml
|
||||
tmdb_movie: {%
|
||||
{%
|
||||
include-markdown "../../../defaults/movie/seasonal.yml"
|
||||
comments=false
|
||||
preserve-includer-indent=false
|
||||
preserve-includer-indent=true
|
||||
dedent=true
|
||||
start="# check6"
|
||||
end="mdblist_list:"
|
||||
end="# check7"
|
||||
%}
|
||||
```
|
||||
|
||||
|
|
@ -266,12 +278,13 @@ If you want to customize these values, use the methods described above.
|
|||
Pass `mdblist_list_<<key>>` to the file as template variables to change this value per collection.
|
||||
|
||||
```yaml
|
||||
mdblist_list: {%
|
||||
{%
|
||||
include-markdown "../../../defaults/movie/seasonal.yml"
|
||||
comments=false
|
||||
preserve-includer-indent=false
|
||||
preserve-includer-indent=true
|
||||
dedent=true
|
||||
start="# check7"
|
||||
end="trakt_list:"
|
||||
end="# check8"
|
||||
%}
|
||||
```
|
||||
|
||||
|
|
@ -284,11 +297,12 @@ If you want to customize these values, use the methods described above.
|
|||
Pass `trakt_list_<<key>>` to the file as template variables to change this value per collection.
|
||||
|
||||
```yaml
|
||||
trakt_list: {%
|
||||
{%
|
||||
include-markdown "../../../defaults/movie/seasonal.yml"
|
||||
comments=false
|
||||
preserve-includer-indent=false
|
||||
preserve-includer-indent=true
|
||||
dedent=true
|
||||
start="# check8"
|
||||
end="visible_home:"
|
||||
end="# check9"
|
||||
%}
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
# Writer Collections
|
||||
|
||||
The `writer` Default Collection File is used to dynamically create collections based on the most popular writers in your library.
|
||||
The `writer` Default Collection File is used to dynamically create collections based on the most popular writers in your
|
||||
library.
|
||||
|
||||
## Requirements & Recommendations
|
||||
|
||||
|
|
@ -14,7 +15,7 @@ Supported Library Types: Movie
|
|||
| `<<writer_name>>`<br>**Example:** `Frank Welker` | `<<writer_name>>`<br>**Example:** `Frank Welker` | Collection of Movies by the Writer. |
|
||||
|
||||
{%
|
||||
include-markdown "../people.md"
|
||||
include-markdown "../people.md"
|
||||
%}
|
||||
|
||||
## Config
|
||||
|
|
@ -30,20 +31,23 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Shared Template Variables** are additional variables shared across the PMM Defaults.
|
||||
|
||||
* **Shared Separator Variables** are additional variables available since this Default contains a
|
||||
[Separator](../separators.md).
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Shared Template Variables" tab for additional variables.
|
||||
|
||||
This file contains a [Separator](../separators.md) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-----------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `style` | **Description:** Controls the visual theme of the collections created.<br>**Default:** `bw`<br>**Values:** `bw`, `rainier`, `signature`, `diiivoy`, or `diiivoycolor` |
|
||||
|
|
@ -59,29 +63,27 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `tmdb_birthday` | **Description:** Controls if the Definition is run based on `tmdb_person`'s Birthday. Has 3 possible attributes `this_month`, `before` and `after`.<br>**Values:**<table class="clearTable"><tr><td>`this_month`</td><td>Run's if Birthday is in current Month</td><td>`true`/`false`</td></tr><tr><td>`before`</td><td>Run if X Number of Days before the Birthday</td><td>Number 0 or greater</td></tr><tr><td>`after`</td><td>Run if X Number of Days after the Birthday</td><td>Number 0 or greater</td></tr></table> |
|
||||
| `tmdb_person_offset_<<key>>`<sup>1</sup> | **Description:** Changes the summary tmdb_person_offset for the specific key.<br>**Default:** `0`<br>**Values:** Dictionary of Actor Name as the keys and the tmdb_person_offset as the value. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace
|
||||
`<<key>>` with when calling.
|
||||
|
||||
{%
|
||||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
=== "Shared Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../collection_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
=== "Shared Separator Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../separator_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
???+ tip
|
||||
|
||||
Anywhere you see this icon:
|
||||
|
||||
> :fontawesome-solid-circle-plus:
|
||||
|
||||
That's a tooltip, you can press them to get more information.
|
||||
|
||||
Click the :fontawesome-solid-circle-plus: icon to learn more
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
@ -101,4 +103,5 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
2. Create 20 collections maximum
|
||||
3. use the [diivivoy Style](#rainier-style)
|
||||
4. Do not create a "Writers Collections" separator
|
||||
5. There are two Richard Brooks, so use the 2nd [Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb
|
||||
5. There are two Richard Brooks, so use the 2nd
|
||||
[Richard Brooks](https://www.themoviedb.org/search?query=Richard%20Brooks) found on TMDb
|
||||
|
|
|
|||
|
|
@ -1,12 +1,18 @@
|
|||
## 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.
|
||||
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 :fontawesome-solid-circle-exclamation:{ .red } 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 :fontawesome-solid-circle-exclamation:{ .orange } 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 common
|
||||
sense age-rating since only Movies and Shows are rated by Common Sense.
|
||||
|
||||
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).
|
||||
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 Common Sense age rating would apply to all episodes).
|
||||
|
||||
These overlays are applied by calling the below paths into the `overlay_files` [section](../config/files.md) of your config.yml
|
||||
These overlays are applied by calling the below paths into the `overlay_files` [section](../config/files.md) of your
|
||||
config.yml
|
||||
|
||||
### Chart Overlays
|
||||
|
||||
|
|
@ -26,22 +32,35 @@ These overlays are applied by calling the below paths into the `overlay_files` [
|
|||
|
||||
<sup>1</sup> Requires Template Variables to function
|
||||
|
||||
### Content Rating Overlays
|
||||
|
||||
| Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
|
||||
|:------------------------------------------------------------------|:--------------------------|:------------------------------------|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:|:------------------------------------------:|
|
||||
| [US Content Ratings (Movie)](overlays/content_rating_us_movie.md) | `content_rating_us_movie` | G, PG, PG-13, R, NC-17, NR | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
| [US Content Ratings (Show)](overlays/content_rating_us_show.md) | `content_rating_us_show` | TV-G, TV-Y, TV-PG, TV-14, TV-MA, NR | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [UK Content Ratings](overlays/content_rating_uk.md) | `content_rating_uk` | U, PG, 12, 12a, 15, 18, R18, NR | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [DE Content Ratings](overlays/content_rating_de.md) | `content_rating_de` | 0, 6, 12, 16, 18, BPjM, NR | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Common Sense Age Rating](overlays/commonsense.md) | `commonsense` | 1+, 2+, 3+, 4+, ..., 17+, 18+, NR | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
|
||||
<sup>1</sup> Requires Template Variables to function
|
||||
|
||||
### Media Overlays
|
||||
|
||||
| Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
|
||||
|:------------------------------------------------------------|:-----------------|:--------------------------------------------------------------------------|:------------------------------------------:|:----------------------------------------------:|:----------------------------------------------:|:------------------------------------------:|
|
||||
| [Aspect Ratio](overlays/aspect.md)<sup>1</sup> | `aspect` | "1.33","1.78" | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Audio Codec](overlays/audio_codec.md)<sup>1</sup> | `audio_codec` | Dolby Atmos logo, DTS logo | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Audio/Subtitle Language Count](overlays/language_count.md) | `language_count` | Dual-Audio, Multi-Audio, Dual-Subtitle, Multi-Subtitle | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Audio/Subtitle Language Flags](overlays/languages.md) | `languages` | Flags Based on the Audio/Subtitles a file has | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Resolution/Editions](overlays/resolution.md)<sup>2</sup> | `resolution` | 4K Dolby Vision logo, 720P logo, "Director's Cut", "Criterion Collection" | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Runtimes](overlays/runtimes.md) | `runtimes` | "Runtime: 1h 30m" | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Versions](overlays/versions.md) | `versions` | Multiple Versions logo | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Video Format](overlays/video_format.md)<sup>1</sup> | `video_format` | "REMUX", "HDTV" | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-exclamation:{ .red } | :fontawesome-solid-circle-exclamation:{ .red } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
|
||||
|:------------------------------------------------------------|:-----------------|:--------------------------------------------------------------------------|:------------------------------------------:|:-------------------------------------------------:|:-------------------------------------------------:|:------------------------------------------:|
|
||||
| [Aspect Ratio](overlays/aspect.md)<sup>1</sup> | `aspect` | "1.33","1.78" | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Audio Codec](overlays/audio_codec.md)<sup>1</sup> | `audio_codec` | Dolby Atmos logo, DTS logo | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Audio/Subtitle Language Count](overlays/language_count.md) | `language_count` | Dual-Audio, Multi-Audio, Dual-Subtitle, Multi-Subtitle | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Audio/Subtitle Language Flags](overlays/languages.md) | `languages` | Flags Based on the Audio/Subtitles a file has | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Resolution/Editions](overlays/resolution.md)<sup>2</sup> | `resolution` | 4K Dolby Vision logo, 720P logo, "Director's Cut", "Criterion Collection" | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Runtimes](overlays/runtimes.md) | `runtimes` | "Runtime: 1h 30m" | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-xmark:{ .red } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Versions](overlays/versions.md) | `versions` | Multiple Versions logo | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| [Video Format](overlays/video_format.md)<sup>1</sup> | `video_format` | "REMUX", "HDTV" | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-exclamation:{ .orange } | :fontawesome-solid-circle-exclamation:{ .orange } | :fontawesome-solid-circle-check:{ .green } |
|
||||
|
||||
<sup>1</sup> Designed to use the [TRaSH Guides](https://trash-guides.info/) filename naming scheme
|
||||
|
||||
<sup>2</sup> Editions overlay is designed to use the Editions field within Plex [which requires Plex Pass to use] or the [TRaSH Guides](https://trash-guides.info/) filename naming scheme
|
||||
<sup>2</sup> Editions overlay is designed to use the Editions field within Plex [which requires Plex Pass to use] or the
|
||||
[TRaSH Guides](https://trash-guides.info/) filename naming scheme
|
||||
|
||||
### Production Overlays
|
||||
|
||||
|
|
@ -53,6 +72,6 @@ These overlays are applied by calling the below paths into the `overlay_files` [
|
|||
|
||||
### Utility Overlays
|
||||
|
||||
| Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
|
||||
|:---------------------------------------|:--------------|:-------------------|:------------------------------------------:|:----------------------------------------------:|:----------------------------------------------:|:------------------------------------------:|
|
||||
| [Direct Play](overlays/direct_play.md) | `direct_play` | "Direct Play Only" | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-exclamation:{ .red } | :fontawesome-solid-circle-exclamation:{ .red } | :fontawesome-solid-circle-check:{ .green } |
|
||||
| Default | Path | Example Overlays | Movies | Shows | Seasons | Episodes |
|
||||
|:---------------------------------------|:--------------|:-------------------|:------------------------------------------:|:-------------------------------------------------:|:-------------------------------------------------:|:------------------------------------------:|
|
||||
| [Direct Play](overlays/direct_play.md) | `direct_play` | "Direct Play Only" | :fontawesome-solid-circle-check:{ .green } | :fontawesome-solid-circle-exclamation:{ .orange } | :fontawesome-solid-circle-exclamation:{ .orange } | :fontawesome-solid-circle-check:{ .green } |
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
The below additional template variables are available for this PMM Defaults file as it is a text-based overlay.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-----------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
The below additional template variables are available for this PMM Defaults file as it is an Overlay file.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:---------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
|
|
@ -24,4 +23,5 @@ The below additional template variables are available for this PMM Defaults file
|
|||
| `back_line_color` | **Description:** Controls the Backdrop Line Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA``AA` is transparency; 00 [transparent] to FF [opaque] |
|
||||
| `back_line_width` | **Description:** Controls the Backdrop Line Width for the Text Overlay.<br>**Values:** Any number greater than 0 |
|
||||
|
||||
1. Each default overlay has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
1. Each default overlay has a `key` that when calling to effect a specific collection you must replace `<<key>>` with
|
||||
when calling.
|
||||
|
|
@ -43,11 +43,19 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults.
|
||||
|
||||
* **Overlay Text Template Variables** are additional variables shared across the PMM Text Overlay Defaults.
|
||||
|
||||
??? example "Default Template Variable Values (click to expand)"
|
||||
|
||||
|
|
@ -64,30 +72,30 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Overlay Template Variables" tab for additional variables.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-----------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `text_<<key>>`<sup>1</sup> | **Description:** Choose the text for the Overlay.<br>**Default:** <table class="clearTable"><tr><th>Key</th><th>Default</th></tr><tr><td>`1.33`</td><td>`1.33`</td></tr><tr><td>`1.65`</td><td>`1.65`</td></tr><tr><td>`1.66`</td><td>`1.66`</td></tr><tr><td>`1.78`</td><td>`1.78`</td></tr><tr><td>`1.85`</td><td>`1.85`</td></tr><tr><td>`2.2`</td><td>`2.2`</td></tr><tr><td>`2.35`</td><td>`2.35`</td></tr><tr><td>`2.77`</td><td>`2.77`</td></tr></table>**Values:** Any String |
|
||||
| `weight_<<key>>`<sup>1</sup> | **Description:** Controls the weight of the Overlay. Higher numbers have priority.<br>**Values:** Any Number |
|
||||
|
||||
=== "Overlay Template Variables"
|
||||
1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>`
|
||||
with when calling.
|
||||
|
||||
{%
|
||||
include-markdown "../overlay_text_variables.md"
|
||||
%}
|
||||
=== "Overlay Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../overlay_variables.md"
|
||||
%}
|
||||
|
||||
=== "Overlay Text Template Variables"
|
||||
|
||||
### Example Template Variable Amendments
|
||||
{%
|
||||
include-markdown "../overlay_text_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
@ -112,4 +120,4 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
overlay_level: season
|
||||
text_1.33: "4:9"
|
||||
text_1.77: "16:9"
|
||||
```
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
# Audio Codec Overlay
|
||||
|
||||
The `audio_codec` Default Overlay File is used to create an overlay based on the audio codec available on each item within your library.
|
||||
The `audio_codec` Default Overlay File is used to create an overlay based on the audio codec available on each item
|
||||
within your library.
|
||||
|
||||
|
||||
|
||||
|
|
@ -59,11 +60,17 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults.
|
||||
|
||||
??? example "Default Template Variable Values (click to expand)"
|
||||
|
||||
|
|
@ -80,10 +87,6 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Overlay Template Variables" tab for additional variables.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-----------------------------|:-------------------------------------------------------------------------------------------------------------|
|
||||
| `style` | **Description:** Choose the Overlay Style.<br>**Default:** `compact`<br>**Values:** `compact` or `standard` |
|
||||
|
|
@ -91,18 +94,19 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `weight_<<key>>`<sup>1</sup> | **Description:** Controls the weight of the Overlay. Higher numbers have priority.<br>**Values:** Any Number |
|
||||
| `regex_<<key>>`<sup>1</sup> | **Description:** Controls the regex of the Overlay Search.<br>**Values:** Any Proper Regex |
|
||||
|
||||
1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` with when calling.
|
||||
1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>`
|
||||
with when calling.
|
||||
|
||||
=== "Overlay Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../overlay_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
# CommonSense Age Rating Overlay
|
||||
# Common Sense Age Rating Overlay
|
||||
|
||||
The `commonsense` Default Overlay File is used to create an overlay based on the CommonSense Age Rating on each item within your library.
|
||||
The `commonsense` Default Overlay File is used to create an overlay based on the Common Sense Age Rating on each item
|
||||
within your library.
|
||||
|
||||
|
||||
|
||||
|
|
@ -8,9 +9,11 @@ The `commonsense` Default Overlay File is used to create an overlay based on the
|
|||
|
||||
Supported library types: Movie & Show
|
||||
|
||||
Requirements: Use the [Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with either `mdb_commonsense` or `mdb_commonsense0` to update Plex to the Common Sense Rating.
|
||||
Requirements: Use the [Mass Content Rating Update Library
|
||||
Operation](../../config/operations.md#mass-content-rating-update) with either `mdb_commonsense` or `mdb_commonsense0` to
|
||||
update Plex to the Common Sense Rating.
|
||||
|
||||
## Supported CommonSense Age Rating
|
||||
## Supported Common Sense Age Rating
|
||||
|
||||
| Rating | Key |
|
||||
|:-------|:-----|
|
||||
|
|
@ -56,11 +59,17 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults.
|
||||
|
||||
??? example "Default Template Variable Values (click to expand)"
|
||||
|
||||
|
|
@ -77,10 +86,6 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Overlay Template Variables" tab for additional variables.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any number greater than 0 |
|
||||
|
|
@ -96,11 +101,11 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
{%
|
||||
include-markdown "../overlay_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
# Content Rating DE Overlay
|
||||
|
||||
The `content_rating_de` Default Overlay File is used to create an overlay based on the FSK Rating on each item within your library.
|
||||
The `content_rating_de` Default Overlay File is used to create an overlay based on the FSK Rating on each item within
|
||||
your library.
|
||||
|
||||
|
||||
|
||||
|
|
@ -8,7 +9,9 @@ The `content_rating_de` Default Overlay File is used to create an overlay based
|
|||
|
||||
Supported library types: Movie & Show
|
||||
|
||||
Requirements: Use the [Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with either `mdb` or `omdb` to update Plex to the BBFC Rating.
|
||||
Requirements: Use the [Mass Content Rating Update Library
|
||||
Operation](../../config/operations.md#mass-content-rating-update) with either `mdb` or `omdb` to update Plex to the BBFC
|
||||
Rating.
|
||||
|
||||
## Supported Content Rating DE
|
||||
|
||||
|
|
@ -44,11 +47,17 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults.
|
||||
|
||||
??? example "Default Template Variable Values (click to expand)"
|
||||
|
||||
|
|
@ -62,31 +71,27 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Overlay Template Variables" tab for additional variables.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:------------------|:--------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `color` | **Description:** Color version of the content rating images<br>**Default:**`` Set to `false` if you want b&w version. |
|
||||
| `back_color` | **Description:** Choose the back color in RGBA for the overlay lozenge.<br>**Default:**`#00000099` |
|
||||
| `back_radius` | **Description:** Choose the back radius for the overlay lozenge.<br>**Default:**`30` |
|
||||
| `back_width` | **Description:** Choose the back width for the overlay lozenge.<br>**Default:**`305` |
|
||||
| `back_height` | **Description:** Choose the back height for the overlay lozenge.<br>**Default:**`105` |
|
||||
| `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any number greater than 0 |
|
||||
| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `left`<br>**Values:** `left`, `right`, `top`, `bottom` |
|
||||
| `builder_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` |
|
||||
| Variable | Description & Values |
|
||||
|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `color` | **Description:** Color version of the content rating images<br>**Default:**`` Set to `false` if you want b&w version. |
|
||||
| `back_color` | **Description:** Choose the back color in RGBA for the overlay lozenge.<br>**Default:**`#00000099` |
|
||||
| `back_radius` | **Description:** Choose the back radius for the overlay lozenge.<br>**Default:**`30` |
|
||||
| `back_width` | **Description:** Choose the back width for the overlay lozenge.<br>**Default:**`305` |
|
||||
| `back_height` | **Description:** Choose the back height for the overlay lozenge.<br>**Default:**`105` |
|
||||
| `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any number greater than 0 |
|
||||
| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `left`<br>**Values:** `left`, `right`, `top`, `bottom` |
|
||||
| `builder_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` |
|
||||
|
||||
=== "Overlay Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../overlay_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
# Content Rating UK Overlay
|
||||
|
||||
The `content_rating_uk` Default Overlay File is used to create an overlay based on the BBFC Age Rating on each item within your library.
|
||||
The `content_rating_uk` Default Overlay File is used to create an overlay based on the BBFC Age Rating on each item
|
||||
within your library.
|
||||
|
||||
|
||||
|
||||
|
|
@ -8,7 +9,9 @@ The `content_rating_uk` Default Overlay File is used to create an overlay based
|
|||
|
||||
Supported library types: Movie & Show
|
||||
|
||||
Requirements: Use the [Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with either `mdb` or `omdb` to update Plex to the BBFC Rating.
|
||||
Requirements: Use the [Mass Content Rating Update Library
|
||||
Operation](../../config/operations.md#mass-content-rating-update) with either `mdb` or `omdb` to update Plex to the BBFC
|
||||
Rating.
|
||||
|
||||
## Supported Content Rating UK
|
||||
|
||||
|
|
@ -45,11 +48,17 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults.
|
||||
|
||||
??? example "Default Template Variable Values (click to expand)"
|
||||
|
||||
|
|
@ -63,31 +72,27 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Overlay Template Variables" tab for additional variables.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:------------------|:--------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `color` | **Description:** Color version of the content rating images<br>**Default:**`` Set to `false` if you want b&w version. |
|
||||
| `back_color` | **Description:** Choose the back color in RGBA for the overlay lozenge.<br>**Default:**`#00000099` |
|
||||
| `back_radius` | **Description:** Choose the back radius for the overlay lozenge.<br>**Default:**`30` |
|
||||
| `back_width` | **Description:** Choose the back width for the overlay lozenge.<br>**Default:**`305` |
|
||||
| `back_height` | **Description:** Choose the back height for the overlay lozenge.<br>**Default:**`105` |
|
||||
| `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any number greater than 0 |
|
||||
| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `left`<br>**Values:** `left`, `right`, `top`, `bottom` |
|
||||
| `builder_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` |
|
||||
| Variable | Description & Values |
|
||||
|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `color` | **Description:** Color version of the content rating images<br>**Default:**`` Set to `false` if you want b&w version. |
|
||||
| `back_color` | **Description:** Choose the back color in RGBA for the overlay lozenge.<br>**Default:**`#00000099` |
|
||||
| `back_radius` | **Description:** Choose the back radius for the overlay lozenge.<br>**Default:**`30` |
|
||||
| `back_width` | **Description:** Choose the back width for the overlay lozenge.<br>**Default:**`305` |
|
||||
| `back_height` | **Description:** Choose the back height for the overlay lozenge.<br>**Default:**`105` |
|
||||
| `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any number greater than 0 |
|
||||
| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `left`<br>**Values:** `left`, `right`, `top`, `bottom` |
|
||||
| `builder_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` |
|
||||
|
||||
=== "Overlay Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../overlay_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
# Content Rating US Movie Overlay
|
||||
|
||||
The `content_rating_us_movie` Default Overlay File is used to create an overlay based on the MPAA Age Rating on each item within your library.
|
||||
The `content_rating_us_movie` Default Overlay File is used to create an overlay based on the MPAA Age Rating on each
|
||||
item within your library.
|
||||
|
||||
|
||||
|
||||
|
|
@ -8,7 +9,9 @@ The `content_rating_us_movie` Default Overlay File is used to create an overlay
|
|||
|
||||
Supported library types: Movie
|
||||
|
||||
Requirements: Use the [Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with either `mdb` or `omdb` to update Plex to the MPAA Rating.
|
||||
Requirements: Use the [Mass Content Rating Update Library
|
||||
Operation](../../config/operations.md#mass-content-rating-update) with either `mdb` or `omdb` to update Plex to the MPAA
|
||||
Rating.
|
||||
|
||||
## Supported Content Rating US
|
||||
|
||||
|
|
@ -34,11 +37,17 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults.
|
||||
|
||||
??? example "Default Template Variable Values (click to expand)"
|
||||
|
||||
|
|
@ -52,10 +61,6 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Overlay Template Variables" tab for additional variables.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `color` | **Description:** Color version of the content rating images<br>**Default:**`` Set to `false` if you want b&w version. |
|
||||
|
|
@ -71,11 +76,11 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
{%
|
||||
include-markdown "../overlay_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
# Content Rating US Show Overlay
|
||||
|
||||
The `content_rating_us_show` Default Overlay File is used to create an overlay based on the MPAA Age Rating on each item within your library.
|
||||
The `content_rating_us_show` Default Overlay File is used to create an overlay based on the MPAA Age Rating on each item
|
||||
within your library.
|
||||
|
||||
|
||||
|
||||
|
|
@ -8,7 +9,9 @@ The `content_rating_us_show` Default Overlay File is used to create an overlay b
|
|||
|
||||
Supported library types: Show
|
||||
|
||||
Requirements: Use the [Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with either `mdb` or `omdb` to update Plex to the MPAA Rating.
|
||||
Requirements: Use the [Mass Content Rating Update Library
|
||||
Operation](../../config/operations.md#mass-content-rating-update) with either `mdb` or `omdb` to update Plex to the MPAA
|
||||
Rating.
|
||||
|
||||
## Supported Content Rating US
|
||||
|
||||
|
|
@ -40,11 +43,17 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults.
|
||||
|
||||
??? example "Default Template Variable Values (click to expand)"
|
||||
|
||||
|
|
@ -58,30 +67,26 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Overlay Template Variables" tab for additional variables.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-----------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `color` | **Description:** Color version of the content rating images<br>**Default:**`` Set to `false` if you want b&w version. |
|
||||
| `back_color` | **Description:** Choose the back color in RGBA for the overlay lozenge.<br>**Default:**`#00000099` |
|
||||
| `back_radius` | **Description:** Choose the back radius for the overlay lozenge.<br>**Default:**`30` |
|
||||
| `back_width` | **Description:** Choose the back width for the overlay lozenge.<br>**Default:**`305` |
|
||||
| `back_height` | **Description:** Choose the back height for the overlay lozenge.<br>**Default:**`105` |
|
||||
| `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any number greater than 0 |
|
||||
| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `left`<br>**Values:** `left`, `right`, `top`, `bottom` |
|
||||
| Variable | Description & Values |
|
||||
|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `color` | **Description:** Color version of the content rating images<br>**Default:**`` Set to `false` if you want b&w version. |
|
||||
| `back_color` | **Description:** Choose the back color in RGBA for the overlay lozenge.<br>**Default:**`#00000099` |
|
||||
| `back_radius` | **Description:** Choose the back radius for the overlay lozenge.<br>**Default:**`30` |
|
||||
| `back_width` | **Description:** Choose the back width for the overlay lozenge.<br>**Default:**`305` |
|
||||
| `back_height` | **Description:** Choose the back height for the overlay lozenge.<br>**Default:**`105` |
|
||||
| `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any number greater than 0 |
|
||||
| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `left`<br>**Values:** `left`, `right`, `top`, `bottom` |
|
||||
|
||||
=== "Overlay Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../overlay_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
TV Shows:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
# Direct Play Overlay
|
||||
|
||||
The `direct_play` Default Overlay File is used to create an overlay to indicate items that cannot be transcoded and instead only support Direct Play (i.e. if you use Tautulli to kill 4K transcoding)
|
||||
The `direct_play` Default Overlay File is used to create an overlay to indicate items that cannot be transcoded and
|
||||
instead only support Direct Play (i.e. if you use Tautulli to kill 4K transcoding)
|
||||
|
||||
|
||||
|
||||
|
|
@ -24,11 +25,19 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults.
|
||||
|
||||
* **Overlay Text Template Variables** are additional variables shared across the PMM Text Overlay Defaults.
|
||||
|
||||
??? example "Default Template Variable Values (click to expand)"
|
||||
|
||||
|
|
@ -45,29 +54,26 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Overlay Template Variables" tab for additional variables.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:----------------|:--------------------------------------------------------------------------------|
|
||||
| `builder_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` |
|
||||
|
||||
=== "Overlay Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../overlay_text_variables.md"
|
||||
%}
|
||||
|
||||
{%
|
||||
include-markdown "../overlay_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
=== "Overlay Text Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../overlay_text_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
# Episode Info Overlay
|
||||
|
||||
The `episode_info` Default Overlay File is used to create an overlay on the episode title card on the episode numbering within a given series in your library.
|
||||
The `episode_info` Default Overlay File is used to create an overlay on the episode title card on the episode numbering
|
||||
within a given series in your library.
|
||||
|
||||
|
||||
|
||||
|
|
@ -21,11 +22,17 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults.
|
||||
|
||||
* **Overlay Text Template Variables** are additional variables shared across the PMM Text Overlay Defaults.
|
||||
|
||||
??? example "Default Template Variable Values (click to expand)"
|
||||
|
||||
|
|
@ -40,19 +47,22 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `back_width` | `305` |
|
||||
| `back_height` | `105` |
|
||||
|
||||
{%
|
||||
include-markdown "../overlay_text_variables.md"
|
||||
%}
|
||||
=== "Overlay Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../overlay_variables.md"
|
||||
%}
|
||||
{%
|
||||
include-markdown "../overlay_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
=== "Overlay Text Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../overlay_text_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
TV Shows:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
# FlixPatrol Top Overlays
|
||||
|
||||
The `flixpatrol` Default Overlay File is used to create an overlay based on the Top Lists from FlixPatrol on items within your library.
|
||||
The `flixpatrol` Default Overlay File is used to create an overlay based on the Top Lists from FlixPatrol on items
|
||||
within your library.
|
||||
|
||||
|
||||
|
||||
|
|
@ -36,11 +37,19 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults.
|
||||
|
||||
* **Overlay Text Template Variables** are additional variables shared across the PMM Text Overlay Defaults.
|
||||
|
||||
??? example "Default Template Variable Values (click to expand)"
|
||||
|
||||
|
|
@ -55,13 +64,13 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `back_width` | `160` |
|
||||
| `back_height` | `160` |
|
||||
| `back_padding` | `15` |
|
||||
|
||||
???+ bug "Warning"
|
||||
|
||||
`horizontal_offset`, `horizontal_align`, `vertical_offset`, and `vertical_align` are NOT available for use in this file
|
||||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Overlay Template Variables" tab for additional variables.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:----------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `position` | **Description:** Changes the position of the Overlays.<br>**Default:** `right`<br>**Values:** `right`, `left`, or List of Coordinates |
|
||||
|
|
@ -77,34 +86,25 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `30`<br>**Values:** Any Number greater than 0 |
|
||||
| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `top`<br>**Values:** `left`, `right`, `top`, `bottom` |
|
||||
|
||||
1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` with when calling.
|
||||
1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>`
|
||||
with when calling.
|
||||
|
||||
=== "Overlay Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../overlay_variables.md"
|
||||
%}
|
||||
|
||||
=== "Overlay Text Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../overlay_text_variables.md"
|
||||
%}
|
||||
|
||||
{%
|
||||
include-markdown "../overlay_variables.md"
|
||||
end="Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored."
|
||||
%}
|
||||
|
||||
???+ bug "Warning"
|
||||
|
||||
`horizontal_offset`, `horizontal_align`, `vertical_offset`, and `vertical_align` are NOT available for use in this file
|
||||
|
||||
{%
|
||||
include-markdown "../overlay_variables.md"
|
||||
start="The below template variables are available for this PMM Defaults file."
|
||||
%}
|
||||
|
||||
|
||||
### Example Template Variable Amendments
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
# Audio/Subtitle Language Count Overlay
|
||||
|
||||
The `language_count` Default Overlay File is used to create an overlay based on the number of audio/subtitle languages available on each item within your library.
|
||||
The `language_count` Default Overlay File is used to create an overlay based on the number of audio/subtitle languages
|
||||
available on each item within your library.
|
||||
|
||||
|
||||
|
||||
|
|
@ -37,11 +38,17 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults.
|
||||
|
||||
??? example "Default Template Variable Values (click to expand)"
|
||||
|
||||
|
|
@ -58,10 +65,6 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Overlay Template Variables" tab for additional variables.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:-----------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `use_subtitles` | **Description:** Controls if the overlay is based on subtitle language instead of audio language.<br>**Values:** `true` to look at subtitle language instead of audio language |
|
||||
|
|
@ -69,19 +72,19 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `builder_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` |
|
||||
| `weight_<<key>>`<sup>1</sup> | **Description:** Controls the weight of the Overlay. Higher numbers have priority.<br>**Values:** Any Number |
|
||||
|
||||
1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` with when calling.
|
||||
1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>`
|
||||
with when calling.
|
||||
|
||||
=== "Overlay Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../overlay_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,8 @@
|
|||
# Audio/Subtitle Language Flags Overlay
|
||||
|
||||
The `languages` Default Overlay File is used to create an overlay of a flag and [ISO 639-1 Code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) based on the audio/subtitle languages available on each item within your library.
|
||||
The `languages` Default Overlay File is used to create an overlay of a flag and [ISO 639-1
|
||||
Code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) based on the audio/subtitle languages available on each
|
||||
item within your library.
|
||||
|
||||
|
||||
|
||||
|
|
@ -86,17 +88,17 @@ Supported library types: Movie & Show
|
|||
| Luxembourgish | `lb` | `2` | `lu` | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
| Mossi | `mos` | `1` | `bf` | :fontawesome-solid-circle-xmark:{ .red } |
|
||||
|
||||
### Square Style
|
||||
??? tip "Square Style (click to expand)"
|
||||
|
||||
Below is a screenshot of the alternative Square (`square`) style which can be set via the `style` template variable.
|
||||
Below is a screenshot of the alternative Square (`square`) style which can be set via the `style` template variable.
|
||||
|
||||
|
||||
|
||||
|
||||
??? tip "Half Style (click to expand)"
|
||||
|
||||
### Half Style
|
||||
|
||||
Below is a screenshot of the alternative Half (`half`) style which can be set via the `style` template variable.
|
||||
|
||||
|
||||
Below is a screenshot of the alternative Half (`half`) style which can be set via the `style` template variable.
|
||||
|
||||
|
||||
|
||||
## Config
|
||||
|
||||
|
|
@ -120,11 +122,19 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **File-Specific Template Variables** are variables available specifically for this PMM Defaults file.
|
||||
|
||||
* **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults.
|
||||
|
||||
* **Overlay Text Template Variables** are additional variables shared across the PMM Text Overlay Defaults.
|
||||
|
||||
??? example "Default Template Variable Values (click to expand)"
|
||||
|
||||
|
|
@ -144,10 +154,6 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
|
||||
=== "File-Specific Template Variables"
|
||||
|
||||
The below template variables are available specifically for this PMM Defaults file.
|
||||
|
||||
Be sure to also check out the "Overlay Template Variables" tab for additional variables.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `languages` | **Description:** Controls which Languages will be active.<br>**Default:** `["en", "de", "fr", "es", "pt", "ja"]` <br>**Values:** List of [ISO 639-1 Codes](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for the Languages desired |
|
||||
|
|
@ -165,23 +171,25 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `country_<<key>>`<sup>1</sup> | **Description:** Controls the country image for the Overlay.<br>**Default:** Listed in the [Table](#supported-audiosubtitle-language-flags) above<br>**Values:** [ISO 3166-1 Country Code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) for the flag desired |
|
||||
| `weight_<<key>>`<sup>1</sup> | **Description:** Controls the weight of the Overlay. Higher numbers have priority.<br>**Values:** Any Number |
|
||||
|
||||
1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>` with when calling.
|
||||
1. Each default overlay has a `key` that when calling to effect a specific overlay you must replace `<<key>>`
|
||||
with when calling.
|
||||
|
||||
=== "Overlay Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../overlay_text_variables.md"
|
||||
%}
|
||||
|
||||
{%
|
||||
include-markdown "../overlay_variables.md"
|
||||
%}
|
||||
|
||||
### Example Template Variable Amendments
|
||||
=== "Overlay Text Template Variables"
|
||||
|
||||
{%
|
||||
include-markdown "../overlay_text_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
# MediaStinger Overlay
|
||||
|
||||
The `mediastinger` Default Overlay File is used to create an overlay based on if there's an after/during credit scene on each movie within your library.
|
||||
The `mediastinger` Default Overlay File is used to create an overlay based on if there's an after/during credit scene on
|
||||
each movie within your library.
|
||||
|
||||
|
||||
|
||||
|
|
@ -21,11 +22,15 @@ libraries:
|
|||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to
|
||||
make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
||||
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
||||
|
||||
??? info "Click to expand"
|
||||
??? abstract "Variable Lists (click to expand)"
|
||||
|
||||
* **Overlay Template Variables** are additional variables shared across the PMM Overlay Defaults.
|
||||
|
||||
??? example "Default Template Variable Values (click to expand)"
|
||||
|
||||
|
|
@ -40,15 +45,16 @@ Note that the `template_variables:` section only needs to be used if you do want
|
|||
| `back_width` | `105` |
|
||||
| `back_height` | `105` |
|
||||
|
||||
{%
|
||||
include-markdown "../overlay_variables.md"
|
||||
%}
|
||||
=== "Overlay Template Variables"
|
||||
|
||||
### Example Template Variable Amendments
|
||||
{%
|
||||
include-markdown "../overlay_variables.md"
|
||||
%}
|
||||
|
||||
???+ example "Example Template Variable Amendments"
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue