Documentation

This is the documentation for RPG Cards Generator. Click here to see the generator in action.

Export JSON data

Export objects are json files containing a few fields:

• version (string): Defining the version of the export object
  • Possible values "1"
• cards (array): The list of cards
  • see Card JSON data

Example:

{
  "version": "1",
  "cards": [...]
}

Card JSON data

Cards objects have the following fields:

• count (number): Amount of the card to be printed
• color (string): Color of the card
• title (string): Title of the card
• icon_back(string): Name of the icon used on the back of the card
  • See Icons
• layout (object): Information about the layout of the card such as text size
• text_back (string): Text showed on the back of the card such as the spell level
• contents (array): Array of contents of the card
  • See Contents

Example:

{
  "count": 1,
  "color": "#4a6898",
  "title": "Hex",
  "icon_back": "magic-swirl",
  "contents": [
    ...
  ],
  "layout": {
    "text_font_size": ""
  },
  "text_back": ""
}

Contents JSON data

Content objects have the following fields:

• id (string): A unique id used by the drag and drop mechanics
• type (string): The type of the content, used by the renderer
  • See the table below
• content (string): The actual content where parameters are divided by a pipe |.

Content types

Name	Description	Parameters
text	Simple paragraph	Text (textarea): Text
subtitle	Sligtly larger italics text	Subtitle: Subtitle text Right-aligned: Additional right-aligned text
rule	A horizontal line taking up full width
property	A property with a bold name and normal description - if spanning more than one line, description is indented.	Name: Propety name (bolded) Description: Propety description
description	Same as `property` but with no indentation and name is italicized.	Name: Description name (bolded, italicized) Description: Description description
section	Section header	Section name: Section name Right-aligned: Additional right-aligned text
boxes	Empty boxes	Amount (number): Amount of boxes Size: Size of the boxes
fill	Empty area taking up available space	Height (number): Height in mm
bullet	Bulleted text	Text: Text
picture	A picture from an url	URL: URL of the picture Height: Height of the picture in pixels
dndstats	A Dungeons & Dragons stat block	Str (number): Strength score Dex (number): Dexterity score Con (number): Constitution score Int (number): Intelligence score Wis (number): Wisdom score Cha (number): Charisma score
dndspellblock	A Dungeons & Dragons spell card block	Casting: Casting time Range: Range Components: Components Duration: Duration

Examples:

...
{
  "type": "dndspellblock",
  "content": "1 action | Self (15-foot radius) | V | Instantaneous",
  "id": "17252d82-2ff1-44f0-9a3b-8e82406a1d90"
},
{
  "type": "rule",
  "content": "",
  "id": "23e3310c-6e4f-4d9e-9849-93a9936fba71"
},
{
  "type": "text",
  "content": "You create a lash of lightning energy that strikes at one creature of your choice that you can see within 15 feet of you. The target must succeed on a Strength saving throw or be pulled up to 10 feet in a straight line toward you and then take 1d8 lightning damage if it is within 5 feet of you.",
  "id": "04ea19f0-2655-44d4-9de5-595c9b554b75"
},
...

Icons

Icons available in RPG Card Generator are provided by Game-icons.net - please check them out!