VictoryCard

Flexible card game prototyping engine

Generate printable cards for prototyping using yaml, html, and css.

Card data is stored in yaml
HTML is used for templating (using Jinja2)
CSS is used for styling

Requires Python 3.6+

Only tested in Python 3.7

Quick Start

git clone https://github.com/Beefster09/VictoryCard.git
cd VictoryCard
pip install -r requirements.txt
python victorycard.py examples/cards.yaml

Example output

$ python victorycard.py examples/cards.yaml
2019-05-24 20:34:46 - Invalid value for 'copies': invalid literal for int() with base 10: 'Invalid (assumes 1)'
2019-05-24 20:34:46 - No icons found for 'bad-icon'. Using placeholder
2019-05-24 20:34:46 - 22 total cards
[I 190524 20:34:46 server:296] Serving on http://0.0.0.0:8800
2019-05-24 20:34:46 - Serving on http://0.0.0.0:8800
[I 190524 20:34:46 handlers:62] Start watching changes
2019-05-24 20:34:46 - Start watching changes
[I 190524 20:34:46 handlers:64] Start detecting changes
2019-05-24 20:34:46 - Start detecting changes
[I 190524 20:34:54 web:2246] 101 GET /livereload (127.0.0.1) 0.00ms
2019-05-24 20:34:54 - 101 GET /livereload (127.0.0.1) 0.00ms
[I 190524 20:34:55 handlers:135] Browser Connected: http://localhost:8800/cards.html
2019-05-24 20:34:55 - Browser Connected: http://localhost:8800/cards.html

Navigate to localhost:8800 to see your cards. This page will automatically refresh anytime changes are made.

You can also run python victorycard.py --help for a list of options.

Explanation

YAML deck data file

VictoryCard uses YAML to define card data. The top level accepts these attributes:

title: Corresponds to the page title
extends: allows adding to or overriding data from another deck. Mappings are deep-merged and sequences are concatenated.
general for general settings about the cards themselves
- template: the card template to use for each card in the deck. By default, the default template is the same as the yaml, but with one of these extensions:
  - .html.jinja2
  - .jinja2
  - .hj2
  - .vct See Jinja Documentation for details on how to create templates for each card.
- stylesheet: the stylesheet used for the whole deck. Defaults to the same name as the yaml, but with a css extension.
- embed_styles: indicates that styles should be inserted into the <style> section of the rendered deck (default true)
- card_spacing: controls how much space is between each card. This should use css units. (Default: 2pt)
- header: a path to an optional header that gets inserted in the <head> of the deck template. Defaults to the same as the yaml, but with an html.header extension
- output: the path to output the deck to. Defaults to the same as the yaml, but with an html extension
- icon_path: a path (relative to the YAML file) of where icons are kept.
- markdown: allows customizing markdown features
  - default_mode: (paragraph, inline, or auto. Default auto) specifies whether the regular markdown filter strips out p tags or not
  - extensions: A list of extensions to enable. smarty is enabled by default in order to get smart quotes, dashes, and ellipses.
  - extension_configs: A dictionary defining configurations for those extensions
defaults allows you to set some defaults for each card
cards - [Required] A yaml list or dict of each card and its attributes. Each field is passed to the jinja2 template and is pulled from your defaults section if missing. Some additional fields:
- copies: indicates how many copies of that card will be rendered. Set to 0 to exclude the card from rendering. Defaults to 1 unless otherwise specified in the defaults section

Jinja2 Extensions

VictoryCard adds a few extensions to Jinja2:

Markdown filter. This enables data from your yaml file to be processed by markdown first. There are a few variants:
- md_paragraph: Resulting text is wrapped in <p> tags. This is good for raw multiline strings (| prefix) and when you might want multi-paragraph text.
- md_inline: Resulting text is stripped of all paragraph tags. This is good for flow-style strings (single-line, quotes, or no start tokens)
- md_auto: Resulting text is wrapped in <p> tags only if the input string includes newlines
- markdown is an alias for md_auto by default.
Icon search (icon). This will search your icon_path for suitable icons.
Embed file contents (embed) to dump the entire contents of a (text) file into that point.

Markdown Exensions

VictoryCard adds a few extensions to Markdown:

Inline icons, either with a [icon:whatever] or &whatever; syntax. The latter will not be replaced by placeholder text so that it doesn't interfere with HTML entities.
~~ strikethrough
Concise spans for things such as game keywords that you may want to style differently. ({#id.class1.class2}[text])

Credits

Originally Forked from ghostsquad/pycard, which was inspired by HCCD

Beefster09 / VictoryCard