aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorIndrajith K L2022-06-12 22:42:24 +0530
committerIndrajith K L2022-06-12 22:42:24 +0530
commitaefec38767c798ad3c8ec8bdc224ddd53bf886c8 (patch)
tree4ee65fc67b315fbfb34e3a5b8786b4560923e943 /README.md
downloaddialog-starter-aefec38767c798ad3c8ec8bdc224ddd53bf886c8.tar.gz
dialog-starter-aefec38767c798ad3c8ec8bdc224ddd53bf886c8.tar.bz2
dialog-starter-aefec38767c798ad3c8ec8bdc224ddd53bf886c8.zip
Initial Commit
* Adds Working Example * Adds release scripts
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..78040f0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+### Dialog Interactive Fiction Starter Kit
+<hr/>
+
+This repo contains starter kit for developing Interactive Fiction using [`Dialog language`][dialog]. Includes a powershell script to generate a web version of the game
+
+> Script assumes you have already installed [`dialog`][dialog] and [`Å-machine VM`][a-machine] in your system path. Also you have to copy stdlib.dg from the dialog folder to your game root path.
+
+### IFID
+Make sure you have replaced your story with a new `IFID` in `story.dg`.
+> You can easily generate `IFID` using [`IFID generator`][dialog] available at [dialog website][dialog].
+
+[dialog]: https://www.linusakesson.net/dialog/
+[a-machine]: https://www.linusakesson.net/dialog/aamachine/index.php \ No newline at end of file