You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
# Navigraph Navdata Interface in MSFS
1
+
# Navigraph Navigation Data Interface in MSFS
2
2
3
-
This is a barebones implementation to be able to download up-to-date Navigraph navdata into MSFS (more specifically into the `work` folder of the aircraft).
3
+
This is a barebones implementation to be able to download up-to-date Navigraph navigation data into MSFS (more specifically into the `work` folder of the aircraft).
4
4
5
5
Documentation on the events used on the CommBus is located [here](/DOCS.md)
6
6
@@ -9,26 +9,26 @@ Documentation on the events used on the CommBus is located [here](/DOCS.md)
9
9
Here's an overview on the structure of this repository, which is designed to be as simple as possible to use
10
10
11
11
-`examples/`
12
-
- Contains sample implementations for using the navdata interface
12
+
- Contains sample implementations for using the navigation data interface
13
13
-`aircraft/` includes a base aircraft to test in the sim
14
14
-`gauge/` includes a very simple TypeScript instrument to communicate with the WASM module
15
15
-`src/`
16
16
-`database` Includes rust source code for interfacing with a DFD sqlite file (not WASM specific)
17
17
-`js` Includes source code for the JS interface for using the sdk
18
18
-`test` Includes code for testing the JS and Rust code using a Node runtime
19
-
-`wasm` includes the Rust source code for the WASM module which handles the downloading of the databse file, and interfacing with the database implementation
19
+
-`wasm` includes the Rust source code for the WASM module which handles the downloading of the database file, and interfacing with the database implementation
20
20
21
21
## Including in Your Aircraft
22
22
23
-
1. You'll need to either build the WASM module yourself (not recommended, but documented further down) or download it from [the latest release](https://github.com/Navigraph/msfs-navdata-interface/releases) (alternatively you can download it off of a commit by looking at the uploaded artifacts).
23
+
1. You'll need to either build the WASM module yourself (not recommended, but documented further down) or download it from [the latest release](https://github.com/Navigraph/msfs-navigation-data-interface/releases) (alternatively you can download it off of a commit by looking at the uploaded artifacts).
24
24
2. Add the WASM module into your `panel` folder in `PackageSources`
25
25
3. Add the following entry into `panel.cfg` (make sure to replace `NN` with the proper `VCockpit` ID):
- Note that if you already have a `VCockpit` with `NO_TEXTURE` you can just add another `htmlgauge` to it, while making sure to increase the index
34
34
@@ -41,18 +41,18 @@ Before building, make sure you have properly created and set an `.env` file in `
41
41
3. Run `npm i` the first time you build, in order to install dependencies
42
42
4. Run `npm run build` to build into the `PackageSources` folder of the aircraft sample (or `npm run dev` to build into the `Packages` folder of the aircraft and listen to changes in the source).
43
43
5. Make sure the WASM module is included in the `panel` folder! Look at either [Including in Your Aircraft](#including-in-your-aircraft) or [Building the WASM Module Yourself](#building-the-wasm-module-yourself) for info on that
44
-
6. Open the `examples/aircraft/NavdataInterfaceAircraftProject.xml` file in the simulator and build there
44
+
6. Open the `examples/aircraft/NavigationDataInterfaceAircraftProject.xml` file in the simulator and build there
- This will take a while to download and build the first time, but subsequent runs will be quicker
51
-
3. The compiled WASM module will be copied to `out`**and**`examples/aircraft/PackageSources/SimObjects/Airplanes/Navigraph_Navdata_Interface_Aircraft/panel`
51
+
3. The compiled WASM module will be copied to `out`**and**`examples/aircraft/PackageSources/SimObjects/Airplanes/Navigraph_Navigation_Data_Interface_Aircraft/panel`
52
52
53
-
## Interfacing with the navdata gauge manually
53
+
## Interfacing with the gauge manually
54
54
55
-
The navdata interface acts as its own WASM gauge in sim, so in order to communicate with it, you must use the [CommBus](https://docs.flightsimulator.com/html/Programming_Tools/WASM/Communication_API/Communication_API.htm).
55
+
The navigation data interface acts as its own WASM gauge in sim, so in order to communicate with it, you must use the [CommBus](https://docs.flightsimulator.com/html/Programming_Tools/WASM/Communication_API/Communication_API.htm).
56
56
57
57
The gauge communicates using the following event names:
Copy file name to clipboardExpand all lines: docs/RFC 001.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,9 +8,9 @@ Status: Active
8
8
9
9
## Problem
10
10
11
-
Accessing Navigraph's navdata in Microsoft Flight Simulator has always been challenging due to the limitations of the JavaScript and Webassembly APIs. However, with the recent addition of the Communications API, allowing different WASM modules and Coherent pages to interact with each other, this has become possible.
11
+
Accessing Navigraph's navigation data in Microsoft Flight Simulator has always been challenging due to the limitations of the JavaScript and Webassembly APIs. However, with the recent addition of the Communications API, allowing different WASM modules and Coherent pages to interact with each other, this has become possible.
12
12
13
-
Navigraph has decided to use an architecture consisting of a wasm module whose job it is to download navdata databases from the internet, and to query them. This means an API must be designed and implemented to best cater to the needs of aircraft developers.
13
+
Navigraph has decided to use an architecture consisting of a wasm module whose job it is to download navigation data databases from the internet, and to query them. This means an API must be designed and implemented to best cater to the needs of aircraft developers.
14
14
15
15
This RFC will outline the following:
16
16
@@ -20,7 +20,7 @@ This RFC will outline the following:
20
20
21
21
## Anti-Goals
22
22
23
-
This interface will not be designed for use in parallel with in sim data, it is meant to provide the best experience possible with Navigraph's navdata capabilities. This interface will only be providing data from Navigraph's databases.
23
+
This interface will not be designed for use in parallel with in sim data, it is meant to provide the best experience possible with Navigraph's navigation data capabilities. This interface will only be providing data from Navigraph's databases.
24
24
25
25
This interface is also not designed for use outside of Microsoft Flight Simulator and is not designed (as of now) with anything other than the Flight Management System in mind.
0 commit comments