Browse Source

update read me for placement phase

Bastien Sevajol 5 years ago
parent
commit
a1436b0766
1 changed files with 30 additions and 8 deletions
  1. 30 8
      README.md

+ 30 - 8
README.md View File

@@ -29,16 +29,38 @@ You also need a running redis server (used db number is `0`, soon configurable).
29 29
 
30 30
 # Run
31 31
 
32
-Example run:
32
+## Troops selection
33
+
34
+Not developed yet
35
+
36
+## Troops Placement phase
37
+
38
+You must: specify a map and a state and `--placement` option:
39
+
40
+    python run.py maps/001 --state maps/001/state1.xml --placement
41
+
42
+Map will be loaded with state file troops and you will be able
43
+to move (drag and drop with your mouse) troops.
44
+
45
+Press `s` key will generate a state file in current dir.
46
+
47
+## Combat phase
48
+
49
+You must: specify a map and a state:
33 50
 
34 51
     python run.py maps/001 --state maps/001/state1.xml
35 52
 
36
-# Actual keys
53
+Map will be loaded with state file troops and you will be able to order them.
54
+
55
+# Actual keys / Give orders
56
+
57
+When unit selected (click with mouse on soldier):
58
+
59
+* `r`: run
60
+* `c`: crouch
61
+* `m`: move
62
+* `f`: fire (not implemented)
37 63
 
38
-When unit selected: 
64
+And you can:
39 65
 
40
-* R: run
41
-* C: crouch
42
-* M: move
43
-* F: fire (not implemented)
44
-* S: Save current state into OpenCombat dir (or dir specified with `--state-save-dir`)
66
+* `s`: Save current state into OpenCombat dir (or dir specified with `--state-save-dir`)