Compiling - Revision history

BASys: Replaced Applicable-FSVersion for MSFS with MSFS2020, added MSFS2024. Corrected CATEGORY to appropriate version(s)

2024-05-25T20:48:12Z

Replaced Applicable-FSVersion for MSFS with MSFS2020, added MSFS2024. Corrected CATEGORY to appropriate version(s)

← Older revision		Revision as of 15:48, 25 May 2024
Line 1:		Line 1:
	{{Infobox-Applicable-FSVersion		{{Infobox-Applicable-FSVersion
	\| FSXI = ~~false~~		\| MSFS2024 = unknown
			\| MSFS2020 = unknown
			\| FSXI = unknown
			\| P3D5 = true
			\| P3D4 = true
			\| P3D3 = true
			\| P3D2 = true
			\| P3D = true
			\| FSW = unknown
			\| FSXSE = true
	\| FSXA = true		\| FSXA = true
	\| FSX = true		\| FSX = true
	\| FS2004 = ~~false~~		\| FS2004 = unknown
	\| FS2002 = ~~false~~		\| FS2002 = unknown
	\| ~~FS2000~~ = unknown		\| XP11 = unknown
	\| ~~FS98~~ = unknown		\| XP10 = unknown
			\| XP9 = unknown

	}}		}}

BASys at 15:22, 30 May 2010

2010-05-30T15:22:32Z

← Older revision		Revision as of 10:22, 30 May 2010
Line 16:		Line 16:
	On the other hand, it can also cause a little confusion for you, the mission designer. You have to keep the original mission XML available, otherwise you can't edit it any more. When you compile your mission though, FSX has two different versions to choose between and it prefers the compiled version. That means that if you compile a mission and then make some more changes, those changes won't appear in FSX unless you delete the compiled version. It's easier to only compile your mission once it's absolutely finished, or to not compile it at all.		On the other hand, it can also cause a little confusion for you, the mission designer. You have to keep the original mission XML available, otherwise you can't edit it any more. When you compile your mission though, FSX has two different versions to choose between and it prefers the compiled version. That means that if you compile a mission and then make some more changes, those changes won't appear in FSX unless you delete the compiled version. It's easier to only compile your mission once it's absolutely finished, or to not compile it at all.

	==~~= Running the~~ Mission Compiler ===		== Mission Compiler ==
	The mission compiler, <tt>simpropcompiler.exe</tt>, is part of the [[SDK#FSX\|SDK]]. It's located in the "<tt>Core Utilities Kit\SimProp</tt>" subfolder of the SDK and is a command-line tool. That means that if you double-click it, you'll see nothing more than a brief, black flash.		The mission compiler, <tt>simpropcompiler.exe</tt>, is part of the [[SDK#FSX\|SDK]]. It's located in the "<tt>Core Utilities Kit\SimProp</tt>" subfolder of the SDK and is a command-line tool. That means that if you double-click it, you'll see nothing more than a brief, black flash.

Line 43:		Line 43:
	If this works, you will get an SPB file created. There is no 'success' message; if all goes well you will see the normal Microsoft copyright messages and nothing else. If it doesn't compile, you'll get a list of errors and you can use this list to find out what's wrong, and fix it. You can usually try compiling it again by just pressing the up-arrow key and then Enter.		If this works, you will get an SPB file created. There is no 'success' message; if all goes well you will see the normal Microsoft copyright messages and nothing else. If it doesn't compile, you'll get a list of errors and you can use this list to find out what's wrong, and fix it. You can usually try compiling it again by just pressing the up-arrow key and then Enter.

	==== Switches ====		=== Switches ===
	* '''2spb''' - Compiles an xml file to a .SPB output file, (or produces an error list).		* '''2spb''' - Compiles an xml file to a .SPB output file, (or produces an error list).
	* '''validate''' - Validates an xml file without creating an output file.		* '''validate''' - Validates an xml file without creating an output file.

	==== Likely Errors ====		=== Likely Errors ===
	Some of the most common errors are:		Some of the most common errors are:
	# <tt>Myfile.xml(0) : error 80004005 : Unable to load symbols.</tt>		# <tt>Myfile.xml(0) : error 80004005 : Unable to load symbols.</tt>
Line 60:		Line 60:
	#: This is an actual error in the XML. The first number after the filename is the line number that it thinks is wrong, and the error description should give you an idea of what's wrong and how to fix it.		#: This is an actual error in the XML. The first number after the filename is the line number that it thinks is wrong, and the error description should give you an idea of what's wrong and how to fix it.

	==~~= Running the~~ Reward Compiler ===		== Reward Compiler ==
	As with the mission compiler, the reward compiler is also a command-line tool. However, it's a little less complex to use.		As with the mission compiler, the reward compiler is also a command-line tool. However, it's a little less complex to use.

Line 77:		Line 77:
	Parse complete!</pre>		Parse complete!</pre>

	==== Likely Errors ====		=== Likely Errors ===
	If BGLComp.exe can't open the XML file, you will get no output at all! However, if there are any errors in the XML, the reasons for the errors are clearly described. For example:		If BGLComp.exe can't open the XML file, you will get no output at all! However, if there are any errors in the XML, the reasons for the errors are clearly described. For example:
	* <tt>INTERNAL COMPILER ERROR: #C2623: Couldn't open file: (a filename)</tt>		* <tt>INTERNAL COMPILER ERROR: #C2623: Couldn't open file: (a filename)</tt>
Line 83:		Line 83:
	* <tt>INTERNAL COMPILER ERROR: #C2032: XML Parse Error! Element tree follows:</tt>		* <tt>INTERNAL COMPILER ERROR: #C2032: XML Parse Error! Element tree follows:</tt>
	*: There's some kind of problem in the XML, and the next lines of output show where the error is.		*: There's some kind of problem in the XML, and the next lines of output show where the error is.

			== Simplified Method ==
			If frequently using FSX SDK command-line tools
			<br>
			it'll save a lot of time/head-banging, if you set up ''environment variables''.

			Please see '''[[SDK - Tools - Command Line - Environment Variables (FSX/A)]]'''

	== Related ==		== Related ==

BASys: /* External */

2009-06-07T13:14:38Z

External

← Older revision		Revision as of 08:14, 7 June 2009
Line 91:		Line 91:
	=== External ===		=== External ===
	{{:Transclusion-Missions-Links-External-Common}}		{{:Transclusion-Missions-Links-External-Common}}

			=== Reference ===

	[[Category:Missions]]		[[Category:Missions]]
	[[Category:FSX]]		[[Category:FSX]]

BASys at 13:12, 7 June 2009

2009-06-07T13:12:42Z

← Older revision		Revision as of 08:12, 7 June 2009
Line 83:		Line 83:
	* <tt>INTERNAL COMPILER ERROR: #C2032: XML Parse Error! Element tree follows:</tt>		* <tt>INTERNAL COMPILER ERROR: #C2032: XML Parse Error! Element tree follows:</tt>
	*: There's some kind of problem in the XML, and the next lines of output show where the error is.		*: There's some kind of problem in the XML, and the next lines of output show where the error is.

			== Related ==

			=== Internal ===
			{{Template:Navbox-Missions-ObjRef}}

			=== External ===
			{{:Transclusion-Missions-Links-External-Common}}

	[[Category:Missions]]		[[Category:Missions]]
	[[Category:FSX]]		[[Category:FSX]]

BASys: /* Switches */

2008-06-11T08:41:22Z

Switches

← Older revision		Revision as of 03:41, 11 June 2008
Line 44:		Line 44:

	==== Switches ====		==== Switches ====
	* '''2spb''' - ~~Will compile~~ an xml file to a .SPB output file.		* '''2spb''' - Compiles an xml file to a .SPB output file, (or produces an error list).
	* '''validate''' - ~~Will validate~~ an xml file without creating an output file.		* '''validate''' - Validates an xml file without creating an output file.

	==== Likely Errors ====		==== Likely Errors ====

BASys: /* Running the Mission Compiler */

2008-06-11T08:40:27Z

Running the Mission Compiler

← Older revision		Revision as of 03:40, 11 June 2008
Line 42:		Line 42:
	</pre>		</pre>
	If this works, you will get an SPB file created. There is no 'success' message; if all goes well you will see the normal Microsoft copyright messages and nothing else. If it doesn't compile, you'll get a list of errors and you can use this list to find out what's wrong, and fix it. You can usually try compiling it again by just pressing the up-arrow key and then Enter.		If this works, you will get an SPB file created. There is no 'success' message; if all goes well you will see the normal Microsoft copyright messages and nothing else. If it doesn't compile, you'll get a list of errors and you can use this list to find out what's wrong, and fix it. You can usually try compiling it again by just pressing the up-arrow key and then Enter.

			==== Switches ====
			* '''2spb''' - Will compile an xml file to a .SPB output file.
			* '''validate''' - Will validate an xml file without creating an output file.

	==== Likely Errors ====		==== Likely Errors ====

BASys at 11:42, 2 June 2008

2008-06-02T11:42:48Z

← Older revision		Revision as of 06:42, 2 June 2008
Line 1:		Line 1:
	~~__TOC__~~		{{Infobox-Applicable-FSVersion
			\| FSXI = false
			\| FSXA = true
			\| FSX = true
			\| FS2004 = false
			\| FS2002 = false
			\| FS2000 = unknown
			\| FS98 = unknown
			}}

	== Compiling Missions and Rewards ==		== Compiling Missions and Rewards ==

Arno: /* Likely Errors */

2008-01-04T15:24:58Z

Likely Errors

← Older revision		Revision as of 10:24, 4 January 2008
Line 72:		Line 72:
	*: There's some kind of problem in the XML, and the next lines of output show where the error is.		*: There's some kind of problem in the XML, and the next lines of output show where the error is.

	[[Category:Missions~~]][[Category:SDK~~]]		[[Category:Missions]]
	[[Category:FSX]]		[[Category:FSX]]

Arno: /* Likely Errors */

2008-01-04T15:24:23Z

Likely Errors

← Older revision		Revision as of 10:24, 4 January 2008
Line 73:		Line 73:

	[[Category:Missions]][[Category:SDK]]		[[Category:Missions]][[Category:SDK]]
			[[Category:FSX]]

Jimkeir: New page: TOC == Compiling Missions and Rewards == Both Missions and Rewards are written as XML files. While missions may be (and usually are) run straight from the XML, rewards must be compile...

2008-01-04T14:24:15Z

New page: __TOC__ == Compiling Missions and Rewards == Both Missions and Rewards are written as XML files. While missions may be (and usually are) run straight from the XML, rewards must be compile...

New page

__TOC__

== Compiling Missions and Rewards ==
Both Missions and Rewards are written as XML files. While missions may be (and usually are) run straight from the XML, rewards must be compiled before they can be used. In short, if you don't use any rewards and don't care about saving a fraction of a second in loading time which the player won't notice anyway because they're reading the mission briefing, stop reading now.

There are two reasons for compiling a mission. First, it makes it rather faster to load. For all but the largest missions though, this isn't going to make much noticeable difference. Second, it makes it a little harder for the unwashed masses to find out your mission-writing tricks because the compiled version can't be loaded into mission editors. However, thanks to the SPB2XML [http://www.google.com/search?q=SPB2XML] tool it can be converted back to XML.

On the other hand, it can also cause a little confusion for you, the mission designer. You have to keep the original mission XML available, otherwise you can't edit it any more. When you compile your mission though, FSX has two different versions to choose between and it prefers the compiled version. That means that if you compile a mission and then make some more changes, those changes won't appear in FSX unless you delete the compiled version. It's easier to only compile your mission once it's absolutely finished, or to not compile it at all.

=== Running the Mission Compiler ===
The mission compiler, <tt>simpropcompiler.exe</tt>, is part of the [[SDK#FSX|SDK]]. It's located in the "<tt>Core Utilities Kit\SimProp</tt>" subfolder of the SDK and is a command-line tool. That means that if you double-click it, you'll see nothing more than a brief, black flash.

While it's certainly possible to set it up to work with drag-n-drop operation, there is a significant downside to this. If there are any errors in the XML, you won't see what they are because the DOS box that opens temporarily will close before you can read the error messages. It's better to open a good, old-fashioned DOS prompt.

Unfortunately there are several different paths needed, so the command-line can get rather long. After you've opened the DOS prompt (use Start->Run and type "cmd"), change directory to the folder with the file you want to compile. If you ''really'' don't do typing, you can drag the folder from an Explorer window over the DOS window and it will do it for you. Type <code>cd </code> (with the space afterwards) and then drop the folder.

The command you need will be similar to this:
<pre>
"(Path to Compiler)" 2spb -symbols "(Path to FSX)\propdefs\*.xml" my_file.xml my_file.spb
</pre>

'''(Path to Compiler)''' must be replaced with the path to the compiler, oddly enough. It must include the "simpropcompiler.exe" part. Again, the easiest way to do this is to find it using Explorer and then drag-n-drop simpropcompiler.exe onto the DOS window. The rest of the line gives the compiler instructions.

'''2spb''' tells the compiler what to do - that is, compile some XML to spb. '''-symbols "(Path to FSX)\propdefs\*.xml''' tells it where to find some important reference data. '''my_file.xml''' is the file you want it to compile, and '''my_file.spb''' is the file it will create. You need to change '''(Path to FSX)''' to wherever you've installed FSX to. If you have a standard installation, this will be:
<pre>C:\Program Files\Microsoft Games\Microsoft Flight Simulator X</pre>
so the full symbol path will be:
<pre>C:\Program Files\Microsoft Games\Microsoft Flight Simulator X\propdefs\*.xml</pre>

A full command-line, then, might look like this:
<pre>"C:\Program Files\Microsoft Games\Microsoft Flight Simulator X SDK\SDK\&crarr;
Core Utilities Kit\SimProp\simpropcompiler.exe" 2spb&crarr;
-symbols "C:\Program Files\Microsoft Games\Microsoft Flight Simulator X\propdefs\*.xml"&crarr;
my_file.xml my_file.spb
</pre>
If this works, you will get an SPB file created. There is no 'success' message; if all goes well you will see the normal Microsoft copyright messages and nothing else. If it doesn't compile, you'll get a list of errors and you can use this list to find out what's wrong, and fix it. You can usually try compiling it again by just pressing the up-arrow key and then Enter.

==== Likely Errors ====
Some of the most common errors are:
# <tt>Myfile.xml(0) : error 80004005 : Unable to load symbols.</tt>
#: This means that the path to the symbols - the bit after "'''-symbols'''" - was wrong.
# <tt>MyFile.xml(0) : error 80004005 : Read failed.</tt>
#: It can't read the XML file you told it to compile. Check that you're in the right directory, and that you've typed the filename correctly.
# <tt>MyFile.xml(0) : error 80070057 : Write failed.</tt>
#: It can't write the compiled SPB file. Maybe you've not given it an output filename (the last option).
# <tt>MyFile.xml(0) : error 80070005 : Write failed.</tt>
#: It still can't write the compiled SPB file. This usually means that it's tried to write it over a read-only file that already exists, or that you don't have permission to write to the output folder.
# <tt>MyFile.xml(1234,56) : error ??????? : Some Error Description</tt>
#: This is an actual error in the XML. The first number after the filename is the line number that it thinks is wrong, and the error description should give you an idea of what's wrong and how to fix it.

=== Running the Reward Compiler ===
As with the mission compiler, the reward compiler is also a command-line tool. However, it's a little less complex to use.

The reward compiler, <code>BGLComp.exe</code>, is also found under the [[SDK#FSX|SDK]] folder, in a subfolder called "<code>Environment Kit\BGL Compiler SDK</code>". Unlike the mission compiler, all you need to do to compile your rewards is change into the directory containing the XML file that contains your rewards, and run the compiler with:

<pre>(Path to BGLComp.exe) MyRewards.xml</pre>

With a standard SDK installation, that would be:

<pre>"C:\Program Files\Microsoft Games\Microsoft Flight Simulator X SDK\SDK\&crarr;
Environment Kit\BGL Compiler SDK\BGLComp.exe" MyRewards.xml</pre>

If this works as expected, a .RWD file will be created and you will see something like this:
<pre>Parsing document: MyRewards.xml

Parse complete!</pre>

==== Likely Errors ====
If BGLComp.exe can't open the XML file, you will get no output at all! However, if there are any errors in the XML, the reasons for the errors are clearly described. For example:
* <tt>INTERNAL COMPILER ERROR: #C2623: Couldn't open file: (a filename)</tt>
*: A file referenced by the reward, most probably an image, couldn't be found.
* <tt>INTERNAL COMPILER ERROR: #C2032: XML Parse Error! Element tree follows:</tt>
*: There's some kind of problem in the XML, and the next lines of output show where the error is.

[[Category:Missions]][[Category:SDK]]

Compiling - Revision history

BASys: Replaced Applicable-FSVersion for MSFS with MSFS2020, added MSFS2024. Corrected CATEGORY to appropriate version(s)

BASys at 15:22, 30 May 2010

BASys: /* External */

BASys at 13:12, 7 June 2009

BASys: /* Switches */

BASys: /* Running the Mission Compiler */

BASys at 11:42, 2 June 2008

Arno: /* Likely Errors */

Arno: /* Likely Errors */

Jimkeir: New page: __TOC__ == Compiling Missions and Rewards == Both Missions and Rewards are written as XML files. While missions may be (and usually are) run straight from the XML, rewards must be compile...

Jimkeir: New page: TOC == Compiling Missions and Rewards == Both Missions and Rewards are written as XML files. While missions may be (and usually are) run straight from the XML, rewards must be compile...