Anime Card Type
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
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_color |
white |
Color of the kanji text |
kanji_font_size |
1.0 |
Scalar for the size of the kanji text |
kanji_stroke_color |
black |
Color of the stroke for the kanji text |
kanji_stroke_width |
1.0 |
Stroke width of the kanji text |
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 |
episode_stroke_color |
black |
Color of the stroke 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
This card type looks for data under the kanji key within a series' datafile.
If present, the text is added above the episode title. This text can be
automatically added by the Maker (with some configuration).
If TMDb 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 the YAML must would look something like
this:
series:
"Demon Slayer: Kimetsu no Yaiba (2019)":
card_type: anime
translation:
language: ja
key: kanji
How do you add kanji manually?
If TMDb is not globally enabled, then this data must be entered manually. Within a given datafile, add the kanji text like so (for the given example):
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 - but feel free to modify for your needs.
templates:
anime_with_kanji:
card_type: anime
library: Anime # Change to your library name, or delete completely
translation:
language: ja
key: kanji
This can then be used like so:
templates:
anime_with_kanji:
card_type: anime
library: Anime # Change to your library name, or delete completely
translation:
language: ja
key: kanji
series:
"Demon Slayer: Kimetsu no Yaiba (2019)":
template: anime_with_kanji
TCM will then automatically look for kanji translations for all series which use this template.
Customization
Kanji
Color (kanji_color)
The color of the kanji text can be adjusted with the kanji_color extra. This
defaults to white (to match the default font color of the title text).
Example
Requiring Kanji (require_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 the require_kanji extra can be specified to skip a card if there is no
Kanji present. This defaults to false.
Example
If this is present for a given series, 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.
Size (kanji_font_size)
The size of the kanji text can be adjusted with the kanji_font_size extra.
This defaults to 1.0 (meaning no adjustment). Values above 1.0 will increase
the size, values below 1.0 will decrease it.
Example
The following would reduce the size of the kanji text by 20% (to 80%).
Stroke Color (kanji_stroke_color)
The stroke of the color for the kanji text can be adjusted with the
kanji_stroke_color extra. This defaults to black.
Example
Vertical Shift (kanji_vertical_shift)
If kanji text is added, the Kanji text might appear either too high or low
(especially if using a custom font). To fix this, this can be adjusted via the
kanji_vertical_shift extra. Positive values move the kanji up, and negative
ones move it down.
Example
Episode Text
Color (episode_text_color)
The color of the episode text can be adjusted with the episode_text_color
extra. This defaults to #CFCFCF.
Example
Stroke Color (episode_stroke_color)
The color of the stroke outline on the episode text can be changed with the
episode_stroke_color extra. This defaults to black.
Gradient Overlay (omit_gradient)
By default, this card type applys a gradient on top of the source image so that
the text is more legible on the card. This can be disabled by setting the
omit_gradient extra to false.
Example
Separator Character (separator)
The character between the season and episode text (a.k.a. the separator) can
be customized with the separator extra. By default, a · character is used.
Example
Stroke Color (stroke_color)
The color of the stroke used for the title text can be adjusted with the
stroke_color extra. This defaults to black (like all other stroke colors).
