CJ4: 0.4.0 prerelease bugfixes

.github/workflows/workingtitle-cj4-build.yml

@@ -1,24 +1,24 @@
-name: CI - CJ4 Build
-on:
-  push:
-    branches:
-      - main
-  pull_request:
-    branches:
-      - main
-jobs:
-  build:
-    runs-on: windows-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Build Package
-        run: powershell.exe -noexit .\build.ps1 -Project workingtitle-project-cj4.xml
-      - name: Upload Package
-        uses: actions/upload-artifact@v2.1.4
-        with:
-          name: workingtitle-cj4
-          path: |
-            build/workingtitle-aircraft-cj4
-            build/workingtitle-vcockpits-instruments-cj4
-            build/workingtitle-vcockpits-instruments-airliners
-          if-no-files-found: error
+name: CI - CJ4 Build
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+jobs:
+  build:
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Build Package
+        run: powershell.exe -noexit .\build.ps1 -Project workingtitle-project-cj4.xml
+      # - name: Upload Package
+      #   uses: actions/upload-artifact@v2.1.4
+      #   with:
+      #     name: workingtitle-cj4
+      #     path: |
+      #       build/workingtitle-aircraft-cj4
+      #       build/workingtitle-vcockpits-instruments-cj4
+      #       build/workingtitle-vcockpits-instruments-airliners
+      #     if-no-files-found: error

.gitignore

@@ -7,3 +7,12 @@ ref
 .idea/modules.xml
 .idea/vcs.xml
 .idea/workspace.xml
+CJ4 Build.ps1
+
+src/sound/.cache
+*.akd
+*.prof
+*.wsetting
+*.validationcache
+*.wem
+*.wsettings

build.ps1

@@ -55,18 +55,18 @@ function Update-Packages {
             Write-Host "Creating package path $packagePath..."  
             New-Item -Path $packagePath -ItemType directory | Out-Null
         }
-
-        Write-Host "Writing $manifestPath..."  
-        $manifest | ConvertTo-Json | Out-File -FilePath $manifestPath -Encoding ASCII
-
+
         Write-Host "Copying source files..."
         foreach ($assetGroup in $packageDef.AssetGroups.AssetGroup) {
             $src = Join-Path "." $assetGroup.AssetDir
             $dest = Join-Path $packagePath $assetGroup.OutputDir
             Write-Host "Copying $src to $dest..."
-            robocopy $src $dest /XO /e /njh /njs /nfl /nc /ndl
+            robocopy $src $dest /XO /e /PURGE /XF manifest.json layout.json  | Out-Null
         }
 
+        Write-Host "Writing $manifestPath..."  
+        $manifest | ConvertTo-Json | Out-File -FilePath $manifestPath -Encoding ASCII
+
         Write-Host "Building layout file..."
         $layoutEntries = @()
         foreach ($file in Get-ChildItem -Path $packagePath -Recurse -Exclude "manifest.json" -Attributes !Directory) {

docs/workingtitle-cj4/CHANGES.md

@@ -1,45 +1,82 @@
-# Working Title CJ4 v0.3.1 Changes
+# Working Title CJ4 v0.4.0 Changes
 
-Welcome to the latest update of the Working Title CRJ (v0.3.1). This is still very much a beta. Thank you to everyone who contributed to this release. This update focuses on compatibility with MSFS 1.9.3, but also includes a few new features and quality of life updates as well.
+Welcome to the latest update of the Working Title CJ4 (v0.4.0). This is still very much a beta. Thank you to everyone who contributed to this release. We have been hard at work behind the scenes to tackle some of the core flight management systems, so the number of changes is shorter this time, but still with some fun and important features and fixes. Overall, this bird should be a bunch more fun to fly.
 
 ## Installation
-Installation is easy, simply copy the `workingtitle-aircraft-cj4` folder inside the zip file to your MSFS Community folder. **Important: Due to some file location changes in the latest MSFS version, it is mandatory that you fully delete the previous `workingtitle-aircraft-cj4` folder before copying this release.**
+Installation is easy, simply copy the `workingtitle-aircraft-cj4` folder inside the zip file to your MSFS Community folder. 
+
+**Important: We recommend that you fully delete the previous `workingtitle-aircraft-cj4` folder before copying this release.**
 
 ## Key Features
 
-* Now compatible with MSFS 1.9.3
+* New custom engine fuel consumption model code based on FJ44 curves and pilot input
+* Overhauled LEGS page for more flexibility and real unit functions (WIP)
+* Many FPLN page bug fixes
+* A few quality of life and critical bug fixes
+* Overhaul of DEP/ARR pages and working STAR approaches (thanks @tscharlii)
+* Added functional options in the UPR MENU
 
-### FPLN Page
-* Incorrect page numbering has been fixed
-* Added colors to selected SIDS/Runways for DEP page only (WIP due to 1.9.3 patch)
-* Added ability to insert waypoints in the middle of the flight plan
-* Fixed issue where FPLN would always return to page 1 after EXEC
+### Engine Model
+* Engine fuel consumption model has been custom coded and replaces the sim fuel consumption. Fuel consumption, especially at cruise, should be much, much closer to published. Expect 1800-1850pph per side at ISA full power at sea level and 500-800pph per side at cruise, depending on altitude, mach, and power settings.
+* Thrust now scales exponentially with N1 instead of linearly. Power settings should feel much more accurate.
 
-### DEP/ARR Page
-* Executing a change doesn’t move you away from the page
-* Improved formatting
+### Flight Model
+* Added gear drag (Was non-existent before)
+* Greatly reduced spoiler drag & pitch down moment (You shouldn't be losing airspeed in a 30 degree nose down dive with the speedbrakes out)
+* Reduced flap drag 
 
 ### LEGS Page
-* Adjusted layout and colors to better match the real unit
+* Added ability to insert a new fix
+* Added ability to remove whole segments by pressing LSK of one fix and then LSK of another
+* Added ability to to direct-to a leg by pressing LSK of the fix and then dropping onto the magenta line
+* Added ability to delete individual fixes
+* Magenta fix distance updates distance to go as aircraft moves
+* Fixed issue where unable to delete with a departure active
+* Made the WORKING prompt more consistent
+* Added feature to show runway where possible
+* Disabled the ability to adjust approach fixes due to simulator limitations
+* Each waypoint now shows the distance to the next fix instead of the cumulative flight plan distance.
+* Blue waypoint is the FROM waypoint
+* Magenta waypoint is the current TO waypoint
+* Only fixes with an altitude or speed restriction will populate on the right side in green.  (It does not show cruise altitude anymore)
+
+### FPLN Page
+* Fixed issue where adding via airway would not add all fixes along airway to flight plan
+* Fixed issue where a blank line was not always provided to add a fix
+* Condensed display to only show airway entry and exit as per the real unit
+* Fixed issue where VIA was not displayed on page 2+
+* Fixed issue where attempting to delete the first fix on page 1 would insert CLRIC
+* Fixed issue where unable to delete with a departure active
+
+### DEP/ARR Pages
+* Proper formatting and flow of DEP/ARR pages (thanks @tscharlii)
+* Fixed scrolling through procedures and runways (thanks @tscharlii)
+* STAR approaches should now work properly (thanks @tscharlii)
+
+### FUEL MGMT Page
+* Total fuel used now initialized to its starting point when the FMC loads
 
 ### TUNE Page
-* Fixed issue where nav radios would not update the sim radios on update
+* Page now updates and syncs back radio changes made from other instruments or the simulator
 
 ### PFD/MFD
-* Adjusted font size, color, and spacing for better readability and accuracy
-
-### PFD
-* Added DME readout for VORs
-* Changed to use correct colors (Magenta for FMS, green for ground NAVAIDS)
-* Changed formatting of VOR info block to match the correct layout and element spacing
+* Fixed issue where ILS localizers reporting DME distance as strings would crash the displays
+* Show animated radar bug
+* MFD Checklists have been added
+* Pax Brief Menu has been added (Unfortunately, no sounds for it yet, next release)
+* Added FMS Text option (this essentially displays the PROG page on the MFD)
+* Added functional PASS BRIEF, CHECKLIST, and SYS buttons on the CCP (Cursor Control Panel)
 
-### Aircraft Exterior Model
-* Aircraft lights have been updated in style to add some lens flaring, brighter visibility, and textures (thanks @Uwajimaya)
+### Audio
+* Improved BELT button audio (Currently the chime is non-functional for this.  Fix soon)
+* Added SAFETY button chime and announcement and also chime when you turn the SAFETY and BELT buttons off.
+* Increased volume of pilot and co-pilot fan air sounds
 
 ## Known Issues
-* You cannot currently select Direct-To of a fix on your approach that is not the initial approach fix. This is a limitation of the sim flightplan system at present. We are investigating solutions to this issue.
+* Modifications of the flight plan can be slow at times. The cause for this is Asobo's FacilityLoader which they need to fix. When the FMC shows "Working..." it indicates an operation is in progress.
+* Sometimes when entering an airway and the exit fix, the airway name will change to the shared airway, however the routing is still correct.
+* You cannot currently select Direct-To of a fix on your approach that is not the initial approach fix. This is a limitation of the sim flightplan system at present. We are currently overhauling the flight plan management system to allow for much more flexibility and stability.
 * After using Direct-To, the navigation will not always automatically sequence to the next fix and may enter ROL mode. You can re-activate NAV to navigate to the next fix if you encounter this issue.
 * The aircraft is still using the built-in MSFS autopilot (for now). All the existing limitations of that still apply. It does behave a bit better with the various enhancements applied.
-* TUN page doesn't update automatically when radios are updated externally - reopening the TUN page will reflect these changes.
 * Performance pages don't currently have input error handling for wind, temp or QNH. These values must be entered correctly and completly in the proper format for the page to work. Note that valid wind directions are 001 through 360 as of now.
 * FLC stability appears to have regressed with the autopilot aircraft energy calculation changes in 1.9.3. We have attempted tuning the autopilot PIDs but as of right now the behavior of the underlying sim FLC PID itself seems to be at issue. We will continue to investigate.

docs/workingtitle-cj4/Working Title CJ4 v0.3.1 Changes.md

@@ -0,0 +1,45 @@
+# Working Title CJ4 v0.3.1 Changes
+
+Welcome to the latest update of the Working Title CRJ (v0.3.1). This is still very much a beta. Thank you to everyone who contributed to this release. This update focuses on compatibility with MSFS 1.9.3, but also includes a few new features and quality of life updates as well.
+
+## Installation
+Installation is easy, simply copy the `workingtitle-aircraft-cj4` folder inside the zip file to your MSFS Community folder. **Important: Due to some file location changes in the latest MSFS version, it is mandatory that you fully delete the previous `workingtitle-aircraft-cj4` folder before copying this release.**
+
+## Key Features
+
+* Now compatible with MSFS 1.9.3
+
+### FPLN Page
+* Incorrect page numbering has been fixed
+* Added colors to selected SIDS/Runways for DEP page only (WIP due to 1.9.3 patch)
+* Added ability to insert waypoints in the middle of the flight plan
+* Fixed issue where FPLN would always return to page 1 after EXEC
+
+### DEP/ARR Page
+* Executing a change doesn’t move you away from the page
+* Improved formatting
+
+### LEGS Page
+* Adjusted layout and colors to better match the real unit
+
+### TUNE Page
+* Fixed issue where nav radios would not update the sim radios on update
+
+### PFD/MFD
+* Adjusted font size, color, and spacing for better readability and accuracy
+
+### PFD
+* Added DME readout for VORs
+* Changed to use correct colors (Magenta for FMS, green for ground NAVAIDS)
+* Changed formatting of VOR info block to match the correct layout and element spacing
+
+### Aircraft Exterior Model
+* Aircraft lights have been updated in style to add some lens flaring, brighter visibility, and textures (thanks @Uwajimaya)
+
+## Known Issues
+* You cannot currently select Direct-To of a fix on your approach that is not the initial approach fix. This is a limitation of the sim flightplan system at present. We are investigating solutions to this issue.
+* After using Direct-To, the navigation will not always automatically sequence to the next fix and may enter ROL mode. You can re-activate NAV to navigate to the next fix if you encounter this issue.
+* The aircraft is still using the built-in MSFS autopilot (for now). All the existing limitations of that still apply. It does behave a bit better with the various enhancements applied.
+* TUN page doesn't update automatically when radios are updated externally - reopening the TUN page will reflect these changes.
+* Performance pages don't currently have input error handling for wind, temp or QNH. These values must be entered correctly and completly in the proper format for the page to work. Note that valid wind directions are 001 through 360 as of now.
+* FLC stability appears to have regressed with the autopilot aircraft energy calculation changes in 1.9.3. We have attempted tuning the autopilot PIDs but as of right now the behavior of the underlying sim FLC PID itself seems to be at issue. We will continue to investigate.

src/.eslintrc.json

@@ -1,22 +1,22 @@
 {
     "env": {
         "browser": true,
-        "es6": true
+        "es2017": true
     },
     "extends": "eslint:recommended",
     "rules": {
         "no-redeclare": [
             "error", {
-              "builtinGlobals": false
+                "builtinGlobals": false
             }
-          ],
-          "no-unused-vars": [
+        ],
+        "no-unused-vars": [
             "error", {
-              "vars": "all",
-              "varsIgnorePattern": "^CJ4_FMC|^WT_FMC"
+                "vars": "all",
+                "varsIgnorePattern": "^CJ4_|^WT_|Loader$"
             }
-          ],
-          "semi": [2, "always"]
+        ],
+        "semi": [2, "always"]
     },
     "globals": {
         "Avionics": "readonly",
@@ -26,13 +26,72 @@
         "SimVar": "writable",
         "Simplane": "writable",
         "Aircraft": "writable",
+        "BaseAirliners": "writable",
         "FMCMainDisplay": "writable",
+        "ERadarMode": "writable",
         "NavMode": "writable",
+        "IntersectionInfo": "writable",
         "RadioNav": "writable",
         "RegisterViewListener": "writable",
+        "EMapDisplayMode": "writable",
         "registerInstrument": "writable",
         "WT_FMC_Renderer": "readonly",
+        "Utils": "readonly",
+        "Jet_NDCompass_Display": "readonly",
+        "NearestAirspace": "readonly",
+        "FacilityLoader": "readonly",
+        "MFD_MapElement": "readonly",
+        "NavSystemElement": "readonly",
+        "MFD_NearestNDB_Element": "readonly",
+        "AS1000": "readonly",
+        "g_modDebugMgr": "readonly",
+        "BaseAS1000": "readonly",
+        "NearestWaypointRoute": "readonly",
+        "NearestIntersection": "readonly",
+        "NearestAirport": "readonly",
+        "NearestNDB": "readonly",
+        "WayPoint": "readonly",
+        "Airway": "readonly",
+        "NDBLoader": "readonly",
+        "VORLoader": "readonly",
+        "NearestVOR": "readonly",
+        "IntersectionLoader": "readonly",
+        "LatLongAlt": "readonly",
+        "SoftKeyElement": "readonly",
+        "WTDataStore": "readonly",
+        "MFD_WaypointLine": "readonly",
+        "MFD_Procedures": "readonly",
+        "MFD_ApproachWaypointLine": "readonly",
+        "MFD_ActiveFlightPlan_Element": "readonly",
+        "MFD_NearestVOR_Element": "readonly",
+        "MFD_NearestAirport_Element": "readonly",
+        "MFD_NearestIntersection_Element": "readonly",
+        "NavSystemPage": "readonly",
+        "SearchFieldWaypointICAO": "readonly",
+        "SelectableElementSliderGroup": "readonly",
+        "SelectableElement": "readonly",
+        "SoftKeysMenu": "readonly",
+        "WTEngine": "readonly",
+        "Include": "readonly",
+        "NavSystemPageGroup": "readonly",
+        "NavSystemEventLinkedPopUpWindow": "readonly",
+        "Jet_NDCompass_Navigation": "readonly",
+        "CJ4_MapSymbol": "readonly",
+        "CJ4_PopupMenu": "readonly",
+        "CJ4_PopupMenu_Key": "readonly",
+        "CJ4_SystemPage": "readonly",
+        "CJ4_MapContainer": "readonly",
+        "CJ4_MapOverlayContainer": "readonly",
+        "CJ4_Checklist_Container": "readonly",
+        "CJ4_PassengerBrief_Container": "readonly",
+        "CJ4_NavBarContainer": "readonly",
+        "CJ4_PopupMenuContainer": "readonly",
+        "WayPointInfo": "writable",
+        "AirportInfo": "writable",
         "CJ4_FMC_LegsPage": "readonly",
+        "CJ4_SystemContainer": "readonly",
+        "NavSystemElementGroup": "readonly",
+        "NavSystemElementContainer": "readonly",
         "CJ4_FMC_DepArrPage": "readonly",
         "CJ4_FMC_DsplMenuPage": "readonly",
         "CJ4_FMC_PerfInitPage": "readonly",
@@ -44,4 +103,4 @@
         "CJ4_FMC_InitRefIndexPage": "readonly",
         "CJ4_FMC_PosInitPage": "readonly"
     }
-}
+}