From 1f2f9bd2eabbd05c119af3edef6ae804c1572134 Mon Sep 17 00:00:00 2001 From: meisnate12 Date: Thu, 28 Jul 2022 01:05:09 -0400 Subject: [PATCH] [12] update overlay doc --- VERSION | 2 +- docs/metadata/overlay.md | 31 +++++++++++++++---------------- 2 files changed, 16 insertions(+), 17 deletions(-) diff --git a/VERSION b/VERSION index da0d6250..af386c0b 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.17.2-develop11 +1.17.2-develop12 diff --git a/docs/metadata/overlay.md b/docs/metadata/overlay.md index 4d84636b..c2e1a659 100644 --- a/docs/metadata/overlay.md +++ b/docs/metadata/overlay.md @@ -175,22 +175,21 @@ You can use the item's metadata to determine the text. You set the `name` to `te There are multiple Special Text Variables that can be used when formatting the text. The variables are defined like so `<>` and some can have modifiers like so `<>` where `$` is the modifier. The available options are: -| Special Text Variables | Format Variables & Mods | Movies | Shows | Seasons | Episodes | -|:-----------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------:|:--------:|:--------:|:--------:| -| audience_rating | `<>`: audience rating (`8.7`, `9.0`)
`<>`: audience rating out of 100 (`87`, `90`)
`<>`: audience rating removing `.0` as needed (`8.7`, `9`) | ✅ | ✅ | ❌ | ✅ | -| critic_rating | `<>`: critic rating (`8.7`, `9.0`)
`<>`: critic rating out of 100 (`87`, `90`)
`<>`: critic rating removing `.0` as needed (`8.7`, `9`) | ✅ | ✅ | ❌ | ✅ | -| user_rating | `<>`: user rating (`8.7`, `9.0`)
`<>`: user rating out of 100 (`87`, `90`)
`<>`: user rating removing `.0` as needed (`8.7`, `9`) | ✅ | ✅ | ✅ | ✅ | -| title | `<>`: Title of the Item | ✅ | ✅ | ✅ | ✅ | -| show_title | `<<show_title>>`: Title of the Item's Show | ❌ | ❌ | ✅ | ✅ | -| season_title | `<<season_title>>`: Title of the Item's Season | ❌ | ❌ | ❌ | ✅ | -| original_title | `<<original_title>>`: Original Title of the Item | ✅ | ✅ | ❌ | ❌ | -| content_rating | `<<content_rating>>`: Content Rating of the Item | ✅ | ✅ | ❌ | ✅ | -| episode_count | `<<episode_count>>`: Number of Episodes (`1`)<br>`<<episode_countW>`: Number of Episodes As Words (`One`)<br>`<<episode_count0>`: Number of Episodes With 10s Padding (`01`)<br>`<<episode_count00>>`: Number of Episodes With 100s Padding (`001`) | ❌ | ✅ | ✅ | ❌ | -| season_number | `<<season_number>>`: Season Number (`1`)<br>`<<season_numberW>`: Season Number As Words (`One`)<br>`<<season_number0>`: Season Number With 10s Padding (`01`)<br>`<<season_number00>>`: Season Number With 100s Padding (`001`) | ❌ | ❌ | ✅ | ✅ | -| episode_number | `<<episode_number>>`: Episode Number (`1`)<br>`<<episode_numberW>`: Episode Number As Words (`One`)<br>`<<episode_number0>`: Episode Number With 10s Padding (`01`)<br>`<<episode_number00>>`: Episode Number With 100s Padding (`001`) | ❌ | ❌ | ❌ | ✅ | -| runtime | `<<runtime>>`: Runtime of the Item in minutes<br>`<<runtimeH>>`: Hours in runtime of the Item<br>`<<runtimeM>>`: Minutes remaining in the hour in the runtime of the Item | ✅ | ❌ | ❌ | ✅ | -| originally_available | `<<originally_available>>`: Original Available Date of the Item<br>`<<originally_available[DATE_FORMAT_STRING]>>`: Original Available Date of the Item in the given format. [Format Options](https://strftime.org/) | ✅ | ✅ | ❌ | ✅ | - +| Special Text Variables & Mods | Description | Movies | Shows | Seasons | Episodes | +|:----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------:|:--------:|:--------:|:--------:| +| `<<audience_rating>>`<br>`<<audience_rating%>>`<br>`<<audience_rating#>>` | audience rating (`8.7`, `9.0`)<br>audience rating out of 100 (`87`, `90`)<br>audience rating removing `.0` as needed (`8.7`, `9`) | ✅ | ✅ | ❌ | ✅ | +| `<<critic_rating>>`<br>`<<critic_rating%>>`<br>`<<critic_rating#>>` | critic rating (`8.7`, `9.0`)<br>critic rating out of 100 (`87`, `90`)<br>critic rating removing `.0` as needed (`8.7`, `9`) | ✅ | ✅ | ❌ | ✅ | +| `<<user_rating>>`<br>`<<user_rating%>>`<br>`<<user_rating#>>` | user rating (`8.7`, `9.0`)<br>user rating out of 100 (`87`, `90`)<br>user rating removing `.0` as needed (`8.7`, `9`) | ✅ | ✅ | ✅ | ✅ | +| `<<title>>` | Title of the Item | ✅ | ✅ | ✅ | ✅ | +| `<<show_title>>` | Title of the Item's Show | ❌ | ❌ | ✅ | ✅ | +| `<<season_title>>` | Title of the Item's Season | ❌ | ❌ | ❌ | ✅ | +| `<<original_title>>` | Original Title of the Item | ✅ | ✅ | ❌ | ❌ | +| `<<content_rating>>` | Content Rating of the Item | ✅ | ✅ | ❌ | ✅ | +| `<<episode_count>>`<br>`<<episode_countW>`<br>`<<episode_count0>`<br>`<<episode_count00>` | Number of Episodes (`1`)<br>Number of Episodes As Words (`One`)<br>Number of Episodes With 10s Padding (`01`)<br>Number of Episodes With 100s Padding (`001`) | ❌ | ✅ | ✅ | ❌ | +| `<<season_number>>`<br>`<<season_numberW>`<br>`<<season_number0>`<br>`<<season_number00>` | Season Number (`1`)<br>Season Number As Words (`One`)<br>Season Number With 10s Padding (`01`)<br>Season Number With 100s Padding (`001`) | ❌ | ❌ | ✅ | ✅ | +| `<<episode_number>>`<br>`<<episode_numberW>`<br>`<<episode_number0>`<br>`<<episode_number00>` | Episode Number (`1`)<br>Episode Number As Words (`One`)<br>Episode Number With 10s Padding (`01`)<br>Episode Number With 100s Padding (`001`) | ❌ | ❌ | ❌ | ✅ | +| `<<runtime>>`<br>`<<runtimeH>>`<br>`<<runtimeM>>` | Runtime of the Item in minutes<br>Hours in runtime of the Item<br>Minutes remaining in the hour in the runtime of the Item | ✅ | ❌ | ❌ | ✅ | +| `<<originally_available>>`<br>`<<originally_available[FORMAT]>>` | Original Available Date of the Item<br>Original Available Date of the Item in the given format. [Format Options](https://strftime.org/) | ✅ | ✅ | ❌ | ✅ | Note: You can use the `mass_audience_rating_update` or `mass_critic_rating_update` [Library Operation](../config/operations) to update your plex ratings to various services like `tmdb`, `imdb`, `mdb`, `metacritic`, `letterboxd` and many more.