diff --git a/VERSION b/VERSION index 107127e6..9f6be3ea 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.17.3-develop140 +1.17.3-develop141 diff --git a/defaults/translations/CHANGELOG b/defaults/translations/CHANGELOG index 7cd09d97..e2bdf98a 100644 --- a/defaults/translations/CHANGELOG +++ b/defaults/translations/CHANGELOG @@ -1,3 +1,8 @@ +1.18.0.4 -> 1.18.0.5 + +Added list of Key Names +changed `<>` to `<>` + 1.18.0.3 -> 1.18.0.4 basic_episodes_summary: Changed `A collection of newly-released <>s.` to `A collection of newly-released Episodes.` diff --git a/defaults/translations/de.yml b/defaults/translations/de.yml index 8293d6b6..eb72c921 100644 --- a/defaults/translations/de.yml +++ b/defaults/translations/de.yml @@ -1,4 +1,4 @@ -version: 1.18.0.4 +version: 1.18.0.5 variables: library_translationU_singular: # For Movie Libraries @@ -257,29 +257,29 @@ translations: bafta_best_summary: British Academy of Film and Television Arts Bester Film Gewinner. # Beispiel key_name: 2022 - bafta_year_name: BAFTA <> - bafta_year_summary: <> BAFTA Filmpreise. + bafta_year_name: BAFTA <> + bafta_year_summary: <> BAFTA Filmpreise. cannes_best_name: Cannes Goldene Palme Gewinner cannes_best_summary: Cannes Goldene Palme Gewinner. # Beispiel key_name: 2022 - cannes_year_name: Cannes <> - cannes_year_summary: <> Cannes Filmpreise. + cannes_year_name: Cannes <> + cannes_year_summary: <> Cannes Filmpreise. - choice_year_name: Critics Choice Filmpreise <> - choice_year_summary: <> Critics Choice Filmpreise. + choice_year_name: Critics Choice Filmpreise <> + choice_year_summary: <> Critics Choice Filmpreise. # Beispiel key_name: 2022 - emmy_year_name: Emmys <> - emmy_year_summary: <> Emmy Gewinner. + emmy_year_name: Emmys <> + emmy_year_summary: <> Emmy Gewinner. golden_best_name: Golden Globe Bester Film golden_best_summary: Golden Globe Bester Film. # Beispiel key_name: 2022 - golden_year_name: Golden Globe <> - golden_year_summary: <> Golden Globe Gewinner. + golden_year_name: Golden Globe <> + golden_year_summary: <> Golden Globe Gewinner. oscars_picture_name: Oscars Bester Film Gewinner oscars_picture_summary: Der Filmpreis der Akademie für Bester Film ist einer der jährlich präsentierten Filmpreise der Akademie für Motion Picture Arts and Sciences seit der ersten Verleihung in 1929. @@ -288,8 +288,8 @@ translations: oscars_director_summary: Der Filmpreis der Akademie für Bester Direktor ist einer der jährlich präsentierten Filmpreise der Akademie für Motion Picture Arts and Sciences seit der ersten Verleihung in 1929. # Beispiel key_name: 2022 - oscars_year_name: Oscars Gewinner <> - oscars_year_summary: Academy Filmpreise (Oscars) Gewinner für <>. + oscars_year_name: Oscars Gewinner <> + oscars_year_summary: Academy Filmpreise (Oscars) Gewinner für <>. berlinale_best_name: Berlinale Goldener Bären berlinale_best_summary: Bis zu 400 Filme werden jedes Jahr als Teil des öffentlichen Programms der Berlinale (Internationales Film Festival Berlin) gezeigt, die meisten davon als Welt oder Europäische Premiere. Filme jeden/jeder Genres, Länge und Formats können eingereicht werden. Der Goldene Bär ist der höchste Preis der für den besten gezeigten Film des Festivals verliehen wird. @@ -304,15 +304,15 @@ translations: venice_best_summary: Die Internationalen Filmfestspiele von Venedig sind die ältesten Filmfestspiele der Welt. Gegründet in 1932 haben sie jedes Jahr in Venedig, Italien, stattgefunden. Sie sind Teil der Biennale di Venezia, einer großen, zweijährlich stattfindenden Ausstellung für zeitgenössische Kunst. Der Leone d'Oro (Goldener Löwe) Filmpreis wird an den besten Film verliehen der während der Filmfestspiele gezeigt wird. # Beispiel key_name: 2022 - spirit_year_name: Independent Spirit Filmpreise <> - spirit_year_summary: <> Independent Spirit Filmpreise. + spirit_year_name: Independent Spirit Filmpreise <> + spirit_year_summary: <> Independent Spirit Filmpreise. sundance_best_name: Sundance Grand Jury Gewinner sundance_best_summary: Das Sundance Film Festival ist ein jährlich im US-Bundesstaat Utah stattfindendes Film Festival. Es ist das größte unabhängige Kinofestival in den Vereinigten Staaten. Das Festival im Januar ist die erste Anlaufstelle für neue Arbeiten von amerikanischen und internationalen unabhängigen Filmemachern. Es besteht aus kompetitiven Bereichen für amerikanische und internationale dramaturgische und dokumentarische Filme, sowohl in Spielfilmlänge als auch Kurzfilmlänge. Es gibt auch eine Gruppe nicht kompetitiver Bereiche in denen Filme nur zur Vorstellung gezeigt werden. # Beispiel key_name: 2022 - sundance_year_name: Sundance Film Festival <> - sundance_year_summary: Sundance Film Festival von <>. + sundance_year_name: Sundance Film Festival <> + sundance_year_summary: Sundance Film Festival von <>. ############################################################# # Chart # @@ -337,8 +337,8 @@ translations: basic_episodes_summary: Eine Sammlung von neu veröffentlichten Episoden. # Möglichkeiten key_name: Netflix, Disney, HBO, Hulu, Paramount Plus, Prime Video - flixpatrol_name: <> Top <> - flixpatrol_summary: Top <> <> zu <> laut FlixPatrol. + flixpatrol_name: <> Top <> + flixpatrol_summary: Top <> <> zu <> laut FlixPatrol. imdb_popular_name: IMDb Beliebt imdb_popular_summary: Liste von IMDb Beliebt <>. @@ -417,92 +417,92 @@ translations: ############################################################# # Möglichkeiten key_name: Seasonal, Chart, Universe, Streaming, Network, Genre, Studio, Country, Audio Language, Subtitle Language, Decade, Year, Ratings, Resolution, Award, Actors, Directors, Producers, Writers - separator_name: <> Sammlungen - separator_summary: Abschnittstrenner für <> Sammlungen + separator_name: <> Sammlungen + separator_summary: Abschnittstrenner für <> Sammlungen. # Beispiel key_name: Robin Williams - actor_name: <> - actor_summary: <> mit <>. + actor_name: <> + actor_summary: <> mit <>. # Beispiel key_name: Deutsch - audio_language_name: <> Audio - audio_language_summary: <> in <> Sprache gefilmt. + audio_language_name: <> Audio + audio_language_summary: <> in <> Sprache gefilmt. audio_language_other_name: Anderes Audio audio_language_other_summary: <> in anderen ungewöhnlichen Sprachen gefilmt. # Beispiel key_name: de/16 - content_rating_name: <> <> - content_rating_summary: <> mit <> Bewertung. + content_rating_name: <> <> + content_rating_summary: <> mit <> Bewertung. # Beispiel key_name: de/16 - content_rating_cs_name: Alter <>+ <> - content_rating_cs_summary: <> die durch das Common Sense Rating System als <> bewertet wurden. + content_rating_cs_name: Alter <>+ <> + content_rating_cs_summary: <> die durch das Common Sense Rating System als <> bewertet wurden. content_rating_other_name: Nicht bewertete <> content_rating_other_summary: <> die nicht bewertet oder mit anderen ungewöhnlichen Bewertungen bewertet sind. # Beispiel key_name: Deutschland - country_name: <> - country_summary: <> in <> gefilmt. + country_name: <> + country_summary: <> in <> gefilmt. country_other_name: Andere Länder country_other_summary: <> anderen ungewöhnlichen Ländern gefilmt. # Beispiel key_name: 2010er - decade_name: Best of <> - decade_summary: Top <> <> der <>. + decade_name: Best of <> + decade_summary: Top <> <> der <>. # Beispiel key_name: 2010 - decade_show_name: Best of <>er - decade_show_summary: Top <> <> der <>er. + decade_show_name: Best of <>er + decade_show_summary: Top <> <> der <>er. # Beispiel key_name: Robin Williams - director_name: <> (Regisseur) - director_summary: <> mit Regie durch <>. + director_name: <> (Regisseur) + director_summary: <> mit Regie durch <>. # Beispiel key_name: Action - genre_name: <> <> - genre_summary: <> aus dem Genre <>. + genre_name: <> <> + genre_summary: <> aus dem Genre <>. # Beispiel key_name: NBC - network_name: <> - network_summary: <> ausgestrahlt auf <>. + network_name: <> + network_summary: <> ausgestrahlt auf <>. # Beispiel key_name: Robin Williams - producer_name: <> (Produzent) - producer_summary: <> produziert durch <>. + producer_name: <> (Produzent) + producer_summary: <> produziert durch <>. # Beispiel key_name: 1080p - resolution_name: <> <> - resolution_summary: <> mit der Auflösung <>. + resolution_name: <> <> + resolution_summary: <> mit der Auflösung <>. resolution_other_name: Andere Auflösungen resolution_other_summary: <> mit anderen ungewöhnlichen Auflösungen. # Möglichkeiten key_name: New Year's Day, Valentine's Day, St. Patrick's Day, Easter, Mother's Day, Memorial Day, Father's Day, Independence Day, Labor Day, Halloween, Thanksgiving, Christmas - seasonal_name: <> <> - seasonal_summary: Eine Sammlung von <> <> die zur aktuellen Jahreszeit passen könnten. + seasonal_name: <> <> + seasonal_summary: Eine Sammlung von <> <> die zur aktuellen Jahreszeit passen könnten. # Möglichkeiten key_name: All 4, Apple TV+, BET+, BritBox, Disney+, hayu, HBO Max, Hulu, Netflix, NOW, Paramount+, Peacock, Prime Video - streaming_name: <> <> - streaming_summary: <> die auf <> streamen. + streaming_name: <> <> + streaming_summary: <> die auf <> streamen. # Beispiel key_name: Studio Ghibli - studio_name: <> - studio_summary: <> produziert von <>. + studio_name: <> + studio_summary: <> produziert von <>. # Beispiel key_name: Deutsch - subtitle_language_name: <> Untertitel - subtitle_language_summary: <> mit <> Untertitel. + subtitle_language_name: <> Untertitel + subtitle_language_summary: <> mit <> Untertitel. subtitle_language_other_name: Andere Untertitel subtitle_language_other_summary: <> mit anderen ungewöhnlichen Untertiteln. # Beispiel key_name: Robin Williams - writer_name: <> (Autor) - writer_summary: <> geschrieben durch <>. + writer_name: <> (Autor) + writer_summary: <> geschrieben durch <>. # Beispiel key_name: 2015 - year_name: Best of <> - year_summary: <> veröffentlicht in <>. + year_name: Best of <> + year_summary: <> veröffentlicht in <>. diff --git a/defaults/translations/default.yml b/defaults/translations/default.yml index 7000f9dc..8baf0d90 100644 --- a/defaults/translations/default.yml +++ b/defaults/translations/default.yml @@ -1,4 +1,4 @@ -version: 1.18.0.4 +version: 1.18.0.5 variables: library_translation: # For Movie Libraries @@ -23,6 +23,219 @@ variables: # For Playlists item: Item key_names: + # Action: Action + # Action & Adventure: Action & Adventure + # Actors: Actors + # Adventure: Adventure + # Adult: Adult + # Albanian: Albanian + # Animation: Animation + # Anime: Anime + # Audio Language: Audio Language + # Arabic: Arabic + # Argentina: Argentina + # Australia: Australia + # Austria: Austria + # Award: Award + # Bahamas: Bahamas + # Basque: Basque + # Belgium: Belgium + # Bengali: Bengali + # Biography: Biography + # Biopic: Biopic + # Bosnian: Bosnian + # Brazil: Brazil + # Bulgaria: Bulgaria + # Bulgarian: Bulgarian + # Canada: Canada + # Catalan: Catalan + # Chart: Chart + # Children: Children + # Chile: Chile + # China: China + # Chinese: Chinese + # Christmas: Christmas + # Comedy: Comedy + # Competition: Competition + # Costa Rica: Costa Rica + # Country: Country + # Crime: Crime + # Croatia: Croatia + # Croatian: Croatian + # Czech: Czech + # Czech Republic: Czech Republic + # Danish: Danish + # Decade: Decade + # Denmark: Denmark + # Directors: Directors + # Documentary: Documentary + # Dominican Republic: Dominican Republic + # Drama: Drama + # Dutch: Dutch + # Easter: Easter + # Egypt: Egypt + # English: English + # Erotica: Erotica + # Estonia: Estonia + # Estonian: Estonian + # Family: Family + # Fantasy: Fantasy + # Father's Day: Father's Day + # Filipino: Filipino + # Film Noir: Film Noir + # Finland: Finland + # Finnish: Finnish + # Food: Food + # France: France + # French: French + # Galician: Galician + # Game Show: Game Show + # Gangster: Gangster + # Genre: Genre + # Georgian: Georgian + # German: German + # Germany: Germany + # Greece: Greece + # Greek: Greek + # Halloween: Halloween + # Hebrew: Hebrew + # Hindi: Hindi + # History: History + # Home and Garden: Home and Garden + # Hong Kong: Hong Kong + # Horror: Horror + # Hungarian: Hungarian + # Hungary: Hungary + # Iceland: Iceland + # Icelandic: Icelandic + # Independence Day: Independence Day + # India: India + # Indie: Indie + # Indonesia: Indonesia + # Indonesian: Indonesian + # Iran: Iran + # Ireland: Ireland + # Israel: Israel + # Italian: Italian + # Italy: Italy + # Japan: Japan + # Japanese: Japanese + # Kannada: Kannada + # Kazakh: Kazakh + # Kids: Kids + # Korea: Korea + # Korean: Korean + # Labor Day: Labor Day + # Latin: Latin + # Latvia: Latvia + # Latvian: Latvian + # LGBTQ+: LGBTQ+ + # Luxembourg: Luxembourg + # Macedonian: Macedonian + # Malay: Malay + # Malaysia: Malaysia + # Malaysian: Malaysian + # Marathi: Marathi + # Martial Arts: Martial Arts + # Memorial Day: Memorial Day + # Mexico: Mexico + # Mind-Bend: Mind-Bend + # Mind-Fuck: Mind-Fuck + # Mini-Series: Mini-Series + # Morocco: Morocco + # Mother's Day: Mother's Day + # Music: Music + # Musical: Musical + # Mystery: Mystery + # Nepal: Nepal + # Netherlands: Netherlands + # Network: Network + # New Year's Day: New Year's Day + # New Zealand: New Zealand + # News & Politics: News & Politics + # News: News + # Norway: Norway + # Norwegian: Norwegian + # Norwegian Bokmål: Norwegian Bokmål + # Norwegian Nynorsk: Norwegian Nynorsk + # Pakistan: Pakistan + # Panama: Panama + # Persian: Persian + # Peru: Peru + # Philippines: Philippines + # Poland: Poland + # Polish: Polish + # Politics: Politics + # Portugal: Portugal + # Portugese: Portugese + # Producers: Producers + # Punjabi: Punjabi + # Qatar: Qatar + # Ratings: Ratings + # Reality: Reality + # Resolution: Resolution + # Romance: Romance + # Romania: Romania + # Romanian: Romanian + # Romantic Comedy: Romantic Comedy + # Romantic Drama: Romantic Drama + # Russia: Russia + # Russian: Russian + # Saudi Arabia: Saudi Arabia + # Sci-Fi & Fantasy: Sci-Fi & Fantasy + # Science Fiction: Science Fiction + # Seasonal: Seasonal + # Serbia: Serbia + # Serbian: Serbian + # Short: Short + # Singapore: Singapore + # Slasher: Slasher + # Slovak: Slovak + # Slovenian: Slovenian + # South Africa: South Africa + # Soap: Soap + # Spain: Spain + # Spanish: Spanish + # Sport: Sport + # Sri Lanka: Sri Lanka + # St. Patrick's Day: St. Patrick's Day + # Stand-Up Comedy: Stand-Up Comedy + # Streaming: Streaming + # Studio: Studio + # Subtitle Language: Subtitle Language + # Superhero: Superhero + # Suspense: Suspense + # Swahili: Swahili + # Sweden: Sweden + # Swedish: Swedish + # Switzerland: Switzerland + # Sword & Sorcery: Sword & Sorcery + # Tamil: Tamil + # Telugu: Telugu + # Thai: Thai + # Thailand: Thailand + # Thanksgiving: Thanksgiving + # Turkey: Turkey + # Turkish: Turkish + # TV Movie: TV Movie + # Talk Show: Talk Show + # Thriller: Thriller + # Travel: Travel + # Ukraine: Ukraine + # Ukrainian: Ukrainian + # United Arab Emirates: United Arab Emirates + # United Kingdom: United Kingdom + # United States of America: United States of America + # Universe: Universe + # Urdu: Urdu + # Valentine's Day: Valentine's Day + # Vietnam: Vietnam + # Vietnamese: Vietnamese + # War & Politics: War & Politics + # Welsh: Welsh + # Western: Western + # Writers: Writers + # Year: Year translations: ############################################################# @@ -33,29 +246,29 @@ translations: bafta_best_summary: British Academy of Film and Television Arts Best Film Winners. # example key_name: 2022 - bafta_year_name: BAFTA <> - bafta_year_summary: <> BAFTA Awards. + bafta_year_name: BAFTA <> + bafta_year_summary: <> BAFTA Awards. cannes_best_name: Cannes Golden Palm Winners cannes_best_summary: Cannes Golden Palm Winners. # example key_name: 2022 - cannes_year_name: Cannes <> - cannes_year_summary: <> Cannes Awards. + cannes_year_name: Cannes <> + cannes_year_summary: <> Cannes Awards. - choice_year_name: Critics Choice Awards <> - choice_year_summary: <> Critics Choice Awards. + choice_year_name: Critics Choice Awards <> + choice_year_summary: <> Critics Choice Awards. # example key_name: 2022 - emmy_year_name: Emmys <> - emmy_year_summary: <> Emmy Winners. + emmy_year_name: Emmys <> + emmy_year_summary: <> Emmy Winners. golden_best_name: Golden Globe Best Motion Pictures golden_best_summary: Golden Globe Best Motion Pictures. # example key_name: 2022 - golden_year_name: Golden Globe <> - golden_year_summary: <> Golden Globe Winners. + golden_year_name: Golden Globe <> + golden_year_summary: <> Golden Globe Winners. oscars_picture_name: Oscars Best Picture Winners oscars_picture_summary: The Academy Award for Best Picture is one of the Academy Awards presented annually by the Academy of Motion Picture Arts and Sciences since the awards debuted in 1929. @@ -64,8 +277,8 @@ translations: oscars_director_summary: The Academy Award for Best Director is one of the Academy Awards presented annually by the Academy of Motion Picture Arts and Sciences since the awards debuted in 1929. # example key_name: 2022 - oscars_year_name: Oscars Winners <> - oscars_year_summary: Academy Awards (Oscars) Winners for <>. + oscars_year_name: Oscars Winners <> + oscars_year_summary: Academy Awards (Oscars) Winners for <>. berlinale_best_name: Berlinale Golden Bears berlinale_best_summary: Up to 400 films are shown every year as part of the Berlinale's (Berlin International Film Festival) public programme, the vast majority of which are world or European premieres. Films of every genre, length and format can be submitted for consideration. The Golden Bear (German Goldener Bär) is the highest prize awarded for the best film shown during this festival. @@ -80,15 +293,15 @@ translations: venice_best_summary: The Venice Film Festival is the oldest film festival in the world. Founded 1932, the festival has since taken place every year in Venice, Italy. It is part of the Venice Biennale, a major biennial exhibition and festival for contemporary art. The festival's Leone d'Oro (Golden Lion) prize is awarded to the best film screened at the festival. # example key_name: 2022 - spirit_year_name: Independent Spirit Awards <> - spirit_year_summary: <> Independent Spirit Awards. + spirit_year_name: Independent Spirit Awards <> + spirit_year_summary: <> Independent Spirit Awards. sundance_best_name: Sundance Grand Jury Winners sundance_best_summary: The Sundance Film Festival is a film festival that takes place annually in the state of Utah, in the United States. It is the largest independent cinema festival in the U.S. Held in January, the festival is the premier showcase for new work from American and international independent filmmakers. The festival comprises competitive sections for American and international dramatic and documentary films, both feature-length films and short films, and a group of non-competitive showcase sections. # example key_name: 2022 - sundance_year_name: Sundance Film Festival <> - sundance_year_summary: Sundance Film Festival of <>. + sundance_year_name: Sundance Film Festival <> + sundance_year_summary: Sundance Film Festival of <>. ############################################################# # Chart # @@ -113,8 +326,8 @@ translations: basic_episodes_summary: A collection of newly-released Episodes. # possible key_name: Netflix, Disney, HBO, Hulu, Paramount Plus, Prime Video - flixpatrol_name: <> Top <> - flixpatrol_summary: Top <> <>s on <> according to FlixPatrol. + flixpatrol_name: <> Top <> + flixpatrol_summary: Top <> <>s on <> according to FlixPatrol. imdb_popular_name: IMDb Popular imdb_popular_summary: List of IMDb Popular <>s. @@ -193,92 +406,92 @@ translations: ############################################################# # possible key_names: Seasonal, Chart, Universe, Streaming, Network, Genre, Studio, Country, Audio Language, Subtitle Language, Decade, Year, Ratings, Resolution, Award, Actors, Directors, Producers, Writers - separator_name: <> Collections - separator_summary: Section separator for <> Collections + separator_name: <> Collections + separator_summary: Section separator for <> Collections. # example key_name: Robin Williams - actor_name: <> - actor_summary: <>s with <>. + actor_name: <> + actor_summary: <>s with <>. # example key_name: English - audio_language_name: <> Audio - audio_language_summary: <>s filmed in the <> Language. + audio_language_name: <> Audio + audio_language_summary: <>s filmed in the <> Language. audio_language_other_name: Other Audio audio_language_other_summary: <>s filmed in other uncommon Languages. # example key_name: TV-MA - content_rating_name: <> <>s - content_rating_summary: <>s that are rated <>. + content_rating_name: <> <>s + content_rating_summary: <>s that are rated <>. # example key_name: TV-MA - content_rating_cs_name: Age <>+ <>s - content_rating_cs_summary: <>s that are rated <> according to the Common Sense Rating System. + content_rating_cs_name: Age <>+ <>s + content_rating_cs_summary: <>s that are rated <> according to the Common Sense Rating System. content_rating_other_name: Not Rated <>s content_rating_other_summary: <>s that are Unrated, Not Rated or any other uncommon Ratings. # example key_name: United States - country_name: <> - country_summary: <>s filmed in <>. + country_name: <> + country_summary: <>s filmed in <>. country_other_name: Other Countries country_other_summary: <>s filmed in other uncommon Countries. # example key_name: 2010s - decade_name: Best of <> - decade_summary: Top <> <>s of the <>. + decade_name: Best of <> + decade_summary: Top <> <>s of the <>. # example key_name: 2010 - decade_show_name: Best of <>s - decade_show_summary: Top <> <>s of the <>s. + decade_show_name: Best of <>s + decade_show_summary: Top <> <>s of the <>s. # example key_name: Robin Williams - director_name: <> (Director) - director_summary: <>s directed by <>. + director_name: <> (Director) + director_summary: <>s directed by <>. # example key_name: Action - genre_name: <> <>s - genre_summary: <>s that have the genre <>. + genre_name: <> <>s + genre_summary: <>s that have the genre <>. # example key_name: NBC - network_name: <> - network_summary: <>s broadcast on <>. + network_name: <> + network_summary: <>s broadcast on <>. # example key_name: Robin Williams - producer_name: <> (Producer) - producer_summary: <>s produced by <>. + producer_name: <> (Producer) + producer_summary: <>s produced by <>. # example key_name: 1080p - resolution_name: <> <>s - resolution_summary: <>s that have the resolution <>. + resolution_name: <> <>s + resolution_summary: <>s that have the resolution <>. resolution_other_name: Other Resolution <>s resolution_other_summary: <>s that have other uncommon resolutions. # possible key_names: New Year's Day, Valentine's Day, St. Patrick's Day, Easter, Mother's Day, Memorial Day, Father's Day, Independence Day, Labor Day, Halloween, Thanksgiving, Christmas - seasonal_name: <> <>s - seasonal_summary: A collection of <> <>s that may relate to the season. + seasonal_name: <> <>s + seasonal_summary: A collection of <> <>s that may relate to the season. # possible key_names: All 4, Apple TV+, BET+, BritBox, Disney+, hayu, HBO Max, Hulu, Netflix, NOW, Paramount+, Peacock, Prime Video - streaming_name: <> <>s - streaming_summary: <>s streaming on <>. + streaming_name: <> <>s + streaming_summary: <>s streaming on <>. # example key_name: Studio Ghibli - studio_name: <> - studio_summary: <>s produced by <>. + studio_name: <> + studio_summary: <>s produced by <>. # example key_name: English - subtitle_language_name: <> Subtitles - subtitle_language_summary: <>s with <> Subtitles. + subtitle_language_name: <> Subtitles + subtitle_language_summary: <>s with <> Subtitles. subtitle_language_other_name: Other Subtitles subtitle_language_other_summary: <>s with other uncommon Subtitles. # example key_name: Robin Williams - writer_name: <> (Writer) - writer_summary: <>s written by <>. + writer_name: <> (Writer) + writer_summary: <>s written by <>. # example key_name: 2015 - year_name: Best of <> - year_summary: <>s released in <>. + year_name: Best of <> + year_summary: <>s released in <>. diff --git a/defaults/translations/fr.yml b/defaults/translations/fr.yml index 7d9d99ea..3d6e0d97 100644 --- a/defaults/translations/fr.yml +++ b/defaults/translations/fr.yml @@ -116,29 +116,29 @@ translations: bafta_best_summary: Gagnants du meilleur film de la British Academy of Film and Television Arts. # example key_name: 2022 - bafta_year_name: BAFTA <> - bafta_year_summary: Prix BAFTA <>. + bafta_year_name: BAFTA <> + bafta_year_summary: Prix BAFTA <>. cannes_best_name: Gagnants de la Palme d’Or de Cannes cannes_best_summary: Gagnants de la Palme d’Or de Cannes. # example key_name: 2022 - cannes_year_name: Cannes <> - cannes_year_summary: Prix Cannes <>. + cannes_year_name: Cannes <> + cannes_year_summary: Prix Cannes <>. - choice_year_name: Critics Choice Awards <> - choice_year_summary: Critics Choice Awards <>. + choice_year_name: Critics Choice Awards <> + choice_year_summary: Critics Choice Awards <>. # example key_name: 2022 - emmy_year_name: Emmys <> - emmy_year_summary: Lauréats des Emmy Awards <>. + emmy_year_name: Emmys <> + emmy_year_summary: Lauréats des Emmy Awards <>. golden_best_name: Golden Globe meilleurs films golden_best_summary: Golden Globe meilleurs films. # example key_name: 2022 - golden_year_name: Golden Globe <> - golden_year_summary: Lauréats des Golden Globes <>. + golden_year_name: Golden Globe <> + golden_year_summary: Lauréats des Golden Globes <>. oscars_picture_name: Gagnants des Oscars du meilleur film oscars_picture_summary: L’Oscar du meilleur film est l’un des Oscars décernés chaque année par l’Academy of Motion Picture Arts and Sciences depuis ses débuts en 1929. @@ -147,8 +147,8 @@ translations: oscars_director_summary: L’Oscar du meilleur réalisateur est l’un des Oscars décernés chaque année par l’Academy of Motion Picture Arts and Sciences depuis ses débuts en 1929. # example key_name: 2022 - oscars_year_name: Lauréats des Oscars <> - oscars_year_summary: Lauréats des Oscars <>. + oscars_year_name: Lauréats des Oscars <> + oscars_year_summary: Lauréats des Oscars <>. berlinale_best_name: Ours d’or de la Berlinale berlinale_best_summary: Jusqu’à 400 films sont projetés chaque année dans le cadre du programme public de la Berlinale (Festival international du film de Berlin), dont la grande majorité sont des premières mondiales ou européennes. Les films de tous genres, de toutes les durées et de tous les formats peuvent être soumis pour examen. L’Ours d’or (allemand Goldener Bär) est le prix le plus élevé décerné au meilleur film présenté lors de ce festival. @@ -163,15 +163,15 @@ translations: venice_best_summary: La Mostra de Venise est la plus ancienne fête du film au monde. Fondé en 1932, le festival a depuis lieu chaque année à Venise, en Italie. Il fait partie de la Biennale de Venise, une grande exposition biennale et festival d’art contemporain. Le prix Leone d’Oro (Lion d’or) du festival est décerné au meilleur film projeté au festival. # example key_name: 2022 - spirit_year_name: Independent Spirit Awards <> - spirit_year_summary: Independent Spirit Awards <>. + spirit_year_name: Independent Spirit Awards <> + spirit_year_summary: Independent Spirit Awards <>. sundance_best_name: Gagnants du Grand Jury sundance sundance_best_summary: Le Festival du film de Sundance est un festival de cinéma qui a lieu chaque année dans l’État de l’Utah, aux États-Unis. C’est le plus grand festival de cinéma indépendant aux États-Unis Tenu en janvier, le festival est la première vitrine pour les nouvelles œuvres de cinéastes indépendants américains et internationaux. Le festival comprend des sections compétitives pour les films dramatiques et documentaires américains et internationaux, les longs métrages et les courts métrages, ainsi qu’un groupe de sections vitrines non compétitives. # example key_name: 2022 - sundance_year_name: Festival du film de Sundance <> - sundance_year_summary: Festival du film de Sundance <>. + sundance_year_name: Festival du film de Sundance <> + sundance_year_summary: Festival du film de Sundance <>. ############################################################# # Chart # @@ -196,8 +196,8 @@ translations: basic_episodes_summary: Une collection d'épisodes nouvellement publiés. # possible key_name: Netflix, Disney, HBO, Hulu, Paramount Plus, Prime Video - flixpatrol_name: Top <> <> - flixpatrol_summary: Top <> des <>s sur <> selon FlixPatrol. + flixpatrol_name: Top <> <> + flixpatrol_summary: Top <> des <>s sur <> selon FlixPatrol. imdb_popular_name: IMDb Populaire imdb_popular_summary: Liste des <>s IMDb Popular. @@ -276,92 +276,92 @@ translations: ############################################################# # possible key_names: Seasonal, Chart, Universe, Streaming, Network, Genre, Studio, Country, Audio Language, Subtitle Language, Decade, Year, Ratings, Resolution, Award, Actors, Directors, Producers, Writers - separator_name: Collections <> - separator_summary: Séparateur de section pour les collections <> + separator_name: Collections <> + separator_summary: Séparateur de section pour les collections <>. # example key_name: Robin Williams - actor_name: <> - actor_summary: <>s avec <>. + actor_name: <> + actor_summary: <>s avec <>. # example key_name: English - audio_language_name: Audio <> - audio_language_summary: <>s tournés en langue <>. + audio_language_name: Audio <> + audio_language_summary: <>s tournés en langue <>. audio_language_other_name: Autres audio audio_language_other_summary: <>s tournés dans d’autres langues peu communes. # example key_name: TV-MA - content_rating_name: <>s <> - content_rating_summary: <>s classés <>. + content_rating_name: <>s <> + content_rating_summary: <>s classés <>. # example key_name: TV-MA - content_rating_cs_name: <>s pour les <> ans et plus - content_rating_cs_summary: <> qui sont notés <> selon le Common Sense Rating System. + content_rating_cs_name: <>s pour les <> ans et plus + content_rating_cs_summary: <> qui sont notés <> selon le Common Sense Rating System. content_rating_other_name: <>s non classés content_rating_other_summary: <>s qui ne sont pas classés, non classés ou tout autre classement peu commun. # example key_name: United States - country_name: <> - country_summary: <>s filmés dans <>. + country_name: <> + country_summary: <>s filmés dans <>. country_other_name: Autres pays country_other_summary: <>s filmés dans d'autres pays peu communs. # example key_name: 2010s - decade_name: Les meilleurs des années <> - decade_summary: Top <> des <>s des années <>. + decade_name: Les meilleurs des années <> + decade_summary: Top <> des <>s des années <>. # example key_name: 2010 - decade_show_name: Les meilleurs des années <> - decade_show_summary: Top <> des <>s des années <>. + decade_show_name: Les meilleurs des années <> + decade_show_summary: Top <> des <>s des années <>. # example key_name: Robin Williams - director_name: <> (Réalisateur) - director_summary: <>s réalisés par <>. + director_name: <> (Réalisateur) + director_summary: <>s réalisés par <>. # example key_name: Action - genre_name: <>s de <> - genre_summary: <>s qui ont le genre <>. + genre_name: <>s de <> + genre_summary: <>s qui ont le genre <>. # example key_name: NBC - network_name: <> - network_summary: <>s diffusés sur <>. + network_name: <> + network_summary: <>s diffusés sur <>. # example key_name: Robin Williams - producer_name: <> (Producteur) - producer_summary: <>s produits par <>. + producer_name: <> (Producteur) + producer_summary: <>s produits par <>. # example key_name: 1080p - resolution_name: <>s de <> - resolution_summary: <>s ayant la résolution <>. + resolution_name: <>s de <> + resolution_summary: <>s ayant la résolution <>. resolution_other_name: Autres résolutions de <>s resolution_other_summary: <>s qui ont d’autres résolutions inhabituelles # possible key_names: New Year's Day, Valentine's Day, St. Patrick's Day, Easter, Mother's Day, Memorial Day, Father's Day, Independence Day, Labor Day, Halloween, Thanksgiving, Christmas - seasonal_name: <>s <> - seasonal_summary: Une collection de <> <> qui peuvent se rapporter à la saison. + seasonal_name: <>s <> + seasonal_summary: Une collection de <> <> qui peuvent se rapporter à la saison. # possible key_names: All 4, Apple TV+, BET+, BritBox, Disney+, hayu, HBO Max, Hulu, Netflix, NOW, Paramount+, Peacock, Prime Video - streaming_name: <>s de <> - streaming_summary: <>s en streaming sur <>. + streaming_name: <>s de <> + streaming_summary: <>s en streaming sur <>. # example key_name: Studio Ghibli - studio_name: <> - studio_summary: <>s produits par <>. + studio_name: <> + studio_summary: <>s produits par <>. # example key_name: English - subtitle_language_name: Sous-titres <> - subtitle_language_summary: <>s avec sous-titres <>. + subtitle_language_name: Sous-titres <> + subtitle_language_summary: <>s avec sous-titres <>. subtitle_language_other_name: Autres sous-titres subtitle_language_other_summary: <>s avec d’autres sous-titres inhabituels. # example key_name: Robin Williams - writer_name: <> (Scénariste) - writer_summary: <> écrits par <>. + writer_name: <> (Scénariste) + writer_summary: <> écrits par <>. # example key_name: 2015 - year_name: Les meilleurs de <> - year_summary: <>s sortis en <>. + year_name: Les meilleurs de <> + year_summary: <>s sortis en <>. diff --git a/defaults/translations/pt-br.yml b/defaults/translations/pt-br.yml index 492bf979..4920d9bd 100644 --- a/defaults/translations/pt-br.yml +++ b/defaults/translations/pt-br.yml @@ -1,4 +1,4 @@ -version: 1.18.0.3 +version: 1.18.0.4 variables: library_translation: # For Movie Libraries @@ -45,29 +45,29 @@ translations: bafta_best_summary: Vencedores do Melhor Filme da Academia Britânica de Artes Cinematográficas e Televisão. # example key_name: 2022 - bafta_year_name: BAFTA <> - bafta_year_summary: <> Prêmio BAFTA. + bafta_year_name: BAFTA <> + bafta_year_summary: <> Prêmio BAFTA. cannes_best_name: Vencedores do Cannes Golden Palm cannes_best_summary: Vencedores do Cannes Golden Palm. # example key_name: 2022 - cannes_year_name: Cannes <> - cannes_year_summary: <> Prêmios Cannes. + cannes_year_name: Cannes <> + cannes_year_summary: <> Prêmios Cannes. - choice_year_name: Prêmio Critics Choice <> - choice_year_summary: <> Prêmio Critics Choice. + choice_year_name: Prêmio Critics Choice <> + choice_year_summary: <> Prêmio Critics Choice. # example key_name: 2022 - emmy_year_name: Emmys <> - emmy_year_summary: <> Vencedores do Emmy. + emmy_year_name: Emmys <> + emmy_year_summary: <> Vencedores do Emmy. golden_best_name: Globo de Ouro de Melhores Filmes golden_best_summary: Globo de Ouro de Melhores Filmes. # example key_name: 2022 - golden_year_name: Globo de Ouro <> - golden_year_summary: <> Vencedores do Globo de Ouro. + golden_year_name: Globo de Ouro <> + golden_year_summary: <> Vencedores do Globo de Ouro. oscars_picture_name: Vencedores do Oscar de Melhor Filme oscars_picture_summary: O Oscar de Melhor Filme é um dos prêmios da Academia apresentados anualmente pela Academia de Artes e Ciências Cinematográficas desde que os prêmios estreou em 1929. @@ -76,8 +76,8 @@ translations: oscars_director_summary: O Oscar de Melhor Diretor é um dos prêmios da Academia apresentados anualmente pela Academia de Artes e Ciências Cinematográficas desde que os prêmios estreou em 1929. # example key_name: 2022 - oscars_year_name: Vencedores do Oscar <> - oscars_year_summary: Vencedores da Academia do Oscar de <>. + oscars_year_name: Vencedores do Oscar <> + oscars_year_summary: Vencedores da Academia do Oscar de <>. berlinale_best_name: Prêmio Berlinale Golden Bears berlinale_best_summary: Até 400 filmes são exibidos todos os anos como parte do programa público da Berlinale (Festival Internacional de Cinema de Berlim), a grande maioria dos quais são estreias mundiais ou europeias. Filmes de todos os gêneros, duração e formato podem ser enviados para consideração. O Urso de Ouro (Goldener Bär alemão) é o maior prêmio concedido ao melhor filme exibido durante este festival. @@ -92,15 +92,15 @@ translations: venice_best_summary: O Festival de Cinema de Veneza é o festival de cinema mais antigo do mundo. Fundado em 1932, o festival acontece todos os anos em Veneza, na Itália. Faz parte da Bienal de Veneza, uma grande exposição bienal e festival de arte contemporânea. O prêmio Leone d'Oro (Leão de Ouro) do festival é concedido ao melhor filme exibido no festival. # example key_name: 2022 - spirit_year_name: Prêmio Independent Spirit <> - spirit_year_summary: <> Prêmio Independent Spirit. + spirit_year_name: Prêmio Independent Spirit <> + spirit_year_summary: <> Prêmio Independent Spirit. sundance_best_name: Vencedores Prêmio do Sundance Grand Jury sundance_best_summary: O Sundance Film Festival é um festival de cinema que acontece anualmente no estado de Utah, nos Estados Unidos. É o maior festival de cinema independente dos EUA Realizado em janeiro, o festival é a principal vitrine para novos trabalhos de cineastas independentes americanos e internacionais. O festival compreende seções competitivas para filmes dramáticos e documentários americanos e internacionais, longas-metragens e curtas-metragens, e um grupo de seções de exibição não competitivas. # example key_name: 2022 - sundance_year_name: Festival de Cinema de Sundance <> - sundance_year_summary: Festival de Cinema de Sundance de <>. + sundance_year_name: Festival de Cinema de Sundance <> + sundance_year_summary: Festival de Cinema de Sundance de <>. ############################################################# # Chart # @@ -125,8 +125,8 @@ translations: basic_episodes_summary: Uma coleção de episódios recém-lançados <>s. # possible key_name: Netflix, Disney, HBO, Hulu, Paramount Plus, Prime Video - flixpatrol_name: <> Top <> - flixpatrol_summary: Top <> <>s da <> de acordo com FlixPatrol. + flixpatrol_name: <> Top <> + flixpatrol_summary: Top <> <>s da <> de acordo com FlixPatrol. imdb_popular_name: Popular no IMDb imdb_popular_summary: Lista dos mais populares de acordo com IMDb <>s. @@ -204,89 +204,93 @@ translations: # Both # ############################################################# + # possible key_names: Seasonal, Chart, Universe, Streaming, Network, Genre, Studio, Country, Audio Language, Subtitle Language, Decade, Year, Ratings, Resolution, Award, Actors, Directors, Producers, Writers + separator_name: <> Coleções + separator_summary: Separador de seção para Coleções de <>. + # example key_name: Robin Williams - actor_name: <> - actor_summary: <>s com <>. + actor_name: <> + actor_summary: <>s com <>. # example key_name: English - audio_language_name: <> Áudio - audio_language_summary: <>s filmado em <> Language. + audio_language_name: <> Áudio + audio_language_summary: <>s filmado em <> Language. audio_language_other_name: Outros Áudios audio_language_other_summary: <>s filmado em outras línguas. # example key_name: TV-MA - content_rating_name: <> <>s - content_rating_summary: <>s que são classificados <>. + content_rating_name: <> <>s + content_rating_summary: <>s que são classificados <>. # example key_name: TV-MA - content_rating_cs_name: Idade <>+ <>s - content_rating_cs_summary: <>s que são classificados <> de acordo com Sistema de classificação do Common Sense . + content_rating_cs_name: Idade <>+ <>s + content_rating_cs_summary: <>s que são classificados <> de acordo com Sistema de classificação do Common Sense . content_rating_other_name: Não avaliado <>s content_rating_other_summary: <>s que estão sem classificação ou quaisquer outras classificações. # example key_name: United States - country_name: <> - country_summary: <>s filmado no <>. + country_name: <> + country_summary: <>s filmado no <>. country_other_name: Outros países country_other_summary: <>s filmado em outros países. # example key_name: 2010s - decade_name: Melhores de <> - decade_summary: Top <> <>s dos <>. + decade_name: Melhores de <> + decade_summary: Top <> <>s dos <>. # example key_name: 2010 - decade_show_name: Melhores de <>s - decade_show_summary: Top <> <>s dos <>s. + decade_show_name: Melhores de <>s + decade_show_summary: Top <> <>s dos <>s. # example key_name: Robin Williams - director_name: <> (Diretor) - director_summary: <>s dirigido por <>. + director_name: <> (Diretor) + director_summary: <>s dirigido por <>. # example key_name: Action - genre_name: <> <>s - genre_summary: <>s que tem o gênero <>. + genre_name: <> <>s + genre_summary: <>s que tem o gênero <>. # example key_name: NBC - network_name: <> - network_summary: <>s transmitido por <>. + network_name: <> + network_summary: <>s transmitido por <>. # example key_name: Robin Williams - producer_name: <> (Producer) - producer_summary: <>s produzido por <>. + producer_name: <> (Producer) + producer_summary: <>s produzido por <>. # example key_name: 1080p - resolution_name: <> <>s - resolution_summary: <>s que tem a resolução <>. + resolution_name: <> <>s + resolution_summary: <>s que tem a resolução <>. resolution_other_name: Outra Resolução <>s resolution_other_summary: <>s que têm outras resoluções. # possible key_names: New Year's Day, Valentine's Day, St. Patrick's Day, Easter, Mother's Day, Memorial Day, Father's Day, Independence Day, Labor Day, Halloween, Thanksgiving, Christmas - seasonal_name: <> <>s - seasonal_summary: Uma coleção de <> <>s que podem estar relacionados com a temporada. + seasonal_name: <> <>s + seasonal_summary: Uma coleção de <> <>s que podem estar relacionados com a temporada. # possible key_names: All 4, Apple TV+, BET+, BritBox, Disney+, hayu, HBO Max, Hulu, Netflix, NOW, Paramount+, Peacock, Prime Video - streaming_name: <> <>s - streaming_summary: <>s transmitindo por <>. + streaming_name: <> <>s + streaming_summary: <>s transmitindo por <>. # example key_name: Studio Ghibli - studio_name: <> - studio_summary: <>s produzido por <>. + studio_name: <> + studio_summary: <>s produzido por <>. # example key_name: English - subtitle_language_name: Legendas em <> - subtitle_language_summary: <>s com Legendas em <> . + subtitle_language_name: Legendas em <> + subtitle_language_summary: <>s com Legendas em <> . subtitle_language_other_name: Outras legendas subtitle_language_other_summary: <>s com outras legendas. # example key_name: Robin Williams - writer_name: <> (Escritor) - writer_summary: <>s escrito por <>. + writer_name: <> (Escritor) + writer_summary: <>s escrito por <>. # example key_name: 2015 - year_name: Melhores de <> - year_summary: <>s Lançados em <>. \ No newline at end of file + year_name: Melhores de <> + year_summary: <>s Lançados em <>. \ No newline at end of file diff --git a/docs/defaults/collections.md b/docs/defaults/collections.md new file mode 100644 index 00000000..d92c0c9c --- /dev/null +++ b/docs/defaults/collections.md @@ -0,0 +1,60 @@ +## 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 collections are applied by calling the below paths into the `metadata_path` section of your config.yml + +### Chart Collections + +| Default | Path | Example Collections | Works with Movies | Works with Shows | +|:-----------------------------------|:-----------------:|:-------------------------------------------|:-----------------:|:----------------:| +| [Chart Separator](chart/separator) | `separator_chart` | Chart Collections | ✅ | ✅ | +| [AniList](chart/anilist) | `anilist` | AniList Popular, AniList Season | ✅ | ✅ | +| [Basic](chart/basic) | `basic` | Newly Released, New Episodes | ✅ | ✅ | +| [FlixPatrol](chart/flixpatrol) | `flixpatrol` | Top Disney, Top Hbo, Top Hulu, Top Netflix | ✅ | ✅ | +| [IMDb](chart/imdb) | `imdb` | IMDb Popular, IMDb Top 250 | ✅ | ✅ | +| [MyAnimeList](chart/myanimelist) | `myanimelist` | MyAnimeList Popular, MyAnimeList Top Rated | ✅ | ✅ | +| [Other](chart/other) | `other_chart` | AniDB Popular, Common Sense Selection | ✅ | ✅ | +| [Tautulli](chart/tautulli) | `tautulli` | Plex Popular, Plex Watched | ✅ | ✅ | +| [TMDb](chart/tmdb) | `tmdb` | TMDb Popular, TMDb Airing Today | ✅ | ✅ | +| [Trakt](chart/trakt) | `trakt` | Trakt Popular, Trakt Trending | ✅ | ✅ | + +### Award Collections + +| Default | Path | Example Collections | Works with Movies | Works with Shows | +|:-----------------------------------------------------------|:-----------------:|:--------------------------------------------|:-----------------:|:----------------:| +| [Award Separator](award/separator) | `separator_award` | Award Collections | ✅ | ✅ | +| [British Academy of Film and Television Arts](award/bafta) | `bafta` | BAFTA Best Films, BAFTA 2021 | ✅ | ❌ | +| [Cannes](award/cannes) | `cannes` | Cannes - Palme d'or, Cannes 2018 | ✅ | ❌ | +| [Critics Choice](award/choice) | `choice` | Critics Choice Awards 2020 | ✅ | ✅ | +| [Emmys](award/emmy) | `emmy` | Emmys 2021 | ✅ | ✅ | +| [Golden Globes](award/golden) | `golden` | Best Motion Pictures | ✅ | ✅ | +| [Academy Awards (Oscars)](award/oscars) | `oscars` | Best Picture Winners | ✅ | ✅ | +| [Independent Spirit](award/spirit) | `spirit` | Independent Spirit Awards 2021 | ✅ | ❌ | +| [Sundance](award/sundance) | `sundance` | Sundance Grand Jury Winners | ✅ | ✅ | +| [Other](award/other) | `other_award` | Berlinale Golden Bears, Venice Golden Lions | ✅ | ❌ | + +### General Collections + +| Default | Path | Example Collections | Works with Movies | Works with Shows | +|:------------------------------------------------------------------------------------|:----------------------:|:-------------------------------------------------------|:-----------------:|:----------------:| +| [Actor](both/actor) | `actor` | Chris Hemsworth, Margot Robbie | ✅ | ✅ | +| [Audio Language](both/audio_language) | `audio_language` | French Audio, Korean Audio | ✅ | ✅ | +| [Common Sense Content Rating](both/content_rating_cs) | `content_rating_cs` | 1, 2, 3, 4, 5, 6, 15, 16, 17, 18 | ✅ | ✅ | +| [Content Rating (UK)](both/content_rating_uk) | `content_rating_uk` | U, PG, 12A | ✅ | ✅ | +| Content Rating (US) [Movie](movie/content_rating_us)/[Show](show/content_rating_us) | `content_rating_us` | G, PG, NC-17 | ✅ | ✅ | +| Country [Movie](movie/country)/[Show](show/country) | `country` | Belgium, India | ✅ | ✅ | +| Decade [Movie](movie/decade)/[Show](show/decade) | `decade` | Best of 2012, Best of 2022 | ✅ | ✅ | +| [Director](movie/director) | `director` | Steven Spielberg (Director), Olivia Wilde (Director) | ✅ | ❌ | +| Franchise [Movie](movie/franchise)/[Show](show/franchise) | `franchise` | Star Wars: Skywalker Saga, Godzilla (Anime) | ✅ | ✅ | +| [Genre](both/genre) | `genre` | Action, Drama, Science Fiction | ✅ | ✅ | +| [Network](show/network) | `network` | Disney Channel, Lifetime | ❌ | ✅ | +| [Producer](movie/producer) | `producer` | James Cameron (Producer), Reese Witherspoon (Producer) | ✅ | ❌ | +| [Resolution](both/resolution) | `resolution` | 4K Movies, 1080p Movies, 720p Movies | ✅ | ✅ | +| [Seasonal](movie/seasonal) | `seasonal` | Easter, Christmas | ✅ | ❌ | +| [Streaming](both/streaming) | `streaming` | Disney+ Movies, HBO Max Shows | ✅ | ✅ | +| [Studio](both/studio) | `studio` | DreamWorks Studios, Walt Disney Pictures | ✅ | ✅ | +| [Subtitle Language](both/subtitle_language) | `subtitle_language` | German Subtitles, Swedish Subtitles | ✅ | ✅ | +| [Universe](movie/universe) | `universe` | Marvel Cinematic Universal, Wizarding World | ✅ | ❌ | +| [Year](both/year) | `year` | Best of 2010, Best of 2019 | ✅ | ✅ | +| [Writer](movie/writer) | `writer` | James Cameron (Writer), Lilly Wachowski (Writer) | ✅ | ❌ | diff --git a/docs/defaults/defaults.md b/docs/defaults/defaults.md index 3b97644c..0a941ae0 100644 --- a/docs/defaults/defaults.md +++ b/docs/defaults/defaults.md @@ -1 +1,241 @@ -# Collection Defaults \ No newline at end of file +# Collection Defaults + +There are many Default Metadata Files built into PMM itself which offer an easy-to-use and customizable set of Collections that the user can achieve without having to worry about creating the files that makes the collections possible. + +This is the simplest way to create Collections using Plex Meta Manager. + +## Metadata Files + +```{include} collections.md +``` + +## Configurations + +To run a default pmm file you can simply add it to your `metadata_path` using `pmm` like so: + +```yaml +libraries: + Movies: + metadata_path: + - pmm: actor + - pmm: genre +``` + +## Separators + +Most Metadata files use separators to denote different sections of collection like actor collections vs studio collections. + +**Chart Separator and Award Separator each have their own file, while the other Separators are part of their respective files.** + +
+ Click to expand to see an example of Separators. + + ![](images/separators.jpg) + +
+ +### Library On/Off + +Chart Separators are turned On by default (except `seasonal`), to turn the Separators On/Off on a per Library basis. + +```yaml +libraries: + LIBRARYNAME: + template_variables: + use_separator: false + metadata_path: + - pmm: actor + - pmm: genre +``` + +## Collection Section Order + +All Default Metadata Files have a `collection_section` attribute. These attributes determine the order of the various sections and can be set by [customizing your config](#customizing-configs). + +For example: `collection_section: 01` translates to `sort_title: "!<><
><>>><>"` and so for `genre` if you have a `Fantasy` collection, plex is going to show `!06_Fantasy`
+
+This is the default PMM collection ordering:
+
+| Collection             | Collection Section |
+|:-----------------------|:------------------:|
+| `seasonal`             |        `00`        |
+| `anilist`              |        `01`        |
+| `basic`                |        `01`        |
+| `imdb`                 |        `01`        |
+| `flixpatrol`           |        `01`        |
+| `myanimelist`          |        `01`        |
+| `other_chart`          |        `01`        |
+| `tautulli`             |        `01`        |
+| `tmdb`                 |        `01`        |
+| `trakt`                |        `01`        |
+| `universe`             |        `02`        |
+| `streaming`            |        `03`        |
+| `network`              |        `04`        |
+| `genre`                |        `06`        |
+| `studio`               |        `07`        |
+| `country`              |        `09`        |
+| `audio_language`       |        `10`        |
+| `subtitle_language`    |        `11`        |
+| `decade`               |        `12`        |
+| `year`                 |        `13`        |
+| `content_rating_us`    |        `14`        |
+| `content_rating_uk`    |        `14`        |
+| `content_rating_cs`    |        `14`        |
+| `resolution`           |        `15`        |
+| `resolution_standards` |        `15`        |
+| `bafta`                |        `16`        |
+| `cannes`               |        `16`        |
+| `choice`               |        `16`        |
+| `emmy`                 |        `16`        |
+| `golden`               |        `16`        |
+| `oscars`               |        `16`        |
+| `other_award`          |        `16`        |  
+| `spirit`               |        `16`        |
+| `sundance`             |        `16`        |
+| `actor`                |        `17`        |
+| `director`             |        `18`        |
+| `producer`             |        `19`        |
+| `writer`               |        `20`        |
+
+## Rating Overlays
+
+By default for Movies in Plex, the `Ratings Source` dropdown (`#3`) below, can come from Rotten Tomatoes (and includes Critic Ratings and Audience Ratings) or IMDb (Audience Ratings). This only changes the tiny icons displayed and where Plex will retrieve the ratings from upon initial scan and import of the media metadata.
+
+**Plex Meta Manager can insert up to three ratings of your choice into the three spots regardless of what you choose in the `Advanced` tab of that Plex library**
+
+![](images/ratings_source.png)
+
+Plex has three available spots in the Plex DB to store ratings and thus Plex Meta Manager can be used to insert ratings sources of your choice into those spots. They are known as the User Rating (`#1`), Critic Rating (`#2`), and Audience Rating (`#3`). 
+
+**Note that the little icons cannot be changed and that the numbers next to the little icons are reflected in the poster ratings overlay**
+
+![](images/ratings_spot.png)
+
+To be able to insert the ratings you want, Plex Meta Manager operations need to be defined. In this example below, User ratings (`#1`) are being filled with Rotten Tomatoes Critics Ratings. Critic ratings (`#2`) are filled with IMDb, and Audience ratings (`#3`) are filled with TMDb.
+
+**mass_*_rating_update** sources can be found here: [operations](../../config/operations)
+
+![](images/ratings_operations.png)
+
+Finally, to show the ratings on the poster, the following was added to the `overlay_path` section in the `config.yml` file to post Rotten Tomatoes Critics Ratings in (`#1`), IMDb ratings in (`#2`), and TMDb ratings in (`#3`)
+
+![](images/ratings_overlay_path.png)
+
+
+## Customizing Configs
+
+Configs can be customized using the `template_variables` attribute when calling the file. These `template_variables` will be given to every template call in the file which allows them to affect how that file runs.
+
+This example changes the ratings overlay to work on episodes.
+
+```yaml
+libraries:
+  TV Shows:
+    overlay_path:
+    - pmm: ratings
+      template_variables:
+        overlay_level: episode
+```
+
+Each file has a comment block at the top showing the available `template_variables` for each file. For example the [`pmm: genre`](https://github.com/meisnate12/Plex-Meta-Manager-Configs/blob/master/PMM/genre.yml) has this:
+
+```yaml
+#############################################################
+#                 Dynamic Genre Collections                 #
+#         Created by Yozora, Bullmoose20, & Sohjiro         #
+#############################################################
+#  Call this from your config.yml (Movie or Show)           #
+#  If nothing is specified these are the defaults           #
+#                                                           #
+#    metadata_path:                                         #
+#      - pmm: genre                                     #
+#        template_variables:                                #
+#          # Turn the [Separator Collection](../separators) on/off           #
+#          use_separator: true                              #
+#          # Sets how the collection is sorted              #
+#          sort_by: release.desc                            #
+#          # Sets the collection mode of the collection     #
+#          collection_mode:                                 #
+#          # Sets the value at the start of the sort title  #
+#          collection_section: "06"                         #
+#############################################################
+```
+ 
+Each of these when passed will change how the collection runs slightly. 
+* `use_separator` Turn the [Separator Collection](../separators) on/off
+* `sort_by` Sets how the collection is sorted
+* `collection_mode` Sets the collection mode of the collection 
+* `collection_section` Sets the value at the start of the sort title
+
+**In addition to the defined `template_variables` each file in the PMM Folder has access to the `radarr_add_missing` and `sonarr_add_missing` template variables and for dynamic collections most attributes can be passed as template variables**
+
+For example if you want yearly oscar collections that go back 10 years instead of 5 all of which gets sent to radarr use the `data` and `radarr_add_missing` template variables.
+
+```yaml
+libraries:
+  Movies:
+    metadata_path:
+    - pmm: oscars
+      template_variables:
+        radarr_add_missing: true
+        data:
+          starting: current_year-10
+          ending: current_year
+```
+
+Or maybe you want to change the number of actor collections made using pmm: actor.
+
+```yaml
+libraries:
+  Movies:
+    overlay_path:
+    - pmm: actor
+      template_variables:
+        collection_mode: hide
+        data:
+          depth: 5
+          limit: 50
+```
+
+Or maybe you want to change the collection sort order of the genre collections using pmm: genre.
+
+```yaml
+libraries:
+  Movies:
+    metadata_path:
+    - pmm: genre
+      template_variables:
+        collection_section: 11
+```
+
+Or maybe you want to disable separators globally per library.
+
+```yaml
+libraries:
+  LIBRARYNAME:
+    template_variables:
+      use_separator: false
+    metadata_path:
+```
+
+Alternatively it can be turned off individually per git file:
+
+```yaml
+libraries:
+  LIBRARYNAME:
+    metadata_path:
+      - pmm:     # separator is disabled
+        template_variables:
+          use_separator: false
+      - pmm:     # separator is enabled by default
+      - pmm:     # separator is disabled
+        template_variables:
+          use_separator: false
+```
+
+## Errors
+
+If there are collections being made that have configuration errors or missing posters please either bring it up in our Discord or raise an Issue on the [Configs Repo](https://github.com/meisnate12/Plex-Meta-Manager-Configs/issues/new/choose). 
+
+```{include} example.md
+```
\ No newline at end of file
diff --git a/docs/defaults/example.md b/docs/defaults/example.md
new file mode 100644
index 00000000..7c946a21
--- /dev/null
+++ b/docs/defaults/example.md
@@ -0,0 +1,194 @@
+## Example Configuration File
+
+
+ Click to expand sample config.yml file: + +```yaml +libraries: + Movies: + metadata_path: + - pmm: bafta + - pmm: cannes + - pmm: choice + - pmm: golden + - pmm: oscars + - pmm: other_award + - pmm: spirit + - pmm: sundance + - pmm: anilist + - pmm: basic + - pmm: imdb + - pmm: myanimelist + - pmm: other_chart + - pmm: tautulli + - pmm: tmdb + - pmm: trakt + - pmm: actor + - pmm: audio_language + - pmm: content_rating_us # Choose content_rating_uk or content_rating_us + - pmm: genre + - pmm: resolution_standards # Choose resolution_standards or resolution + - pmm: streaming + - pmm: studio + - pmm: subtitle_language + - pmm: year + - pmm: country + - pmm: decade + - pmm: director + - pmm: franchise + - pmm: universe + - pmm: producer + - pmm: seasonal + - pmm: writer + overlay_path: + - remove_overlays: false + - pmm: audio_codec + - pmm: audio_language + - pmm: commonsense + - pmm: direct_play + - pmm: edition + - pmm: episode_info + - pmm: flixpatrol + - pmm: mediastinger + - pmm: ratings + template_variables: + rating1: critic + rating1_image: rt_tomato + - pmm: resolution + - pmm: ribbon + - pmm: runtimes + - pmm: special_release + - pmm: streaming + - pmm: versions + - pmm: video_format + TV Shows: + metadata_path: + - pmm: choice + - pmm: golden + - pmm: emmy + - pmm: anilist + - pmm: basic + - pmm: imdb + - pmm: myanimelist + - pmm: other_chart + - pmm: tautulli + - pmm: tmdb + - pmm: trakt + - pmm: actor + - pmm: audio_language + - pmm: content_rating_us # Choose content_rating_uk or content_rating_us + - pmm: genre + - pmm: resolution_standards # Choose resolution_standards or resolution + - pmm: streaming + - pmm: studio + - pmm: subtitle_language + - pmm: year + - pmm: country + - pmm: decade + - pmm: network + overlay_path: + - remove_overlays: false + - pmm: audio_codec + - pmm: audio_codec + template_variables: + overlay_level: episode + - pmm: audio_codec + template_variables: + overlay_level: season + - pmm: audio_language + - pmm: audio_language + template_variables: + overlay_level: episode + - pmm: audio_language + template_variables: + overlay_level: season + - pmm: commonsense + - pmm: commonsense + template_variables: + overlay_level: episode + - pmm: commonsense + template_variables: + overlay_level: season + - pmm: direct_play + - pmm: direct_play + template_variables: + overlay_level: episode + - pmm: direct_play + template_variables: + overlay_level: season + - pmm: edition + - pmm: edition + template_variables: + overlay_level: episode + - pmm: episode_info + template_variables: + overlay_level: episode + - pmm: flixpatrol + - pmm: flixpatrol + template_variables: + overlay_level: episode + - pmm: flixpatrol + template_variables: + overlay_level: season + - pmm: mediastinger + - pmm: mediastinger + template_variables: + overlay_level: episode + - pmm: mediastinger + template_variables: + overlay_level: season + - pmm: ratings + template_variables: + rating2: audience + rating2_image: imdb + - pmm: ratings + template_variables: + rating2: audience + rating2_image: imdb + overlay_level: episode + - pmm: resolution + - pmm: resolution + template_variables: + overlay_level: episode + - pmm: resolution + template_variables: + overlay_level: season + - pmm: ribbon + - pmm: ribbon + template_variables: + overlay_level: episode + - pmm: ribbon + template_variables: + overlay_level: season + - pmm: runtimes + template_variables: + overlay_level: episode + - pmm: special_release + - pmm: special_release + template_variables: + overlay_level: episode + - pmm: special_release + template_variables: + overlay_level: season + - pmm: streaming + - pmm: versions + - pmm: versions + template_variables: + overlay_level: episode + - pmm: versions + template_variables: + overlay_level: season + - pmm: versions + template_variables: + overlay_level: show + - pmm: video_format + - pmm: video_format + template_variables: + overlay_level: episode + - pmm: video_format + template_variables: + overlay_level: season +playlist_files: +- pmm: playlist +``` +
diff --git a/docs/defaults/files.md b/docs/defaults/files.md index 5c4f75d0..cf9c9809 100644 --- a/docs/defaults/files.md +++ b/docs/defaults/files.md @@ -2,100 +2,15 @@ The below table outlines the available Defaults files which can be called via `metadata_path` (for Collections), `overlay_path` (for Overlays) and `playlist_files` (for Playlists). -## Collections +```{include} collections.md +``` -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 `metadata_path:` section of your config.yml - -### Chart Collections - -| Default | Path | Example Collections | Works with Movies | Works with Shows | -|:-----------------------------------|:-----------------:|:-------------------------------------------|:-----------------:|:----------------:| -| [Chart Separator](chart/separator) | `separator_chart` | Chart Collections | ✅ | ✅ | -| [AniList](chart/anilist) | `anilist` | AniList Popular, AniList Season | ✅ | ✅ | -| [Basic](chart/basic) | `basic` | Newly Released, New Episodes | ✅ | ✅ | -| [FlixPatrol](chart/flixpatrol) | `flixpatrol` | Top Disney, Top Hbo, Top Hulu, Top Netflix | ✅ | ✅ | -| [IMDb](chart/imdb) | `imdb` | IMDb Popular, IMDb Top 250 | ✅ | ✅ | -| [MyAnimeList](chart/myanimelist) | `myanimelist` | MyAnimeList Popular, MyAnimeList Top Rated | ✅ | ✅ | -| [Other](chart/other) | `other_chart` | AniDB Popular, Common Sense Selection | ✅ | ✅ | -| [Tautulli](chart/tautulli) | `tautulli` | Plex Popular, Plex Watched | ✅ | ✅ | -| [TMDb](chart/tmdb) | `tmdb` | TMDb Popular, TMDb Airing Today | ✅ | ✅ | -| [Trakt](chart/trakt) | `trakt` | Trakt Popular, Trakt Trending | ✅ | ✅ | - -### Award Collections - -| Default | Path | Example Collections | Works with Movies | Works with Shows | -|:-----------------------------------------------------------|:-----------------:|:--------------------------------------------|:-----------------:|:----------------:| -| [Award Separator](award/separator) | `separator_award` | Award Collections | ✅ | ✅ | -| [British Academy of Film and Television Arts](award/bafta) | `bafta` | BAFTA Best Films, BAFTA 2021 | ✅ | ❌ | -| [Cannes](award/cannes) | `cannes` | Cannes - Palme d'or, Cannes 2018 | ✅ | ❌ | -| [Critics Choice](award/choice) | `choice` | Critics Choice Awards 2020 | ✅ | ✅ | -| [Emmys](award/emmy) | `emmy` | Emmys 2021 | ✅ | ✅ | -| [Golden Globes](award/golden) | `golden` | Best Motion Pictures | ✅ | ✅ | -| [Academy Awards (Oscars)](award/oscars) | `oscars` | Best Picture Winners | ✅ | ✅ | -| [Independent Spirit](award/spirit) | `spirit` | Independent Spirit Awards 2021 | ✅ | ❌ | -| [Sundance](award/sundance) | `sundance` | Sundance Grand Jury Winners | ✅ | ✅ | -| [Other](award/other) | `other_award` | Berlinale Golden Bears, Venice Golden Lions | ✅ | ❌ | - -### General Collections - -| Default | Path | Example Collections | Works with Movies | Works with Shows | -|:------------------------------------------------------------------------------------|:----------------------:|:-------------------------------------------------------|:-----------------:|:----------------:| -| [Actor](both/actor) | `actor` | Chris Hemsworth, Margot Robbie | ✅ | ✅ | -| [Audio Language](both/audio_language) | `audio_language` | French Audio, Korean Audio | ✅ | ✅ | -| [Common Sense Content Rating](both/content_rating_cs) | `content_rating_cs` | 1, 2, 3, 4, 5, 6, 15, 16, 17, 18 | ✅ | ✅ | -| [Content Rating (UK)](both/content_rating_uk) | `content_rating_uk` | U, PG, 12A | ✅ | ✅ | -| Content Rating (US) [Movie](movie/content_rating_us)/[Show](show/content_rating_us) | `content_rating_us` | G, PG, NC-17 | ✅ | ✅ | -| Country [Movie](movie/country)/[Show](show/country) | `country` | Belgium, India | ✅ | ✅ | -| Decade [Movie](movie/decade)/[Show](show/decade) | `decade` | Best of 2012, Best of 2022 | ✅ | ✅ | -| [Director](movie/director) | `director` | Steven Spielberg (Director), Olivia Wilde (Director) | ✅ | ❌ | -| Franchise [Movie](movie/franchise)/[Show](show/franchise) | `franchise` | Star Wars: Skywalker Saga, Godzilla (Anime) | ✅ | ✅ | -| [Genre](both/genre) | `genre` | Action, Drama, Science Fiction | ✅ | ✅ | -| [Network](show/network) | `network` | Disney Channel, Lifetime | ❌ | ✅ | -| [Producer](movie/producer) | `producer` | James Cameron (Producer), Reese Witherspoon (Producer) | ✅ | ❌ | -| [Resolution](both/resolution) | `resolution` | 4K Movies, 1080p Movies, 720p Movies | ✅ | ✅ | -| [Seasonal](movie/seasonal) | `seasonal` | Easter, Christmas | ✅ | ❌ | -| [Streaming](both/streaming) | `streaming` | Disney+ Movies, HBO Max Shows | ✅ | ✅ | -| [Studio](both/studio) | `studio` | DreamWorks Studios, Walt Disney Pictures | ✅ | ✅ | -| [Subtitle Language](both/subtitle_language) | `subtitle_language` | German Subtitles, Swedish Subtitles | ✅ | ✅ | -| [Universe](movie/universe) | `universe` | Marvel Cinematic Universal, Wizarding World | ✅ | ❌ | -| [Year](both/year) | `year` | Best of 2010, Best of 2019 | ✅ | ✅ | -| [Writer](movie/writer) | `writer` | James Cameron (Writer), Lilly Wachowski (Writer) | ✅ | ❌ | - -## Overlays - -These files apply overlays and can generally be used on both Movie and Show library-types, and often works at the season and episode-level too. - -It should be noted that when an overlay has ❗ for a season or episode, it normally means that whilst the overlay can technically be applied at the level, it wasn't designed for this purpose. For example, a show's season cannot have a resolution since it is not a video file, and an episode cannot have a commonsense age-rating since only Movies and Shows are rated by CommonSense. - -In the scenario where there is missing data such as age ratings for episodes, then generally the highest-level data available will be applied at the lower level (i.e. a Show's CommonSense age rating would apply to all episodes). - -These overlays are applied by calling the below paths into the `overlay_path:` [section](../config/libraries.md#overlay-path) of your config.yml - -### Overlay Files - -| Default | path | Example Overlays | Movies | Shows | Seasons | Episodes | -|:-----------------------------------------------|:-----------------:|:--------------------------------------------------------------------------|:--------:|:---------:|:---------:|:--------:| -| [Audio Codec](overlays/audio_codec) | `audio_codec` | Dolby Atmos logo, DTS logo | ✅ | ✅ | ✅ | ✅ | -| [Audio Language](overlays/audio_language) | `audio_language` | French Audio, Korean Audio | ✅ | ✅ | ✅ | ✅ | -| [CommonSense Age Rating](overlays/commonsense) | `commonsense` | "3+", "16+" | ✅ | ✅ | ❗ | ❗ | -| [Direct Play](overlays/direct_play) | `direct_play` | "Direct Play Only" | ✅ | ❗ | ❗ | ✅ | -| [Episode Info](overlays/episode_info) | `episode_info` | "S01E01", "S02E09" | ❌ | ❌ | ❌ | ✅ | -| [FlixPatrol](overlays/flixpatrol) | `flixpatrol` | "Streaming service logo with words "TOP" | ✅ | ✅ | ❌ | ❌ | -| [Mediastinger](overlays/mediastinger) | `mediastinger` | Mediastinger Logo for After/During Credit Scenes | ✅ | ✅ | ❌ | ❌ | -| [Ratings](overlays/ratings) | `ratings` | IMDb Audience Rating, Metacritic Critic Rating | ✅ | ✅ | ❌ | ✅ | -| [Resolution/Editions](overlays/resolution) | `resolution` | 4K Dolby Vision logo, 720P logo, "Director's Cut", "Criterion Collection" | ✅ | ✅ | ❌ | ✅ | -| [Ribbon](overlays/ribbon) | `ribbon` | IMDb Top 250 Ribbon, RT Fresh Ribbon | ✅ | ✅ | ❌ | ❌ | -| [Runtimes](overlays/runtimes) | `runtimes` | "Runtime: 1h 30m" | ✅ | ✅ | ❌ | ❌ | -| [Status](overlays/status) | `status` | Airing, Returning, Canceled, Ended | ❌ | ✅ | ❌ | ❌ | -| [Streaming](overlays/streaming) | `streaming` | Netflix logo, Hulu logo | ✅ | ✅ | ❌ | ❌ | -| [Versions](overlays/versions) | `versions` | Multiple Versions logo | ✅ | ✅ | ✅ | ✅ | -| [Video Format](overlays/video_format) | `video_format` | "REMUX", "HDTV" | ✅ | ❗ | ❗ | ✅ | +```{include} overlays.md +``` ## Playlists -These files apply playlists to the "Playlists" section of Plex and are applied by calling the below paths into the `playlist_files:` section of your config.yml +These files apply playlists to the "Playlists" section of Plex and are applied by calling the below paths into the `playlist_files` section of your config.yml ### Playlist Files diff --git a/docs/defaults/guide.md b/docs/defaults/guide.md index 46ae3c66..e7f0fb7b 100644 --- a/docs/defaults/guide.md +++ b/docs/defaults/guide.md @@ -1 +1,403 @@ -# Defaults Usage Guide \ No newline at end of file +# Defaults Usage Guide + +Plex Meta Manager includes a pre-created set of Metadata Files and Overlay Files which can be found in the "defaults" folder in the root of your Plex Meta Manager installation directory. + +These files offer an easy-to-use and customizable set of Collections and Overlays that the user can achieve without having to worry about creating the files that makes the collections and overlays possible. + +All Collections come with a matching poster to make a clean, consistent set of collections in your library. These files are stored in the [Plex Meta Manager Images](https://github.com/meisnate12/Plex-Meta-Manager-Images) Repository and each poster is downloaded straight to your Plex Collection when you run Plex Meta Manager. + +It should be noted that users running the on [nightly branch](https://metamanager.wiki/en/nightly/home/kb.html#how-do-i-switch-to-the-nightly-branch) of Plex Meta Manager will receive all updates to the PMM Defaults as soon as they are published via [GitHub](https://github.com/meisnate12/Plex-Meta-Manager-Configs/tree/master/PMM), which may at times involve bugs or implementations that need to be further addressed. Users of the [develop](https://metamanager.wiki/en/nightly/home/kb.html#how-do-i-switch-to-the-develop-branch) and [master](https://metamanager.wiki/en/nightly/home/kb.html#how-do-i-switch-back-to-the-master-branch) branches will only receive updated Defaults files when an update to Plex Meta Manager is released - this helps to protect to keep these branches stable and prevent bugs from reaching the wider user-base. + +Credits to Bullmoose20 and Yozora for helping drive this entire Default Set of Configs through the concept, design and implementation. + +Special thanks to Magic815 for the overlay image inspiration and base template. + +Please consider [donating](https://github.com/sponsors/meisnate12) towards the project. + + +## Configurations + +To run a file in git you can simply add it to your `metadata_path` (For Metadata Files) or `overlay_path` (For Overlay Files) using `git` like so: + +```yaml +libraries: + Movies: + metadata_path: + - pmm: actor + - pmm: genre + overlay_path: + - remove_overlays: false + - pmm: ribbon + - pmm: ratings +``` + +## Overlays + +The default set of overlays are a combination of Positional Overlays and Text Overlays. + +### Example Poster Overlays + +![](images/movie-overlays1-annotated.png) +![](images/movie-overlays2-annotated.png) +
+ Click to expand sample config.yml Movies overlays section: + +```yaml +libraries: + Movies: + overlay_path: + - remove_overlays: false + - reapply_overlay: true + - pmm: resolution # 1 + - pmm: audio_codec # 2 + - pmm: mediastinger # 3 + - pmm: special_release # 4 + - pmm: ratings # 5, 6, 7 + template_variables: + rating1: user # 5 as this is user and mass_user_rating_update: mdb_tomatoes + rating1_image: rt_tomato # 5 as this is user and mass_user_rating_update: mdb_tomatoes + rating1_font: config/custom_fonts/Adlib.ttf # 5 local font accessible to PMM + rating1_font_size: 63 # 5 adjusted font size to fit rating + + rating2: critic # 6 as this is critic and mass_critic_rating_update: imdb + rating2_image: imdb # 6 as this is critic and mass_critic_rating_update: imdb + rating2_font: config/custom_fonts/Impact.ttf # 6 local font accessible to PMM + rating2_font_size: 70 # 6 adjusted font size to fit rating + + rating3: audience # 7 as this is audience and mass_audience_rating_update: tmdb + rating3_image: tmdb # 7 as this is audience and mass_audience_rating_update: tmdb + rating3_font: config/custom_fonts/Avenir_95_Black.ttf # 7 local font accessible to PMM + rating3_font_size: 70 # 7 adjusted font size to fit rating + + horizontal_position: right # the set of ratings is on the right of the poster + - pmm: streaming # 8 + - pmm: video_format # 9 + - pmm: audio_language # 10 + - pmm: ribbon # 11, 12 Bottom right sash is used by more than one overlay so a weight for priority can be applied + operations: + mass_user_rating_update: mdb_tomatoes # 5 This operation will update the user rating in plex with Rotten Tomatoes ratings information + mass_critic_rating_update: imdb # 6 This operation will update the critic rating in plex with IMDb ratings information + mass_audience_rating_update: tmdb # 7 This operation will update the audience rating in plex with TMDb ratings information +``` +
+ +### Example TV Shows - Show Overlays + +![](images/tvshow-poster-annotated.png) +
+ Click to expand sample config.yml TV Shows overlays section for the Show Poster: + +```yaml +libraries: + TV Shows: + overlay_path: + - remove_overlays: false + - reapply_overlay: true + - pmm: resolution # 1 + - pmm: audio_codec # 2 + - pmm: mediastinger # 3 + - pmm: ratings # 4, 5, 6 + template_variables: + rating1: user # 4 as this is user and mass_user_rating_update: mdb_tomatoes + rating1_image: rt_tomato # 4 as this is user and mass_user_rating_update: mdb_tomatoes + rating1_font: config/custom_fonts/Adlib.ttf # 4 local font accessible to PMM + rating1_font_size: 63 # 4 adjusted font size to fit rating + + rating2: critic # 5 as this is critic and mass_critic_rating_update: imdb + rating2_image: imdb # 5 as this is critic and mass_critic_rating_update: imdb + rating2_font: config/custom_fonts/Impact.ttf # 5 local font accessible to PMM + rating2_font_size: 70 # 5 adjusted font size to fit rating + + rating3: audience # 6 as this is audience and mass_audience_rating_update: tmdb + rating3_image: tmdb # 6 as this is audience and mass_audience_rating_update: tmdb + rating3_font: config/custom_fonts/Avenir_95_Black.ttf # 6 local font accessible to PMM + rating3_font_size: 70 # 6 adjusted font size to fit rating + + horizontal_position: right # the set of ratings is on the right of the poster + - pmm: streaming # 7 + - pmm: video_format # 8 + - pmm: ribbon # 10, 11 Bottom right sash is used by more than one overlay so a weight for priority can be applied + operations: + mass_user_rating_update: mdb_tomatoes # 4 This operation will update the user rating in plex with Rotten Tomatoes ratings information + mass_critic_rating_update: imdb # 5 This operation will update the critic rating in plex with IMDb ratings information + mass_audience_rating_update: tmdb # 6 This operation will update the audience rating in plex with TMDb ratings information +``` +
+ +### Example TV Shows - Season Overlays + +![](images/tvshow-poster-season-annotated.png) +
+ Click to expand sample config.yml TV Shows overlays section for the Season Poster: + +```yaml +libraries: + TV Shows: + overlay_path: + - remove_overlays: false + - reapply_overlay: true + - pmm: resolution # 1 + template_variables: + overlay_level: season + - pmm: audio_codec # 2 + template_variables: + overlay_level: season + - pmm: video_format # 3 + template_variables: + overlay_level: season +``` +
+ +### Example TV Shows - Episode Overlays + +![](images/tvshow-poster-episode-annotated.png) +
+ Click to expand sample config.yml TV Shows overlays section for the Episode Poster: + +```yaml +libraries: + TV Shows: + overlay_path: + - remove_overlays: false + - reapply_overlay: true + - pmm: resolution # 1 + template_variables: + overlay_level: episode + - pmm: audio_codec # 2 + template_variables: + overlay_level: episode + - pmm: ratings # 3, 4 + template_variables: + + rating1: critic # 3 as this is critic and mass_critic_rating_update: imdb + rating1_image: imdb # 3 as this is critic and mass_critic_rating_update: imdb + rating1_font: config/custom_fonts/Impact.ttf # 3 local font accessible to PMM + rating1_font_size: 70 # 3 adjusted font size to fit rating + + rating2: audience # 4 as this is audience and mass_audience_rating_update: tmdb + rating2_image: tmdb # 4 as this is audience and mass_audience_rating_update: tmdb + rating2_font: config/custom_fonts/Avenir_95_Black.ttf # 4 local font accessible to PMM + rating2_font_size: 70 # 4 adjusted font size to fit rating + + horizontal_position: right # the set of ratings is on the right of the poster + overlay_level: episode + - pmm: video_format # 5 + template_variables: + overlay_level: episode + - pmm: episode_info # 6 + template_variables: + overlay_level: episode + - pmm: runtimes # 7 + template_variables: + overlay_level: episode + + operations: + mass_episode_critic_rating_update: imdb # 3 This operation will update the episodes critic rating in plex with IMDb ratings information + mass_episode_audience_rating_update: tmdb # 4 This operation will update the episodes audience rating in plex with TMDb ratings information +``` +
+ +## Separators + +By default, most metadata files use separators to denote different sections of collection like actor collections vs studio collections. + +
+ Click to expand to see an example of Separators. + + ![](images/separators.jpg) + +
+ +* Can be turned off by [customizing your config](#customizing-configs) + +## Collection Section Order + +Almost every default metadata file has a `collection_section` attribute. These attributes determine the order of the various sections and can be set by [customizing your config](#customizing-configs). + +For example: `collection_section: 01` translates to `sort_title: "!<><
><>>><>"` and so for `genre.yml` if you have a `Fantasy` collection, plex is going to show `!06_Fantasy`
+
+This is the default PMM collection ordering:
+
+| Collection                        | Collection Section |
+|:----------------------------------|:------------------:|
+| `seasonal.yml`                    |        `00`        |
+| `anilist.yml`                     |        `01`        |
+| `basic.yml`                       |        `01`        |
+| `imdb.yml`                        |        `01`        |
+| `flixpatrol.yml`                  |        `01`        |
+| `myanimelist.yml`                 |        `01`        |
+| `other_chart.yml`                 |        `01`        |
+| `tautulli.yml`                    |        `01`        |
+| `tmdb.yml`                        |        `01`        |
+| `trakt.yml`                       |        `01`        |
+| `universe.yml`                    |        `02`        |
+| `streaming.yml`                   |        `03`        |
+| `network.yml`                     |        `04`        |
+| `genre.yml`                       |        `06`        |
+| `studio.yml`                      |        `07`        |
+| `country.yml`                     |        `09`        |
+| `audio_language.yml`              |        `10`        |
+| `subtitle_language.yml`           |        `11`        |
+| `decade.yml`                      |        `12`        |
+| `year.yml`                        |        `13`        |
+| `content_rating_us.yml`           |        `14`        |
+| `content_rating_uk.yml`           |        `14`        |
+| `content_rating_cs.yml`           |        `14`        |
+| `resolution.yml`                  |        `15`        |
+| `resolution_standards.yml`        |        `15`        |
+| `bafta.yml`                       |        `16`        |
+| `cannes.yml`                      |        `16`        |
+| `choice.yml`                      |        `16`        |
+| `emmy.yml`                        |        `16`        |
+| `golden.yml`                      |        `16`        |
+| `oscars.yml`                      |        `16`        |
+| `other_award.yml`                 |        `16`        |  
+| `spirit.yml`                      |        `16`        |
+| `sundance.yml`                    |        `16`        |
+| `actor.yml`                       |        `17`        |
+| `director.yml`                    |        `18`        |
+| `producer.yml`                    |        `19`        |
+| `writer.yml`                      |        `20`        |
+
+## Rating Overlays
+
+By default for Movies in Plex, the `Ratings Source` dropdown (`#3`) below, can come from Rotten Tomatoes (and includes Critic Ratings and Audience Ratings) or IMDb (Audience Ratings). This only changes the tiny icons displayed and where Plex will retrieve the ratings from upon initial scan and import of the media metadata.
+
+**Plex Meta Manager can insert up to three ratings of your choice into the three spots regardless of what you choose in the `Advanced` tab of that Plex library**
+
+![](images/ratings_source.png)
+
+Plex has three available spots in the Plex DB to store ratings and thus Plex Meta Manager can be used to insert ratings sources of your choice into those spots. They are known as the User Rating (`#1`), Critic Rating (`#2`), and Audience Rating (`#3`). 
+
+**Note that the little icons cannot be changed and that the numbers next to the little icons are reflected in the poster ratings overlay**
+
+![](images/ratings_spot.png)
+
+To be able to insert the ratings you want, Plex Meta Manager operations need to be defined. In this example below, User ratings (`#1`) are being filled with Rotten Tomatoes Critics Ratings. Critic ratings (`#2`) are filled with IMDb, and Audience ratings (`#3`) are filled with TMDb.
+
+**mass_*_rating_update** sources can be found here: [operations](../../config/operations)
+
+![](images/ratings_operations.png)
+
+Finally, to show the ratings on the poster, the following was added to the `overlay_path` section in the `config.yml` file to post Rotten Tomatoes Critics Ratings in (`#1`), IMDb ratings in (`#2`), and TMDb ratings in (`#3`)
+
+![](images/ratings_overlay_path.png)
+
+
+## Customizing Configs
+
+Configs can be customized using the `template_variables` attribute when calling the file. These `template_variables` will be given to every template call in the file which allows them to affect how that file runs.
+
+This example changes the ratings overlay to work on episodes.
+
+```yaml
+libraries:
+  TV Shows:
+    overlay_path:
+    - pmm: ratings
+      template_variables:
+        overlay_level: episode
+```
+
+Each file has a comment block at the top showing the available `template_variables` for each file. For example the [`pmm: genre`](https://github.com/meisnate12/Plex-Meta-Manager-Configs/blob/master/PMM/genre.yml) has this:
+
+```yaml
+#############################################################
+#                 Dynamic Genre Collections                 #
+#         Created by Yozora, Bullmoose20, & Sohjiro         #
+#############################################################
+#  Call this from your config.yml (Movie or Show)           #
+#  If nothing is specified these are the defaults           #
+#                                                           #
+#    metadata_path:                                         #
+#      - pmm: genre                                     #
+#        template_variables:                                #
+#          # Turn the [Separator Collection](../separators) on/off           #
+#          use_separator: true                              #
+#          # Sets how the collection is sorted              #
+#          sort_by: release.desc                            #
+#          # Sets the collection mode of the collection     #
+#          collection_mode:                                 #
+#          # Sets the value at the start of the sort title  #
+#          collection_section: "06"                         #
+#############################################################
+```
+ 
+Each of these when passed will change how the collection runs slightly. 
+* `use_separator` Turn the [Separator Collection](../separators) on/off
+* `sort_by` Sets how the collection is sorted
+* `collection_mode` Sets the collection mode of the collection 
+* `collection_section` Sets the value at the start of the sort title
+
+**In addition to the defined `template_variables` each file in the PMM Folder has access to the `radarr_add_missing` and `sonarr_add_missing` template variables and for dynamic collections most attributes can be passed as template variables**
+
+For example if you want yearly oscar collections that go back 10 years instead of 5 all of which gets sent to radarr use the `data` and `radarr_add_missing` template variables.
+
+```yaml
+libraries:
+  Movies:
+    metadata_path:
+    - pmm: oscars
+      template_variables:
+        radarr_add_missing: true
+        data:
+          starting: current_year-10
+          ending: current_year
+```
+
+Or maybe you want to change the number of actor collections made using pmm: actor.
+
+```yaml
+libraries:
+  Movies:
+    overlay_path:
+    - pmm: actor
+      template_variables:
+        collection_mode: hide
+        data:
+          depth: 5
+          limit: 50
+```
+
+Or maybe you want to change the collection sort order of the genre collections using pmm: genre.
+
+```yaml
+libraries:
+  Movies:
+    metadata_path:
+    - pmm: genre
+      template_variables:
+        collection_section: 11
+```
+
+Or maybe you want to disable separators globally per library.
+
+```yaml
+libraries:
+  LIBRARYNAME:
+    template_variables:
+      use_separator: false
+    metadata_path:
+```
+
+Alternatively it can be turned off individually per git file:
+
+```yaml
+libraries:
+  LIBRARYNAME:
+    metadata_path:
+      - pmm:     # separator is disabled
+        template_variables:
+          use_separator: false
+      - pmm:     # separator is enabled by default
+      - pmm:     # separator is disabled
+        template_variables:
+          use_separator: false
+```
+
+## Errors
+
+If there are collections being made that have configuration errors or missing posters please either bring it up in our Discord or raise an Issue on the [Configs Repo](https://github.com/meisnate12/Plex-Meta-Manager-Configs/issues/new/choose). 
+
+```{include} example.md
+```
\ No newline at end of file
diff --git a/docs/defaults/overlays.md b/docs/defaults/overlays.md
new file mode 100644
index 00000000..ccf20f86
--- /dev/null
+++ b/docs/defaults/overlays.md
@@ -0,0 +1,29 @@
+## Overlays
+
+These files apply overlays and can generally be used on both Movie and Show library-types, and often works at the season and episode-level too.
+
+It should be noted that when an overlay has ❗ for a season or episode, it normally means that whilst the overlay can technically be applied at the level, it wasn't designed for this purpose. For example, a show's season cannot have a resolution since it is not a video file, and an episode cannot have a commonsense age-rating since only Movies and Shows are rated by CommonSense. 
+
+In the scenario where there is missing data such as age ratings for episodes, then generally the highest-level data available will be applied at the lower level (i.e. a Show's CommonSense age rating would apply to all episodes).
+
+These overlays are applied by calling the below paths into the `overlay_path` [section](../config/libraries.md#overlay-path) of your config.yml
+
+### Overlay Files
+
+| Default                                        |       path        | Example Overlays                                                          |  Movies  |   Shows   |  Seasons  | Episodes |
+|:-----------------------------------------------|:-----------------:|:--------------------------------------------------------------------------|:--------:|:---------:|:---------:|:--------:|
+| [Audio Codec](overlays/audio_codec)            |   `audio_codec`   | Dolby Atmos logo, DTS logo                                                | ✅  |  ✅  |  ✅  | ✅  |
+| [Audio Language](overlays/audio_language)      | `audio_language`  | French Audio, Korean Audio                                                | ✅  |  ✅  |  ✅  | ✅  |
+| [CommonSense Age Rating](overlays/commonsense) |   `commonsense`   | "3+", "16+"                                                               | ✅  |  ✅  | ❗  | ❗ |
+| [Direct Play](overlays/direct_play)            |   `direct_play`   | "Direct Play Only"                                                        | ✅  | ❗  | ❗  | ✅  |
+| [Episode Info](overlays/episode_info)          |  `episode_info`   | "S01E01", "S02E09"                                                        | ❌ | ❌  | ❌  | ✅  |
+| [FlixPatrol](overlays/flixpatrol)              |   `flixpatrol`    | "Streaming service logo with words "TOP"                                  | ✅  |  ✅  | ❌  | ❌ |
+| [Mediastinger](overlays/mediastinger)          |  `mediastinger`   | Mediastinger Logo for After/During Credit Scenes                          | ✅  |  ✅  | ❌  | ❌ |
+| [Ratings](overlays/ratings)                    |     `ratings`     | IMDb Audience Rating, Metacritic Critic Rating                            | ✅  |  ✅  | ❌  | ✅  |
+| [Resolution/Editions](overlays/resolution)     |   `resolution`    | 4K Dolby Vision logo, 720P logo, "Director's Cut", "Criterion Collection" | ✅  |  ✅  | ❌  | ✅  |
+| [Ribbon](overlays/ribbon)                      |     `ribbon`      | IMDb Top 250 Ribbon, RT Fresh Ribbon                                      | ✅  |  ✅  | ❌  | ❌ |
+| [Runtimes](overlays/runtimes)                  |    `runtimes`     | "Runtime: 1h 30m"                                                         | ✅  |  ✅  | ❌  | ❌ |
+| [Status](overlays/status)                      |     `status`      | Airing, Returning, Canceled, Ended                                        | ❌ |  ✅  | ❌  | ❌ |
+| [Streaming](overlays/streaming)                |    `streaming`    | Netflix logo, Hulu logo                                                   | ✅  |  ✅  | ❌  | ❌ |
+| [Versions](overlays/versions)                  |    `versions`     | Multiple Versions logo                                                    | ✅  |  ✅  |  ✅  | ✅  |
+| [Video Format](overlays/video_format)          |  `video_format`   | "REMUX", "HDTV"                                                           | ✅  | ❗  | ❗  | ✅  |
diff --git a/docs/defaults/overlays/defaults.md b/docs/defaults/overlays/defaults.md
index ff332eba..95bb9a4e 100644
--- a/docs/defaults/overlays/defaults.md
+++ b/docs/defaults/overlays/defaults.md
@@ -1 +1,330 @@
-# Overlay Defaults
\ No newline at end of file
+# Overlay Defaults
+
+There are many Default Overlay Files built into PMM itself which offer an easy-to-use and customizable set of Overlays that the user can achieve without having to worry about creating the files that makes the overlays possible.
+
+This is the simplest way to create Overlays using Plex Meta Manager.
+
+## Overlay Files
+
+```{include} ../overlays.md
+```
+
+## Configurations
+
+To run a file in git you can simply add it to your `metadata_path` (For Metadata Files) or `overlay_path` (For Overlay Files) using `git` like so:
+
+```yaml
+libraries:
+  Movies:
+    overlay_path:
+    - pmm: ribbon
+    - pmm: ratings
+```
+
+## Overlays
+
+The default set of overlays are a combination of Positional Overlays and Text Overlays.
+
+### Example Poster Overlays
+
+![](images/movie-overlays1-annotated.png)
+![](images/movie-overlays2-annotated.png)
+
+ Click to expand sample config.yml Movies overlays section: + +```yaml +libraries: + Movies: + overlay_path: + - remove_overlays: false + - reapply_overlay: true + - pmm: resolution # 1 + - pmm: audio_codec # 2 + - pmm: mediastinger # 3 + - pmm: special_release # 4 + - pmm: ratings # 5, 6, 7 + template_variables: + rating1: user # 5 as this is user and mass_user_rating_update: mdb_tomatoes + rating1_image: rt_tomato # 5 as this is user and mass_user_rating_update: mdb_tomatoes + rating1_font: config/custom_fonts/Adlib.ttf # 5 local font accessible to PMM + rating1_font_size: 63 # 5 adjusted font size to fit rating + + rating2: critic # 6 as this is critic and mass_critic_rating_update: imdb + rating2_image: imdb # 6 as this is critic and mass_critic_rating_update: imdb + rating2_font: config/custom_fonts/Impact.ttf # 6 local font accessible to PMM + rating2_font_size: 70 # 6 adjusted font size to fit rating + + rating3: audience # 7 as this is audience and mass_audience_rating_update: tmdb + rating3_image: tmdb # 7 as this is audience and mass_audience_rating_update: tmdb + rating3_font: config/custom_fonts/Avenir_95_Black.ttf # 7 local font accessible to PMM + rating3_font_size: 70 # 7 adjusted font size to fit rating + + horizontal_position: right # the set of ratings is on the right of the poster + - pmm: streaming # 8 + - pmm: video_format # 9 + - pmm: audio_language # 10 + - pmm: ribbon # 11, 12 Bottom right sash is used by more than one overlay so a weight for priority can be applied + operations: + mass_user_rating_update: mdb_tomatoes # 5 This operation will update the user rating in plex with Rotten Tomatoes ratings information + mass_critic_rating_update: imdb # 6 This operation will update the critic rating in plex with IMDb ratings information + mass_audience_rating_update: tmdb # 7 This operation will update the audience rating in plex with TMDb ratings information +``` +
+ +### Example TV Shows - Show Overlays + +![](images/tvshow-poster-annotated.png) +
+ Click to expand sample config.yml TV Shows overlays section for the Show Poster: + +```yaml +libraries: + TV Shows: + overlay_path: + - remove_overlays: false + - reapply_overlay: true + - pmm: resolution # 1 + - pmm: audio_codec # 2 + - pmm: mediastinger # 3 + - pmm: ratings # 4, 5, 6 + template_variables: + rating1: user # 4 as this is user and mass_user_rating_update: mdb_tomatoes + rating1_image: rt_tomato # 4 as this is user and mass_user_rating_update: mdb_tomatoes + rating1_font: config/custom_fonts/Adlib.ttf # 4 local font accessible to PMM + rating1_font_size: 63 # 4 adjusted font size to fit rating + + rating2: critic # 5 as this is critic and mass_critic_rating_update: imdb + rating2_image: imdb # 5 as this is critic and mass_critic_rating_update: imdb + rating2_font: config/custom_fonts/Impact.ttf # 5 local font accessible to PMM + rating2_font_size: 70 # 5 adjusted font size to fit rating + + rating3: audience # 6 as this is audience and mass_audience_rating_update: tmdb + rating3_image: tmdb # 6 as this is audience and mass_audience_rating_update: tmdb + rating3_font: config/custom_fonts/Avenir_95_Black.ttf # 6 local font accessible to PMM + rating3_font_size: 70 # 6 adjusted font size to fit rating + + horizontal_position: right # the set of ratings is on the right of the poster + - pmm: streaming # 7 + - pmm: video_format # 8 + - pmm: ribbon # 10, 11 Bottom right sash is used by more than one overlay so a weight for priority can be applied + operations: + mass_user_rating_update: mdb_tomatoes # 4 This operation will update the user rating in plex with Rotten Tomatoes ratings information + mass_critic_rating_update: imdb # 5 This operation will update the critic rating in plex with IMDb ratings information + mass_audience_rating_update: tmdb # 6 This operation will update the audience rating in plex with TMDb ratings information +``` +
+ +### Example TV Shows - Season Overlays + +![](images/tvshow-poster-season-annotated.png) +
+ Click to expand sample config.yml TV Shows overlays section for the Season Poster: + +```yaml +libraries: + TV Shows: + overlay_path: + - remove_overlays: false + - reapply_overlay: true + - pmm: resolution # 1 + template_variables: + overlay_level: season + - pmm: audio_codec # 2 + template_variables: + overlay_level: season + - pmm: video_format # 3 + template_variables: + overlay_level: season +``` +
+ +### Example TV Shows - Episode Overlays + +![](images/tvshow-poster-episode-annotated.png) +
+ Click to expand sample config.yml TV Shows overlays section for the Episode Poster: + +```yaml +libraries: + TV Shows: + overlay_path: + - remove_overlays: false + - reapply_overlay: true + - pmm: resolution # 1 + template_variables: + overlay_level: episode + - pmm: audio_codec # 2 + template_variables: + overlay_level: episode + - pmm: ratings # 3, 4 + template_variables: + + rating1: critic # 3 as this is critic and mass_critic_rating_update: imdb + rating1_image: imdb # 3 as this is critic and mass_critic_rating_update: imdb + rating1_font: config/custom_fonts/Impact.ttf # 3 local font accessible to PMM + rating1_font_size: 70 # 3 adjusted font size to fit rating + + rating2: audience # 4 as this is audience and mass_audience_rating_update: tmdb + rating2_image: tmdb # 4 as this is audience and mass_audience_rating_update: tmdb + rating2_font: config/custom_fonts/Avenir_95_Black.ttf # 4 local font accessible to PMM + rating2_font_size: 70 # 4 adjusted font size to fit rating + + horizontal_position: right # the set of ratings is on the right of the poster + overlay_level: episode + - pmm: video_format # 5 + template_variables: + overlay_level: episode + - pmm: episode_info # 6 + template_variables: + overlay_level: episode + - pmm: runtimes # 7 + template_variables: + overlay_level: episode + + operations: + mass_episode_critic_rating_update: imdb # 3 This operation will update the episodes critic rating in plex with IMDb ratings information + mass_episode_audience_rating_update: tmdb # 4 This operation will update the episodes audience rating in plex with TMDb ratings information +``` +
+ +## Rating Overlays + +By default for Movies in Plex, the `Ratings Source` dropdown (`#3`) below, can come from Rotten Tomatoes (and includes Critic Ratings and Audience Ratings) or IMDb (Audience Ratings). This only changes the tiny icons displayed and where Plex will retrieve the ratings from upon initial scan and import of the media metadata. + +**Plex Meta Manager can insert up to three ratings of your choice into the three spots regardless of what you choose in the `Advanced` tab of that Plex library** + +![](images/ratings_source.png) + +Plex has three available spots in the Plex DB to store ratings and thus Plex Meta Manager can be used to insert ratings sources of your choice into those spots. They are known as the User Rating (`#1`), Critic Rating (`#2`), and Audience Rating (`#3`). + +**Note that the little icons cannot be changed and that the numbers next to the little icons are reflected in the poster ratings overlay** + +![](images/ratings_spot.png) + +To be able to insert the ratings you want, Plex Meta Manager operations need to be defined. In this example below, User ratings (`#1`) are being filled with Rotten Tomatoes Critics Ratings. Critic ratings (`#2`) are filled with IMDb, and Audience ratings (`#3`) are filled with TMDb. + +**mass_*_rating_update** sources can be found here: [operations](../../config/operations) + +![](images/ratings_operations.png) + +Finally, to show the ratings on the poster, the following was added to the `overlay_path` section in the `config.yml` file to post Rotten Tomatoes Critics Ratings in (`#1`), IMDb ratings in (`#2`), and TMDb ratings in (`#3`) + +![](images/ratings_overlay_path.png) + +## Customizing Configs + +Configs can be customized using the `template_variables` attribute when calling the file. These `template_variables` will be given to every template call in the file which allows them to affect how that file runs. + +This example changes the ratings overlay to work on episodes. + +```yaml +libraries: + TV Shows: + overlay_path: + - pmm: ratings + template_variables: + overlay_level: episode +``` + +Each file has a comment block at the top showing the available `template_variables` for each file. For example the [`pmm: genre`](https://github.com/meisnate12/Plex-Meta-Manager-Configs/blob/master/PMM/genre.yml) has this: + +```yaml +############################################################# +# Dynamic Genre Collections # +# Created by Yozora, Bullmoose20, & Sohjiro # +############################################################# +# Call this from your config.yml (Movie or Show) # +# If nothing is specified these are the defaults # +# # +# metadata_path: # +# - pmm: genre # +# template_variables: # +# # Turn the [Separator Collection](../separators) on/off # +# use_separator: true # +# # Sets how the collection is sorted # +# sort_by: release.desc # +# # Sets the collection mode of the collection # +# collection_mode: # +# # Sets the value at the start of the sort title # +# collection_section: "06" # +############################################################# +``` + +Each of these when passed will change how the collection runs slightly. +* `use_separator` Turn the [Separator Collection](../separators) on/off +* `sort_by` Sets how the collection is sorted +* `collection_mode` Sets the collection mode of the collection +* `collection_section` Sets the value at the start of the sort title + +**In addition to the defined `template_variables` each file in the PMM Folder has access to the `radarr_add_missing` and `sonarr_add_missing` template variables and for dynamic collections most attributes can be passed as template variables** + +For example if you want yearly oscar collections that go back 10 years instead of 5 all of which gets sent to radarr use the `data` and `radarr_add_missing` template variables. + +```yaml +libraries: + Movies: + metadata_path: + - pmm: oscars + template_variables: + radarr_add_missing: true + data: + starting: current_year-10 + ending: current_year +``` + +Or maybe you want to change the number of actor collections made using pmm: actor. + +```yaml +libraries: + Movies: + overlay_path: + - pmm: actor + template_variables: + collection_mode: hide + data: + depth: 5 + limit: 50 +``` + +Or maybe you want to change the collection sort order of the genre collections using pmm: genre. + +```yaml +libraries: + Movies: + metadata_path: + - pmm: genre + template_variables: + collection_section: 11 +``` + +Or maybe you want to disable separators globally per library. + +```yaml +libraries: + LIBRARYNAME: + template_variables: + use_separator: false + metadata_path: +``` + +Alternatively it can be turned off individually per git file: + +```yaml +libraries: + LIBRARYNAME: + metadata_path: + - pmm: # separator is disabled + template_variables: + use_separator: false + - pmm: # separator is enabled by default + - pmm: # separator is disabled + template_variables: + use_separator: false +``` + +## Errors + +If there are collections being made that have configuration errors or missing posters please either bring it up in our Discord or raise an Issue on the [Configs Repo](https://github.com/meisnate12/Plex-Meta-Manager-Configs/issues/new/choose). + +```{include} ../example.md +``` \ No newline at end of file diff --git a/docs/home/acknowledgements.md b/docs/home/acknowledgements.md index 1c0eb27f..e7e2efbc 100644 --- a/docs/home/acknowledgements.md +++ b/docs/home/acknowledgements.md @@ -9,6 +9,8 @@ | [bullmoose20](https://github.com/bullmoose20) | bullmoose20 | PMM Discord Moderator, Default Configs Creator & Maintainer, Wiki Contributor, [Configs Repo](https://github.com/meisnate12/Plex-Meta-Manager-Configs) Maintainer | | [chazlarson](https://github.com/chazlarson/) | chazlarson | PMM Master Discord Support and Wiki Contributor who created the [Local](guides/local) and [Docker](guides/docker) guides | | [cpt-kuesel](https://github.com/cpt-kuesel) | Cpt Kuesel | PMM Master Discord Support and [Configs Repo](https://github.com/meisnate12/Plex-Meta-Manager-Configs) Maintainer | +| [JohnFawkes](https://github.com/JohnFawkes) | anon_fawkes | PMM Apprentice Discord Support | +| zaP | zaP | PMM Apprentice Discord Support, Reddit Moderator | | [mikenobbs](https://github.com/mikenobbs) | mikenobbs | PMM Discord Moderator | The team at Plex Meta Manager would like to recognize and thank those who have helped the project become what it is today. diff --git a/modules/meta.py b/modules/meta.py index ba9b22c9..be80c5fa 100644 --- a/modules/meta.py +++ b/modules/meta.py @@ -272,8 +272,8 @@ class DataFile: variables[f"{var_key}U"] = var_value[language] elif language in var_value: key_name_variables[var_key] = var_value[language] - if "key_name" in variables and variables["key_name"] in key_name_variables: - variables["key_name"] = key_name_variables[variables["key_name"]] + if "key_name" in variables: + variables["translated_key_name"] = key_name_variables[variables["key_name"]] if variables["key_name"] in key_name_variables else variables["key_name"] def replace_var(input_item, search_dicts): if not isinstance(search_dicts, list): diff --git a/plex_meta_manager.py b/plex_meta_manager.py index 19083585..fda79b63 100644 --- a/plex_meta_manager.py +++ b/plex_meta_manager.py @@ -644,7 +644,7 @@ def run_collection(config, library, metadata, requested_collections): logger.stacktrace() run_item_details = False logger.info("") - logger.separator("No {builder.Type} to Update", space=False, border=False) + logger.separator(f"No {builder.Type} to Update", space=False, border=False) else: details_list = builder.update_details() if details_list: