Skip to content

Commit

Permalink
[12] update overlay doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@meisnate12
meisnate12 committed Jul 28, 2022
1 parent c0a3723 commit 1f2f9bd
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 17 deletions.
2 changes: 1 addition & 1 deletion VERSION
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.17.2-develop11
1.17.2-develop12
31 changes: 15 additions & 16 deletions docs/metadata/overlay.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<<name>>` and some can have modifiers like so `<<name$>>` where `$` is the modifier. The available options are:

| Special Text Variables | Format Variables & Mods | Movies | Shows | Seasons | Episodes |
|:-----------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------:|:--------:|:--------:|:--------:|
| audience_rating | `<<audience_rating>>`: audience rating (`8.7`, `9.0`)<br>`<<audience_rating%>>`: audience rating out of 100 (`87`, `90`)<br>`<<audience_rating#>>`: audience rating removing `.0` as needed (`8.7`, `9`) | &#9989; | &#9989; | &#10060; | &#9989; |
| critic_rating | `<<critic_rating>>`: critic rating (`8.7`, `9.0`)<br>`<<critic_rating%>>`: critic rating out of 100 (`87`, `90`)<br>`<<critic_rating#>>`: critic rating removing `.0` as needed (`8.7`, `9`) | &#9989; | &#9989; | &#10060; | &#9989; |
| user_rating | `<<user_rating>>`: user rating (`8.7`, `9.0`)<br>`<<user_rating%>>`: user rating out of 100 (`87`, `90`)<br>`<<user_rating#>>`: user rating removing `.0` as needed (`8.7`, `9`) | &#9989; | &#9989; | &#9989; | &#9989; |
| title | `<<title>>`: Title of the Item | &#9989; | &#9989; | &#9989; | &#9989; |
| show_title | `<<show_title>>`: Title of the Item's Show | &#10060; | &#10060; | &#9989; | &#9989; |
| season_title | `<<season_title>>`: Title of the Item's Season | &#10060; | &#10060; | &#10060; | &#9989; |
| original_title | `<<original_title>>`: Original Title of the Item | &#9989; | &#9989; | &#10060; | &#10060; |
| content_rating | `<<content_rating>>`: Content Rating of the Item | &#9989; | &#9989; | &#10060; | &#9989; |
| 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`) | &#10060; | &#9989; | &#9989; | &#10060; |
| 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`) | &#10060; | &#10060; | &#9989; | &#9989; |
| 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`) | &#10060; | &#10060; | &#10060; | &#9989; |
| 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 | &#9989; | &#10060; | &#10060; | &#9989; |
| 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/) | &#9989; | &#9989; | &#10060; | &#9989; |

| 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`) | &#9989; | &#9989; | &#10060; | &#9989; |
| `<<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`) | &#9989; | &#9989; | &#10060; | &#9989; |
| `<<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`) | &#9989; | &#9989; | &#9989; | &#9989; |
| `<<title>>` | Title of the Item | &#9989; | &#9989; | &#9989; | &#9989; |
| `<<show_title>>` | Title of the Item's Show | &#10060; | &#10060; | &#9989; | &#9989; |
| `<<season_title>>` | Title of the Item's Season | &#10060; | &#10060; | &#10060; | &#9989; |
| `<<original_title>>` | Original Title of the Item | &#9989; | &#9989; | &#10060; | &#10060; |
| `<<content_rating>>` | Content Rating of the Item | &#9989; | &#9989; | &#10060; | &#9989; |
| `<<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`) | &#10060; | &#9989; | &#9989; | &#10060; |
| `<<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`) | &#10060; | &#10060; | &#9989; | &#9989; |
| `<<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`) | &#10060; | &#10060; | &#10060; | &#9989; |
| `<<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 | &#9989; | &#10060; | &#10060; | &#9989; |
| `<<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/) | &#9989; | &#9989; | &#10060; | &#9989; |

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.

Expand Down

0 comments on commit 1f2f9bd

Please sign in to comment.