SDK Installation (FSX)

2009-12-18T23:09:17Z

Misho:

{{Infobox-Applicable-FSVersion
| FSXI = false
| FSXA = true
| FSX = true
| FS2004 = false
| FS2002 = false
| FS2000 = unknown
| FS98 = unknown
}}
{{:Transclusion-SDK-Oneline-Installation}}
{{:Transclusion-SDK-Oneline}}
 
The majority of the tools are command-line based, but some are accessible via the in-game '''Tools''' menu, (not the GUI).
 
* '''Print out this page, and work from that.'''
* Read through thoroughly before commencing installation.
* Ensure you've followed '''ALL''' instructions before you request assistance.
 
== Prerequisites ==
* The [[SDK]] is available in the '''[[FSX]] Deluxe''' package only, (not on '''FSX Standard''').
* Purchasers of '''[[FSX]] Standard''' can obtain the SDK by purchasing and installing '''[[FSX]] Acceleration'''.
* '''[[FSX]] Deluxe''' users must as a minimum have the RTM FSX SDK installed before attempting to upgrade to the SDK Service Packs.
 
* FSX must not be running whilst installing the SDK.
* After editing either fsx.CFG or dll.xml, FSX must be restarted, (they're only read on FSX launch).
 
== Installation ==
To install the RTM FSX SDK -
# FSX must not be running.
# Browse the '''FSX Deluxe Edition disk 1'''
# Open the '''SDK''' sub-folder
# Double-click the '''setup.exe'''
# Tell it where to install.
 
Default installation location is '''C:\Program Files\Microsoft Games\Microsoft Flight Simulator X SDK'''

=== .NET v2 ===
Several tools '''require''' Microsoft .NET Framework Version 2.0 ''to be installed '''first'''''.
 
Download from -
[http://www.microsoft.com/downloads/details.aspx?FamilyID=0856EACB-4362-4B0D-8EDD-AAB15C5E04F5&displaylang=en Microsoft Downloads - .NET Framework Version 2.0]

After installing ''.NET v 2'', (and rebooting if required), ensure you then run Windows Update to obtain subsequent patches.
 
Then reinstall/repair the SDK.

'''Please note -'''
 
''.NET v 3'' is '''supplemental''' to ''.NET v 2'',
 
it is not a replacement version !

However, if you are running .NET v 3.5, it DOES include v 2.0.

== Versions ==
The FSX '''simulator''' has '''Service Packs.'''

The FSX '''SDK''' has '''Service Packs.'''

{| class="h1" style="background:#FF0000" border="1"
|--
| style="font-size:200%;" |    You MUST install    the appropriate SDK Service Pack version    to match your FSX Service Pack version.     
|}

Find your installed FSX version in the FSX column, read the matching SDK column/row details.
{| class="prettytable" style="background:#f2f2f2" border="0"
|--
| style="background:#FF0000; font-size:200%;" | '''FSX'''
| style="background:#808080; font-size:100%;" | '''ID#'''
| style="background:#FF0000; font-size:200%;" | '''SDK'''
| style="background:#808080; font-size:100%;" | '''Availability'''
| style="background:#808080;" | '''Installer'''
| style="background:#808080;" | '''Location'''
|-
| style="background:#F8EABA;" | RTM
| style="background:#F8EABA;" | 10.0.60905
| style="background:#F8EABA;" | RTM
| style="background:#F8EABA;" | Retail
| style="background:#F8EABA;" | sdk.msi
| style="background:#F8EABA;" | FSX RTM disk 1, SDK sub-folder
|-
| style="background:#F8EABA;" |
| style="background:#F8EABA;" |
| style="background:#F8EABA;" | SP1
| style="background:#F8EABA;" | Discontinued
| style="background:#F8EABA;" | N/A
| style="background:#F8EABA;" | Standalone
|--
|
|
|
|
|-
|
|
|
|
|-
| SP1
| 10.0.61355 (Russian: 10.0.61357)
| SP1A
| [http://www.microsoft.com/downloads/details.aspx?displaylang=en&FamilyID=24910e66-96b0-4543-9b4a-647b7e28f212 Download * (166Mb)]
| fsx_sdk_sp1a.exe
| Standalone '''(Updated)'''
|-
|
|
|
|
|-
|
|
|
|
|-
| style="background:#C0C090;" | SP2
| style="background:#C0C090;" | 10.0.61472
| style="background:#C0C090;" | SP2
| style="background:#C0C090;" | [http://download.microsoft.com/download/3/C/A/3CAD9417-A0BE-4892-9224-4A4479F9F633/sdk.msi Download * (211Mb)]
| style="background:#C0C090;" | sdk.msi
| style="background:#C0C090;" | Standalone '''(Updated)'''
|-
| style="background:#C0C090;" | Acceleration
| style="background:#C0C090;" | 10.0.61637
| style="background:#C0C090;" | SP2/XPack
| style="background:#C0C090;" | Retail
| style="background:#C0C090;" | sdk.msi
| style="background:#C0C090;" | FSX Acceleration disk, SDK sub-folder
|}

'''*''' May also be available on magazine cover discs.
=== Version Notes ===
You must as a minimum have the FSX RTM SDK installed
 
before attempting to upgrade to the SDK Service Packs.

==== 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.'''
{| class="h1" style="background:#FF0000" border="1"
|--
| style="font-size:200%;" |    You MUST install    ALL the appropriate Addon updates    to match your SDK Service Pack 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 ====
{| class="h1" style="background:#FF0000" border="1"
|--
| style="font-size:200%;" |    There are several example/backup '''dll.xml''' files        located in the -       - SDK subfolders, (4 example dll.xml)    - FSX root folder, (default dll.xml backup copy).       IGNORE THOSE - They are irrelevant.    
|}
 
'''There is only one relevant dll.xml '''
 
'''dll.xml file is located in your ''%APPDATA%'' folder '''
 
'''that's the same location as your ''fsx.cfg'', at''' -
 
 
{| class="prettytable" style="background:#f2f2f2" border="0"
|--
| style="background:#808080;" | '''OS'''
| style="background:#808080;" | '''dll.xml location'''
|--
| style="background:#F8EABA;" | XP
| style="background:#F8EABA;" | C:\Documents and Settings\USERNAME\Application Data\Microsoft\FSX\
|--
| style="background:#C0C090;" | Vista
| style="background:#C0C090;" | C:\Users\USERNAME\AppData\Roaming\Microsoft\FSX\
|--
| style="background:#F8EABA;" | Win7
| style="background:#F8EABA;" | C:\Users\USERNAME\AppData\Roaming\Microsoft\FSX\
|}
 

==== 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.
<pre>
<Disabled>False</Disabled>
<ManualLoad>False</ManualLoad>
</pre>

=== fsx.CFG ===
{{:Ambox-Content-WIP}}
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.
<pre>
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
</pre>
Where LONGSTRING is a 'meaningless' alphanumeric string.
 
The final value should be '''=1'''

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.

{| class="h1" style="background:#FF0000" border="1"
|--
| style="font-size:200%;" |    Go back and read it again !        
|}

== Still having problems ? ==
You can post a request for assistance to the FSDeveloper forums
 
but before doing so
 
'''we need some basic information about your system'''.

Please download [http://www.interkultur.de/gossmann/FSD/ADE-Check.zip Martin Gossman's '''ADE-Checker''']

Run ADE-Checker
 
and it will generate an output about your PC configuration
 
allowing us to identify which/if any components are installed/missing.

Please save the report and post it to this forum. (Link to be added)

== Related ==
=== Internal ===
{{Template:Navbox-SDK (FSX)-Related}}

=== External ===
Placeholder text

[[Category:Aircraft Design]]
[[Category:Scenery Design]]
[[Category:Missions]]
[[Category:SimConnect]]
[[Category:Tools]]

FSDeveloper Wiki - User contributions [en-gb]

SDK Installation (FSX)