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

[63] doc update

Browse Source
pull/1448/head
meisnate12 2 years ago
parent 9cf625d007
commit 6e54003b0d
7 changed files with 36 additions and 31 deletions
Show Stats Download Patch File Download Diff File

2
VERSION
Unescape View File

@ -1 +1 @@
1.19.0-develop62 1.19.0-develop63

2
defaults/chart/flixpatrol.yml
Unescape View File

@ -39,7 +39,7 @@ dynamic_collections:
data: data:
netflix: Netflix netflix: Netflix
disney: Disney+ disney: Disney+
max: MAX max: Max
hulu: Hulu hulu: Hulu
paramount: Paramount+ paramount: Paramount+
prime: Prime Video prime: Prime Video

2
docs/defaults/collection_variables.md
Unescape View File

@ -12,7 +12,7 @@ Below are the available variables which can be used to customize the file.
| `use_<<key>>`<sup>1</sup> | **Description:** Turns off individual Collections in a Defaults file.<br>**Values:** `false` to turn off the collection | | `use_<<key>>`<sup>1</sup> | **Description:** Turns off individual Collections in a Defaults file.<br>**Values:** `false` to turn off the collection |
| `name_<<key>>`<sup>1</sup> | **Description:** Changes the name of the specified key's collection.<br>**Values:** New Collection Name | | `name_<<key>>`<sup>1</sup> | **Description:** Changes the name of the specified key's collection.<br>**Values:** New Collection Name |
| `summary_<<key>>`<sup>1</sup> | **Description:** Changes the summary of the specified key's collection.<br>**Values:** New Collection Summary | | `summary_<<key>>`<sup>1</sup> | **Description:** Changes the summary of the specified key's collection.<br>**Values:** New Collection Summary |
| `collection_section` | **Description:** Changes the sort order of the collection sections against other default collection sections.<br>**Values:** Any number | | `collection_section` | **Description:** Changes the sort order of the collection sections against other default collection sections. (Use quotes to not lose leading zeros `"05"`)<br>**Values:** Any number |
| `sort_prefix` | **Description:** Changes the prefix of the sort title.<br>**Default:** `!`<br>**Values:** Any String | | `sort_prefix` | **Description:** Changes the prefix of the sort title.<br>**Default:** `!`<br>**Values:** Any String |
| `sort_title` | **Description:** Changes the sort title of all collections.<br>**Default:** `<<sort_prefix>><<collection_section>><<pre>><<order_<<key>>>><<title>>`<br>**Values:** Any String | | `sort_title` | **Description:** Changes the sort title of all collections.<br>**Default:** `<<sort_prefix>><<collection_section>><<pre>><<order_<<key>>>><<title>>`<br>**Values:** Any String |
| `name_mapping` | **Description:** Changes the `name_mapping` of all collections.<br>**Default:** `<<title>>`<br>**Values:** Any String with `<<key_name>>` in it. | | `name_mapping` | **Description:** Changes the `name_mapping` of all collections.<br>**Default:** `<<title>>`<br>**Values:** Any String with `<<key_name>>` in it. |

49
docs/defaults/overlays/ratings.md
Unescape View File

@ -84,29 +84,32 @@ All [Shared Overlay Variables](../overlay_variables) can be appended by `rating1
| `back_radius` | `30` | | `back_radius` | `30` |
| `back_height` | `105` | | `back_height` | `105` |
| Variable | Description & Values | | Variable | Description & Values |
|:-----------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |:-----------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `rating1` | **Description:** Choose the rating to display in rating1.<br>**Values:** `critic`, `audience`, or `user` | | `rating1` | **Description:** Choose the rating to display in rating1.<br>**Values:** `critic`, `audience`, or `user` |
| `rating1_image` | **Description:** Choose the rating image to display in rating1.<br>**Values:** `anidb`, `imdb`, `letterboxd`, `tmdb`, `metacritic`, `rt_popcorn`, `rt_tomato`, `trakt`, `mal`, `mdb`, or `star` | | `rating1_image` | **Description:** Choose the rating image to display in rating1.<br>**Values:** `anidb`, `imdb`, `letterboxd`, `tmdb`, `metacritic`, `rt_popcorn`, `rt_tomato`, `trakt`, `mal`, `mdb`, or `star` |
| `rating2` | **Description:** Choose the rating to display in rating2.<br>**Values:** `critic`, `audience`, or `user` | | `rating1_style` | **Description:** Choose the rating number style for rating1.<br>**Values:** <table><tr><td>Ten Scale</td><td><code>""</code></td><td><code>8.7</code>, <code>9.0</code></td>/tr><tr><td>Ten Scale removing <code>.0</code></td><td><code>"#"</code></td><td><code>8.7</code>, <code>9</code></td>/tr><tr><td>Hundred Scale</td><td><code>"%"</code></td><td><code>87</code>, <code>90</code></td>/tr><tr><td>Five Scale</td><td><code>"/"</code></td><td><code>8.6</code> rating in plex will show as <code>4.3</code> on the overlay</td>/tr></table> |
| `rating2_image` | **Description:** Choose the rating image to display in rating2.<br>**Values:** `anidb`, `imdb`, `letterboxd`, `tmdb`, `metacritic`, `rt_popcorn`, `rt_tomato`, `trakt`, `mal`, `mdb`, or `star` | | `rating2` | **Description:** Choose the rating to display in rating2.<br>**Values:** `critic`, `audience`, or `user` |
| `rating3` | **Description:** Choose the rating to display in rating3.<br>**Values:** `critic`, `audience`, or `user` | | `rating2_image` | **Description:** Choose the rating image to display in rating2.<br>**Values:** `anidb`, `imdb`, `letterboxd`, `tmdb`, `metacritic`, `rt_popcorn`, `rt_tomato`, `trakt`, `mal`, `mdb`, or `star` |
| `rating3_image` | **Description:** Choose the rating image to display in rating3.<br>**Values:** `anidb`, `imdb`, `letterboxd`, `tmdb`, `metacritic`, `rt_popcorn`, `rt_tomato`, `trakt`, `mal`, `mdb`, or `star` | | `rating2_style` | **Description:** Choose the rating number style for rating2.<br>**Values:** <table><tr><td>Ten Scale</td><td><code>""</code></td><td><code>8.7</code>, <code>9.0</code></td>/tr><tr><td>Ten Scale removing <code>.0</code></td><td><code>"#"</code></td><td><code>8.7</code>, <code>9</code></td>/tr><tr><td>Hundred Scale</td><td><code>"%"</code></td><td><code>87</code>, <code>90</code></td>/tr><tr><td>Five Scale</td><td><code>"/"</code></td><td><code>8.6</code> rating in plex will show as <code>4.3</code> on the overlay</td>/tr></table> |
| `horizontal_position` | **Description:** Choose the horizontal position for the rating group.<br>**Default:** `left`<br>**Values:** `left`, `right`, or `center` | | `rating3` | **Description:** Choose the rating to display in rating3.<br>**Values:** `critic`, `audience`, or `user` |
| `vertical_position` | **Description:** Choose the vertical position for the rating group.<br>**Default:** `center`<br>**Values:** `top`, `bottom`, or `center` | | `rating3_image` | **Description:** Choose the rating image to display in rating3.<br>**Values:** `anidb`, `imdb`, `letterboxd`, `tmdb`, `metacritic`, `rt_popcorn`, `rt_tomato`, `trakt`, `mal`, `mdb`, or `star` |
| `rating_alignment` | **Description:** Choose the display alignment for the rating group.<br>**Default:** `vertical`<br>**Values:** `horizontal`, or `vertical` | | `rating3_style` | **Description:** Choose the rating number style for rating3.<br>**Values:** <table><tr><td>Ten Scale</td><td><code>""</code></td><td><code>8.7</code>, <code>9.0</code></td>/tr><tr><td>Ten Scale removing <code>.0</code></td><td><code>"#"</code></td><td><code>8.7</code>, <code>9</code></td>/tr><tr><td>Hundred Scale</td><td><code>"%"</code></td><td><code>87</code>, <code>90</code></td>/tr><tr><td>Five Scale</td><td><code>"/"</code></td><td><code>8.6</code> rating in plex will show as <code>4.3</code> on the overlay</td>/tr></table> |
| `minimum_rating` | **Description:** Minimum Rating to display<br>**Default:** 0.0<br>**Values:** Any Number | | `horizontal_position` | **Description:** Choose the horizontal position for the rating group.<br>**Default:** `left`<br>**Values:** `left`, `right`, or `center` |
| `fresh_rating` | **Description:** Determines when ratings are considered Fresh<br>**Default:** 6.0<br>**Values:** Any Number | | `vertical_position` | **Description:** Choose the vertical position for the rating group.<br>**Default:** `center`<br>**Values:** `top`, `bottom`, or `center` |
| `maximum_rating` | **Description:** Maximum Rating to display<br>**Default:** 10.0<br>**Values:** Any Number | | `rating_alignment` | **Description:** Choose the display alignment for the rating group.<br>**Default:** `vertical`<br>**Values:** `horizontal`, or `vertical` |
| `font`<sup>1</sup> | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Bold.ttf`<br>**Values:** Path to font file | | `minimum_rating` | **Description:** Minimum Rating to display<br>**Default:** 0.0<br>**Values:** Any Number |
| `font_style`<sup>1</sup> | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style | | `fresh_rating` | **Description:** Determines when ratings are considered Fresh<br>**Default:** 6.0<br>**Values:** Any Number |
| `font_size`<sup>1</sup> | **Description:** Choose the font size for the Overlay.<br>**Default:** `63`<br>**Values:** Any Number greater then 0 | | `maximum_rating` | **Description:** Maximum Rating to display<br>**Default:** 10.0<br>**Values:** Any Number |
| `font_color`<sup>1</sup> | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` | | `font`<sup>1</sup> | **Description:** Choose the font for the Overlay.<br>**Default:** `fonts/Inter-Bold.ttf`<br>**Values:** Path to font file |
| `stroke_width`<sup>1</sup> | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any Number greater then 0 | | `font_style`<sup>1</sup> | **Description:** Font style for Variable Fonts.<br>**Values:** Variable Font Style |
| `stroke_color`<sup>1</sup> | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` | | `font_size`<sup>1</sup> | **Description:** Choose the font size for the Overlay.<br>**Default:** `63`<br>**Values:** Any Number greater then 0 |
| `addon_offset`<sup>1</sup> | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any Number greater then 0 | | `font_color`<sup>1</sup> | **Description:** Choose the font color for the Overlay.<br>**Default:** `#FFFFFF`<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
| `addon_position`<sup>1</sup> | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `left`<br>**Values:** `left`, `right`, `top`, `bottom` | | `stroke_width`<sup>1</sup> | **Description:** Font Stroke Width for the Text Overlay.<br>**Values:** Any Number greater then 0 |
| `builder_level` | **Description:** Choose the Overlay Level.<br>**Values:** `episode` | | `stroke_color`<sup>1</sup> | **Description:** Font Stroke Color for the Text Overlay.<br>**Values:** Color Hex Code in format `#RGB`, `#RGBA`, `#RRGGBB` or `#RRGGBBAA` |
| `addon_offset`<sup>1</sup> | **Description:** Text Addon Image Offset from the text.<br>**Default:** `15`<br>**Values:** Any Number greater then 0 |
| `addon_position`<sup>1</sup> | **Description:** Text Addon Image Alignment in relation to the text.<br>**Default:** `left`<br>**Values:** `left`, `right`, `top`, `bottom` |
| `builder_level` | **Description:** Choose the Overlay Level.<br>**Values:** `episode` |
1. These Variables can be appended by `rating1_`, `rating2_`, or `rating3_` to change that attribute on each rating individually. 1. These Variables can be appended by `rating1_`, `rating2_`, or `rating3_` to change that attribute on each rating individually.

2
docs/metadata/overlay.md
Unescape View File

@ -8,7 +8,7 @@ All overlay coordinates assume 1000 x 1500 for Posters and 1920 x 1080 for Backg
**To remove all overlays add `remove_overlays: true` to the `overlay_path` [Libraries Attribute](../config/libraries.md#remove-overlays).** **To remove all overlays add `remove_overlays: true` to the `overlay_path` [Libraries Attribute](../config/libraries.md#remove-overlays).**
**IMPORTANT NOTE ON OVERLAYS:** Once you have applied overlays to your posters in PLex, it is highly recommended that you never change artwork on a thing directly in Plex again. PMM uses labels on the items in Plex to decide if an overlays has been applied, so if you change artwork behind PMM's back things can become confused and items can end up with double-overlaid posters. It's recommended to set new artwork using the asset directory, which will ensure that this doesn't happen. **IMPORTANT NOTE ON OVERLAYS:** Once you have applied overlays to your posters in Plex, it is highly recommended that you never change artwork on a thing directly in Plex again. PMM uses labels on the items in Plex to decide if an overlay has been applied, so if you change artwork behind PMM's back things can become confused and items can end up with double-overlaid posters. It's recommended to set new artwork using the asset directory, which will ensure that this doesn't happen.
**To change a single overlay original image either remove the `Overlay` shared label and update the Image in Plex or replace the image in the assets folder and then PMM will overlay the new image** **To change a single overlay original image either remove the `Overlay` shared label and update the Image in Plex or replace the image in the assets folder and then PMM will overlay the new image**

4
modules/builder.py
Unescape View File

@ -1132,7 +1132,9 @@ class CollectionBuilder:
self.beginning_count = len(self.remove_item_map) if self.playlist else self.obj.childCount self.beginning_count = len(self.remove_item_map) if self.playlist else self.obj.childCount
else: else:
self.obj = None self.obj = None
self.sync = False if self.sync:
logger.warning(f"{self.Type} Error: Sync Mode can only be append when using build_collection: false")
self.sync = False
self.run_again = False self.run_again = False
if self.non_existing is not False and self.obj: if self.non_existing is not False and self.obj:
raise NotScheduled(self.non_existing) raise NotScheduled(self.non_existing)

6
requirements.txt
Unescape View File

@ -2,13 +2,13 @@ arrapi==1.4.2
GitPython==3.1.31 GitPython==3.1.31
lxml==4.9.2 lxml==4.9.2
num2words==0.5.12 num2words==0.5.12
pathvalidate==2.5.2 pathvalidate==3.0.0
pillow==9.5.0 pillow==9.5.0
PlexAPI==4.13.4 PlexAPI==4.14.0
psutil==5.9.5 psutil==5.9.5
python-dotenv==1.0.0 python-dotenv==1.0.0
requests==2.31.0 requests==2.31.0
retrying==1.3.4 retrying==1.3.4
ruamel.yaml==0.17.27 ruamel.yaml==0.17.31
schedule==1.2.0 schedule==1.2.0
tmdbapis==1.2.0 tmdbapis==1.2.0
Write Preview
Loading…
Cancel
Save