first commit yay

README.md

@@ -1,3 +1,65 @@
-# inscryption-card-generator
+# Inscryption Card Generator CLI
 
-Python script for Inscryption cards generation
+To generate a single card:
+```
+python main.py grizzly.png -p grizzly -ca 3 -ct blood -r 2 -n Grizzly -hp 6 -d 4
+```
+
+To generate a cardset from json:
+```
+python main.py act1 -cs act1_ru.json
+```
+
+cardset.json
+```json
+[
+    {
+        "background": "common", 
+        "name": "Grizzly", 
+        "portrait": "grizzly",
+        "symbols": [],
+        "cost-type": "blood",
+        "cost-amount": 3,
+        "hp": 4,
+        "damage": 6
+    }
+]
+```
+
+## Assets Directory Structure
+
+```
+assets/
+├── backgrounds/
+│   ├── blank.png
+│   ├── common.png
+│   ├── golden.png
+│   ├── rare.png
+│   └── terrain.png
+├── costs/
+│   ├── cost_1blood.png
+│   ├── cost_1bone.png
+│   └── [other card costs up to 4 blood and 10 bone]
+├── deathcard/
+│   ├── deathcard_eyes_1.png
+│   ├── deathcard_eyes_2.png
+│   └── [other deathcard portrait parts]
+├── decals/
+│   ├── decal_blood_1.png
+│   ├── decal_smoke.png
+│   └── [other card decals up to blood 4]
+├── portraits/
+│   ├── portrait_amalgam.png
+│   └── [other card portraits]
+├── symbols/
+│   ├── portrait_amalgam.png
+│   └── [other card symbols]
+├── tribes/
+│   ├── tribe_bird.png
+│   ├── tribe_canine.png
+│   ├── tribe_hooved.png
+│   ├── tribe_insect.png
+│   └── tribe_reptile.png
+├── squid_title.png (name for squid cards)
+└── HEAVYWEIGHT.ttf
+```