Skip to content

Notification Card Type

This card type features two compact rectangular frames, styled to resemble a notification prompt. These "notifications" can be resized, positioned, and colored with extras.

This card type is used whenever card_type is specified as notification.

Example

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
edge_color Matches the font Color of the edge of each notification box
edge_width 5 How wide to make the edge coloring
episode_text_color Matches the font Color of the index text
episode_text_font_size 1.0 Size adjustment for the index text
episode_text_vertical_shift 0 Additional vertical shift to index text
glass_color rgba(0,0,0,0.50) Background color of both text boxes
position right Where to position the notifications
box_adjustments 0 0 0 0 Adjustments to the bounds of the notification boxes
separator - Character that separates the season and episode text

Customization

Edge

Color (edge_color)

The color of each notification's edge can be adjusted with the edge_color extra. This matches the font color by default.

Example
tv.yml
series:
  Succession (2018):
    card_type: notification
    extras:
      edge_color: crimson

Width (edge_width)

The width of each notification's edge can be adjusted with the edge_width extra. This defaults to 5, and is in pixels.

Example
tv.yml
series:
  Succession (2018):
    card_type: notification
    extras:
      edge_width: 15

Episode Text

Color (episode_text_color)

The color of the episode text can be adjusted with the episode_text_color extra. This matches the font color by default.

Example
tv.yml
series:
  Succession (2018):
    card_type: notification
    extras:
      episode_text_color: crimson

Size (episode_text_font_size)

The size of the episode text can be adjusted with the episode_text_font_size extra. This defaults to 1.0.

Example
tv.yml
series:
  Succession (2018):
    card_type: notification
    extras:
      episode_text_font_size: 1.5

Vertical Shift (episode_text_vertical_shift)

The vertical positioning of the index text (and the matching notification box) can be adjusted with the episode_text_vertical_shift extra. Positive values shift the box (and text) up, negative values down.

Example
tv.yml
series:
  Succession (2018):
    card_type: notification
    extras:
      episode_text_vertical_shift: -30

Notification

Adjustments (box_adjustments)

If you'd like to adjust the dimensions of the title text's notification box to either appear further/closer to your title text (especially when using a custom font), then the box_adjustments extra can be used to individually adjust the boundaries of each of the box's faces.

This is specified in clockwise order, like so {top} {right} {bottom} {left}, with positive values moving the face in, negative out. The default is 0 0 0 0, meaning no adjustments are made.

Example

The following will move the bounds of the title text box in 20 pixels on the top, 10 pixels out on the right, 5 pixels in on the botton, and make no adjustment on the left.

tv.yml
series:
  Succession (2018):
    card_type: notification
    extras:
      box_adjustments: -20 10 -5 0

Color (glass_color)

The background color of both notification boxes can be adjusted with the glass_color extra. This defaults to rgba(0,0,0,0.50) - which corresponds to black at 50% opacity. A transparent color can be specified.

Example
tv.yml
series:
  Succession (2018):
    card_type: notification
    extras:
      glass_color: rgba(5, 122, 246, 0.5)

Position (position)

The position of both notification boxes can be adjusted with the position extra. This can be either left or right, and defaults to right.

Example
tv.yml
series:
  Succession (2018):
    card_type: notification
    extras:
      position: right

Separator Character (separator)

If both the season and episode text are displayed on the Card, then a separator character is added between them. This character can be adjusted with the separator extra.

Example
tv.yml
series:
  Succession (2018):
    card_type: notification
    extras:
      separator: "||"

Mask Images

This card also natively supports mask images. Like all mask images, TCM will automatically search for alongside the input Source Image in the Series' source directory, and apply this atop all other Card effects.

Example