Skip to content

Commit

Permalink
Various card type doc improvements
Browse files Browse the repository at this point in the history
- Way more progress on the Anime page
- Create Banner page, need to update image compares
  • Loading branch information
CollinHeist committed Nov 14, 2024
1 parent 68dfce2 commit 07da0b6
Show file tree
Hide file tree
Showing 3 changed files with 354 additions and 3 deletions.
207 changes: 205 additions & 2 deletions docs/card_types/anime.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This card design was created by [CollinHeist](https://github.com/CollinHeist),
and designed by Reddit User
[/u/Recker_Man](https://www.reddit.com/user/Recker_Man). Because this is the
only card which explicitly supports adding kanji, this is the de-facto
card type used for _most_ Anime series by _most_ users.
card type used for Anime series by _most_ users.

These cards feature relatively unobtrusive text in the lower left-hand corner of
the image. The kanji, title, and season/episode text can all be adjusted.
Expand All @@ -27,7 +27,65 @@ the image. The kanji, title, and season/episode text can all be adjusted.

![Labeled Anime Card Elements](./assets/anime-labeled.webp)

## Adding Kanji
## Episode Text

Unless _explicitly_ stated otherwise, all "episode text" customizations refer to
both the season and episode text.

### Color

The color of the episode text can be adjusted with the _Episode Text Color_
extra. This will also change the color of the [season text](#season-text), but
that can be overwritten with the [_Season Text Color_](#season-text-color)
extra.

??? example "Example"

<div class="image-compare example-card"
data-starting-point="15"
data-left-label="basic" data-right-label="artwork">
<img src="../assets/music-basic-style.webp"/>
<img src="../assets/music.webp"/>
</div>

### Size

The size of the episode text can be adjusted with the _Episode Text Font Size_
extra. Like all font sizes, values greater than `#!yaml 1.0` will increase the
size of the text, and values less than `#!yaml 1.0` will decrease it.

??? example "Example"

<div class="image-compare example-card"
data-starting-point="15"
data-left-label="basic" data-right-label="artwork">
<img src="../assets/music-basic-style.webp"/>
<img src="../assets/music.webp"/>
</div>

### Stroke Color

The color of the stroke used for the episode text can be adjusted with the
_Episode Text Stroke Color_ extra.

## Gradient Overlay

By default, TCM applies a subtle gradient overlay on top of the source image so
that the (default) white text appears more legible. If you would like to remove
this gradient overlay, set the _Gradient Omission_ extra to `True`.

??? example "Example"

<div class="image-compare example-card"
data-starting-point="90"
data-left-label="/" data-right-label="||">
<img src="../assets/notification.webp"/>
<img src="../assets/notification-separator.webp"/>
</div>

## Kanji

### Adding Kanji

This card supports the addition of Kanji (Japanese text) to the Card through
TCM's built-in [translation](...) feature.
Expand All @@ -45,3 +103,148 @@ as "Translate `Japanese` titles into `kanji`".
your Series when [Syncing](../user_guide/syncs.md); _or_ add the Template
with some filters (i.e. by library name) to your
[Global Templates](../user_guide/settings.md#...).

### Coloring

The color of the kanji text can be adjusted with the _Kanji Color_ extra.

??? example "Example"

<div class="image-compare example-card"
data-starting-point="15"
data-left-label="basic" data-right-label="artwork">
<img src="../assets/music-basic-style.webp"/>
<img src="../assets/music.webp"/>
</div>

### Requiring Kanji

If you want to __require__ kanji text to be present in order for a Title Card
to be created, you can set the _Require Kanji_ extra to `True`

This is _generally_ not recommended as TCM will automatically delete and remake
Cards if they were made without kanji (that was later added).

### Size

The size of the kanji text can be adjusted with the _Kanji Font Size_ extra.
Like all font sizes, values greater than `#!yaml 1.0` will increase the size of
the text, and values less than `#!yaml 1.0` will decrease it.

??? example "Example"

<div class="image-compare example-card"
data-starting-point="15"
data-left-label="basic" data-right-label="artwork">
<img src="../assets/music-basic-style.webp"/>
<img src="../assets/music.webp"/>
</div>

### Stroke Color

The color of the stroke which surrounds the kanji text can be adjusted with the
_Kanji Stroke Color_ extra. If unspecified, the stroke color will match that of
the [title text](#...).

??? example "Example"

<div class="image-compare example-card"
data-starting-point="15"
data-left-label="basic" data-right-label="artwork">
<img src="../assets/music-basic-style.webp"/>
<img src="../assets/music.webp"/>
</div>

### Stroke Width

The width of the stroke effect can be adjusted wit the _Kanji Stroke Width_
extra.

??? example "Example"

<div class="image-compare example-card"
data-starting-point="15"
data-left-label="basic" data-right-label="artwork">
<img src="../assets/music-basic-style.webp"/>
<img src="../assets/music.webp"/>
</div>

### Vertical Shift

By default, TCM calculates the dimensions of the title text in order to position
the kanji text above it. However, if you want to manually offset the position
of the kanji, you can do so with the _Kanji Vertical Shift_ extra.


??? example "Example"

<div class="image-compare example-card"
data-starting-point="15"
data-left-label="basic" data-right-label="artwork">
<img src="../assets/music-basic-style.webp"/>
<img src="../assets/music.webp"/>
</div>

## Season Text Color

The color of the season text can be adjusted with the _Season Text Color_ extra.
If unspecified, this color matches the [_Episode Text Color_](#color), but this
extra overrides that.

??? example "Example"

<div class="image-compare example-card"
data-starting-point="15"
data-left-label="basic" data-right-label="artwork">
<img src="../assets/music-basic-style.webp"/>
<img src="../assets/music.webp"/>
</div>

## Separator Character

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 Character_ extra.

The color of this character will be controlled by the
[_Episode Text Color_](#color) and [_Season Text Color_](#season-text-color)
extras, with the season coloring taking priority over the episode.

??? example "Example"

<div class="image-compare example-card"
data-starting-point="90"
data-left-label="/" data-right-label="||">
<img src="../assets/notification.webp"/>
<img src="../assets/notification-separator.webp"/>
</div>

## Stroke Color

The color of the stroke applied to the title text can be adjusted with the
_Stroke Text Color_ extra.

??? example "Example"

<div class="image-compare example-card"
data-starting-point="90"
data-left-label="/" data-right-label="||">
<img src="../assets/notification.webp"/>
<img src="../assets/notification-separator.webp"/>
</div>

## Mask Images

This card also natively supports [mask images](../user_guide/mask_images.md).
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 "Example"

<div class="image-compare example-card"
data-starting-point="83"
data-left-label="Mask Image" data-right-label="Resulting Title Card">
<img src="../assets/notification-mask-raw.webp"/>
<img src="../assets/notification-mask.webp"/>
</div>
145 changes: 145 additions & 0 deletions docs/card_types/banner.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
---
title: Banner Card Type
description: >
An overview of the built-in Banner card type.
---

# Banner Card Type

??? warning "Under Construction"

This documentation is actively being developed.

This card design was created by [CollinHeist](https://github.com/CollinHeist),
and the design was inspired by graphic designer and TPDb contributor
[Danny Beaton](www.DannyBeaton.com.au).

These cards feature a solid-color banner at the bottom of the image, with all
text directly on top of or within the banner. The banner and text can all be
recolored and resized.

<figure markdown="span" style="max-width: 70%">
![Example Banner Card](./assets/banner.webp)
</figure>

??? note "Labeled Card Elements"

![Labeled Banner Card Elements](./assets/banner-labeled.webp)

## Alternate Coloring

Text which is positioned above the banner will be colored according to the font
color, but text positioned inside the banner itself can be adjusted with the
_Alternate Color_ extra. This defaults to black so that there is sufficient
contrast against the default banner color of white.

This extra will also affect the coloring of the season and episode text.

??? example "Example"

<div class="image-compare example-card"
data-starting-point="83"
data-left-label="Mask Image" data-right-label="Resulting Title Card">
<img src="../assets/notification-mask-raw.webp"/>
<img src="../assets/notification-mask.webp"/>
</div>

## Banner Customization

### Color

The color of the banner can be adjusted with the _Banner Color_ extra. By
default, this matches the title text / font color.

??? example "Example"

<div class="image-compare example-card"
data-starting-point="83"
data-left-label="Mask Image" data-right-label="Resulting Title Card">
<img src="../assets/notification-mask-raw.webp"/>
<img src="../assets/notification-mask.webp"/>
</div>

### Height

The height of the banner can be adjusted with the _Banner Height_ extra.

??? example "Example"

<div class="image-compare example-card"
data-starting-point="83"
data-left-label="Mask Image" data-right-label="Resulting Title Card">
<img src="../assets/notification-mask-raw.webp"/>
<img src="../assets/notification-mask.webp"/>
</div>

### Toggle

The banner can be completely disabled by setting the _Disable Banner_ extra to
`True`.

If disabled, all text will still be positioned as if the banner is present, so
this is _generally_ not advised.

??? example "Example"

<div class="image-compare example-card"
data-starting-point="83"
data-left-label="Mask Image" data-right-label="Resulting Title Card">
<img src="../assets/notification-mask-raw.webp"/>
<img src="../assets/notification-mask.webp"/>
</div>

## Episode Text

### Color

The color of the season and episode text is controlled with the
[_Alternate Color_](#alternate-coloring) extra.

### Size

The size of the season and episode text can be adjusted with the
_Episode Text Font Size_ extra. Like all font sizes, values greater than
`#!yaml 1.0` will increase the size of the text, and values less than
`#!yaml 1.0` will decrease it.

??? example "Example"

<div class="image-compare example-card"
data-starting-point="83"
data-left-label="Mask Image" data-right-label="Resulting Title Card">
<img src="../assets/notification-mask-raw.webp"/>
<img src="../assets/notification-mask.webp"/>
</div>

## Horizontal Offset

The distance at which text is offset from the side of the card can be adjusted
with the _Horizontal Offset_ extra. Positive values _increase_ the spacing
between the text and the edge of the image, while negative values _decrease_ it.

??? example "Example"

<div class="image-compare example-card"
data-starting-point="83"
data-left-label="Mask Image" data-right-label="Resulting Title Card">
<img src="../assets/notification-mask-raw.webp"/>
<img src="../assets/notification-mask.webp"/>
</div>

## Mask Images

This card also natively supports [mask images](../user_guide/mask_images.md).
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 "Example"

<div class="image-compare example-card"
data-starting-point="83"
data-left-label="Mask Image" data-right-label="Resulting Title Card">
<img src="../assets/notification-mask-raw.webp"/>
<img src="../assets/notification-mask.webp"/>
</div>
5 changes: 4 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,10 @@ nav:
- Help & Support: help_and_support.md
- Version 1:
- v1/index.md
- Configuration:
- TMDb: v1/config/tmdb.md
- Sync: v1/sync.md
- Translation: v1/translation.md
- Card Types:
- v1/card_types/index.md
- Anime: v1/card_types/anime.md
Expand Down Expand Up @@ -289,4 +292,4 @@ nav:
- Textless: v1/card_types/textless.md
- Tinted Frame: v1/card_types/tinted_frame.md
- Tinted Glass: v1/card_types/tinted_glass.md
- White Border: v1/card_types/white_border.md
- White Border: v1/card_types/white_border.md

0 comments on commit 07da0b6

Please sign in to comment.