How To Use CardPen

Your cards are assembled from a card list, a Mustache/Handlebars template, and optional CSS styles. You edit these and other settings in the upper half of the CardPen window, while the cards themselves appear in the bottom half of the CardPen window (as does this documentation).

Projects

Sets of cards are organized into projects. To change your current project, click one of the buttons under Project (at the top of the CardPen window):

By default, CardPen will load your last project, or if you haven't used it before, the Pico example. In the examples/ directory, there are several more sample project files you can load.

Views

Switching between views in CardPen changes the layout of the editor (not of your cards).

Individual editors for your card list, styles, and card template are available in the Editor view. The editors plus all other options are shown in the Advanced view. The Cards Only view maximizes the section of the window devoted to your cards. This documentation is visible in the Help view.

Editor View

The Editor view is the default view.

Your Card List

You can upload a CSV (comma-separated value) file containing all the information about your cards, or you can enter the data manually. In either case, the CSV delimiter (usually a comma, semicolon, or tab) will be detected automatically.

The first line of your card list should be a header with short names for each of your columns. Each remaining line should have the same number of columns and should describe one card from your set. You can leave some fields blank, but you should include the delimiter. (Load the Scottish Sleuth Clue Deck example to see a card list with blank fields.)

The + button will add a duplicate card to the end of your list. The - button will remove the last card from your list.

Note that the card list is optional; if you only want one card (such as for a card back, score pad, game box or the like), you don't need to fill anything in here.

Card Classes

The Card classes setting turns one or more columns from your card list into CSS classes on each card, which is especially useful for adding background images when doing card bleeds. (Because the card wrapper element itself, card, does not appear in your Mustache template, you can't put a CSS class on it directly.)

To use the Card classes setting, switch to the Advanced view and put the exact name(s) of your card list column(s) into the field. Be sure that the contents of each column you're using this way are valid CSS class names---e.g., single words, not starting with a number, and not including any special characters beyond hyphens or underscores. (The class can also be blank for some cards.) To add more than one class/column to Card classes, separate the column names with spaces.

There is a built-in card class, cardN, for the nth card of your current list. There are also built-in classes, cardHTML and cardImage, corresponding to your output format. (The cardHTML class is applied for HTML and print but not images.)

Rowsets

The Rowsets setting lets you use more than one row from your card list make a single card. To use the Rowsets setting, switch to the Advanced view and put the number of rows you want to group together into the field. Then choose whether you want rows to be picked from your list at random (without reuse), in order (in bunches), or equidistantly (cycling through the whole list).

To iterate over the rows individually in your template, use the {{#rowset}} and {{/rowset}} tags. In addition to the normal columns, the particular {{@index}} of your row within the rowset is also available. (See the Xendo example for more details.)

Your Template

You can upload a Mustache or Handlebars template, or enter one manually.

The template is mostly plain HTML laying out a single card from your set. To insert card-specific information, use Mustache-style braces around one of your column titles from your card list: {{YourColumnNameHere}}. (If you have HTML in your column that you want parsed, use three braces when referring to it instead of two: {{{YourColumnNameHere}}}.)

In the Pico example, there are only two columns in the CSV file, named Number and Score. The card's number is inserted in five places on the card: the center and the four corners. The card's score is used as part of a CSS class that inserts the scoring pips.

There is a built-in tag that you can use to change your template based on whether you are generating cards as HTML or as images: {{cardImage}}. To turn a section of the template on when you are generating card images, put it between two tags {{#cardImage}} and {{/cardImage}}. To turn a section off, put it between {{^cardImage}} and {{/cardImage}}.

For an example of using this tag, open the BGG non-local example and scroll down to the bottom of that template. The template uses the tag to add a proxy to the BoardGameGeek image URL when generating images (because BGG is not set up correctly for CORS). You can also use these tags (or the related CSS classes) to compensate for unexpected differences between your HTML and image output.

CardPen defaults to using Handlebars to process your template; this usually doesn't make a difference, but if you need Mustache in particular check the mustache checkbox above the template area. (It's visible in the Advanced view.)

For more hints on how to set up your Mustache/Handlebars template, see the additional examples, the examples from hccd, the Mustache documentation, or the Handlebars docs.

Your Styles

You can upload a CSS file, enter CSS styles manually, or skip this section of the editor altogether. It is possible to put all your styles inline on elements in your template instead of in this section (though not within <style> tags). CardPen will not judge you for this.

Most of the examples use flexbox and some CSS transforms to position various card elements, but you can use tables or any other approach you like. When styling your cards, you should use print units like in, mm, or pt (points) instead of px in order to keep your output true to the chosen card size.

When writing your styles, keep in mind that you can add your own card classes (as explained previously), use the built-in card class cardN of each card, and even (carefully) style the parent card element.

Advanced View

Click the Advanced button to view and change your project settings.

Card Size

The most important setting is card size, which defaults to poker (2.5"x3.5"). You can change the orientation of your cards to landscape; the default is portrait. You can also set the spacing (gutter) between the cards.

You don't have to keep all the units (millimeters or inches) in sync, but it certainly can't hurt.

Bleed

You can add a bleed outside the card proper (which increases the size of your cards by the specified amount), and you can also designate a safe region inside the card proper. Most printing services require 1/8" bleed per side and recommend a 1/8" safe zone (sometimes expressed as 36 pixels at 300 DPI rather than as 0.125" or 0.12").

To visualize your bleed and safe areas, check the overlay checkbox. The overlay only appears in the HTML view; it will not print out or be included in your card images.

Overlay Templates

You can overlay an entire template image in place of the bleed and safe lines. This is particularly useful for laying out unusual shapes. Enter the image URL in the URL field under Overlay. (If it's a local image and you're running locally, you can put it in the overlays directory and refer to it as /overlays/my-overlay-filename.png in the URL field.)

Load the Scottish Sleuth Box example to see an overlay image in action.

If you need to rotate a template to match your rotated cards, follow the directions below for rotating image output, and use your rotated template as the overlay URL. For example, Scottish Sleuth Scorepad (Simple) uses a rotated overlay.

Once you've produced your images, follow the same directions to rotate your image output back (to match the original direction of the template).

Fonts

You can add Google Fonts or other fonts (e.g., FontAwesome) using the External Stylesheet setting. FontCDN is a handy way to search for Google Fonts. The Pico example also uses a Google font effect for the text shadow. (If you don't see it, you may not be using a browser that supports their font effects.)

The Pico example uses two Google Fonts; see the CSS for how they are invoked.

Please note that Google fonts may scale incorrectly when converted to images at higher DPI. If you experience this problem, try installing the fonts on your computer. (Most Google fonts are also available free elsewhere online in system font format.)

Corners

You can set the corner radius in CardPen, though leaving it off or getting it wrong will probably not matter much in the print process. In the wild, card corner diameters vary between 1/8" and 1/4"; The Game Crafter claims that "US Game" size tends to larger corner radius while smaller is standard.

Read more about corners at Dreadful Games.

Art

You can include URLs for background images in your CSS, and trigger different ones using classes in your template. (This is done in all the Scottish Sleuth card examples.)

For foreground images, you can include the URLs as part of the card list and put the url into an img tag in your template. (See the BGG example for a foreground image.) If your foreground image never changes, you can put it into your template directly instead.

CardPen needs to be able to find your images "online". You can use public URLs of images that are already available online or that you've uploaded to an image hosting site like Google Photos or Unsee, but note that some public images may not work with CardPen due to CORS issues. (Click the BGG button for an example of using a CORS proxy to work around CORS issues.)

If you need lots of images or if you're having CORS issues, you should run CardPen locally. Download CardPen from BitBucket, run it using the instructions there, put your images in the images directory, and refer to them as the examples do (e.g., the BGG Local Images example.)

BGG

CardPen can generate a special card list from your BoardGameGeek game collection for making an I Don't Know, What Do You Want to Play? deck or for similar purposes. Optionally, open a BGG sample template and edit the template and styles to set up the cards the way you want.

Next, in the Advanced view enter your own username in the BGG username field. Click the Get Games button; this will replace the sample card list with one based on your own game collection.

Output Format

You have three card generation options under Format:

Printing HTML

Before printing, choose the appropriate page size for your paper (in the Advanced view). Your cards may fit better in one direction than the other, so try switching from landscape to portrait or back before printing.

The Print button prints the cards; in some browsers you can also right-click on the frame and choose Print Frame from the context menu.

When printing, be sure to uncheck or undo any scaling and remove any headers/footers that the browser might add. Some browsers will not detect your choice of landscape or portrait for your page layout, so you may need to set that manually in the print dialog before printing. You may also need to turn background images on in your browser's print settings if you have them on your cards.

Cut Lines

The cutline checkbox (in the Advanced view) is for adding a cut line when printing cards yourself, not for making borders.

Making actual thick borders around a card is not generally recommended and so is not automated by CardPen, though you can do it using your CSS. When making your own borders around cards against all advice, some recommend that the border extend about 1/8" into the safe zone.

Generating Images

Due to browser security settings affecting the library that CardPen uses to generate images, not all browsers will generate cards as images. Safari will not, nor will any iOS browser; Chrome generally will.

When generating images, choose an adequate DPI (300 is the default and is most printers' minimum), then click the Images button under Format. The images will appear in the output section of the page, with a Zip Images button above them. To download the images as a zip file, click the button. The images inside the zip file will be named after your project and numbered sequentially.

Some browsers will display the images at a strangely small resolution; in that case, right-click on an image to open it in a new tab (then, additionally, zoom in if your browser is zoomed out) in order to see the image at its real pixel size. (You don't need to do anything special to zip such images.)

Image generation is a dark art that sometimes goes wrong; if something else looks awry or if you get a failure message, try again.

Rotating Images

If you need to rotate your landscape cards back to portrait to upload to a printer, I recommend using ImageMagick. The relevant command is:

convert -rotate "90" filename.png newfilename.png

You probably want to rotate the back in the opposite direction:

convert -rotate "-90" filename.png newfilename.png

Often it's easier just to edit the all files in place (as long as you've saved your project and can regenerate them if something goes wrong):

mogrify -rotate "90" *.png

If you want to use a GUI instead of the command line, Preview on MacOS X or Photos on Windows 10 (among others) will let you rotate images.

To flip an image, use "180" instead of "90":

convert -rotate "180" filename.png newfilename.png

Saving

CardPen stores your current card edits in your browser's local storage, so you can come back to it in the same browser later on (but not forever, and not if you overwrite it with another set of cards).

For longer-term storage, use the Export button (next to your project name in the Advanced view) to save your card project as a json file. You can load the saved file again later using the Load button under Project. You can also load the extra examples from the examples directory this way.

Sizes

The Show All button next to the card sizes will show you all the built-in card sizes using your current settings for bleed and card orientation, including conversion to millimeters, inches, and pixels. You should always double-check your card sizes rather than relying on card size names, which can vary strangely from publisher to publisher.

Card Size Clarifications

Some sizes are included because sleeves for them are common, though no one will print them for you---most notably, euroGame and euroMiniGame.