Skip to content

Latest commit

 

History

History
50 lines (42 loc) · 4.46 KB

README.md

File metadata and controls

50 lines (42 loc) · 4.46 KB

Card Types for the TitleCardMaker

This repository contains user-created card types for use in the TitleCardMaker.

Contributing

In order to contribute your own custom Card Type to this repository, follow these steps:

  1. Create a fork of this repo
  2. Create a folder with your Github username (i.e. /CollinHeist/)
  3. Inside that folder, create a README.md file with at least one example and a description of your card (as well as any nuances / features)
  4. Add your custom Card Type Python class (that follows the specifications outlined here) to your username folder
    • Be sure to read the wiki on the specific syntax required for your CardType to work as a remote asset.
    • It can be helpful to look at my example (CollinHeist/BetterStandardTitleCard), or an existing card type, for syntax help
  5. Edit the below table with your username and an example of your card
  6. Submit a pull request to this repository

NOTE: By nature of how the Maker pulls in these files, all pull requests and Card Types will be thoroughly vetted for security implications. Please help me out in this process by documenting your code, and avoiding any unnecessary obfuscations.

Available Card Types

Creator card_type Specification Example
Wdvh Wdvh/WhiteTextStandard
Wdvh Wdvh/WhiteTextAbsolute
Wdvh Wdvh/WhiteTextTitleOnly
lyonza lyonza/WhiteTextBroadcast
Wdvh Wdvh/StarWarsTitleOnly
Beedman Beedman/GradientLogoTitleCard
Yozora Yozora/SlimTitleCard
Yozora Yozora/BarebonesTitleCard
Yozora Yozora/RetroTitleCard
Wdvh Wdvh/WhiteTextAbsoluteLogo
Wdvh Wdvh/WhiteTextStandardLogo
Wdvh Wdvh/WhiteTextTitleOnlyLogo
azuravian azuravian/TitleColorMatch
CollinHeist CollinHeist/BlacklistTitleCard
KHthe8th KHthe8th/TintedFramePlus

Using a Custom Card Type

The available card types can all be specified within the Maker by adding the following:

card_type: {USER/CARDTYPE}

To a specific series, template, or library. For example, to create The Blacklist in my example card type, it might look like:

series:
  The Blacklist (2013):
    card_type: CollinHeist/BlacklistTitleCard