Installation

There are quite a few steps required to setup and use the SPSDK. This will help you get everything setup and working correctly.

Prerequisites

In order to use the API the following are the minimum requirements:

  1. X-Plane
  2. Bens Plugin
  3. JLS_JetBridge
  4. JLS_simPanel_SDK

Also requires the minimum setup:

  • Node (10.16+)

X-Plane

The choosen flight simulator to receive data from at the moment is X-Plane. But any flight simulator can be used as long as the web application receives the correctly formatted data.

Bens Plugin

// TODO: add to docs

Binaries for the XPC plugin on all platforms can be downloaded from releases page. Copy the entire contents of the BensPlugin.zip file to the [X-Plane Path]\Resources\plugins folder.

The plugin should now be installed. To verify, run X-Plane, and open the Plugins->Plugin Admin->Enable/Disable menu. You should see an entry named "BensPlugin [Version 1.X.X]".

JLS_JetBridge

// TODO: add to docs

JLS_simPanel_SDK

The SPSDK can be found and download from it's repository releases page. Installing the SPSDK is simple as copying the JLS_simPanel_SDK folder to any location near your project. Then simply import any modules you wish to use from your project.

Import Examples

    import { TheModuleToImport } from 'path/to/JLS_simPanel_SDK'
    const JLS_simPanel_SDK = require('path/to/JLS_simPanel_SDK')
    const JLS_simPanel_SDK = require('path/to/JLS_simPanel_SDK').example_namespace
← HomeThe Basics →