Merge remote-tracking branch 'origin/yell-about-reapply' into nightly

This commit is contained in:
meisnate12 2024-04-26 13:23:13 -04:00
commit 6ff18bc93f
3 changed files with 16 additions and 8 deletions

View file

@ -298,11 +298,17 @@ The available attributes for each library are as follows:
<div id="reapply-overlays" />Used to reapply overlays from this library only. This will reapply overlays to every item in your library. <div id="reapply-overlays" />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" ???+ 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 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). [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.
<hr style="margin: 0px;"> <hr style="margin: 0px;">
**Attribute:** `reapply_overlays` **Attribute:** `reapply_overlays`

View file

@ -47,7 +47,9 @@
- default: universe # Marvel Cinematic Universe, Wizarding World, etc. - default: universe # Marvel Cinematic Universe, Wizarding World, etc.
remove_overlays: false # Set to true if you want to remove overlays 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 #reset_overlays: tmdb # if you want to reset the poster to default poster from tmdb - can cause image bloat
overlay_files: overlay_files:

View file

@ -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. * `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: 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` * `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: 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` * `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. 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. * 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. 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) * 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: 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` * `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: When the above is run you should get: