2023-05-20 18:55:10 +00:00
|
|
|
# Studio Overlay
|
|
|
|
|
2024-01-07 08:07:13 +00:00
|
|
|
The `studio` Default Overlay File is used to create an overlay based on the show studio on each item within your
|
|
|
|
library.
|
2023-05-20 18:55:10 +00:00
|
|
|
|
|
|
|
![](images/studio.png)
|
|
|
|
|
|
|
|
## Requirements & Recommendations
|
|
|
|
|
|
|
|
Supported library types: Movie / Show
|
|
|
|
|
2024-01-07 08:07:13 +00:00
|
|
|
### Bigger Style
|
|
|
|
|
|
|
|
Below is a screenshot of the alternative White (`bigger`) style which can be set via the `style` template variable.
|
|
|
|
|
|
|
|
![](images/studio_bigger.jpg)
|
|
|
|
|
2023-05-20 18:55:10 +00:00
|
|
|
## 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:
|
2024-04-22 14:20:12 +00:00
|
|
|
- default: studio
|
2023-05-20 18:55:10 +00:00
|
|
|
TV Shows:
|
2023-12-12 22:03:15 +00:00
|
|
|
overlay_files:
|
2024-04-22 14:20:12 +00:00
|
|
|
- default: studio
|
2023-05-20 18:55:10 +00:00
|
|
|
```
|
|
|
|
|
2023-12-31 16:45:00 +00:00
|
|
|
## Template Variables
|
2023-05-20 18:55:10 +00:00
|
|
|
|
2024-01-07 08:07:13 +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
|
|
|
|
2024-01-07 08:07:13 +00:00
|
|
|
Note that the `template_variables:` section only needs to be used if you do want to actually change how the defaults
|
|
|
|
work. Any value not specified will use its default value if it has one if not it's just ignored.
|
2023-12-31 16:45:00 +00:00
|
|
|
|
2024-01-07 08:07:13 +00:00
|
|
|
??? abstract "Variable Lists (click to expand)"
|
|
|
|
|
2024-04-22 14:20:12 +00:00
|
|
|
* **File-Specific Template Variables** are variables available specifically for this Kometa Defaults file.
|
2024-01-07 08:07:13 +00:00
|
|
|
|
2024-04-22 14:20:12 +00:00
|
|
|
* **Overlay Template Variables** are additional variables shared across the Kometa Overlay Defaults.
|
2023-12-31 16:45:00 +00:00
|
|
|
|
2024-01-05 21:55:28 +00:00
|
|
|
??? example "Default Template Variable Values (click to expand)"
|
2024-01-05 21:06:39 +00:00
|
|
|
|
|
|
|
| Variable | Default |
|
|
|
|
|:--------------------|:------------|
|
|
|
|
| `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-12-31 16:45:00 +00:00
|
|
|
=== "File-Specific Template Variables"
|
|
|
|
|
2024-01-05 21:06:39 +00:00
|
|
|
| Variable | Description & Values |
|
|
|
|
|:----------------|:-------------------------------------------------------------------------------------------------|
|
|
|
|
| `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-12-31 16:45:00 +00:00
|
|
|
|
|
|
|
=== "Overlay Template Variables"
|
|
|
|
|
|
|
|
{%
|
|
|
|
include-markdown "../overlay_variables.md"
|
|
|
|
%}
|
2024-01-07 08:07:13 +00:00
|
|
|
|
|
|
|
???+ example "Example Template Variable Amendments"
|
2023-12-31 16:45:00 +00:00
|
|
|
|
|
|
|
The below is an example config.yml extract with some Template Variables added in to change how the file works.
|
2024-01-07 08:07:13 +00:00
|
|
|
|
2023-12-31 16:45:00 +00:00
|
|
|
```yaml
|
|
|
|
libraries:
|
|
|
|
Movies:
|
|
|
|
overlay_files:
|
2024-04-22 14:20:12 +00:00
|
|
|
- default: studio
|
2023-12-31 16:45:00 +00:00
|
|
|
template_variables:
|
|
|
|
vertical_offset: 390
|
|
|
|
TV Shows:
|
|
|
|
overlay_files:
|
2024-04-22 14:20:12 +00:00
|
|
|
- default: studio
|
|
|
|
- default: studio
|
2023-12-31 16:45:00 +00:00
|
|
|
template_variables:
|
|
|
|
builder_level: season
|
|
|
|
vertical_align: bottom
|
|
|
|
vertical_offset: 15
|
|
|
|
horizontal_align: left
|
|
|
|
horizontal_offset: 15
|
|
|
|
style: bigger
|
2024-04-22 14:20:12 +00:00
|
|
|
- default: studio
|
2023-12-31 16:45:00 +00:00
|
|
|
template_variables:
|
|
|
|
builder_level: episode
|
|
|
|
vertical_align: top
|
|
|
|
vertical_offset: 15
|
|
|
|
```
|