Plex
/
Plex-Meta-Manager
mirror of https://github.com/meisnate12/Plex-Meta-Manager.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

[8] docs to support network & us/uk content rating overlays

Browse Source
pull/1382/head
bullmoose20 2 years ago
parent 96460d00ae
commit f4ad43768f
9 changed files with 318 additions and 1 deletions
Show Stats Download Patch File Download Diff File

2
VERSION
Unescape View File

@ -1 +1 @@
1.19.0-develop7
1.19.0-develop8

87
docs/defaults/overlays/content_rating_uk.md
Unescape View File

@ -0,0 +1,87 @@
# Content Rating UK Overlay
The `content_rating_uk` Default Overlay File is used to create an overlay based on the BBFC Age Rating on each item within your library.
![](images/content_rating_uk.png)
## Requirements & Recommendations
Supported library types: Movie & Show
Requirements: Use the [Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with either `mdb` or `omdb` to update Plex to the BBFC Rating.
## Supported Content Rating UK
| Rating | Key |
|:-------|:------|
| U | `u` |
| PG | `pg` |
| 12 | `12` |
| 12a | `12a` |
| 15 | `15` |
| 18 | `18` |
| R18 | `r18` |
| NR | `nr` |
## Config
The below YAML in your config.yml will create the overlays:
```yaml
libraries:
Movies:
overlay_path:
- pmm: content_rating_uk
TV Shows:
overlay_path:
- pmm: content_rating_uk
- pmm: content_rating_uk
template_variables:
overlay_level: season
- pmm: content_rating_uk
template_variables:
overlay_level: episode
```
## 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 |
|:--------------------|:---------|
| `color` | `c` |
| `horizontal_offset` | `15` |
| `horizontal_align` | `left` |
| `vertical_offset` | `270` |
| `vertical_align` | `bottom` |
| Variable | Description & Values |
|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `back_color` | **Description:** Choose the back color in RGBA for the overlay lozenge.<br>**Default:**`#00000099` |
| `back_radius` | **Description:** Choose the back radius for the overlay lozenge.<br>**Default:**`30` |
| `back_width` | **Description:** Choose the back width for the overlay lozenge.<br>**Default:**`305` |
| `back_height` | **Description:** Choose the back height for the overlay lozenge.<br>**Default:**`105` |
| `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:** `55`<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` |
| `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any Number greater then 0 |
| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `left`<br>**Values:** `left`, `right`, `top`, `bottom` |
| `overlay_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` |
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: content_rating_uk
template_variables:
color: "" # since it is blank, the black and white version will be applied
```

75
docs/defaults/overlays/content_rating_us_movie.md
Unescape View File

@ -0,0 +1,75 @@
# Content Rating US Movie Overlay
The `content_rating_us_movie` Default Overlay File is used to create an overlay based on the MPAA Age Rating on each item within your library.
![](images/content_rating_us_movie.png)
## Requirements & Recommendations
Supported library types: Movie
Requirements: Use the [Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with either `mdb` or `omdb` to update Plex to the MPAA Rating.
## Supported Content Rating US
| Rating | Key |
|:-------|:--------|
| G | `g` |
| PG | `pg` |
| PG-13 | `pg-13` |
| R | `r` |
| NC-17 | `nc-17` |
| NR | `nr` |
## Config
The below YAML in your config.yml will create the overlays:
```yaml
libraries:
Movies:
overlay_path:
- pmm: content_rating_us_movie
```
## 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 |
|:--------------------|:---------|
| `color` | `c` |
| `horizontal_offset` | `15` |
| `horizontal_align` | `left` |
| `vertical_offset` | `270` |
| `vertical_align` | `bottom` |
| Variable | Description & Values |
|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `back_color` | **Description:** Choose the back color in RGBA for the overlay lozenge.<br>**Default:**`#00000099` |
| `back_radius` | **Description:** Choose the back radius for the overlay lozenge.<br>**Default:**`30` |
| `back_width` | **Description:** Choose the back width for the overlay lozenge.<br>**Default:**`305` |
| `back_height` | **Description:** Choose the back height for the overlay lozenge.<br>**Default:**`105` |
| `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:** `55`<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` |
| `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any Number greater then 0 |
| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `left`<br>**Values:** `left`, `right`, `top`, `bottom` |
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: content_rating_us_movie
template_variables:
color: "" # since it is blank, the black and white version will be applied
```

90
docs/defaults/overlays/content_rating_us_show.md
Unescape View File

@ -0,0 +1,90 @@
# Content Rating US Show Overlay
The `content_rating_us_show` Default Overlay File is used to create an overlay based on the MPAA Age Rating on each item within your library.
![](images/content_rating_us_show.png)
## Requirements & Recommendations
Supported library types: Show
Requirements: Use the [Mass Content Rating Update Library Operation](../../config/operations.md#mass-content-rating-update) with either `mdb` or `omdb` to update Plex to the MPAA Rating.
## Supported Content Rating US
| Rating | Key |
|:-------|:--------|
| TV-G | `tv-g` |
| TV-Y | `tv-y` |
| TV-PG | `tv-pg` |
| TV-14 | `tv-14` |
| TV-MA | `tv-ma` |
| NR | `nr` |
## Config
The below YAML in your config.yml will create the overlays:
```yaml
libraries:
TV Shows:
overlay_path:
- pmm: content_rating_us_show
- pmm: content_rating_us_show
template_variables:
overlay_level: season
- pmm: content_rating_us_show
template_variables:
overlay_level: episode
```
## 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 |
|:--------------------|:---------|
| `color` | `c` |
| `horizontal_offset` | `15` |
| `horizontal_align` | `left` |
| `vertical_offset` | `270` |
| `vertical_align` | `bottom` |
| Variable | Description & Values |
|:-----------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `back_color` | **Description:** Choose the back color in RGBA for the overlay lozenge.<br>**Default:**`#00000099` |
| `back_radius` | **Description:** Choose the back radius for the overlay lozenge.<br>**Default:**`30` |
| `back_width` | **Description:** Choose the back width for the overlay lozenge.<br>**Default:**`305` |
| `back_height` | **Description:** Choose the back height for the overlay lozenge.<br>**Default:**`105` |
| `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:** `55`<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` |
| `addon_offset` | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any Number greater then 0 |
| `addon_position` | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `left`<br>**Values:** `left`, `right`, `top`, `bottom` |
| `overlay_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` |
The below is an example config.yml extract with some Template Variables added in to change how the file works.
```yaml
libraries:
TV Shows:
overlay_path:
- pmm: content_rating_us_show
template_variables:
color: "" # since it is blank, the black and white version will be applied
- pmm: content_rating_us_show
template_variables:
color: "" # since it is blank, the black and white version will be applied
overlay_level: season
- pmm: content_rating_us_show
template_variables:
color: "" # since it is blank, the black and white version will be applied
overlay_level: episode
```

BIN
docs/defaults/overlays/images/content_rating_uk.png
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 392 KiB

BIN
docs/defaults/overlays/images/content_rating_us_movie.png
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 279 KiB

BIN
docs/defaults/overlays/images/content_rating_us_show.png
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 394 KiB

BIN
docs/defaults/overlays/images/network.png
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 392 KiB

65
docs/defaults/overlays/network.md
Unescape View File

@ -0,0 +1,65 @@
# Network Overlay
The `network` Default Overlay File is used to create an overlay based on the show network on each item within your library.
![](images/network.png)
## Requirements & Recommendations
Supported library types: Show
## Config
The below YAML in your config.yml will create the overlays:
```yaml
libraries:
TV Shows:
overlay_path:
- pmm: network
- pmm: network
template_variables:
overlay_level: season
- pmm: network
template_variables:
overlay_level: episode
```
## 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` | `15` |
| `horizontal_align` | `left` |
| `vertical_offset` | `370` |
| `vertical_align` | `bottom` |
| `back_color` | `#00000099` |
| `back_radius` | `30` |
| `back_width` | `305` |
| `back_height` | `105` |
The below is an example config.yml extract with some Template Variables added in to change how the file works.
```yaml
libraries:
TV Shows:
overlay_path:
- pmm: network
template_variables:
vertical_offset: 390
- pmm: network
template_variables:
vertical_offset: 390
overlay_level: season
- pmm: network
template_variables:
vertical_offset: 390
overlay_level: episode
```
Write Preview
Loading…
Cancel
Save