-
Notifications
You must be signed in to change notification settings - Fork 283
Getting Started
There are two parts to getting XPC up and running.
First, the XPC plugin needs to be installed in X-Plane. Once the plugin is installed and X-Plane is running, the plugin will continually listen for commands.
The second thing you need to do is write some code to interact with X-Plane. X-Plane Connect is a toolbox to help researchers use X-Plane. On their own, the XPC clients don't do much of anything.
Windows and Mac binaries for the XPC plugin are included in this repository. Thus, for Windows or Mac, installing the plugin is simply a matter of copying a few files. The plugin binaries are located in [XPlaneConnect Repository]\xpcPlugin\XPlaneConnect. Copy this entire folder 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 "xplaneConnect".
We do not currently have a build environment set up for Linux, however we will be adding full Linux support in the future. If you want to run the plugin on Linux, you have two options. The fastest way to get up and running on Linux is to compile the plugin yourself. If you run into any issues compiling the plugin for Linux, please open an issue in the issue tracker and we will do our best to troubleshoot and fix the issue.
If you want to use the plugin under Linux but aren't comfortable compiling it yourself, you can also open an issue in the issue tracker requesting Linux support. Knowing that there are users out there who actively want to run XPC on Linux is likely to expedite the process of adding full Linux support to the project.
XPC includes several clients written in various languages. Currently, the official repository includes C and MATLAB clients, with Java and Python clients under active development. Clients are located in folders named for their respective languages. For example, The C client can be found in the [XPlaneConnect Repository]\C folder. Under each client folder, you will find both the client code and an example folder with a short program demonstrating the correct use of each language's client.