Skip to content

Commit 867ae07

Browse files
pepperoni505pepperoni505
committed
refactor: rename old project name references
1 parent 3c51d2a commit 867ae07

File tree

134 files changed

+3905
-3905
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

134 files changed

+3905
-3905
lines changed

‎.github/workflows/pr.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ jobs:
6161
- name: Create env file
6262
run: |
6363
touch .env
64-
echo NAVDATA_SIGNED_URL=${{ secrets.NAVDATA_SIGNED_URL }} >> .env
64+
echo NAVIGATION_DATA_SIGNED_URL=${{ secrets.NAVIGATION_DATA_SIGNED_URL }} >> .env
6565
6666
- name: Build WASM module
6767
run: npm run build:wasm-workflow
@@ -72,5 +72,5 @@ jobs:
7272
- name: Upload WASM module to GitHub
7373
uses: actions/upload-artifact@v4
7474
with:
75-
name: msfs_navdata_interface.wasm
76-
path: ./out/msfs_navdata_interface.wasm
75+
name: msfs_navigation_data_interface.wasm
76+
path: ./out/msfs_navigation_data_interface.wasm

‎.github/workflows/pre-release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ jobs:
2020
- name: Pre-Release
2121
uses: softprops/action-gh-release@v1
2222
with:
23-
files: ./out/msfs_navdata_interface.wasm
23+
files: ./out/msfs_navigation_data_interface.wasm
2424
prerelease: true
2525
generate_release_notes: true
2626

‎.github/workflows/release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ jobs:
2222
- name: Release
2323
uses: softprops/action-gh-release@v1
2424
with:
25-
files: ./out/msfs_navdata_interface.wasm
25+
files: ./out/msfs_navigation_data_interface.wasm

‎.gitignore

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ _PackageInt
44
.rollup.cache
55
tsconfig.tsbuildinfo
66
.vs
7-
examples/aircraft/PackageSources/html_ui/Pages/VCockpit/Instruments/Navigraph/NavdataInterfaceSample
8-
examples/aircraft/PackageSources/SimObjects/Airplanes/Navigraph_Navdata_Interface_Aircraft/panel/msfs_navdata_interface.wasm
7+
examples/aircraft/PackageSources/html_ui/Pages/VCockpit/Instruments/Navigraph/NavigationDataInterfaceSample
8+
examples/aircraft/PackageSources/SimObjects/Airplanes/Navigraph_Navigation_Data_Interface_Aircraft/panel/msfs_navigation_data_interface.wasm
99
out
1010

1111
# Rust

‎README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Navigraph Navdata Interface in MSFS
1+
# Navigraph Navigation Data Interface in MSFS
22

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).
44

55
Documentation on the events used on the CommBus is located [here](/DOCS.md)
66

@@ -9,26 +9,26 @@ Documentation on the events used on the CommBus is located [here](/DOCS.md)
99
Here's an overview on the structure of this repository, which is designed to be as simple as possible to use
1010

1111
- `examples/`
12-
- Contains sample implementations for using the navdata interface
12+
- Contains sample implementations for using the navigation data interface
1313
- `aircraft/` includes a base aircraft to test in the sim
1414
- `gauge/` includes a very simple TypeScript instrument to communicate with the WASM module
1515
- `src/`
1616
- `database` Includes rust source code for interfacing with a DFD sqlite file (not WASM specific)
1717
- `js` Includes source code for the JS interface for using the sdk
1818
- `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
2020

2121
## Including in Your Aircraft
2222

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).
2424
2. Add the WASM module into your `panel` folder in `PackageSources`
2525
3. Add the following entry into `panel.cfg` (make sure to replace `NN` with the proper `VCockpit` ID):
2626
```
2727
[VCockpitNN]
2828
size_mm=0,0
2929
pixel_size=0,0
3030
texture=NO_TEXTURE
31-
htmlgauge00=WasmInstrument/WasmInstrument.html?wasm_module=msfs_navdata_interface.wasm&wasm_gauge=navdata_interface,0,0,1,1
31+
htmlgauge00=WasmInstrument/WasmInstrument.html?wasm_module=msfs_navigation_data_interface.wasm&wasm_gauge=navigation_data_interface,0,0,1,1
3232
```
3333
- 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
3434

@@ -41,18 +41,18 @@ Before building, make sure you have properly created and set an `.env` file in `
4141
3. Run `npm i` the first time you build, in order to install dependencies
4242
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).
4343
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
4545

4646
## Building the WASM Module Yourself
4747

4848
1. [Download](https://www.docker.com/products/docker-desktop/) Docker Desktop
4949
2. Run `npm run build:wasm` (must be on Windows)
5050
- 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`
5252

53-
## Interfacing with the navdata gauge manually
53+
## Interfacing with the gauge manually
5454

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).
5656

5757
The gauge communicates using the following event names:
5858

‎docs/RFC 001.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ Status: Active
88

99
## Problem
1010

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.
1212

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.
1414

1515
This RFC will outline the following:
1616

@@ -20,7 +20,7 @@ This RFC will outline the following:
2020

2121
## Anti-Goals
2222

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.
2424

2525
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.
2626

‎env.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ declare namespace NodeJS {
44
interface ProcessEnv {
55
// For test running
66
// Must be a client which supports password auth grants
7-
NAVDATA_SIGNED_URL: string
7+
NAVIGATION_DATA_SIGNED_URL: string
88
}
99
}

‎examples/aircraft/NavdataInterfaceAircraftProject.xml

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎examples/aircraft/NavigationDataInterfaceAircraftProject.xml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<Project Version="2" Name="NavigationDataInterfaceAircraftProject" FolderName="Packages" PublishingGroupFolderName="PublishingGroupsContent" MetadataFolderName="PackagesMetadata" PublishingGroupMetadataFolderName="PublishingGroupsMetadata">
3+
<OutputDirectory>.</OutputDirectory>
4+
<TemporaryOutputDirectory>_PackageInt</TemporaryOutputDirectory>
5+
<PublishingGroupTemporaryOutputDirectory>_PublishingGroupInt</PublishingGroupTemporaryOutputDirectory>
6+
<Packages>
7+
<Package>PackageDefinitions\navigraph-aircraft-navigation-data-interface-sample.xml</Package>
8+
</Packages>
9+
<PublishingGroups/>
10+
</Project>
11+

‎examples/aircraft/PackageDefinitions/navigraph-aircraft-navdata-interface-sample.xml renamed to ‎examples/aircraft/PackageDefinitions/navigraph-aircraft-navigation-data-interface-sample.xml

Lines changed: 48 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,48 @@
1-
<?xml version="1.0" encoding="utf-8"?>
2-
<AssetPackage Version="0.1.0">
3-
<ItemSettings>
4-
<ContentType>AIRCRAFT</ContentType>
5-
<Title>Navigraph Navdata Interface Sample Aircraft</Title>
6-
<Manufacturer>My Manufacturer</Manufacturer>
7-
<Creator>Navigraph</Creator>
8-
</ItemSettings>
9-
<Flags>
10-
<VisibleInStore>true</VisibleInStore>
11-
<CanBeReferenced>true</CanBeReferenced>
12-
</Flags>
13-
<AssetGroups>
14-
<AssetGroup Name="ContentInfo">
15-
<Type>Copy</Type>
16-
<Flags>
17-
<FSXCompatibility>false</FSXCompatibility>
18-
</Flags>
19-
<AssetDir>PackageDefinitions\navigraph-aircraft-navdata-interface-sample\ContentInfo\</AssetDir>
20-
<OutputDir>ContentInfo\navigraph-aircraft-navdata-interface-sample\</OutputDir>
21-
</AssetGroup>
22-
<AssetGroup Name="Data">
23-
<Type>Copy</Type>
24-
<Flags>
25-
<FSXCompatibility>false</FSXCompatibility>
26-
</Flags>
27-
<AssetDir>PackageSources\Data\</AssetDir>
28-
<OutputDir>Data\</OutputDir>
29-
</AssetGroup>
30-
<AssetGroup Name="SimObject">
31-
<Type>SimObject</Type>
32-
<Flags>
33-
<FSXCompatibility>false</FSXCompatibility>
34-
</Flags>
35-
<AssetDir>PackageSources\SimObjects\Airplanes\Navigraph_Navdata_Interface_Aircraft\</AssetDir>
36-
<OutputDir>SimObjects\Airplanes\Navigraph_Navdata_Interface_Aircraft\</OutputDir>
37-
</AssetGroup>
38-
<AssetGroup Name="html_ui">
39-
<Type>Copy</Type>
40-
<Flags>
41-
<FSXCompatibility>false</FSXCompatibility>
42-
</Flags>
43-
<AssetDir>PackageSources\html_ui\</AssetDir>
44-
<OutputDir>html_ui\</OutputDir>
45-
</AssetGroup>
46-
</AssetGroups>
47-
</AssetPackage>
48-
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<AssetPackage Version="0.1.0">
3+
<ItemSettings>
4+
<ContentType>AIRCRAFT</ContentType>
5+
<Title>Navigraph Navigation Data Interface Sample Aircraft</Title>
6+
<Manufacturer>My Manufacturer</Manufacturer>
7+
<Creator>Navigraph</Creator>
8+
</ItemSettings>
9+
<Flags>
10+
<VisibleInStore>true</VisibleInStore>
11+
<CanBeReferenced>true</CanBeReferenced>
12+
</Flags>
13+
<AssetGroups>
14+
<AssetGroup Name="ContentInfo">
15+
<Type>Copy</Type>
16+
<Flags>
17+
<FSXCompatibility>false</FSXCompatibility>
18+
</Flags>
19+
<AssetDir>PackageDefinitions\navigraph-aircraft-navigation-data-interface-sample\ContentInfo\</AssetDir>
20+
<OutputDir>ContentInfo\navigraph-aircraft-navigation-data-interface-sample\</OutputDir>
21+
</AssetGroup>
22+
<AssetGroup Name="Data">
23+
<Type>Copy</Type>
24+
<Flags>
25+
<FSXCompatibility>false</FSXCompatibility>
26+
</Flags>
27+
<AssetDir>PackageSources\Data\</AssetDir>
28+
<OutputDir>Data\</OutputDir>
29+
</AssetGroup>
30+
<AssetGroup Name="SimObject">
31+
<Type>SimObject</Type>
32+
<Flags>
33+
<FSXCompatibility>false</FSXCompatibility>
34+
</Flags>
35+
<AssetDir>PackageSources\SimObjects\Airplanes\Navigraph_Navigation_Data_Interface_Aircraft\</AssetDir>
36+
<OutputDir>SimObjects\Airplanes\Navigraph_Navigation_Data_Interface_Aircraft\</OutputDir>
37+
</AssetGroup>
38+
<AssetGroup Name="html_ui">
39+
<Type>Copy</Type>
40+
<Flags>
41+
<FSXCompatibility>false</FSXCompatibility>
42+
</Flags>
43+
<AssetDir>PackageSources\html_ui\</AssetDir>
44+
<OutputDir>html_ui\</OutputDir>
45+
</AssetGroup>
46+
</AssetGroups>
47+
</AssetPackage>
48+

‎examples/aircraft/PackageDefinitions/navigraph-aircraft-navdata-interface-sample/Business.json renamed to ‎examples/aircraft/PackageDefinitions/navigraph-aircraft-navigation-data-interface-sample/Business.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
{
2-
"PriceInUSD": 0,
3-
"ThirdPartyShortName": "mycompany",
4-
"AccountSellerId": "sellerid",
5-
"UseFirstAvailableReleaseDate": true
6-
}
1+
{
2+
"PriceInUSD": 0,
3+
"ThirdPartyShortName": "mycompany",
4+
"AccountSellerId": "sellerid",
5+
"UseFirstAvailableReleaseDate": true
6+
}

‎examples/aircraft/PackageDefinitions/navigraph-aircraft-navdata-interface-sample/ContentInfo/Thumbnail.jpg renamed to ‎examples/aircraft/PackageDefinitions/navigraph-aircraft-navigation-data-interface-sample/ContentInfo/Thumbnail.jpg

File renamed without changes.

0 commit comments

Comments
 (0)