These pages, available as GitHub pages, document both usage and internals of the XPMP2 library.
Content and availability status:
These aspects are relevant for developers using XPMP2 in their own plugin:
XCode projects, Visual Studio solutions, and a Docker environment for Linux and Mac OS builds are provided. The details are documented here.
This part will probably need more attention, but find some first
information here and study the working sample plugin
All header (and code) files are documented using Doxygen-style comments. The generated doxygen files are checked in, too, so that the are available online:
If you are familiar with the original
libxplanemp and are using it already
in your plugins, then you will find
these information on backward compatibility
useful, which explain how you can replace
libxplanemp with XPMP2
with limited effort.
Apart from the binaries that you build you will need to ship the files provided here in the ‘Resources’ folder. Also, users will need to install CSL models. Find more details here.
These aspects are relevant for CSL model developers and package providers:
xsb_aircraft.txt file defines the content of one CSL model packages.
It´s format is define here.
.objfiles on load
CSL packages come in different flavours. Popular ones for general use are
the Bluebell and the X-CSL packages. Both come with different history.
For XPMP2 to use all their features it needs to change their
Performing these changes is built into XPMP2.
See here for details.
TCAS Override approach
explains how TCAS information is provided, the classic multiplayer dataRefs are maintained
and how 3rd party plugins can access this information. XPMP2 publishes data