This document describes the Prepar3D preferred method for development and installation of add-on material.
For add-on libraries and executables, it is recommended that all software add-ons be developed using Visual Studio 2013. Further, the Platform Toolset should be set to v120 and the Targeted Framework should be .NET Framework Version 4.5.1. These settings will help ensure consistency and compatibility for all new development.
It is essential to turn Content Error Reporting on while developing add-on content as every error or invalid implementation in content can slow down the overall program. Content errors can have a cascading effect, as in most programming, and even cause correct implementations to fail in practice. For the best results and most effective products turn Content Error Reporting on during development and fix anything that is reported.
Content Error reporting can be turned on in the General -> Simulation Settings Screen or by setting ContentErrorLogging=1 in Prepar3D.cfg's [MAIN] section.
In addition to library (DLL) and application (EXE) add-on developers, those developing add-on content (SimObjects, Scenery, Effects, Scenarios, etc.) should also adhere to these guidelines.
When creating an add-on for Prepar3D, the directory structure are expected to be adhered to help maintain consistency.
%USERPROFILE%\Documents\Prepar3d v3 Files\add-ons
- This is the recommended <Installation Directory> where your product folder should install to. In the case where the developer wants to have their add-on automatically discovered, the installation path should instead be:
<Installation Directory>\<Product Name>
- The main product installation directory for an add-on. Typically, the main application executable will be placed in this location.
- The Add-on Package file which describes how Prepar3D should load the add-on.
<Installation Directory>\<Product Name>\bin
- For development only, this is typically the path for all compiled executables and libraries used for by the add-on. It is recommended that for a release the bin folder is not included and that all of these files be placed in the main installation directory.
<Installation Directory>\<Product Name>\data
- The path for any data files needed for use by the add-on.
<Installation Directory>\<Product Name>\doc
- The path for any HTML documents, CSS, and other documents provided with the add on for reference.
<Installation Directory>\<Product Name>\src
- The path for any source files, projects, etc. that may be distributed with the add on for use. This is not required to be distributed with the add-on.
NOTE: Please be aware that Prepar3D's base installation files should never be modified by developers. Instead, use an accepted way of distributing Add-ons.