add aspect ratio

This commit is contained in:
bullmoose20 2023-07-11 11:15:31 -04:00
parent 66f95ca94b
commit 49404e2499
7 changed files with 379 additions and 0 deletions

101
defaults/both/aspect.yml Normal file
View file

@ -0,0 +1,101 @@
##############################################################################
# Aspect Ratio Collections #
# Created by Yozora, Bullmoose20, & Sohjiro #
# EDITING THIS url_poster MAY CAUSE PULLING NEW UPDATES TO FAIL #
# https://metamanager.wiki/en/latest/defaults/both/aspect.html #
##############################################################################
external_templates:
pmm: templates
template_variables:
collection_section: "125"
translations:
pmm: translations
templates:
aspect:
template:
url_poster: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager-Images/master/aspect/<<mapping_name>>.jpg
summary: A collection of media items with the aspect ratio of <<mapping_name>>.
collections:
Aspect Ratio Collections:
template:
- name: separator
separator: aspect
key_name: Aspect Ratio
translation_key: separator
1.33:
plex_all: true
name: 1.33 - Academy Aperture
template:
- name: aspect
- name: shared
filters:
aspect.gt: 1.32
aspect.lt: 1.34
1.65:
plex_all: true
name: 1.65 - Early Widescreen
template:
- name: aspect
- name: shared
filters:
aspect.gt: 1.64
aspect.lt: 1.66
1.66:
plex_all: true
name: 1.66 - European Widescreen
template:
- name: aspect
- name: shared
filters:
aspect.gt: 1.65
aspect.lt: 1.67
1.78:
plex_all: true
name: 1.78 - Widescreen TV
template:
- name: aspect
- name: shared
filters:
aspect.gt: 1.77
aspect.lt: 1.79
1.85:
plex_all: true
name: 1.85 - American Widescreen
template:
- name: aspect
- name: shared
filters:
aspect.gt: 1.84
aspect.lt: 1.86
2.2:
plex_all: true
name: 2.2 - 70mm Frame
template:
- name: aspect
- name: shared
filters:
aspect.gt: 2.1
aspect.lt: 2.3
2.35:
plex_all: true
name: 2.35 - Anamorphic Projection
template:
- name: aspect
- name: shared
filters:
aspect.gt: 2.34
aspect.lt: 2.36
2.77:
plex_all: true
name: 2.77 - Cinerama
template:
- name: aspect
- name: shared
filters:
aspect.gt: 2.76
aspect.lt: 2.78

View file

@ -0,0 +1,100 @@
##############################################################################
# Aspect Ratio Overlay #
# Created by Yozora, Bullmoose20, & Sohjiro #
# EDITING THIS FILE MAY CAUSE PULLING NEW UPDATES TO FAIL #
# https://metamanager.wiki/en/latest/defaults/overlays/aspect.html #
##############################################################################
external_templates:
pmm: templates
template_variables:
default:
text_<<key>>: <<overlay_name>>
horizontal_align: center
vertical_align: bottom
conditionals:
vertical_offset:
default: 15
conditions:
- vertical_align: center
value: 0
- vertical_align: top
value: 15
- vertical_align: bottom
value: 150
horizontal_offset:
default: 15
conditions:
- horizontal_align: center
value: 0
- horizontal_align: [left, right]
value: 15
group: aspect
font: fonts/Inter-Medium.ttf
font_size: 63
back_color: "#00000099"
back_width: 305
back_height: 105
final_name: text(<<text_<<key>>>>)
templates:
aspect:
ignore_blank_results: true
plex_all: true
overlays:
1.33:
variables: {key: 1.33, weight: 80}
template: [name: standard, name: aspect]
filters:
aspect.gt: 1.32
aspect.lt: 1.34
1.65:
variables: {key: 1.65, weight: 70}
template: [name: standard, name: aspect]
plex_all: true
filters:
aspect.gt: 1.64
aspect.lt: 1.66
1.66:
variables: {key: 1.66, weight: 60}
template: [name: standard, name: aspect]
plex_all: true
filters:
aspect.gt: 1.65
aspect.lt: 1.67
1.78:
variables: {key: 1.78, weight: 50}
template: [name: standard, name: aspect]
plex_all: true
filters:
aspect.gt: 1.77
aspect.lt: 1.79
1.85:
variables: {key: 1.85, weight: 40}
template: [name: standard, name: aspect]
plex_all: true
filters:
aspect.gt: 1.84
aspect.lt: 1.86
2.2:
variables: {key: 2.2, weight: 30}
template: [name: standard, name: aspect]
plex_all: true
filters:
aspect.gt: 2.1
aspect.lt: 2.3
2.35:
variables: {key: 2.35, weight: 20}
template: [name: standard, name: aspect]
plex_all: true
filters:
aspect.gt: 2.34
aspect.lt: 2.36
2.77:
variables: {key: 2.77, weight: 10}
template: [name: standard, name: aspect]
plex_all: true
filters:
aspect.gt: 2.76
aspect.lt: 2.78

View file

@ -249,6 +249,7 @@ html_theme_options = {
]),
("_menu", "Movie", "defaults/collections", "#general-collections", [
("Actors", "defaults/both/actor"),
("Aspect Ratio", "defaults/both/aspect"),
("Audio Languages", "defaults/both/audio_language"),
("Based On...", "defaults/both/based"),
("Collectionless", "defaults/both/collectionless"),
@ -274,6 +275,7 @@ html_theme_options = {
]),
("_menu", "Show", "defaults/collections", "#general-collections", [
("Actors", "defaults/both/actor"),
("Aspect Ratio", "defaults/both/aspect"),
("Audio Languages", "defaults/both/audio_language"),
("Based On...", "defaults/both/based"),
("Collectionless", "defaults/both/collectionless"),
@ -300,6 +302,7 @@ html_theme_options = {
("Overlays", "defaults/overlays"),
("Shared Variables", "defaults/overlay_variables"),
("_divider", ),
("Aspect Ratio", "defaults/overlays/aspect"),
("Audio Codec", "defaults/overlays/audio_codec"),
("Common Sense Age Ratings", "defaults/overlays/commonsense"),
("Content Ratings (UK)", "defaults/overlays/content_rating_uk"),

View file

@ -0,0 +1,73 @@
# Aspect Ratio Collections
The `aspect` Default Metadata File is used to create collections with items that are based on their aspect ratio.
![](../images/aspect.png)
## Requirements & Recommendations
Supported Library Types: Movie, Show
## Collections Section 125
| Collection | Key | Description |
|:-------------------------------|:------------|:----------------------------------------------------------------------------|
| `Aspect Ratio Collections` | `separator` | [Separator Collection](../separators) to denote the Section of Collections. |
| `1.33 - Academy Aperture` | `1.33` | Collection of Movies/Shows with a 1.33 aspect ratio |
| `1.65 - Early Widescreen` | `1.65` | Collection of Movies/Shows with a 1.65 aspect ratio |
| `1.66 - European Widescreen` | `1.66` | Collection of Movies/Shows with a 1.66 aspect ratio |
| `1.78 - Widescreen TV` | `1.78` | Collection of Movies/Shows with a 1.78 aspect ratio |
| `1.85 - American Widescreen` | `1.85` | Collection of Movies/Shows with a 1.85 aspect ratio |
| `2.2 - 70mm Frame` | `2.2` | Collection of Movies/Shows with a 2.2 aspect ratio |
| `2.35 - Anamorphic Projection` | `2.35` | Collection of Movies/Shows with a 2.35 aspect ratio |
| `2.77 - Cinerama` | `2.77` | Collection of Movies/Shows with a 2.77 aspect ratio |
## Config
The below YAML in your config.yml will create the collections:
```yaml
libraries:
Movies:
metadata_path:
- pmm: aspect
TV Shows:
metadata_path:
- pmm: aspect
```
## 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 |
| `name_format` | **Description:** Changes the title format of the Dynamic Collections.<br>**Default:** `Based on a <<key_name>>`<br>**Values:** Any string with `<<key_name>>` in it. |
| `summary_format` | **Description:** Changes the summary format of the Dynamic Collections.<br>**Default:** `<<library_translationU>>s based on or inspired by <<translated_key_name>>s.`<br>**Values:** Any string. |
1. Each default collection has a `key` that when calling to effect a specific collection you must replace `<<key>>` with when calling.
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: aspect
template_variables:
use_separator: false
sep_style: purple
```

Binary file not shown.

After

Width:  |  Height:  |  Size: 127 KiB

View file

@ -0,0 +1,102 @@
# Status Overlay
The `aspect` Default Overlay File is used to create an overlay on a show detailing its Current Airing Status for all shows in your library.
![](images/aspect.png)
## Requirements & Recommendations
Supported Overlay Level: Movie, Show
## Supported Status
| Status | Key | Weight |
|:-------|:-------|:-------|
| 1.33 | `1.33` | `80` |
| 1.65 | `1.65` | `70` |
| 1.66 | `1.66` | `60` |
| 1.78 | `1.78` | `50` |
| 1.85 | `1.85` | `40` |
| 2.2 | `2.2` | `30` |
| 2.35 | `2.35` | `20` |
| 2.77 | `2.77` | `10` |
## Config
The below YAML in your config.yml will create the overlays:
```yaml
libraries:
Movies:
overlay_path:
- pmm: aspect
TV Shows:
overlay_path:
- pmm: aspect
- pmm: aspect
template_variables:
overlay_level: episode
- pmm: aspect
template_variables:
overlay_level: season
```
## 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 Overlay Variables](../overlay_variables) are available with the default values below as well as the additional Variables below which can be used to customize the file.
| Variable | Default |
|:--------------------|:------------|
| `horizontal_offset` | `150` |
| `horizontal_align` | `center` |
| `vertical_offset` | `0` |
| `vertical_align` | `bottom` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_height` | `105` |
| Variable | Description & Values |
|:-----------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `text_<<key>>`<sup>1</sup> | **Description:** Choose the text for the Overlay.<br>**Default:** <table class="clearTable"><tr><th>Key</th><th>Default</th></tr><tr><td>`1.33`</td><td>`1.33`</td></tr><tr><td>`1.65`</td><td>`1.65`</td></tr><tr><td>`1.66`</td><td>`1.66`</td></tr><tr><td>`1.78`</td><td>`1.78`</td></tr><tr><td>`1.85`</td><td>`1.85`</td></tr><tr><td>`2.2`</td><td>`2.2`</td></tr><tr><td>`2.35`</td><td>`2.35`</td></tr><tr><td>`2.77`</td><td>`2.77`</td></tr></table>**Values:** Any String |
| `weight_<<key>>`<sup>1</sup> | **Description:** Controls the weight of the Overlay. Higher numbers have priority.<br>**Values:** Any Number |
| `font` | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Medium.ttf`<br>**Values:** Path to font file |
| `font_style` | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style |
| `font_size` | **Description:** Choose the font size for the Overlay.<br>**Default:** `50`<br>**Values:** Any Number greater then 0 |
| `font_color` | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
| `stroke_width` | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any Number greater then 0 |
| `stroke_color` | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
1. Each default overlay has a `key` that when calling to effect a specific overlay 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:
overlay_path:
- pmm: aspect
template_variables:
text_1.33: "4:9"
text_1.77: "16:9"
TV Shows:
overlay_path:
- pmm: aspect
template_variables:
text_1.33: "4:9"
text_1.77: "16:9"
- pmm: aspect
template_variables:
overlay_level: episode
text_1.33: "4:9"
text_1.77: "16:9"
- pmm: aspect
template_variables:
overlay_level: season
text_1.33: "4:9"
text_1.77: "16:9"
```

Binary file not shown.

After

Width:  |  Height:  |  Size: 307 KiB