FlyByWire Simulations Installer

This repository contains the installer for FlyByWire Simulations projects such as the A32NX.

How to contribute

The installer is built as an Electron Application for Windows and Linux using TypeScript and React.

Requirements

Please make sure you have:

• git
• NodeJS 20

If you want to build flatpaks (package:flatpak, package:linux, package:all) you will also need to install the following from your preferred package manager:

• flatpak
• flatpak-builder

After installing flatpak add the flathub remote:

flatpak --user remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo

Get started

First fork the project and install the dependencies

npm install

Then run the development server using

npm run dev

To build the package as an executable application, run

npm run package

On Windows this will build an .exe file, on Linux it will build as .AppImage, .deb and .rpm. If you wish to target specific ways of distribution, you may instead run:

npm run package:all # packages for all targets
npm run package:win # packages for windows (.exe)
npm run package:linux # packages for all linux targets (.AppImage,.deb,.rpm,.flatpak and .snap)
npm run package:appimage # packages as .AppImage
npm run package:deb # packages as .deb
npm run package:rpm # packages as .rpm
npm run package:snap # packages as .snap
npm run package:flatpak # packages as .flatpak

Packaged applications (.exe and .AppImage only) will automatically update if there is a newer version available (compared to build version in package.json). On windows, this does also apply to development versions (ending on -devXX), which are updated via a separate stream. Updates are distributed once the build version is changed and a tag has been added.