aboutsummaryrefslogtreecommitdiffstats
path: root/readme.rst
diff options
context:
space:
mode:
Diffstat (limited to 'readme.rst')
-rw-r--r--readme.rst16
1 files changed, 16 insertions, 0 deletions
diff --git a/readme.rst b/readme.rst
index 3b93ae4..52d367a 100644
--- a/readme.rst
+++ b/readme.rst
@@ -6,3 +6,19 @@ kana in this form:
- rock
- void
- empty
+
+
+Level file are store in `kana_quest_level`. Format is yaml.
+Example file `level_XX.XX.yaml`::
+ # kana quest grid level XX.XX
+ size: [3, 2]
+ max_actions: 1
+ target_score: 3
+ grid: [
+ [void, null], [myst, nu ], [void, null],
+ [froz, ne ], [empt, null], [rock, 'no'],
+ ]
+
+**WARNING** in level file definition:
+The kana 'no' need to be protected else the program convert it into False...
+