AnimeTitleCard - CollinHeist/TitleCardMaker GitHub Wiki

Background

This style of title card is based off Reddit user /u/Recker_Man's style. Although it is referred to as the "anime" card style, there is nothing preventing you from using it for any series. The only thing about this card that indicates its anime design is the ability to add kanji text above the episode title.

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

Examples

Spoiler

Blurred

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
kanji - Optional kanji (Japanese) text to place above the title - should be a translation
require_kanji false Whether to require kanji to be provided before a card is created
kanji_vertical_shift 0 Additional vertical offset to apply to the kanji text
stroke_color black Custom color to use for the stroke on the title and kanji text
episode_text_color #CFCFCF Color to utilize for the episode text
omit_gradient false Whether to omit the gradient overlay from the card
separator · Character to separate season and episode text

Customization

Adding Kanji

Details

This card type looks for data under the kanji key within a series' datafile. If present, the text is added above the episode title (see example). This text can be automatically added by the Maker, with some configuration.

If TMDb is not globally and per-series enabled, then this data must be entered manually. Within a given datafile, add the kanji text like so (for the given example):

data:
  Season 3:
    10:
      kanji: 絶対諦めない
      title: Never Give Up

However, if TMDb syncing is enabled, then these can be queried from TMDb automatically by utilizing the title translation feature of the Maker. The ISO code for Japanese is ja, and these titles should be stored under the kanji key, so a series data file would look something like this:

series:
  "Demon Slayer: Kimetsu no Yaiba (2019)":
    card_type: anime
    translation:
      language: ja
      key: kanji

Requiring Kanji

By default, if a kanji translation cannot be found or is not present for a given card, the title card will still be created. This might not be desired behavior, so series extras can be specified to skip a card if there is no Kanji present. How this looks in YAML is shown below:

extras:
  require_kanji: true

If this is present for a given series or template (see below), then an error will be printed and the card will be skipped until Kanji has been identified from TMDb, or entered manually into the datafile.

Recommended Template

To save repeating this translation syntax for every anime you want Kanji added to, it's recommended to use a template. An example of which is shown below:

templates:
  anime_with_kanji:
    year: <<year>>
    card_type: anime
    library: Anime   # Change to your library name, or delete completely
    translation:
      language: ja
      key: kanji
    extras:
      require_kanji: true

This could be used like so:

series:
  "Demon Slayer: Kimetsu no Yaiba (2019)":
    template: anime_with_kanji

The Maker will then automatically look for kanji translations on TMDb, and skip all cards for which no translation was found.

Vertically Shifting Kanji Text

If kanji text is added, and a custom font is used that has a drastically different height to it, the Kanji text might appear either too high or low. This can be adjusted via a series extra, like so:

extras:
  kanji_vertical_shift: 20

This acts identically to the base font vertical shifting, so positive values move the kanji up, while negative ones move it down.

Custom Stroke Color

The color of the stroke to use for the title and kanji text. This defaults to black, but can be changed as a series extra. See the example below.

Example
Pokémon (1997):
  card_type: anime
  font:
    case: source
    color: rgb(247,205,70)
    file: ./fonts/Pokemon Solid.ttf
    kerning: 50%
    size: 110%
    stroke_width: 500%
  extras:
    stroke_color: rgb(64,107,175)

Will use a custom blue stroke color, producing cards like this:

Custom Episode Text Color

The color of the episode text. This defaults to #CFCFCF, but can be changed as a series extra. See the example below.

Example
"Mushoku Tensei: Jobless Reincarnation (2021)":
  card_type: anime
  extras:
    episode_text_color: crimson

Will use a crimson episode text color, producing cards like this:

Removing the Gradient Overlay

By default, this title card overlays a gradient on top of the source image so that the text is more legible on the card. This can be disabled via a series extra, like so:

extras:
  omit_gradient: true

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: "-"
⚠️ **GitHub.com Fallback** ⚠️