diff --git a/docs/defaults/overlays/ratings.md b/docs/defaults/overlays/ratings.md index 0861b04f..88f13cf4 100644 --- a/docs/defaults/overlays/ratings.md +++ b/docs/defaults/overlays/ratings.md @@ -15,7 +15,7 @@ ratings.** Kometa will automatically fetch the live rating from the selecte source (TMDb, IMDb, Trakt via MDBList, etc.) during the Overlays run. This means that **users no longer have to run Mass Rating Update operations to update the Plex ratings**. In effect, this detaches Plex's ratings system from the Ratings overlays. - In addition, Kometa will automatically select the best image to use based on the selected rating source that you have chosen. For example, if you define `rating1: imdb` then Kometa will automatically make the image for that rating `imdb`. **You no longer have to specify `ratingX_image` unless you want to override Kometa's image selection.** + In addition, Kometa will automatically select the best image to use based on the selected rating source that you have chosen. For example, if you define `rating1: imdb` then Kometa will automatically make the image for that rating `imdb`. **You no longer have to specify `ratingX_image` unless you want to override Kometa's default image selection.** ![](images/ratings_overlay.png) @@ -95,16 +95,16 @@ work. Any value not specified will use its default value if it has one if not it | Variable | Description & Values | |:-------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| - | `rating1` | **Description:** Choose the rating to display in rating1.
**Values:** `critic`, `audience`, `user`, `tmdb`, `imdb`, `trakt_user`, `omdb`, `mdb`, `mdb_average`, `mdb_imdb`, `mdb_metacritic`, `mdb_metacriticuser`, `mdb_trakt`, `mdb_tomatoes`, `mdb_tomatoesaudience`, `mdb_tmdb`, `mdb_letterboxd`, `mdb_myanimelist`, `anidb`, `anidb_average`, `anidb_score`, `mal` | - | `rating1_image` | **Description:** Choose the rating image to display in rating1.
**Values:** `critic`, `audience, `star`, `anidb`, `imdb`, `omdb`, `letterboxd`, `tmdb`, `metacritic`, `rt_popcorn`, `rt_tomato`, `trakt`, `mal`, `mdb`, or `star` | + | `rating1` | **Description:** Choose the rating to display in rating1.
**Values:**
Movies / Shows`critic`, `audience`, `user`, `tmdb`, `imdb`, `trakt_user`, `omdb`, `mdb`, `mdb_average`, `mdb_imdb`, `mdb_metacritic`, `mdb_metacriticuser`, `mdb_trakt`, `mdb_tomatoes`, `mdb_tomatoesaudience`, `mdb_tmdb`, `mdb_letterboxd`, `mdb_myanimelist`, `anidb`, `anidb_average`, `anidb_score`, `mal`
Episodes`critic`, `audience`, `user`, `tmdb`, `imdb`
| + | `rating1_image` | **Description:** Choose the rating image to display in rating1.
**Values:** `critic`, `audience`, `star`, `anidb`, `imdb`, `omdb`, `letterboxd`, `tmdb`, `metacritic`, `rt_popcorn`, `rt_tomato`, `trakt`, `mal`, `mdb`, or `star` | | `rating1_style` | **Description:** Choose the rating number style for rating1.
**Values:**
Ten Scale""8.7, 9.0
Ten Scale removing .0 "#"8.7, 9
Hundred Scale"%"87, 90
Five Scale"/"8.6 rating in plex will show as 4.3 on the overlay
| | `rating1_extra` | **Description:** Extra text after rating1.
**Default:** `%` for `rt_popcorn`, `rt_tomato`, `tmdb`.
**Values:** Any Value | - | `rating2` | **Description:** Choose the rating to display in rating2.
**Values:** `critic`, `audience`, `user`, `tmdb`, `imdb`, `trakt_user`, `omdb`, `mdb`, `mdb_average`, `mdb_imdb`, `mdb_metacritic`, `mdb_metacriticuser`, `mdb_trakt`, `mdb_tomatoes`, `mdb_tomatoesaudience`, `mdb_tmdb`, `mdb_letterboxd`, `mdb_myanimelist`, `anidb`, `anidb_average`, `anidb_score`, `mal` | - | `rating2_image` | **Description:** Choose the rating image to display in rating2.
**Values:** `critic`, `audience, `star`, `anidb`, `imdb`, `omdb`, `letterboxd`, `tmdb`, `metacritic`, `rt_popcorn`, `rt_tomato`, `trakt`, `mal`, `mdb`, or `star` | + | `rating2` | **Description:** Choose the rating to display in rating2.
**Values:**
Movies / Shows`critic`, `audience`, `user`, `tmdb`, `imdb`, `trakt_user`, `omdb`, `mdb`, `mdb_average`, `mdb_imdb`, `mdb_metacritic`, `mdb_metacriticuser`, `mdb_trakt`, `mdb_tomatoes`, `mdb_tomatoesaudience`, `mdb_tmdb`, `mdb_letterboxd`, `mdb_myanimelist`, `anidb`, `anidb_average`, `anidb_score`, `mal`
Episodes`critic`, `audience`, `user`, `tmdb`, `imdb`
| + | `rating2_image` | **Description:** Choose the rating image to display in rating2.
**Values:** `critic`, `audience`, `star`, `anidb`, `imdb`, `omdb`, `letterboxd`, `tmdb`, `metacritic`, `rt_popcorn`, `rt_tomato`, `trakt`, `mal`, `mdb`, or `star` | | `rating2_style` | **Description:** Choose the rating number style for rating2.
**Values:**
Ten Scale""8.7, 9.0
Ten Scale removing .0 "#"8.7, 9
Hundred Scale"%"87, 90
Five Scale"/"8.6 rating in plex will show as 4.3 on the overlay
| | `rating2_extra` | **Description:** Extra text after rating2.
**Default:** `%` for `rt_popcorn`, `rt_tomato`, `tmdb`.
**Values:** Any Value | - | `rating3` | **Description:** Choose the rating to display in rating3.
**Values:** `critic`, `audience`, `user`, `tmdb`, `imdb`, `trakt_user`, `omdb`, `mdb`, `mdb_average`, `mdb_imdb`, `mdb_metacritic`, `mdb_metacriticuser`, `mdb_trakt`, `mdb_tomatoes`, `mdb_tomatoesaudience`, `mdb_tmdb`, `mdb_letterboxd`, `mdb_myanimelist`, `anidb`, `anidb_average`, `anidb_score`, `mal` | - | `rating3_image` | **Description:** Choose the rating image to display in rating3.
**Values:** `critic`, `audience, `star`, `anidb`, `imdb`, `omdb`, `letterboxd`, `tmdb`, `metacritic`, `rt_popcorn`, `rt_tomato`, `trakt`, `mal`, `mdb`, or `star` | + | `rating3` | **Description:** Choose the rating to display in rating3.
**Values:**
Movies / Shows`critic`, `audience`, `user`, `tmdb`, `imdb`, `trakt_user`, `omdb`, `mdb`, `mdb_average`, `mdb_imdb`, `mdb_metacritic`, `mdb_metacriticuser`, `mdb_trakt`, `mdb_tomatoes`, `mdb_tomatoesaudience`, `mdb_tmdb`, `mdb_letterboxd`, `mdb_myanimelist`, `anidb`, `anidb_average`, `anidb_score`, `mal`
Episodes`critic`, `audience`, `user`, `tmdb`, `imdb`
| + | `rating3_image` | **Description:** Choose the rating image to display in rating3.
**Values:** `critic`, `audience`, `star`, `anidb`, `imdb`, `omdb`, `letterboxd`, `tmdb`, `metacritic`, `rt_popcorn`, `rt_tomato`, `trakt`, `mal`, `mdb`, or `star` | | `rating3_style` | **Description:** Choose the rating number style for rating3.
**Values:**
Ten Scale""8.7, 9.0
Ten Scale removing .0 "#"8.7, 9
Hundred Scale"%"87, 90
Five Scale"/"8.6 rating in plex will show as 4.3 on the overlay
| | `rating3_extra` | **Description:** Extra text after rating3.
**Default:** `%` for `rt_popcorn`, `rt_tomato`, `tmdb`.
**Values:** Any Value | | `horizontal_position` | **Description:** Choose the horizontal position for the rating group.
**Default:** `left`
**Values:** `left`, `right`, or `center` | @@ -141,7 +141,7 @@ work. Any value not specified will use its default value if it has one if not it include-markdown "../overlay_text_variables.md" %} -???+ example "Example Template Variable Amendments" +??? example "Example Template Variable Amendments" The below is an example config.yml extract with some Template Variables added in to change how the file works.