Skip to content

TintedFrameTitleCard

Jump to bottom
Collin Heist edited this page Dec 28, 2023 · 16 revisions

Background

These cards feature a rectangular frame with blurred content on the outside, and unblurred content within. The frame itself is intersected by the title text, index (season/episode) text, and/or a logo at the top and bottoms.

This card type is used whenever card_type is specified as tinted frame, or blurred border.

Example

Spoiler

Blurred

Mask Images

This card will also automatically search for "mask" images when creating cards. These mask images are be applied after the text, frame, and logo are drawn on the card. This can be used to give the appearance of a part of the image extending beyond the frame itself. For example:

The applied mask image is search for under the name of {filename}-mask.png - e.g. s1e1-mask.png - in the source directory.

Example Mask Image

The above example image uses the following mask:

Valid extras

Below is a table of all valid series extras parsed by this card. These are described in greater detail below.

Label Default Value Description
top_element title What to show at the top of the frame
middle_element omit Whether to show the logo or nothing in the middle of the frame
bottom_element index Whether to show at the bottom of the frame
episode_text_color Matches font color Color to utilize for the episode text
episode_text_font Default Font file to use for the episode text
episode_text_font_size 1.0 Scalar of the size of the episode text
episode_text_vertical_shift 0 How many pixels to vertically shift the episode text
frame_color Matches font color Color of the frame
frame_width 3 How many pixels thick the frame is
separator - Character to separate the season and episode text (if enabled)
logo - Logo file to show on the bottom of the frame (if enabled)
logo_size 1.0 Scalar of the size of the logo (if enabled)
logo_vertical_shift 0 How many pixels to vertically shift the logo (if provided)
blur_edges true Whether to blue the edges beyond the Frame
shadow_color black Color of the drop shadows

Customization

Top and Bottom Element

The element at the top and bottom of the frame can be adjusted. By default, top_element is title - meaning the title text will be written; while bottom_element is index - meaning the season/episode text will be written. These can be title to place the title text, index to place the season/episode text, logo (if a logo is also provided) to place a logo, or omit to place nothing.

NOTE: The top_element, middle_element, and bottom_element cannot be the same (unless all are omit).

Examples of all possible combinations of these options are shown below (zoom in for detail):

top_element (top) bottom_element (left) index logo omit title
index N/A
logo N/A
omit
title N/A

Middle Element

The element in the middle of the frame can be adjusted to display an enlarged logo. This can be given as logo (if a logo is also provided) to place a logo, or omit to place nothing. This works particularly well with blurred cards, for example:

Episode Text Color

The color of the episode text defaults to match the title font color, but can be adjusted via a series extra, like so:

extras:
  episode_text_color: skyblue

This option is only applicable if the top_element or bottom_element extra is index (which is the default behavior).

Separator Character

The character between the season and episode text (a.k.a. the separator) can also be customized. By default, a - character is used. This can be changed as a series extra, like so:

extras:
  separator: "•"

Frame Color

The color of the episode text defaults to match the title font color, but can be adjusted via a series extra, like so:

extras:
  frame_color: skyblue

Logo File

The path to the logo file to place at the bottom of the frame, if the top, middle, or bottom element is logo. This can be specified as a variable logo that depends on the season and episode number.

Examples

The following example adds a logo to the top element of the image:

extras
  top_element: logo
  logo: ./source/What We Do in the Shadows (2019)/logo.png

The following example adds a logo unique to each season in the center of the image:

extras:
  middle_element: logo
  logo: ./source/What We Do in the Shadows (2019)/logo_season{season_number}.png

Logo Size

Size to scale the logo by. This can be less than 1.0 to shrink the logo, and greater than 1.0 to enlarge the logo. This applies if the logo is the the top, middle, or bottom element.

For example, this scales the logo to 115% of the original size:

extras:
  top_element: logo
  logo: ./source/What We Do in the Shadows (2019)/logo_season{season_number}.png
  logo_size: 1.15

Logo Vertical Shift

Additional vertical offset to apply to the logo. This applies whether the logo is the top, middle, or bottom element.

Edge Blurring

By default the outside of the frame is blurred. This can be disabled via the series extra blur_edges. The difference between blurred and not blurred is shown below:

Difference Example

Although the effect is hard to spot in this particular image, compare the left/right half of the image.

Shadow Color

A drop shadow is added to all text, as well as the frame itself. By default this shadow is colored black, but can be recolored.

Clone this wiki locally