@@ -3,6 +3,11 @@ id: user-guide
33title : User Guide
44---
55
6+ ``` mdx-code-block
7+ import Tabs from '@theme/Tabs';
8+ import TabItem from '@theme/TabItem';
9+ ```
10+
611# Installation (Client)
712
813---
@@ -19,52 +24,62 @@ Desktop and start menu shortcuts will be created, and the program will be regist
1924
2025---
2126
22- ### FSX/Prepar3d Configuration
27+ ## Simulator Configuration
28+ <Tabs >
29+ <TabItem value =" msfs " label =" MSFS 2020/2024 " default >
30+ #### WASM Module
2331
24- To use FSX/Prepar3d, you need to install:
32+ If you're using Microsoft Flight Simulator, to read the LVars from the sim you
33+ need the `FSUIPC WASM Module (Version)` from [FSUIPC](https://www.fsuipc.com/) ,
34+ `fsuipc-lvar-module` folder needs to be manually placed in your community
35+ folder.
2536
26- - [ FSUIPC] ( http://www.fsuipc.com ) - the licensed version isn't required.
27- - [ MakeRwys] ( http://fsuipc.simflight.com/beta/MakeRwys.zip )
37+ 
2838
29- After installing both, run ` MakeRwys ` . ` MakeRwys ` also needs to be re-run
30- whenever there are scenery changes (if you want gates/runways to be updated).
31- ACARS will automatically detected changes to the MakeRwys files, and will
32- update its internal database accordingly.
39+ Also, it is possible to install the WASM Module with FSUIPC main installer.
40+ While installing or updating it, be sure you have the WASM Module option
41+ enabled.
3342
34- ### X-Plane Configuration
43+ 
3544
36- X-Plane uses a custom plugin. Open the ` X-Plane ` folder, and copy the
37- ` AcarsConnect ` folder into your ` Resources\plugins ` folder.
45+ ##### Permission Denied Errors
3846
39- ![ ] ( img/plugin-copy.png )
47+ If you're getting a permission-denied error, see
48+ [this thread](https://forum.navigraph.com/t/faq-navigraph-navdata-center-could-not-find-access-simulator/2104)
49+ </TabItem >
50+ <TabItem value =" xplane " label =" X-Plane " >
4051
41- Also it is possible to copy the plugin automatically from vmsAcars settings, be
42- sure X-Plane is not running and click the ` Copy Plugin To X-Plane ` button after
43- selecting your X-Plane root/main folder.
52+ X-Plane uses a custom plugin. Open the `X-Plane` folder, and copy the
53+ `AcarsConnect` folder into your `Resources\plugins` folder.
4454
45- ![ ] ( img/xplane_button .png )
55+ 
4656
47- ### MSFS Configuration
57+ Also it is possible to copy the plugin automatically from vmsAcars settings, be
58+ sure X-Plane is not running and click the `Copy Plugin To X-Plane` button after
59+ selecting your X-Plane root/main folder.
4860
49- #### WASM Module
61+ 
62+ </TabItem >
63+ <TabItem value =" banana " label =" Prepar3d/FSX " >
64+ To use FSX/Prepar3d, you need to install:
5065
51- If you're using Microsoft Flight Simulator, to read the LVars from the sim you
52- need the ` FSUIPC WASM Module (Version) ` from [ FSUIPC] ( https://www.fsuipc.com/ ) ,
53- ` fsuipc-lvar-module ` folder needs to be manually placed in your community
54- folder.
66+ - [FSUIPC](http://www.fsuipc.com) - the licensed version isn't required.
67+ - [MakeRwys](http://fsuipc.simflight.com/beta/MakeRwys.zip)
5568
56- ![ ] ( img/fsuipc_lvar.png )
69+ After installing both, run `MakeRwys`. `MakeRwys` also needs to be re-run
70+ whenever there are scenery changes (if you want gates/runways to be updated).
71+ ACARS will automatically detected changes to the MakeRwys files, and will
72+ update its internal database accordingly.
5773
58- Also, it is possible to install the WASM Module with FSUIPC main installer.
59- While installing or updating it, be sure you have the WASM Module option
60- enabled.
74+ #### Hardware Configuration
6175
62- ![ ] ( img/fsuipc_install.png )
76+ If you're using hardware to control the sim, ACARS heavily relies on several
77+ offsets with FSUIPC, particularly the parking brake. Ensure that the offset
78+ `0x0BC8` gets set
6379
64- ##### Permission Denied Errors
80+ </TabItem >
81+ </Tabs >
6582
66- If you're getting a permission-denied error, see
67- [ this thread] ( https://forum.navigraph.com/t/faq-navigraph-navdata-center-could-not-find-access-simulator/2104 )
6883
6984---
7085
@@ -118,36 +133,15 @@ Parallels or Virtual Box, which is roughly:
1181331 . Copy the ` AcarsConnect ` plugin to the ` Resources\plugin ` folder (see above)
1191341 . Set the IP address in ACARS to the IP of the host
120135
121- In order to get the scenery scanning working properly, add X-Plane as a shared
122- folder:
123-
124- ![ ] ( img/vmware-sharing.png )
125136
126137Then click "Open In Guest", and you can follow the above instructions for then
127- installing the plugin. Then, in ACARS, properly set the "Scenery Path" and IP to
138+ installing the plugin. Then, in ACARS, properly set the IP to
128139your Mac machine:
129140
130- ::: info
131-
132- If you configure it to point to the X-Plane root, the default share path for
133- VMWare Fusion would be ` \\vmware-host\Shared Folders\X-Plane 11 ` .
134-
135- :::
136-
137- ![ ] ( img/vmware-acars-config.png )
138-
139141Then you can launch/run ACARS as usual.
140142
141143---
142144
143- ### Hardware Configuration
144-
145- If you're using hardware to control the sim, ACARS heavily relies on several
146- offsets with FSUIPC, particularly the parking brake. Ensure that the offset
147- ` 0x0BC8 ` gets set
148-
149- ---
150-
151145## Flight Planning
152146
153147There are several ways to configure flight:
@@ -187,18 +181,6 @@ The routes/navpoints are then loaded from the flight plan, along with the TOD
187181
188182---
189183
190- ## Lights and Aircraft Features
191-
192- Lights and other features for aircraft may not work on all aircraft, due to the
193- way developers differently implement the on/off switches/flags for these (for
194- example, PMDG implements their lights differently for each aircraft). There is a
195- ` ConfigMap.xml ` file that can be edited (make sure to create backups before
196- updated - enhancements to this coming soon) which uses the aircraft name/title
197- to determine which offsets (for FSUIPC) or data refs (X-Plane) are used to
198- detect those features.
199-
200- ---
201-
202184## Flight Phases
203185
204186ACARS defines multiple flight phases, and the transitions between them are
@@ -301,8 +283,6 @@ the phases properly for both IFR and VFR flights.
301283## Debugging
302284
303285To debug whether the lights are working or not, you can open the "Debug" window.
304- To open it, go to the "Map" page, and double-click on "Flight Status". It will
305- open up the debug window, then you can scroll down to the lights, and see the
306- values for the lights being returned:
286+ To open it, go to the "Map" page, click the three dots, and select "Debug Window"
307287
308288![ ] ( img/data-window.png )
0 commit comments