README

Opentrack Plugin for X-Plane

Standalone repository of the X-Plane plugin included in Opentrack.
Allows building the plugin without having to build Opentrack as well.
Contains a precompiled plugin in the "build" folder.

Changes from Opentrack's original plugin

Based on commit b8e7865a017363e9d3876539936a6f73310a99d9 (2019/12/24) from Opentrack's repository.

• Plugin output is not enabled after plugin start
• Added On/Off commands for better plugin control (see below)
• Implemented a plugin-specific, writable dataref (see below)
• Robustness improvements (e.g. command phase detection)
• Beautification for plugin strings and commands
• Added some optional debug output strings for X-Plane's dev console and Log.txt (debug_strings in line 64; set to "1" and recompile)
• Makefile for 64 bit Linux, compiling against the version 3.0 APIs
• Added this readme
• Added X-Camera output support (12/09/2020)

Installation

Move opentrack.xpl from the "build" folder into "X-Plane 11/Resources/plugins"

Utilization

The plugin can be controlled via command (and keyboard) and/or dataref.

Commands

These can also be set from X-Plane's keyboard assignment menu.

Opentrack/Toggle - Toggles plugin output to X-Plane
Opentrack/On - Enables plugin output to X-Plane
Opentrack/Off - Disables plugin output to X-Plane
Opentrack/Toggle_Translation - Toggles plugin translation information output to X-Plane

Datarefs

For checking the plugins's status, there is the following dataref.

Opentrack/Tracking - Writable

Value 0: Tracking is disabled Value 1: Tracking is enabled

With X-Camera

When the presence of the X-Camera plugin is detected at startup, head position output will automatically be piped to its datarefs (see X-Camera manual).

• Make sure that "TrackIR" is enabled (checked) in X-Camera's control panel. The checkbox also controls headtracking output to X-Camera when Opentrack and this plugin's output is active.
• This plugin's commands (see above) are still active and required to control output.

Compiling

To ease compilation and because licensing allows it, the repository contains all dependencies to easily compile the plugin.
The standard make commands are configured to do the following:

make clean - Will clean out the "build" folder
make - Will compile a plugin and put it into the "build" folder
make install - Requires adapting the path in XPLANEPLUGINS= in the Makefile and will copy the plugin into your X-Plane/Resources/plugin folder

Known issues

• No MacOS build ; contribution and makefile welcome
• Integration with other X-Plane camera plugins may not work as desired

License

See also the header of plugin.c.

Copyright (c) 2013, Stanislaw Halik sthalik@misaki.pl
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.