2023-05-20 18:55:10 +00:00
|
|
|
# Studio Overlay
|
|
|
|
|
|
|
|
|
|
The `studio` Default Overlay File is used to create an overlay based on the show studio on each item within your library.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Requirements & Recommendations
|
|
|
|
|
|
|
|
|
|
Supported library types: Movie / Show
|
|
|
|
|
|
|
|
|
|
## Config
|
|
|
|
|
|
|
|
|
|
The below YAML in your config.yml will create the overlays:
|
|
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
libraries:
|
|
|
|
|
Movies:
|
2023-12-12 22:03:15 +00:00
|
|
|
overlay_files:
|
2023-05-20 18:55:10 +00:00
|
|
|
- pmm: studio
|
|
|
|
|
TV Shows:
|
2023-12-12 22:03:15 +00:00
|
|
|
overlay_files:
|
2023-05-20 18:55:10 +00:00
|
|
|
- pmm: studio
|
|
|
|
|
```
|
|
|
|
|
|
2023-11-29 15:23:04 +00:00
|
|
|
## Template Variable Default Values
|
2023-05-20 18:55:10 +00:00
|
|
|
|
2023-12-13 21:44:44 +00:00
|
|
|
Template Variables can be used to manipulate the file in various ways to slightly change how it works without having to make your own local copy.
|
2023-05-20 18:55:10 +00:00
|
|
|
|
2023-11-29 15:23:04 +00:00
|
|
|
| Variable | Default / Values |
|
2023-07-05 21:38:10 +00:00
|
|
|
|:--------------------|:-------------------------------------------------------------------------------------------------|
|
2023-11-29 15:23:04 +00:00
|
|
|
| `horizontal_offset` | `15` |
|
|
|
|
|
| `horizontal_align` | `left` |
|
|
|
|
|
| `vertical_offset` | `150` |
|
|
|
|
|
| `vertical_align` | `bottom` |
|
|
|
|
|
| `back_color` | `#00000099` |
|
|
|
|
|
| `back_radius` | `30` |
|
|
|
|
|
| `back_width` | `305` |
|
|
|
|
|
| `back_height` | `105` |
|
2023-07-05 21:38:10 +00:00
|
|
|
| `builder_level` | **Description:** Choose the Overlay Level.<br>**Values:** `season` or `episode` |
|
|
|
|
|
| `style` | **Description:** Choose between the standard size or the **bigger** one.<br>**Values:** `bigger` |
|
2023-07-04 16:49:02 +00:00
|
|
|
|
|
|
|
|
Preview of the bigger style
|
|
|
|
|
|
|
|
|
|
|
2023-05-20 18:55:10 +00:00
|
|
|
|
2023-11-29 15:23:04 +00:00
|
|
|
{%
|
|
|
|
|
include-markdown "../overlay_variables.md"
|
|
|
|
|
%}
|
|
|
|
|
|
|
|
|
|
## Example Template Variable Amendments
|
2023-05-20 18:55:10 +00:00
|
|
|
|
|
|
|
|
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
|
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
|
libraries:
|
|
|
|
|
Movies:
|
2023-12-12 22:03:15 +00:00
|
|
|
overlay_files:
|
2023-05-20 18:55:10 +00:00
|
|
|
- pmm: studio
|
|
|
|
|
template_variables:
|
|
|
|
|
vertical_offset: 390
|
|
|
|
|
TV Shows:
|
2023-12-12 22:03:15 +00:00
|
|
|
overlay_files:
|
2023-05-20 18:55:10 +00:00
|
|
|
- pmm: studio
|
|
|
|
|
- pmm: studio
|
|
|
|
|
template_variables:
|
|
|
|
|
builder_level: season
|
|
|
|
|
vertical_align: bottom
|
|
|
|
|
vertical_offset: 15
|
|
|
|
|
horizontal_align: left
|
|
|
|
|
horizontal_offset: 15
|
2023-07-04 16:49:02 +00:00
|
|
|
style: bigger
|
2023-05-20 18:55:10 +00:00
|
|
|
- pmm: studio
|
|
|
|
|
template_variables:
|
|
|
|
|
builder_level: episode
|
|
|
|
|
vertical_align: top
|
|
|
|
|
vertical_offset: 15
|
|
|
|
|
```
|
