The EditVoicepack Installer API makes it easy for developers of Flight Simulator X addons to include additional ATC modifications like telephony designators (a.k.a. callsigns), aircraft manufactures, aircraft types, and airport names with their addon.

Features:

• Runs on any system with Flight Simulator X installed without any additional runtime dependencies.
• Full support for 32 and 64 bit systems.
• Full support for UAC (User Access Control) on Windows Vista and later.
• Ensures compatibility between all addon products from different developers - even when using different versions of the Installer API.
• Compatible with accelerated voicepacks and phraseology changes performed by EditVoicepack.
• Simple .NET API easily integrated in your own .NET based configuration program or installer.

Licensing conditions:

• The EditVoicepackInstallerApi.dll can be distributed royalty free, but can not be modified in any way.
• The example installer application included with the API can be distributed royalty free. Derived versions of the example installer can freely be created from the included code and redistibuted royalty free.
• One licensed version of any product that includes voicepack modifications must be given free of charge to the developer of EditVoicepack. This version will be used to test future releases of the EditVoicepack API.
• Any voicepack modification created can be freely used in EditVoicepack, and even be included by other addon developers (freeware and/or payware). In return you are of course free to use existing modifications for your own addon (they will still need to be specifically signed for the addon you distribute them with).
• The Installer API is provided "as is" without any warranty.

Download:

The latest version of the EditVoicepack Installer API is available from http://www.editvoicepack.com/API/EditVoicepackAPI.zip

Including voicepack modifications with your addon

1. Create the modifications in EditVoicepack and export them to vcpmod files. Alternatively export exiting modifications where available.
2. Zip the modifications and send them by e-mail clearly indicating in the e-mail subject you are requesting EditVoicepack modifications for an addon product. In the e-mail, clearly state:
   • The name of the addon developer (an individual, a company or a group).
   • Optionally the website of the addon developer.
   • The name of the product the modifications will be included with.
   • Optionally the website of the addon product.
   • Optionally an icon for the addon developer and/or product. This icon must be in an XAML DrawingImage format. The typical bitmap based icon will not work as EditVoicepack (where the icon will be displayed) is fully vector based.
   Please initiate this process as early as possible. If you expect a tight deadline but do not yet have the modifications ready send an e-mail to agree on a timelime for signing the files and work out any potential misunderstandings or problems ahead of time.
3. Include the signed files you get back with your addon in one of the following locations. Notice that you can choose to place the files directly in the listed location, or in a subfolder named "ATC Modifications":
   • Scenery:
     • The root folder of the scenery.
     • The Texture subfolder.
     • The Scenery subfolder.
     The modification will not be installed if it's located under the "Scenery" folder of the Flight Simulator X directory. This folder is reserved for scenery included with Flight Simulator X and should not be used for addon scenery. Notice the scenery must have been added to the Scenery Library in Flight Simulator X before the modification can be installed.
   • Aircrafts:
     • The root folder of the aircraft (the folder containing "sim.cfg" or "aircraft.cfg").
     • The Texture.X folder containing the texture for the aircraft (where X match a definition for the texture defined in "sim.cfg" or "aircraft.cfg").
     The installer will automatically locate aircrafts installed into the standard Flight Simulator directory structure: "<fsxroot>\SimObjects\<objectsfolder>\<aircraftfolder>". It will also locate aircrafts in SimObject folders defined in the current users "fsx.cfg" file, but it can not locate aircrafts only present in the "fsx.cfg" of other users on the system.
   • In the rare case it's not possible to use one of the locations mentioned above, the files can also be placed in a subfolder of "<fsxroot>ATC Modifications". Please ensure the files are not placed in subfolders uniquely identifying the product they belong to.
4. Ensure the EditVoicepack Installer is executed as part of your installation procedure. This can be done in two ways:
   • Integrate the EditVoicepack Installer directly in your own installer and/or configuration program through the EditVoicepack Installer API (this is the preferred approach).
   • Instruct the users to run an EditVoicepack installer. The example installer supplied with the EditVoicepack Installer API can be redistributed for this purpose.

Integrating the EditVoicepack Installer

You can integrate the EditVoicepack Installer in your own .NET 2.0 (or newer) configuration tool or installer using the classes listed below.