This repository contains user-created card types for use in the TitleCardMaker.
In order to contribute your own custom Card Type to this repository, follow these steps:
- Create a fork of this repo
- Create a folder with your Github username (i.e.
/CollinHeist/
) - 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) - 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
- Edit the below table with your username and an example of your card
- 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.
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 Breaking Bad in the example card type, it might look like:
series:
Breaking Bad:
year: 2008
card_type: CollinHeist/BetterStandardTitleCard