https://github.com/flybywiresim/msfs-nodejs

Node.JS bindings for the MSFS-SDK
https://github.com/flybywiresim/msfs-nodejs

Last synced: about 2 months ago
JSON representation

Node.JS bindings for the MSFS-SDK

• Host: GitHub
• URL: https://github.com/flybywiresim/msfs-nodejs
• Owner: flybywiresim
• License: gpl-3.0
• Created: 2022-12-07T22:18:19.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-04-04T20:27:56.000Z (about 1 year ago)
• Last Synced: 2025-04-10T05:26:10.094Z (about 2 months ago)
• Language: C++
• Homepage:
• Size: 580 KB
• Stars: 6
• Watchers: 3
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
![FlyByWire Simulations](https://raw.githubusercontent.com/flybywiresim/branding/master/tails-with-text/FBW-Color-Dark.svg#gh-light-mode-only)

![FlyByWire Simulations](https://raw.githubusercontent.com/flybywiresim/branding/master/tails-with-text/FBW-Color-Light.svg#gh-dark-mode-only)

# FlyByWire Simulations API Client

The Node.JS wrapper around the MSFS SDK.

The library supports both JavaScript and TypeScript.

## Installation

Install the client library using npm:

    $ npm install --save @flybywiresim/msfs-nodejs

## Build steps

Install [node-gyp](https://github.com/nodejs/node-gyp) on the system and follow the the installation instructions.

Start the build process by `npm run build:all`.

### Hotfixes for build issues

If the binding-compilation fails due to v8.h include errors is it required to delete the local cache of node-gyp.

node-gyp cache: `%LocalAppData%/node-gyp/Cache`

Thereafter execute `node-gyp configure` and the problem should be solved.

## Release steps

Some manual steps are required to release the package.

These steps are required to avoid the creation a Windows-VM on Github.

- Build the bindings with Visual Studio on your local machine

- Call `npm run build:rollup`

- Commit and push the new generated *.node-bindings

- Create a new tag on github and publish the release

## License

This software is licensed under the [MIT license](https://github.com/flybywiresim/api-client/blob/main/LICENSE).