From 172e685629a28cd00710bc78b8e9e0b58d4b9126 Mon Sep 17 00:00:00 2001 From: YozoraXCII <96386153+YozoraXCII@users.noreply.github.com> Date: Wed, 10 Jan 2024 15:26:11 +0000 Subject: [PATCH 1/5] fix bad example of `reset_overlays` and amend incorrect statements on what some template variables do. --- CHANGELOG | 1 + docs/defaults/collections.md | 2 +- docs/defaults/guide.md | 4 +++- docs/pmm/faqs.md | 3 ++- 4 files changed, 7 insertions(+), 3 deletions(-) diff --git a/CHANGELOG b/CHANGELOG index 2c6d99f9..4f488e0e 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -9,6 +9,7 @@ Updated lxml requirement to 5.1.0 # Bug Fixes Fixed the Rate Limit on MDbList calls +- Users who do not have VIP status on MDBList will be limited to 1 request per second. Users with VIP status are limited to 5 requests per second Fixed collection fields being locked during batch edits when they shouldn't be. Various other Minor Fixes diff --git a/docs/defaults/collections.md b/docs/defaults/collections.md index 816d7b1b..a1747dcc 100644 --- a/docs/defaults/collections.md +++ b/docs/defaults/collections.md @@ -112,7 +112,7 @@ This is the default PMM collection ordering: 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. +This example disables two keys, which will prevent those collections from being created. It also sets the visibility of one of the keys so that it is visible on the library tab, the server owner's homescreen and shared user's homescreens (assuming they server owner and/or the shared users have the library pinned to their homescreen) ```yaml libraries: diff --git a/docs/defaults/guide.md b/docs/defaults/guide.md index 530f106f..a49642fc 100644 --- a/docs/defaults/guide.md +++ b/docs/defaults/guide.md @@ -39,7 +39,9 @@ libraries: 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. +For collections, this example disables two keys, which will prevent those collections from being created. It also sets the visibility of one of the keys so that it is visible on the library tab, the server owner's homescreen and shared user's homescreens (assuming they server owner and/or the shared users have the library pinned to their homescreen) + +For overlays, this example changes the ratings overlay to apply to episodes rather than shows. ```yaml libraries: diff --git a/docs/pmm/faqs.md b/docs/pmm/faqs.md index 0bcfa09e..f1e04806 100644 --- a/docs/pmm/faqs.md +++ b/docs/pmm/faqs.md @@ -447,13 +447,14 @@ With the release of PMM 1.20, several changes have taken place that we would lik Movies: remove_overlays: false reapply_overlays: false #(1)! - reset_overlays: false + # reset_overlays: plex #(2)! schedule_overlays: daily overlay_files: - pmm: audio_codec ``` 1. We strongly advise never setting this to `true` as it can cause [Image Bloat](scripts/image-cleanup.md) + 2. This is purely an example, you do not need to specify `reset_overlays` or any of these attributes unless you specifically need to use them. ??? blank "`imdb_list` no longer works for Title or Keyword search URLs (click to expand).ΒΆ" From 6b4f01cfa6c018a525d57a6a4e9cb7d0517ae172 Mon Sep 17 00:00:00 2001 From: YozoraXCII <96386153+YozoraXCII@users.noreply.github.com> Date: Wed, 10 Jan 2024 15:30:12 +0000 Subject: [PATCH 2/5] amend wording on changelog --- CHANGELOG | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG b/CHANGELOG index 4f488e0e..3baa5c02 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -9,7 +9,7 @@ Updated lxml requirement to 5.1.0 # Bug Fixes Fixed the Rate Limit on MDbList calls -- Users who do not have VIP status on MDBList will be limited to 1 request per second. Users with VIP status are limited to 5 requests per second +- As per Mdblist's limitations, users who do not have VIP status on MDBList will be limited to 1 request per second and users who do have VIP status are limited to 5 requests per second - users may notice that this slows down mass operations as we now abide by these restrictions to avoid the user being rate limited. Fixed collection fields being locked during batch edits when they shouldn't be. Various other Minor Fixes From ddf3aa8d18dcdef3ad2ee498a5cc69d2f7ab48c2 Mon Sep 17 00:00:00 2001 From: YozoraXCII <96386153+YozoraXCII@users.noreply.github.com> Date: Wed, 10 Jan 2024 15:30:54 +0000 Subject: [PATCH 3/5] bad capitalization --- CHANGELOG | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG b/CHANGELOG index 3baa5c02..2b7f07ac 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -9,7 +9,7 @@ Updated lxml requirement to 5.1.0 # Bug Fixes Fixed the Rate Limit on MDbList calls -- As per Mdblist's limitations, users who do not have VIP status on MDBList will be limited to 1 request per second and users who do have VIP status are limited to 5 requests per second - users may notice that this slows down mass operations as we now abide by these restrictions to avoid the user being rate limited. +- As per MDBList's limitations, users who do not have VIP status on MDBList will be limited to 1 request per second and users who do have VIP status are limited to 5 requests per second - users may notice that this slows down mass operations as we now abide by these restrictions to avoid the user being rate limited. Fixed collection fields being locked during batch edits when they shouldn't be. Various other Minor Fixes From 84748fcd066f7003f4aa07ebac9255ccc2d1a28d Mon Sep 17 00:00:00 2001 From: YozoraXCII <96386153+YozoraXCII@users.noreply.github.com> Date: Thu, 11 Jan 2024 13:19:17 +0000 Subject: [PATCH 4/5] amend `overlay_path` reference in config.yml.example, closes #1819 --- config/config.yml.template | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/config/config.yml.template b/config/config.yml.template index 7735c9c3..ff18ef30 100644 --- a/config/config.yml.template +++ b/config/config.yml.template @@ -6,7 +6,7 @@ libraries: # This is called out once within the config.yml - pmm: basic # This is a file within PMM's defaults folder - pmm: imdb # This is a file within PMM's defaults folder # see the wiki for how to use local files, folders, URLs, or files from git - overlay_path: + overlay_files: - remove_overlays: false # Set this to true to remove all overlays - pmm: ribbon # This is a file within PMM's defaults folder # see the wiki for how to use local files, folders, URLs, or files from git @@ -15,7 +15,7 @@ libraries: # This is called out once within the config.yml - pmm: basic # This is a file within PMM's defaults folder - pmm: imdb # This is a file within PMM's defaults folder # see the wiki for how to use local files, folders, URLs, or files from git - overlay_path: + overlay_files: - remove_overlays: false # Set this to true to remove all overlays - pmm: ribbon # This is a file within PMM's defaults folder # see the wiki for how to use local files, folders, URLs, or files from git From b2469ae9c704dd7b9b296e35498a384f7b54a7ec Mon Sep 17 00:00:00 2001 From: YozoraXCII <96386153+YozoraXCII@users.noreply.github.com> Date: Thu, 11 Jan 2024 13:33:13 +0000 Subject: [PATCH 5/5] Fix bad grammar "Utill" --- docs/config/libraries.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/config/libraries.md b/docs/config/libraries.md index 5c0defd0..4160582b 100644 --- a/docs/config/libraries.md +++ b/docs/config/libraries.md @@ -271,7 +271,7 @@ The available attributes for each library are as follows: ???+ warning "Proceed with Caution" - Utill set to `false` or removed this will remove all overlays from your library every run, but will not delete + When set to `true`, this will remove all overlays from your library every run, but will not delete the overlaid images from your system, resulting in [image bloat](../pmm/scripts/image-cleanup.md).
@@ -300,7 +300,7 @@ The available attributes for each library are as follows: ???+ warning "Proceed with Caution" - Utill set to `false` or removed this will reapply all overlays on each run, which will result in + When set to `true`, this will reapply all overlays on each run even if there is no need to do so, which will result in [image bloat](../pmm/scripts/image-cleanup.md).
@@ -330,7 +330,7 @@ The available attributes for each library are as follows: ???+ warning "Proceed with Caution" - Utill set to `false` or removed this will reset all posters to the desired source on each run and will reapply + This will reset all posters to the desired source on each run and will reapply all overlays on each run, which will result in [image bloat](../pmm/scripts/image-cleanup.md).