Added cardGen folder, with a script to generate DnD cards.

1 files changed, 31 insertions, 0 deletions

diff --git a/cardGen/README.md b/cardGen/README.md
new file mode 100644
index 0000000..7458396
--- /dev/null
+++ b/cardGen/README.md
@@ -0,0 +1,31 @@
+# dndCard.sh
+
+Takes some fields from an input file and builds a pdf or image of a card from them. 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.
+
+Usage:
+
+```
+dndCard.sh [-t templateFile] [-b bodyFile] inputFile
+```
+
+Example of body 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
+```
+
+Example of output, with no image background and using
+[an icon](https://game-icons.net/1x1/lorc/potion-ball.html)
+from the amazing source [game-icons.net](https://game-icons.net/):
+
+![Potion card example](Health_potion.png)