mirror of
https://github.com/meisnate12/Plex-Meta-Manager
synced 2024-11-10 06:54:21 +00:00
Add "Based On..." Defaults file
This commit is contained in:
yozoraxcii
parent
61398f36db
commit
c06009fd03
6 changed files with 131 additions and 1 deletions
45
defaults/both/basedon.yml
Normal file
45
defaults/both/basedon.yml
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
##############################################################################
|
||||
# "Based On..." Collections #
|
||||
# Created by Yozora, Bullmoose20, & Sohjiro #
|
||||
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
|
||||
# https://metamanager.wiki/en/latest/defaults/both/basedon.html #
|
||||
##############################################################################
|
||||
|
||||
external_templates:
|
||||
pmm: templates
|
||||
template_variables:
|
||||
collection_section: "14"
|
||||
|
||||
translations:
|
||||
pmm: translations
|
||||
|
||||
collections:
|
||||
Based On... Collections:
|
||||
template:
|
||||
- name: separator
|
||||
separator: basedon
|
||||
- name: translation
|
||||
key_name: Based On...
|
||||
translation_key: separator
|
||||
|
||||
dynamic_collections:
|
||||
Basedon:
|
||||
type: custom
|
||||
data:
|
||||
books: Book
|
||||
comics: Comic
|
||||
true-story: True Story
|
||||
video-games: Video Game
|
||||
title_format: Based on a <<key_name>>
|
||||
template:
|
||||
- mdb_smart
|
||||
- translation
|
||||
- shared
|
||||
- arr
|
||||
template_variables:
|
||||
mdblist_list:
|
||||
default: https://mdblist.com/lists/plexmetamanager/based-on-<<key>>-<<library_type>>s
|
||||
image:
|
||||
default: basedon/<<key_name_encoded>>
|
||||
translation_key:
|
||||
default: basedon
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
version: 1.18.2.1
|
||||
version: 1.18.2.2
|
||||
variables:
|
||||
library_translation:
|
||||
# For Movie Libraries
|
||||
|
|
@ -43,6 +43,7 @@ key_names:
|
|||
# Bengali: Bengali
|
||||
# Biography: Biography
|
||||
# Biopic: Biopic
|
||||
# Book: Book
|
||||
# Bosnian: Bosnian
|
||||
# Brazil: Brazil
|
||||
# Bulgaria: Bulgaria
|
||||
|
|
@ -55,6 +56,7 @@ key_names:
|
|||
# China: China
|
||||
# Chinese: Chinese
|
||||
# Christmas: Christmas
|
||||
# Comic: Comic
|
||||
# Comedy: Comedy
|
||||
# Competition: Competition
|
||||
# Costa Rica: Costa Rica
|
||||
|
|
@ -221,6 +223,7 @@ key_names:
|
|||
# Thanksgiving: Thanksgiving
|
||||
# Thriller: Thriller
|
||||
# Travel: Travel
|
||||
# True Story: True Story
|
||||
# Turkey: Turkey
|
||||
# Turkish: Turkish
|
||||
# Ukraine: Ukraine
|
||||
|
|
@ -231,6 +234,7 @@ key_names:
|
|||
# Universe: Universe
|
||||
# Urdu: Urdu
|
||||
# Valentine's Day: Valentine's Day
|
||||
# Video Game: Video Game
|
||||
# Vietnam: Vietnam
|
||||
# Vietnamese: Vietnamese
|
||||
# War & Politics: War & Politics
|
||||
|
|
@ -425,6 +429,10 @@ translations:
|
|||
audio_language_other_name: Other Audio
|
||||
audio_language_other_summary: <<library_translationU>>s filmed in other uncommon Languages.
|
||||
|
||||
# possible key_names: Book, Comic, True Story, Video Game
|
||||
basedon_name: Based on a <<translated_key_name>>
|
||||
basedon_summary: <<library_translationU>>s based on or inspired by <<translated_key_name>>s.
|
||||
|
||||
collectionless_name: Collectionless
|
||||
collectionless_summary: Collection of <<library_translationU>>s used to make Plex display items correctly.
|
||||
|
||||
|
|
|
|||
|
|
@ -237,6 +237,7 @@ html_theme_options = {
|
|||
("_menu", "Movie", "defaults/defaults", "#general-collections", [
|
||||
("Actors", "defaults/both/actor"),
|
||||
("Audio Languages", "defaults/both/audio_language"),
|
||||
("Based On...", "defaults/both/basedon"),
|
||||
("Collectionless", "defaults/both/collectionless"),
|
||||
("Common Sense Media Content Ratings", "defaults/both/content_rating_cs"),
|
||||
("MyAnimeList Content Ratings", "defaults/both/content_rating_mal"),
|
||||
|
|
@ -261,6 +262,7 @@ html_theme_options = {
|
|||
("_menu", "Show", "defaults/defaults", "#general-collections", [
|
||||
("Actors", "defaults/both/actor"),
|
||||
("Audio Languages", "defaults/both/audio_language"),
|
||||
("Based On...", "defaults/both/basedon"),
|
||||
("Collectionless", "defaults/both/collectionless"),
|
||||
("Common Sense Media Content Ratings", "defaults/both/content_rating_cs"),
|
||||
("MyAnimeList Content Ratings", "defaults/both/content_rating_mal"),
|
||||
|
|
|
|||
74
docs/defaults/both/basedon.md
Normal file
74
docs/defaults/both/basedon.md
Normal file
|
|
@ -0,0 +1,74 @@
|
|||
# Based On... Collections
|
||||
|
||||
The `basedon` Default Metadata File is used to create collections with items that are based on or inspired by various media outlets (such as Books or Video Games).
|
||||
|
||||
|
||||
|
||||
## Requirements & Recommendations
|
||||
|
||||
Supported Library Types: Movie, Show
|
||||
|
||||
## Collections Section 03
|
||||
|
||||
| Collection | Key | Description |
|
||||
|:---------------------------|:--------------|:----------------------------------------------------------------------------|
|
||||
| `Based On... Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
|
||||
| `Based on a Book` | `books` | Collection of Movies/Shows based on or inspired by books |
|
||||
| `Based on a Comic` | `comics` | Collection of Movies/Shows based on or inspired by comics |
|
||||
| `Based on a True Story` | `true-story` | Collection of Movies/Shows based on or inspired by true stories |
|
||||
| `Based on a Video Game` | `video-games` | Collection of Movies/Shows based on or inspired by video games |
|
||||
|
||||
## Config
|
||||
|
||||
The below YAML in your config.yml will create the collections:
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: basedon
|
||||
TV Shows:
|
||||
metadata_path:
|
||||
- pmm: basedon
|
||||
```
|
||||
|
||||
## Template Variables
|
||||
|
||||
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
||||
|
||||
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults work. Any value not specified is its default value if it has one if not it's just ignored.
|
||||
|
||||
All [Shared Collection Variables](../collection_variables) are available as well as the additional Variables below which can be used to customize the file.
|
||||
|
||||
This file contains a [Separator](../separators) so all [Shared Separator Variables](../separators.md#shared-separator-variables) are available as well.
|
||||
|
||||
| Variable | Description & Values |
|
||||
|:--------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `limit` | **Description:** Changes the Builder Limit for all collections in a Defaults file.<br>**Values:** Number Greater then 0 |
|
||||
| `limit_<<key>>`<sup>1</sup> | **Description:** Changes the Builder Limit of the specified key's collection.<br>**Default:** `limit`<br>**Values:** Number Greater then 0 |
|
||||
| `sort_by` | **Description:** Changes the Smart Filter Sort for all collections in a Defaults file.<br>**Default:** `release.desc`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sort_by_<<key>>`<sup>1</sup> | **Description:** Changes the Smart Filter Sort of the specified key's collection.<br>**Default:** `sort_by`<br>**Values:** [Any `smart_filter` Sort Option](../../metadata/builders/smart.md#sort-options) |
|
||||
| `sync_mode` | **Description:** Changes the Sync Mode for all collections in a Defaults file.<br>**Default:** `sync`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `sync_mode_<<key>>`<sup>1</sup> | **Description:** Changes the Sync Mode of the specified key's collection.<br>**Default:** `sync_mode`<br>**Values:**<table class="clearTable"><tr><td>`sync`</td><td>Add and Remove Items based on Builders</td></tr><tr><td>`append`</td><td>Only Add Items based on Builders</td></tr></table> |
|
||||
| `exclude` | **Description:** Exclude these Media Outlets from creating a Dynamic Collection.<br>**Values:** List of Media Outlet Keys |
|
||||
| `basedon_name` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Based on a <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
|
||||
| `basedon_summary` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s based on or inspired by <<translated_key_name>>s.`<br>**Values:** Any string. |
|
||||
|
||||
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
|
||||
|
||||
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
||||
|
||||
```yaml
|
||||
libraries:
|
||||
Movies:
|
||||
metadata_path:
|
||||
- pmm: basedon
|
||||
template_variables:
|
||||
use_separator: false
|
||||
sep_style: purple
|
||||
use_comics: false
|
||||
order_true-story: 01
|
||||
visible_library_video-games: true
|
||||
visible_home_video-games: true
|
||||
visible_shared_video-games: true
|
||||
```
|
||||
|
|
@ -45,6 +45,7 @@ These collections are applied by calling the below paths into the `metadata_path
|
|||
|:------------------------------------------------------------------------------------|:---------------------|:-------------------------------------------------------|:-----------------:|:----------------:|
|
||||
| [Actor](both/actor) | `actor` | Chris Hemsworth, Margot Robbie | ✅ | ✅ |
|
||||
| [Audio Language](both/audio_language) | `audio_language` | French Audio, Korean Audio | ✅ | ✅ |
|
||||
| [Based On...](both/basedon) | `basedon` | Based on a Book, Based on a True Story | ✅ | ✅ |
|
||||
| [Collectionless](both/collectionless) | `collectionless` | Collectionless | ✅ | ✅ |
|
||||
| [Common Sense Content Rating](both/content_rating_cs) | `content_rating_cs` | 1, 2, 3, 4, 5, 6, 15, 16, 17, 18 | ✅ | ✅ |
|
||||
| [MyAnimeList Content Rating](both/content_rating_mal) | `content_rating_mal` | G, PG, PG-13, R, R+, Rx | ✅ | ✅ |
|
||||
|
|
|
|||
BIN
docs/defaults/images/basedon.png
Normal file
BIN
docs/defaults/images/basedon.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 77 KiB |
Loading…
Reference in a new issue