From 62d41a4a91f9affcaf11ddc8588345cbdaf10fc6 Mon Sep 17 00:00:00 2001 From: Chaz Larson Date: Fri, 26 Apr 2024 09:09:48 -0500 Subject: [PATCH 1/3] Update example.md --- docs/defaults/example.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/defaults/example.md b/docs/defaults/example.md index 0864c4fe..48991f1f 100644 --- a/docs/defaults/example.md +++ b/docs/defaults/example.md @@ -47,7 +47,9 @@ - default: universe # Marvel Cinematic Universe, Wizarding World, etc. remove_overlays: false # Set to true if you want to remove overlays - reapply_overlays: false # If you are doing a lot of testing and changes like me, keep this to true to always reapply overlays - can cause image bloat + reapply_overlays: false # Set to true if you want to force-reapply overlays to everything + # THERE IS RARELY IF EVER A REASON TO DO THIS AS IT WILL EXTEND RUN TIMES ANS CAUSE IMAGE BLOAT + # IF YOU THINK YOU WANT TO DO THIS YOU ARE ALMOST CERTAINLY MISTAKEN #reset_overlays: tmdb # if you want to reset the poster to default poster from tmdb - can cause image bloat overlay_files: From 2fa5abc22eff717e5a1a40e2e80d525536c8c570 Mon Sep 17 00:00:00 2001 From: Chaz Larson Date: Fri, 26 Apr 2024 09:14:28 -0500 Subject: [PATCH 2/3] Update libraries.md --- docs/config/libraries.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/config/libraries.md b/docs/config/libraries.md index a7b16faa..7b8c9038 100644 --- a/docs/config/libraries.md +++ b/docs/config/libraries.md @@ -298,11 +298,17 @@ The available attributes for each library are as follows:
Used to reapply overlays from this library only. This will reapply overlays to every item in your library. + Note that this is typically NEVER required. Kometa will automatically update overlays as needed as part of a regular overlay run. + ???+ warning "Proceed with Caution" 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](../kometa/scripts/imagemaid.md). + If you think you need to use this setting, please think hard about why you have that impression, as you are almost certainly mistaken. + + In general use, this setting will only extend runtimes and cause image bloat in the Plex metadata for no good reason. +
**Attribute:** `reapply_overlays` From 27aa3b2d5d2b2b452ac40ab7966cfcede2189c1c Mon Sep 17 00:00:00 2001 From: Chaz Larson Date: Fri, 26 Apr 2024 09:17:34 -0500 Subject: [PATCH 3/3] Update ratings.md --- docs/kometa/guides/ratings.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/kometa/guides/ratings.md b/docs/kometa/guides/ratings.md index 4e66f7fb..a0747fc7 100644 --- a/docs/kometa/guides/ratings.md +++ b/docs/kometa/guides/ratings.md @@ -55,9 +55,9 @@ Now let's add rating overlays to the poster. We're going to use the minimal conf * `rating3` is set to be the user rating and it's image (`rating3_image`) is set to IMDb just because we have to pick something. - * `reapply_overlays` is set to true to ensure that Kometa always updates the overlays as we run things. + * `reapply_overlays` is set to true to ensure that Kometa always updates the overlays as we run things. This should NEVER be required in a typical scenario, it's being done here just as belt-and-suspender insurance. - * We do not recommend using `reapply_overlays: true` consistently in a live/production environment, make sure to switch this back to `false` when finished. + * `reapply_overlays: true` should NEVER be used in a live/production environment without a very specific reason, make sure to switch this back to `false` when finished. After Kometa is run on this library, you'll get this result: @@ -103,7 +103,7 @@ You and I both know that the IMDb rating isn't 6.0, but Kometa is just doing wha * `rating1_image` and `rating2_image` were both changed from `rt_score` and `rt_popcorn` respectively to `imdb` - * We do not recommend using `reapply_overlays: true` consistently in a live/production environment, make sure to switch this back to `false` when finished. + * `reapply_overlays: true` should NEVER be used in a live/production environment without a very specific reason, make sure to switch this back to `false` when finished. When the above is run you see this result: @@ -140,7 +140,7 @@ Now let's actually update the ratings and push some numbers into those boxes usi * `rating1_image` and `rating2_image` were both changed back to `rt_score` and `rt_popcorn` respectively from `imdb` - * We do not recommend using `reapply_overlays: true` consistently in a live/production environment, make sure to switch this back to `false` when finished. + * `reapply_overlays: true` should NEVER be used in a live/production environment without a very specific reason, make sure to switch this back to `false` when finished. This will put the actual IMDb rating value, retrieved from IMDb, into the "user" rating field. @@ -178,7 +178,7 @@ Now let's update the critic and audience ratings to some different ratings: * under `operations` the attribute `mass_critic_rating_update` set to `trakt_user` and `mass_audience_rating_update` set to `tmdb` are added. - * We do not recommend using `reapply_overlays: true` consistently in a live/production environment, make sure to switch this back to `false` when finished. + * `reapply_overlays: true` should NEVER be used in a live/production environment without a very specific reason, make sure to switch this back to `false` when finished. Running the above will put the Trakt User's personal rating into the critic box and the TMDb rating into the audience box. Note that we haven't changed the rating images yet. @@ -227,7 +227,7 @@ Let's change the Trakt rating to that trakt public rating of `85%` instead, whic * under `operations` the attribute `mass_critic_rating_update` was changed to `mdb_trakt` from `trakt_user`. (This step requires MDBList to be configured) - * We do not recommend using `reapply_overlays: true` consistently in a live/production environment, make sure to switch this back to `false` when finished. + * `reapply_overlays: true` should NEVER be used in a live/production environment without a very specific reason, make sure to switch this back to `false` when finished. When the above is run you should get: @@ -264,7 +264,7 @@ Now, finally, let's make the poster rating images match the numbers we put in th * `rating2_image` was changed to `tmdb` from `rt_popcorn` - * We do not recommend using `reapply_overlays: true` consistently in a live/production environment, make sure to switch this back to `false` when finished. + * `reapply_overlays: true` should NEVER be used in a live/production environment without a very specific reason, make sure to switch this back to `false` when finished. When the above is run you should get: