API

Required Header Files

A new plugin, which wants to use the XPMP2 library, needs to include the following 2 header files, provided in the inc folder:

XPMPMultiplayer.h - Initialization and general control functions
XPMPAircraft.h - Defines the class XPMP2::Aircraft, which represents an aircraft. Subclass this class in your plugin!

Additional Header Files

There are 3 additional headers files, which are usually not required:

The following header files are deprecated and provided only for backward compatibility with previous libxplanemp, not to be used for new projects:

XPCAircraft.h - Defines the class XPCAircraft, representing an aircraft in XPMP2, now derived from XPMP2::Aircraft.
XPMPPlaneRenderer.h - Three rendering control functions, which serve no purpose any longer.

The following header file is for use by the "XPMP2 Remote Client":

XPMPRemote.h - Defines network functionality and data structure for synchronizing planes between networked computers.

Sound Support by FMOD

XPMP2's Audio Engine is FMOD Core API by Firelight Technologies Pty Ltd. Understand FMOD licensing and attribution requirements first, as they will apply to your plugin if using XPMP2 with sound support.

Because of the licensing requirements, XPMP2 by default is built without sound support. See the Sound Support documentation for details how to enable sound support and how to include it into your plugin.

Quick Links to Detailed Documentation: