Showing 1 changed files with 47 additions and 1 deletions
+47 -1
README.md
... ...
@@ -17,6 +17,8 @@
17 17
 [paused]:     http://wiki.flightgear.org/images/thumb/d/dc/Paused.png/16px-Paused.png                 "en pause"
18 18
 
19 19
 ![ZKV1000, just after boot](https://sebmarque.hd.free.fr/bozon/index.php?f=158cf9534074e2)
20
+ZKV1000 just after booting, installed in the Lancair 235 (all other instruments removed)  
21
+[other pictures available here](https://sebmarque.hd.free.fr/bozon/index.php?f=158cf95340742d)
20 22
 
21 23
 # Thanks
22 24
 Thanks to the modeller of the [GDU104X project "Farmin/G1000"](http://wiki.flightgear.org/Project_Farmin/FG1000)(can't remember who, if he/she can tell me...) I can continue the work began many years ago with a nicer (and working) 3D model instrument. Thanks to him/her for the SVG basis file too.  
... ...
@@ -68,6 +70,7 @@ Please report bug at <seb.marque@free.fr>.
68 70
 * ![][80%]
69 71
   * EIS: texts displayed ![][done], animations for fuel ![][ongoing]
70 72
 * ![][70%]
73
+  * make booting animation visible ![][pending]
71 74
 * ![][60%]
72 75
 * ![][50%]
73 76
   * EIS: animations for temperature for YaSim and JSBSim
... ...
@@ -94,7 +97,50 @@ Please report bug at <seb.marque@free.fr>.
94 97
   * tutorials
95 98
   * many more...
96 99
 
97
-# documentation
100
+# Installation
101
+Somewhere in the XML configuration of your aircraft, put only few lines
102
+## Create the `zkv1000` Nasal namespace
103
+In the `<nasal>` place of your aircraft configuration
104
+
105
+        <zkv1000>
106
+            <file>Aircraft/Instruments-3d/zkv1000/zkv1000.nas</file>
107
+        </zkv1000>
108
+
109
+Actually this is where everything begins, please have a look at this code, it would help you to follow the script.
110
+
111
+## 3D models
112
+In the definition of your flightdeck (here are the values for the installation in the Lancair 235 in which I develop the device)
113
+put it everywhere you want to
114
+
115
+        <model>
116
+            <path>Aircraft/Instruments-3d/zkv1000/pfd.xml</path>
117
+            <offsets>
118
+                <x-m> -0.023 </x-m>
119
+                <y-m> -0.235 </y-m>
120
+                <z-m> -0.028 </z-m>
121
+            </offsets>
122
+        </model>
123
+        <model>
124
+            <path>Aircraft/Instruments-3d/zkv1000/mfd.xml</path>
125
+            <offsets>
126
+                <x-m>  0.03  </x-m>
127
+                <y-m>  0.06  </y-m>
128
+                <z-m> -0.028 </z-m>
129
+                <heading-deg> -15 </heading-deg>
130
+            </offsets>
131
+        </model>
132
+
133
+## Switch it up
134
+You can use the multikey (souvenirs, thanks to Melchior having that much expended this feature years ago :)) service by typing:
135
+`:zo`
136
+
137
+The `:z` will be the multikey entry for all multikeys of the zkv1000.
138
+
139
+1. If you see a single red dot under the `ZKV100O xxx init` message (xxx = MFD or PFD), this is likely the sim is paused (press `p` by default to stop the pause).
140
+1. If you see multiple dots under the `ZKV1000 xxx init` message, something wrong happened, time to check console
141
+1. If you see only black screen on one of the screen, something really wrong happened, time to check console
142
+
143
+# Documentation
98 144
 * [Canvas in FG](http://wiki.flightgear.org/Category:Canvas)
99 145
 * [Nasal](http://wiki.flightgear.org/Category:Nasal)
100 146
 * the guides used to create the scenario from [Garmin website](http://support.garmin.com/support/manuals/searchManuals.faces)