aboutsummaryrefslogtreecommitdiff
path: root/cardGen/README.md
blob: 18d120c245ab81c9db96ea1668c3b9fe46c8ebf7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# dndCard.sh

Takes some fields from an input file and builds a pdf and image of a card from them.

## Usage

```
dndCard.sh [-t templateFile] [-b bodyFile] inputFile
```

## Example

Example of input file:

```
name#Health potion
typetext#Consumable
hint#(Restores 2d4+1 HP)
body#Can be uncorked and drank as an action. The potion restores 2d4+1 HP. It can also be given to other characters in a moment of need. Many other useful properties of the potion could be listed here.
flavor#The potion's red liquid glimmers when agitated.
icon#potion-ball.png
```

Note that the body field could be on another file provided with the `-b` option, but it still should
be just one line.

Example of output, with no image background and using
[an icon](https://game-icons.net/1x1/lorc/potion-ball.html) downloaded as-is from the amazing source
[game-icons.net](https://game-icons.net/):

![Potion card example](Health_potion.png)

## Additional notes

A background image can be provided; if not, the background will have a plain color. The template is
fully editable or others could be created, just bare in mind that the words between `@`, such as
`@name@` or `@icon@`, are what the script searches for to insert the text and image file names.
Don't leave commented lines since they are uncommented when no background image is found. Related to
this, the lines containing `%bg%` are deleted when no background image is found.