SDK Installation (FSX)

From FSDeveloper Wiki
Revision as of 17:08, 23 June 2008 by BASys (talk | contribs)
Jump to: navigation, search

How to install the SDK for FSX/FSXA.

Overview

The Software Development Kit (SDK) is a set of development tools which allow you to develop, create or modify content for the simulation.

The SDK is available for FSX Deluxe only.

You must as a minimum have the FSX RTM SDK installed before attempting to upgrade to the SDK Service Packs.

Installation

To install the FSX RTM SDK -

  1. FSX must not be running.
  2. Browse the FSX Deluxe Edition disk 1
  3. Open the SDK sub-folder
  4. Double-click the setup.exe
  5. Tell it where to install.


Default location is C:\Program Files\Microsoft Games\Microsoft Flight Simulator X SDK

Versions

You must as a minimum have the FSX RTM SDK installed before attempting to upgrade to the SDK Service Packs.


   You must install

   the appropriate SDK version update

   to match your FSX version.    


Find your FSX version in the FSX column, read the matching row SDK details.

FSX ID# SDK Availability Installer Location
RTM 10.0.60905 RTM Retail sdk.msi FSX RTM disk 1, SDK sub-folder
SP1 Discontinued N/A Standalone
SP1 10.0.61355
(Russian: 10.0.61357)
SP1A Download * (166Mb) fsx_sdk_sp1a.exe Standalone
SP2 10.0.61472 SP2 Download * (211Mb) sdk.msi Standalone
Acceleration 10.0.61637 SP2/XPack Retail sdk.msi FSX Acceleration disk, SDK sub-folder

'*' May also be available on magazine cover discs.

Version Notes

Acceleration/SP2 Users

The SDK supplied with the Acceleration package includes the SP2 SDK, plus Acceleration specific data.
A prior version of the SDK must be present on your PC before upgrading to SDK SP2.

The additional copy of SDK SP1a is only provided on the Acceleration disk, to allow you to do so.

If your SDK is still in HTML format,
rather than the Windows Help File format, (CHM),
then you've installed SDK SP1a, and not SDK SP2.

SP2 (non-Acceleration) Users

Before attempting upgrading to SDK SP2, the SDK must be at SP1a level.

If not, you will need to upgrade to SDK SP1a first.
You must have installed the SDK versions in the correct sequence, (see table above).

Documentation

RTM, SP1, & SP1a documentation is supplied in html format, with each folder containing the relevant html file(s).

SP2 documentation is supplied in chm format, as a single compiled html file, fsxsdk.chm.
located by default in C:\Program Files\Microsoft Games\Microsoft Flight Simulator X SDK\SDK

Configuration

If you had installed both FSX & SDK to their default locations,
as a quick indicator that the SDK is correctly installed,
the OPT should now be available from the FSX Tools menu.

If you had installed either FSX or the SDK to a non-default location,
you should run configsdk.exe located in the SDK root folder.

N.B.
Running configsdk.exe will only correct the registry paths.
It will not update/correct the user's dll.xml file, (see FSX in-game Tools menu below).

FSX in-game Tools menu

The Tools menu is accessed from within a flight, (not the main GUI).

The only SDK tools available in-game, are the Object placement tool, 3 traffic tools, and the effects tool.

All other tools are run/started from outside the sim GUI.
Look in the root of where you'd installed the SDK, or
Start -> All Programs -> Microsoft Games -> Microsoft Flight Simulator X SDK -> Flight Simulator X SDK

If having correctly followed all the above instructions, and the Tools menu is still not displaying, there are 3 aspects you need to investigate -

  • Addons
  • dll.xml
  • fsx.CFG

All changes must be made with FSX shut down.

Addons

Incorrect addon versions may prevent the Tools menu from loading entirely.


   You must install

   ALL the appropriate Addon updates

   to match your SDK version.    

Ensure you are using the latest version of any addons, (e.g. FSUIPC).
Important particularly when you upgrade FSX to a newer service pack.

If the Tools menu still doesn't load -

  • Remove all addon entries.
  • Ensure the MS SDK tools load.
  • One by one, re-apply your addons, checking each time to confirm the Tools menu is still present.

dll.xml

If the FSX Tools menu option is still not displaying, you may need to edit dll.xml manually, to -

  • include the full paths for the SDK entries.
  • set disabled to false
  • remove all addon entries.

Any changes will not be reflected till next time you start FSX.

Location

The dll.xml file is located at -

OS dll.xml location
XP C:\Documents and Settings\USERNAME\Application Data\Microsoft\FSX\
Vista C:\Users\USERNAME\AppData\Roaming\Microsoft\FSX\

In the root of your FSX installation there's also a dll.xml file, do not edit this, it's only a default backup copy.

Editing

You must use a text editor, e.g. Notepad, or an XML editor.

You must not use Word or Wordpad as they will corrupt the file.

Paths

The defined paths must be correct.

Remark: If you had copies of the SDK-DLLs installed in your FSX modules folder you will have to copy the new versions manually after installation of the SDK SP2.

Default Installation Location

A relative path e.g.
..\Microsoft Flight Simulator X SDK\SDK\Mission Creation Kit\object_placement.dll

is relative to the FSX default location -
C:\Program Files\Microsoft Games\Microsoft Flight Simulator X

Non-Default Installation Location

If either FSX or the SDK is installed to a non-standard location
then use a full path (aka absolute path). e.g.
C:\Program Files\Microsoft Games\Microsoft Flight Simulator X SDK\SDK\Mission Creation Kit\Object_Placement.dll

If you'd installed the SDK to your F: drive, then the full path would be -
F:\Program Files\Microsoft Games\Microsoft Flight Simulator X SDK\SDK\Mission Creation Kit\Object_Placement.dll

Disabled

Each of the 3 SDK tools need to be set as follows.

	<Disabled>False</Disabled>
	<ManualLoad>False</ManualLoad>

fsx.CFG

DRAFT SECTION


Trusted

On initial install of the SDK, then subsequent first FSX run, you are prompted whether to trust/allow each of the 3 SDK in-game tools to run.

Did you ever say no ?


Please open your fsx.cfg in a text editor.

Look for the [Trusted] section find the 3 tools entries, these may appear multiple times, (one for each SDK version).

These are the entries for mine.

C:\Program Files\Microsoft Games\Microsoft Flight Simulator X SDK\SDK\Mission Creation Kit\Object_Placement.dll.LONGSTRING=1
C:\Program Files\Microsoft Games\Microsoft Flight Simulator X SDK\SDK\Environment Kit\Traffic Toolbox SDK\traffictoolbox.dll.LONGSTRING=1
C:\Program Files\Microsoft Games\Microsoft Flight Simulator X SDK\SDK\Environment Kit\Special Effects SDK\visualfxtool.dll.LONGSTRING=1

Where LONGSTRING is a 'meaningless' alphanumeric string.
The final value should be [b]=1[/b]

Is it ?
If not, change it to 1.

Fire up FSX.
Do the tools now display ?

Vista users

If that doesn't work,
it may possible be that part of your fsx.CFG is corrupted,
(contains an inappropriate character).

Try renaming your fsx.cfg
to fsx_TODAYSDATE.cfg

Fire up FSX,
it'll rebuild the fsx.CFG
and prompt for the required permissions.



The 1's not sticking.

It's because Vista treats all .cfg files as being system files.

It opens a copy, and then saves your edited/changed file to somewhere else, (personal folders).

Next time you open fsx.CFG, Vista is giving you the original.

Related

Internal

External

Placeholder text