Browse Source

Slight readme update

master
silverwizard 1 year ago
parent
commit
f3d24e4159
1 changed files with 6 additions and 0 deletions
  1. +6
    -0
      README.md

+ 6
- 0
README.md View File

@@ -7,3 +7,9 @@ Example YAML is shopping.yml
Example Card is:

![Example Rifle Card](http://obscuritus.ca/Rifle.png "Rifle")

Usage:

The YAML file is a Deck object containing a series of sub items, the text of those subitems will become the descriptions of the cards, and the name of the subitems becomes the titles of the cards (obviously, see the example).

Placing png files in the Backgrounds directory with their file name set to the card's title, (so, a card called Sword's background file is Sword.png), will make that png file centered in the middle of the card (allowing card art).

Loading…
Cancel
Save