EFB TEMPLATE SAMPLE

The EFB sample contains a simple template project that can be used as a base for creating your own EFB apps. For more information on creating EFB apps, please see here:

 

You can expand the link below to see the EFB file and folder structure:

File OverviewFile Overview

|---+ EFB
        |---+ PackageDefinitions
        |   |---- mycompany-efb-templateapp.xml
        |---+ PackageSources
        |   |---+ TemplateApp
        |       |---+ Assets
        |       |   |---- app-icon.svg
        |       |   |---- icon.png
        |       |---- TemplateApp.css
        |       |---- TemplateApp.js
        |---- EFBTemplateAppProject.xml

 

 

Loading And Testing The Project

In order to load and build the project in Microsoft Flight Simulator 2024, you must have previously enabled Developer Mode (see here for more information). Once enabled, simply follow these steps:

 

  • Use the Open project... command from the File menu.

Developer Mode Open Project

 

  • Select the file EFBTemplateAppProject.xml from the EFB > TemplateApp sample project.

Opening The EFB Template App Project

 

  • The Project Editor should open automatically and show you the project efb_apps_template (if the Project Editor doesn't open, then you can open it from the Developer Mode Tools menu)

The EFB Template App In The Project Editor

 

  • You can click on the arrow to the left to expand the list and show the asset groups that are used. In this case we have a single Copy group:
    The Asset Groups For The SimpleFX Sample

 

  • We are using a copy asset group because EFB projects are comprised of XML and JS files, which only need to be copied into the final package and placed in a particular output folder. You can see where these files are stored by selecting the asset group and then looking at the OutputDir in the Inspector window:
    Checking The Output Directory for EFB Apps

 

  • There is nothing more to do with this package in the DevMode editors, as it needs to be built to be usable by the EFBs in the simulation. For that you can click the Build All In Project button at the top of the Project Editor. Note that this should be done before starting a flight.

 

  • After building the package, start a flight using any aircraft with an EFB (we recommend the DA 62). You will see the new app on the main screen, named TemplateApp.
    The TemplateApp Running On An EFB In The Simulation

 

  • Tapping on the app will open the following page:
    How The Template App Looks In The SimulationClicking the buttons will open different pages, show a pop-up message, or go back to the main screen with the app list again.