Welcome to Darksaber's X-Wing Station

Home of the Ultimate Craft Pack v2.3

Note: This file can be saved to your hard drive for browsing or future reference. All I ask it that you DO NOT place them on your own site, if you wish to link to them please do so, but only through my main site address.

Darksaber's X-Wing Station

Thank you.

Please read the Disclaimer and Copyright

I would like to thank James "Defiant" Lupiani of Flying Temple for creating XIS (X-Wing Install System) and for allowing me to use part of his manual.

  1. Files to download
  2. A Few Q&A
  3. Table of commands
  4. Creating your directories
  5. Creating your CFG files
  6. Saving your files
  7. Creating your XMOD
  8. Creating an advanced XMOD
  9. Advanced File Structure
  10. Advanced CFG files
  11. Command lines and how they should be applied
 
Files to download

XIS (X-Wing Install System) from Defiant's Flying Temple or from the Installation Utilities section
A Compression Utility such as WinZip or WinRaR
A Text Editor which supports RTF (Rich Text Format), such as Wordpad or Microsoft Word
Either TPWin or ZTMaker which can be downloaded from the Craft Editors section
A Paint Program to create your banner

A few Q&A

Q1. What is a XMOD?
A1. An XMOD is basically a compressed folder i.e. Zip, Rar.

Q2. How do I change a Zip file to an XMOD ?
A2. You can do this in two ways, the first simply select the Zip file and press F2 and change the extension to XMOD, the Second option is to go to the Miscellaneous Files section and download the utility Change File Type (Follow the instruction that come with this file).

Q3. What is a CFG file?
A3. A CFG file is a text file where you write the Strings needed to install your files correctly, these can be opened with Notepad.

Q4. Do I have to keep all the files and Folder separate?
A4. NO, you do not have to keep the files and folder separate, you can actually place most of the files in one folder apart from the High Res Sounds and Low Res Sounds wav files. The files you place in these folder are usually named the same, so I would advise that you do keep the separate.

Q5. I noticed when I install a XMOD it creates a file called XWA.Tab. What does this file do?
A5. The XWA.Tab file is usually associated with International versions of X-Wing Alliance, when you run XWA it reads files such as the

Shiplist.txt
Specdesc.txt
Strings.txt
Fronttxt.txt
Xxaerr.txt
Email.txt (from the Missions Folder)
Cutscene.txt (from the Frontres\Cutscene folder)
FamilyAwards.txt (from the Frontres\Medals folder)

to find out all the information associated with the craft and missions you have installed.

What the XWA.Tab file does, is to over ride these text files so the EXE first reads from the XWA.Tab file and if it can not find the required information in the Tab file it reads from the above mentioned text files.

Top
Table of commands you will need to know
Command Arguments Description
Version [Real Number]

Put this first. It serves to prevent people from yelling at you after installing a patch that's incompatible with their installer.

AddToCraftList [Line Number][File Name]

This command WILL Modify XWA's Spacecraft0.lst and places the file name on the given line number. This is only really necessary if you choose a different ship name, or you're installing a new ship entirely.

So for instance you want to add a craft to line 200 in the Spacecraft0.lst, but your last entry is on line 180, XIS will do this automatically leaving gaps between the last entry and the new entry.

AddToEquipList [Line Number][File Name] Same as AddToCraftList, but puts the file name in the Equipment0.lst instead.
AddToResData [File Name] Basically the same as the above commands, but writes to the top line of ResData.txt used to locate DAT resources.
AddString [Text] Use this to define any new strings for your ships; this is where the really cool part comes in! Instead of modifying a bunch of XWA's text files, the installer will create a TAB file (intended for internationalisation) that contains strings that you define. Anything you put here will override the other files in XWA. It's important, however, to make sure you get the tabs and spaces right. As you can see, my example includes things from Shiplist.txt, Specdesc.txt, and Strings.txt. It appears you can use either exclamation marks or tabs to separate the string name and its value, but don't quote me on that.
PatchFile [File Name][Patch Name] Applies a ZT patch from the component's directory to the given file name (relative to the game's directory). As of version 2.2, this function supports wildcards. For instance, you can patch all pilots by specifying "PatchFile *.PLT PILOTPATCH.ZT". Please don't abuse this ability. I left this option in here to allow for some possible editing tricks (fonts, AI changes, etc.), Not for script kiddies who think they're l33t h4x0rz. The patch name may not exceed 32 characters.
InstallFilm [File Name] Installs a FLM file to the film directory.
InstallFrontRes [File Name][Directory] Installs a resource to a sub-directory in Frontres. It should not have a trailing backslash on it. For instance, "InstallFrontRes boot.cbm combat".
InstallHighResSound [File Name] Installs a WAV file to the high res sound effects directory (Wave\FE_High_Res).
InstallLowResSound [File Name] Same as above, but low res (Wave\FE_Low_Res).
InstallMission [File Name] Much like the InstallOPT command, this copies a file from the component directory to XWA's missions directory. You can actually use this to install new MISSION.LST and EMAIL.TXT files.
InstallMissionVoice [File Name][Directory] Installs files to a sub-directory under Wave\MissionVoice.
InstallMovie [File Name] Installs a movie to the movies directory.
InstallMusic [File Name] Installs an IMC file to the music directory.
InstallOPT [File Name] Installs an OPT file from the component's directory to the user's FlightModels directory.
InstallPilot [File Name] Installs a PLT file from the component's directory to the user's XWA directory.
InstallResData [File Name] Installs a DAT file to the resdata directory.
InstallSkirmish [File Name] Installs a SKM file to the user's Skirmish directory.
InstallSound [File Name] Installs a file from the component's directory to the user's SFX directory.
Top
Creating your directories

1. We'll start by creating a very simple XMOD, well just add a craft so create a directory and for this example we'll call it MyXMOD, in this directory you will place your banner and readme file.

These are both optional but you would like people to know who made your XMOD.

Your banner must be in Bitmap format, size 350x100 and must be named "banner.bmp"

This is a example of the banner I made for the TIE Gunship: -

Your Readme File or Release Notes have to be in Rich Text Format *.RTF (use wordpad or Microsoft Word) and must be named "readme.rtf"

This should include such things as: -

  • Who made your Opt's, Missions etc.
  • You Website (if you have one)
  • Any information about your Opt's, Missions etc.
  • Basically anything you wish to write.

Next inside this directory create another directory and name it MyOpt.

So your directory might look something like this

C:\MyXMOD
	\MyOpt
	banner.bmp
	readme.rtf

2. Place all your Opt's you wish to distribute into the MyOpt directory .

So now it should look like this :-

C:\MyXMOD
	\MyOpt\MyOpt.opt
	\MyOpt\MyOptExterior.opt
	\MyOpt\MyOptCockpit.opt
	banner.bmp
	readme.rtf

So now we have got this far we need to create your CFG files.

Top
Creating your CFG files

1. In MyOpt directory create a new Text.txt file and rename it to: -

MyOpt.txt

Note: The names of these files must match the names of each directory you have created.

Now change the extension to CFG

MyOpt.cfg

Now you might not be able to open these files so "right click" on the MyOpt.cfg file and a pop-up window should open, with the title Open With, scroll down to Notepad (make sure the box is ticked next to the line "Away use this program to open this file"). Click OK and each time you wish to open your CFG files they will open with Notepad.

2. Open the MyOpt.cfgt file.

Now we have to create the script for your files to be installed correctly

This is the example that Defiant has written in his Manual

; X-Wing Install System Script
; ------------------------------------------
; The name of this file must match the name
; of the directory in which the component
; data is contained. It will also be used
; for the name of the package in the index.
; ------------------------------------------

; Script version
Version 2.7

; Install the files InstallOPT XWING.OPT InstallOPT XWINGEXTERIOR.OPT InstallOPT XWINGCOCKPIT.OPT
; Add to a line in the craft list AddToCraftList 1 XWING.OPT
; Set up description strings. They MUST have tabs between the resource name ; and the value or it will not work. AddString SPECIES_1 Xwing,Fighter,Flyable,Known,Skirmish, 6 ,9 ,13 ,20 ,4 ,13 ,32 ,43 AddString SPEC_1_NAME T-65C A2 X-Wing (X-W) AddString SPEC_1_MANU Incom Corp. AddString SPEC_1_SIDE Rebel Alliance AddString SPEC_1_DESC It's an X-Wing AddString SPEC_1_CREW 1 AddString KSPECXW m:X-wing AddString KSPECXW_PLURAL X-wing AddString KSPECXW_SHORT X-W
; Patch the executable PatchFile XWINGALLIANCE.EXE XWING.ZT

3. So for ours it will basically be the same, let's say we want to replace the X-Wing

; X-Wing Install System Script
; ------------------------------------------
; The name of this file must match the name
; of the directory in which the component
; data is contained. It will also be used
; for the name of the package in the index.
; ------------------------------------------

; Script version
Version 2.7 

; Install the files InstallOPT MyOpt.opt InstallOPT MyOptExterior.opt InstallOPT MyOptCockpit.opt
; Add to a line in the craft list AddToCraftList 1 MyOpt.opt
; Set up description strings. They MUST have tabs between the resource name ; and the value or it will not work. AddString SPECIES_1 MyOpt,Fighter,Flyable,Known,Skirmish, 6 ,9 ,13 ,20 ,4 ,13 ,32 ,43 AddString SPEC_1_NAME MyOpt (M/O) AddString SPEC_1_MANU MyOpt Industries AddString SPEC_1_SIDE My Side AddString SPEC_1_DESC Description of your Myopt here. AddString SPEC_1_CREW 1 AddString KSPECXW m:MyOpt AddString KSPECXW_PLURAL MyOpt's AddString KSPECXW_SHORT M/O
; Patch the executable PatchFile XwingAlliance.exe MyOpt.ZT
Top
4. Ok I'll try to show you how each line should look
Command and Arguments How it should be
Version 2.7

[Version][space][2.7]

InstallOPT MyOpt.opt
InstallOPT MyOptExterior.opt
InstallOPT MyOptCockpit.opt
[InstallOPT][space][MyOpt.opt]
AddToCraftList 1 MyOpt.opt [AddToCraftList][space][1][space][MyOpt.opt]
AddString SPECIES_1	MyOpt,Fighter,Flyable,Known,Skirmish,	6 ,9 ,13 ,20 ,4 ,13 ,32 ,43
AddString SPEC_1_NAME	MyOpt (M/O)
AddString SPEC_1_MANU	MyOpt Industries
AddString SPEC_1_SIDE	My Side
AddString SPEC_1_DESC	Description of your Myopt here.
AddString SPEC_1_CREW	1
AddString KSPECXW	m:MyOpt
AddString KSPECXW_PLURAL	MyOpt's
AddString KSPECXW_SHORT	M/O

[AddString][space][SPECIES_1][Tab][MyOpt,Fighter,][Tab][6 ,8 ,13 ,20 ,4 ,13 ,32 ,43 ]
[AddString][space][SPEC_1_NAME][Tab][MyOpt (M/O]
[AddString][space][SPEC_1_MANU][Tab][MyOpt Industries ]
[AddString][space][SPEC_1_SIDE][Tab][My Side]
[AddString][space][SPEC_1_DESC][Tab][Description of MyOpt]
[AddString][space][SPEC_1_CREW][Tab][1]
[AddString][space][KSPECXW][Tab][m:MyOpt]
[AddString][space][KSPECXW_PLURAL][Tab][MyOpt's]
[AddString][space][KSPECXW_SHORT][Tab][M/O]

PatchFile XwingAlliance.exe MyOpt.ZT [PatchFile][space][XwingAlliance.exe][space][MyOpt.ZT]

5. Ok that should be it for your CFG file, now save it.

6. Next we have to make our ZT file, so please refer to the tutorial Creating A *.ZT File

7. Once this is done this place the ZT into the MyOpt Folder.

So now your folder tree should look like this: -

C:\MyXMOD
	\MyOpt\MyOpt.opt
	\MyOpt\MyOptExterior.opt
	\MyOpt\MyOptCockpit.opt
	\MyOpt\MyOpt.cfg
	\MyOpt\MyOpt.ZT
	banner.bmp
	readme.rtf
If like most of the XWAUP Craft, that only replace the existing Totally Games Opt's a CFG script can be condensed into a simple script as so: -
; X-Wing Install System Script
; ------------------------------------------
; The name of this file must match the name
; of the directory in which the component
; data is contained. It will also be used
; for the name of the package in the index.
; ------------------------------------------

; Script version
Version 2.7 

; Install the files InstallOPT Xwing.opt InstallOPT XwingExterior.opt InstallOPT XwingCockpit.opt
; Patch the executable PatchFile XwingAlliance.exe Xwing.ZT

You will see that the script has been shortened, this is because the string text is not needed as the craft already exists and all your doing is replacing the Opt's, but as with most of the XWAUP craft you still might need to create the ZT file as weapons and POV might have been changed, otherwise the following lines: -

; Patch the executable
PatchFile XwingAlliance.exe Xwing.ZT

Can also be deleted, leaving the script as so: -

; X-Wing Install System Script
; ------------------------------------------
; The name of this file must match the name
; of the directory in which the component
; data is contained. It will also be used
; for the name of the package in the index.
; ------------------------------------------

; Script version
Version 2.7 

; Install the files InstallOPT Xwing.opt InstallOPT XwingExterior.opt InstallOPT XwingCockpit.opt

You could also leave out comment lines so your CFG file could be shortened even further to look like this: -

Version 2.7 
InstallOPT Xwing.opt
InstallOPT XwingExterior.opt
InstallOPT XwingCockpit.opt
Top
Saving your files

It's very important how you save these files so read it and take it in!

The Right way to save your files The Wrong way to save your files

Remember how you created your file structure as so: -


C:\MyXMOD
	\MyOpt\MyOpt.opt
	\MyOpt\MyOptExterior.opt
	\MyOpt\MyOptCockpit.opt
	\MyOpt\MyOpt.cfg
	\MyOpt\MyOpt.ZT
	banner.bmp
	readme.rtf

The last thing to do is compress the package. The procedure for this varies depending on your zip program, but the result you want is to have the banner and readme in the root of the zip file and the folders in their sub-directories. Remember to enable any option that says "include sub-directories" or something of that nature. For WinZip and WinRAR, it seems your best bet is to select all of the folder as well as the readme and banner, and then right-click and use the context menu to zip them up. As so: -


\MyOpt
banner.bmp
readme.rtf

Once you have compressed your files, open up the file you've created and make sure that the folder directories are right there in the root of the zip. The banner and readme should also be there. For example: -


MyXMOD.zip
	 \MyOpt\MyOpt.opt
	 \MyOpt\MyOptExterior.opt
	 \MyOpt\MyOptCockpit.opt
	 \MyOpt\MyOpt.cfg
	 \MyOpt\MyOpt.ZT
	 banner.bmp
	 readme.rtf

If you select the directory containing all your files, it will have an extra directory in there and the XMOD will NOT work! For example: -


MyXMOD.zip
	 \MyXMOD
	              \MyOpt\MyOpt.opt
	              \MyOpt\MyOptExterior.opt
	              \MyOpt\MyOptCockpit.opt
	              \MyOpt\MyOpt.cfg
	              \MyOpt\MyOpt.ZT
	              banner.bmp
	              readme.rtf
Top
Creating your XMOD

The next thing is to change your Zip file to a XMOD, as I have said you can do this in one of two ways.

1. The first way is to simply select the Zip file and press F2 and change the extension to XMOD.

2. The second option is to go to the Miscellaneous Files section and download the utility Change File Type (Follow the instruction that come with this file).

Now you ready to test your new XMOD, if you have Zipped up your files correctly, once you open your XMOD you will be greeted with the Release notes, read them (Very important for everyone to remember) Check to see if they are correct, then click on "Dismiss", and you will be greeted with the XIS install window with your banner in the window. For example: -

The Right Way
 
The Wrong Way

If you have Zipped up you files the wrong way, you will NOT be greeted with the "Release Notes" screen and the XIS Window will show the default picture in it's window as shown in the right panel above.

Top
Creating an advanced XMOD

Ok, if you have followed the above correctly and it works fine, you ready to create a more advanced XMOD.

For this part we'll add everything from Opt's to Sounds, As if you were creating a Shipset or as some like to call it a Total Conversion.

Ok let's presume you have created a shipset, but everything is still in the Original XwingAlliance folders on Drive C:\

Plus you have tested all the opts, missions and so on and everything works fine.

Note : Another thing to remember with creating this type of XMOD and or Shipset is what ever craft you install, that they MUST follow in order in the Spacecraft0.lst or Equipment0.lst

With this example I'll keep everything separate as it's easier to track down things if something goes wrong, but you can have everything in one folder if you wish.

So let's make our hypothetical Shipset XMOD

Top
Advanced File Structure

We'll start by creating the folder structure, one for your craft, missions and so on

C:\MyShipsetXMOD
	           \Campaign Craft
	           \Campaign Missions
	           \Mission Waves
	           \Skirmish
	           \CBM Files
	           \Sounds High Res
	           \Sounds Low Res
	           \New Music
	           \Sound Effects
	           \Dat Files
	           \New Movie
	           \Campaign Film
	           banner.bmp
	           readme.rtf

Presumably you have already created you Banner and Release Notes i.e. banner.bmp, readme.rtf, so place these in the MyXMOD Folder.

Create a CFG file and place one in each folder remembering to rename them correctly i.e. Craft Folder would be Craft.CFG and so on.

Ok select the opt's you have created for your shipset and copy them into the craft folder, do the same for the missions, mission voices and so on, so now your folders might look something like this: -


C:\MyShipsetXMOD
	           \Campaign Craft\Campaign Craft.cfg
	           \Campaign Craft\Mypilot.plt
	           \Campaign Craft\MyFighter.opt
	           \Campaign Craft\MyFighterExterior.opt
	           \Campaign Craft\MyFighterCockpit.opt
	           \Campaign Craft\MyShuttle.opt
	           \Campaign Craft\MyStarship.opt
	           \Campaign Craft\MyFrieghter.opt
	           \Campaign Craft\MyContainer.opt
	           \Campaign Craft\MyAdvancedMissile.opt
	           \Campaign Craft\MyAdvancedTorpedo.opt
	           \Campaign Missions\Campaign Missions.cfg
	           \Campaign Missions\1b8m1rebel.tie
	           \Campaign Missions\1b8m2rebel.tie
	           \Campaign Missions\1b8m3rebel.tie
	           \Campaign Missions\Mission.lst
	           \Campaign Missions\Email.lst
	           \Mission Waves\Mission Waves.cfg
	           \Mission Waves\1b8m1r01.wav
	           \Mission Waves\1b8m1r02.wav
	           \Mission Waves\1b8m2r01.wav
	           \Mission Waves\1b8m2r02.wav
	           \Mission Waves\1b8m3r02.wav
	           \Mission Waves\1b8m3r02.wav
	           \Mission Waves\1b8m1.lst
	           \Mission Waves\1b8m2.lst
	           \Mission Waves\1b8m3.lst
	           \Skirmish Missions\Skirmish Missions.cfg
	           \Skirmish Missions\MySkirmish.skm
	           \CBM Files\CBM Files.cfg
	           \CBM Files\Conmkanim.cbm
	           \CBM Files\Licon.bmp
	           \CBM Files\Licons.cbm
	           \CBM Files\lblu_4.cbm
	           \CBM Files\lgrn_4.cbm
	           \CBM Files\lprp_4.cbm
	           \CBM Files\lred_4.cbm
	           \CBM Files\lyel_4.cbm
	           \CBM Files\Squad4.cbm
	           \Sounds High Res\Sounds High Res.cfg
	           \Sounds High Res\Aaaaaa.wav
	           \Sounds High Res\BombFire.wav
	           \Sounds High Res\ChaffStart.wav
	           \Sounds Low Res\Sounds Low Res.cfg
	           \Sounds Low Res\Aaaaaa.wav
	           \Sounds Low Res\BombFire.wav
	           \Sounds Low Res\ChaffStart.wav
	           \New Music\New Music.cfg
	           \New Music\Frconcourse.imc			   
	           \Sound Effects\Sound Effects.cfg
	           \Sound Effects\Alarm00.wav
	           \Sound Effects\Door-1b.wav
	           \Dat Files\Data Files.cfg
	           \Dat Files\Hull_Icons.Dat
	           \Dat Files\Map_Icon.Dat
	           \New Movie\New Movie.cfg
	           \New Movie\Ceremony.snm
	           \Campaign Film\Campaign Film.cfg
	           \Campaign Film\MyFilm.flm
	           banner.bmp
	           readme.rtf

Simple enough right?

Top
Advanced CFG files
So now we have to add the info to each CFG file, we'll start with the Craft.CFG

This has to be placed in the CFG file as such: -

; X-Wing Install System Script
; ------------------------------------------
; The name of this file must match the name
; of the directory in which the component
; data is contained. It will also be used
; for the name of the package in the index.
; ------------------------------------------

; Script version
Version 2.7

; Install the files InstallOPT MyFighter.opt InstallOPT MyFighterExterior.opt InstallOPT MyFighterCockpit.opt InstallOPT MyShuttle.opt InstallOPT MyStarship.opt InstallOPT MyFreighter.opt InstallOPT MyContainer.opt InstallOPT MyAdvancedMissile.opt InstallOPT MyAdvancedTorpedo.opt InstallPilot Mypilot0.plt
; Add to a line in the craft list AddToCraftList 155 MyFighter.opt AddToCraftList 156 MyShuttle.opt AddToCraftList 157 MyStarship.opt AddToCraftList 158 MyFreighter.opt AddToCraftList 159 MyContainer.opt AddToEquipList 159 MyAdvancedMissile.opt AddToEquipList 160 MyAdvancedTorpedo.opt
; Set up description strings. They MUST have tabs between the resource name ; and the value or it will not work. AddString SPECIES_184 MyFighter,Fighter,Flyable,Known,Skirmish, 6 ,9 ,13 ,20 ,4 ,13 ,32 ,43 AddString SPECIES_185 MyFighter2,Fighter,Flyable,Known,Skirmish, 6 ,9 ,13 ,20 ,4 ,13 ,32 ,43 AddString SPECIES_186 MyShuttle,Shuttle/Light Transport,Flyable,Known,Skirmish, 24 ,53 ,32 ,64 ,122,144,145,174 AddString SPECIES_187 MyStarship,Starship,Nonflyable,Known,Skirmish, 214,49 ,222,68 ,280,277,290,307 AddString SPECIES_188 MyFreighter,Freighter/Heavy Transport,Nonflyable,Known,Skirmish, 234,97 ,240,106,0 ,0 ,0 ,0 AddString SPECIES_189 MyContainer,Container,Nonflyable,Known,Skirmish, 234,97 ,240,106,125,322,141,348 AddString SPEC_184_NAME My Fighter (M-F) AddString SPEC_184_MANU My Fighter Corp. AddString SPEC_184_SIDE My Alliance AddString SPEC_184_DESC It's a Fighter AddString SPEC_185_CREW 1 AddString SPEC_185_NAME My Fighter2 (M-F2) AddString SPEC_185_MANU My Fighter Corp. AddString SPEC_185_SIDE My Alliance AddString SPEC_185_DESC It's a Fighter AddString SPEC_185_CREW 2 AddString SPEC_186_NAME My Shuttle (M-S) AddString SPEC_186_MANU My Shuttle Corp. AddString SPEC_186_SIDE My Alliance AddString SPEC_186_DESC It's a Shuttle AddString SPEC_186_CREW 2 AddString SPEC_187_NAME My Starship (SShip) AddString SPEC_187_MANU My Starship Corp. AddString SPEC_187_SIDE My Alliance AddString SPEC_187_DESC It's a Starship AddString SPEC_187_CREW 4500 AddString SPEC_188_NAME My Freighter (Frei) AddString SPEC_188_MANU My Freighter Corp. AddString SPEC_188_SIDE My Alliance AddString SPEC_188_DESC It's a Freighter AddString SPEC_188_CREW 4 AddString SPEC_189_NAME My Container (Con 1) AddString SPEC_189_MANU My Container Corp. AddString SPEC_189_SIDE My Alliance AddString SPEC_189_DESC It's an Container AddString SPEC_189_CREW 0 AddString KSPECFTR0 m:My Fighter AddString KSPECFTR1 m:My Fighter 2 AddString KSPECSHT0 m:My Shuttle AddString KSPECCON0 m:My Container AddString KSPECFRT0 m:My Freighter AddString KSPECSTR3 m:My Starship AddString KSPECFTR0_PLURAL My Fighters AddString KSPECFTR1_PLURAL My Fighter 2's AddString KSPECSHT0_PLURAL My Shuttle AddString KSPECCON0_PLURAL My Containers AddString KSPECFRT0_PLURAL My Freighters AddString KSPECSTR3_PLURAL My Starships AddString KSPECFTR0_SHORT M-F AddString KSPECFTR1_SHORT M-F2 AddString KSPECSHT0_SHORT M-S AddString KSPECCON0_SHORT Con 1 AddString KSPECFRT0_SHORT Frei AddString KSPECSTR3_SHORT SShip
; Patch the executable PatchFile XwingAlliance.exe MyShipset.ZT

Now before we go any further you can add other strings to the CFG, but they MUST be in a specific order in the CFG file.

Please use this French International XWA.tab file to familiarise yourself with the order of the lines.

Download

So you could add strings such as: -

AddString STR_SQUAD1	Blue Squadron
AddString STR_SQUAD2	Phoenix Squadron
AddString STR_SQUAD3	Badger Squadron
AddString STR_SQUAD4	Darksaber Transport
AddString STR_CONFIG_VERSION	My Shipset v1 X-Wing Alliance v
Here is the original String
AddString STR_SQUAD1	Phantom Squadron
AddString STR_SQUAD2	Vector Squadron
AddString STR_SQUAD3	Rogue Squadron
AddString STR_SQUAD4	Family Transport
AddString STR_CONFIG_VERSION	X-Wing Alliance v

This has to be placed in the CFG file as such: -

; X-Wing Install System Script
; ------------------------------------------
; The name of this file must match the name
; of the directory in which the component
; data is contained. It will also be used
; for the name of the package in the index.
; ------------------------------------------

; Script version
Version 2.7

; Install the files InstallOPT MyFighter.opt InstallOPT MyFighterExterior.opt InstallOPT MyFighterCockpit.opt InstallOPT MyShuttle.opt InstallOPT MyStarship.opt InstallOPT MyFreighter.opt InstallOPT MyContainer.opt InstallOPT MyAdvancedMissile.opt InstallOPT MyAdvancedTorpedo.opt InstallPilot Mypilot0.plt
; Add to a line in the craft list AddToCraftList 155 MyFighter.opt AddToCraftList 156 MyShuttle.opt AddToCraftList 157 MyStarship.opt AddToCraftList 158 MyFreighter.opt AddToCraftList 159 MyContainer.opt AddToEquipList 159 MyAdvancedMissile.opt AddToEquipList 160 MyAdvancedTorpedo.opt
; Set up description strings. They MUST have tabs between the resource name ; and the value or it will not work. AddString SPECIES_184 MyFighter,Fighter,Flyable,Known,Skirmish, 6 ,9 ,13 ,20 ,4 ,13 ,32 ,43 AddString SPECIES_185 MyFighter2,Fighter,Flyable,Known,Skirmish, 6 ,9 ,13 ,20 ,4 ,13 ,32 ,43 AddString SPECIES_186 MyShuttle,Shuttle/Light Transport,Flyable,Known,Skirmish, 24 ,53 ,32 ,64 ,122,144,145,174 AddString SPECIES_187 MyStarship,Starship,Nonflyable,Known,Skirmish, 214,49 ,222,68 ,280,277,290,307 AddString SPECIES_188 MyFreighter,Freighter/Heavy Transport,Nonflyable,Known,Skirmish, 234,97 ,240,106,0 ,0 ,0 ,0 AddString SPECIES_189 MyContainer,Container,Nonflyable,Known,Skirmish, 234,97 ,240,106,125,322,141,348 AddString SPEC_184_NAME My Fighter (M-F) AddString SPEC_184_MANU My Fighter Corp. AddString SPEC_184_SIDE My Alliance AddString SPEC_184_DESC It's a Fighter AddString SPEC_185_CREW 1 AddString SPEC_185_NAME My Fighter2 (M-F2) AddString SPEC_185_MANU My Fighter Corp. AddString SPEC_185_SIDE My Alliance AddString SPEC_185_DESC It's a Fighter AddString SPEC_185_CREW 2 AddString SPEC_186_NAME My Shuttle (M-S) AddString SPEC_186_MANU My Shuttle Corp. AddString SPEC_186_SIDE My Alliance AddString SPEC_186_DESC It's a Shuttle AddString SPEC_186_CREW 2 AddString SPEC_187_NAME My Starship (SShip) AddString SPEC_187_MANU My Starship Corp. AddString SPEC_187_SIDE My Alliance AddString SPEC_187_DESC It's a Starship AddString SPEC_187_CREW 4500 AddString SPEC_188_NAME My Freighter (Frei) AddString SPEC_188_MANU My Freighter Corp. AddString SPEC_188_SIDE My Alliance AddString SPEC_188_DESC It's a Freighter AddString SPEC_188_CREW 4 AddString SPEC_189_NAME My Container (Con 1) AddString SPEC_189_MANU My Container Corp. AddString SPEC_189_SIDE My Alliance AddString SPEC_189_DESC It's an Container AddString SPEC_189_CREW 0 AddString STR_SQUAD1 Blue Squadron AddString STR_SQUAD2 Phoenix Squadron AddString STR_SQUAD3 Badger Squadron AddString STR_SQUAD4 Darksaber Transport AddString STR_CONFIG_VERSION My Shipset v1 X-Wing Alliance v AddString KSPECFTR0 m:My Fighter AddString KSPECFTR1 m:My Fighter 2 AddString KSPECSHT0 m:My Shuttle AddString KSPECCON0 m:My Container AddString KSPECFRT0 m:My Freighter AddString KSPECSTR3 m:My Starship AddString KSPECFTR0_PLURAL My Fighters AddString KSPECFTR1_PLURAL My Fighter 2's AddString KSPECSHT0_PLURAL My Shuttle AddString KSPECCON0_PLURAL My Containers AddString KSPECFRT0_PLURAL My Freighters AddString KSPECSTR3_PLURAL My Starships AddString KSPECFTR0_SHORT M-F AddString KSPECFTR1_SHORT M-F2 AddString KSPECSHT0_SHORT M-S AddString KSPECCON0_SHORT Con 1 AddString KSPECFRT0_SHORT Frei AddString KSPECSTR3_SHORT SShip
; Patch the executable PatchFile XwingAlliance.exe MyShipset.ZT
Top
 

First remember to rename the CFG file to Missions.cfg

; X-Wing Install System Script
; ------------------------------------------
; The name of this file must match the name
; of the directory in which the component
; data is contained. It will also be used
; for the name of the package in the index.
; ------------------------------------------

; Script version
Version 2.7

; Install the files InstallMission 1b8m1rebel.tie InstallMission 1b8m2rebel.tie InstallMission 1b8m3rebel.tie InstallMission Mission.lst InstallMission Email.txt
You don't have to add the Email.txt file, only if you have added to it otherwise leave this line out.
Top
 

Again remember to rename the CFG file to match the folder that it's within.

This script is slightly different from the above two examples as you have to specify a directory for the wav files to be places in.

; X-Wing Install System Script
; ------------------------------------------
; The name of this file must match the name
; of the directory in which the component
; data is contained. It will also be used
; for the name of the package in the index.
; ------------------------------------------

; Script version
Version 2.7

; Install the files InstallMissionVoice 1b8m1r01.wav B8m1 InstallMissionVoice 1b8m1r02.wav B8m1 InstallMissionVoice 1b8m2r01.wav B8m2 InstallMissionVoice 1b8m2r02.wav B8m2 InstallMissionVoice 1b8m3r01.wav B8m3 InstallMissionVoice 1b8m3r03.wav B8m3 InstallMissionVoice 1b8m1.lst . InstallMissionVoice 1b8m2.lst . InstallMissionVoice 1b8m3.lst .
Remember there is a Space and then a Full Stop - Period at the end of the *Lst lines, if you do not include them XIS WILL create a new directory called InstallMissionVoice and place the *.Lst files in it, and you will not be able to hear the voices in-game.
Top
 

Again a very simple script, and don't forget to the name the CFG file the same as the folder which it is within.

; X-Wing Install System Script
; ------------------------------------------
; The name of this file must match the name
; of the directory in which the component
; data is contained. It will also be used
; for the name of the package in the index.
; ------------------------------------------

; Script version
Version 2.7

; Install the files InstallSkirmish MySkirmish.skm
Top
 

This script is similar to the MissionVoice script, that is as you have to specify which directory the new file has to be placed in, as we are replacing these files, the folder names will be that of there originals in the XwingAlliance\Frontres folder

; X-Wing Install System Script
; ------------------------------------------
; The name of this file must match the name
; of the directory in which the component
; data is contained. It will also be used
; for the name of the package in the index.
; ------------------------------------------

; Script version
Version 2.7

; Install the files InstallFrontRes Conmkanim.cbm Concourse InstallFrontRes Licon.bmp Mapicons InstallFrontRes Licons.cbm Mapicons InstallFrontRes lblu_4.cbm Mapicons InstallFrontRes lgrn_4.cbm Mapicons InstallFrontRes lprp_4.cbm Mapicons InstallFrontRes lred_4.cbm Mapicons InstallFrontRes lyel_4.cbm Mapicons InstallFrontRes Squad4.cbm Tour
Top
 

It's best to keep the following two folders separate as the wave files are usually named the same

; X-Wing Install System Script
; ------------------------------------------
; The name of this file must match the name
; of the directory in which the component
; data is contained. It will also be used
; for the name of the package in the index.
; ------------------------------------------

; Script version
Version 2.7

; Install the files InstallHighResSound Aaaaaa.wav InstallHighResSound BombFire.wav InstallHighResSound ChaffStart.wav
Top

Same as above really

; X-Wing Install System Script
; ------------------------------------------
; The name of this file must match the name
; of the directory in which the component
; data is contained. It will also be used
; for the name of the package in the index.
; ------------------------------------------

; Script version
Version 2.7

; Install the files InstallLowResSound Aaaaaa.wav InstallLowResSound BombFire.wav InstallLowResSound ChaffStart.wav
Top
; X-Wing Install System Script
; ------------------------------------------
; The name of this file must match the name
; of the directory in which the component
; data is contained. It will also be used
; for the name of the package in the index.
; ------------------------------------------

; Script version
Version 2.7

; Install the files InstallMusic Frconcourse.imc
Top

Just a simple script

; X-Wing Install System Script
; ------------------------------------------
; The name of this file must match the name
; of the directory in which the component
; data is contained. It will also be used
; for the name of the package in the index.
; ------------------------------------------

; Script version
Version 2.7

; Install the files InstallSound Alarm00.wav InstallSound Door-1b.wav
Top

Just a simple script

; X-Wing Install System Script
; ------------------------------------------
; The name of this file must match the name
; of the directory in which the component
; data is contained. It will also be used
; for the name of the package in the index.
; ------------------------------------------

; Script version
Version 2.7

; Add lines to the top of the Resdata text file AddToResData Hull_Icons.dat AddToResData Map_Icon.dat
; Install the files InstallResData Hull_Icons.dat InstallResData Map_Icon.dat
Top
; X-Wing Install System Script
; ------------------------------------------
; The name of this file must match the name
; of the directory in which the component
; data is contained. It will also be used
; for the name of the package in the index.
; ------------------------------------------

; Script version
Version 2.7

; Install the files InstallMovie Ceremony.snm
Top

Last but not least

; X-Wing Install System Script
; ------------------------------------------
; The name of this file must match the name
; of the directory in which the component
; data is contained. It will also be used
; for the name of the package in the index.
; ------------------------------------------

; Script version
Version 2.7

; Install the files InstallFilm MyFilm.flm

Ok so now Zip it up and test your new XMOD.

If you do come across any errors and your have narrowed it down the one folder and you have checked everything looks OK.

I sometimes find that if you create a new CFG file copy across all the info from the old one, delete the old one and rename the new CFG file this sometime works and fixes the error.

Top
Command lines and how they should be applied
Command and Arguments How it should be
; X-Wing Install System Script
; ------------------------------------------
; The name of this file must match the name
; of the directory in which the component
; data is contained. It will also be used
; for the name of the package in the index.
; ------------------------------------------
 
. .
; Script version .
Version 2.7

[Version][space][2.7]

. .
; Install the files .
InstallOPT MyFighter.opt
InstallOPT MyFighterExterior.opt
InstallOPT MyFighterCockpit.opt
InstallOPT MyFighter2.opt
InstallOPT MyFighter2Exterior.opt
InstallOPT MyFighter2Cockpit.opt
InstallOPT MyAdvancedMissile.opt
InstallOPT MyAdvancedTorpedo.opt
InstallMission 1b8m1rebel.tie
InstallMission Mission.lst
InstallMissionVoice 1b8m1r01.wav B8m1
InstallMissionVoice 1b8m2r01.wav B8m2
InstallMissionVoice 1b8m1.lst .
InstallMissionVoice 1b8m2.lst .
InstallSkirmish MySkirmish.skm
InstallFrontRes lyel_4.cbm Mapicons
InstallFrontRes Squad4.cbm Tour
InstallHighResSound Aaaaaa.wav
InstallLowResSound Bombfire.wav
InstallMusic Frconcourse.imc
InstallSound Alarm00.wav
InstallResData Hull_Icons.dat
InstallMovie Ceremony.snm
InstallFilm MyFilm.flm
InstallPilot MyPilot.plt
[InstallOPT][space][MyFighter.opt]
[InstallOPT][space][MyFighterExterior.opt]
[InstallOPT][space][MyFighterCockpit.opt]
[InstallOPT][space][MyFighter2.opt]
[InstallOPT][space][MyFighter2Exterior.opt]
[InstallOPT][space][MyFighter2Cockpit.opt]
[InstallOPT][space][MyAdvancedMissile.opt]
[InstallOPT][space][MyAdvancedTorpedo.opt]
[InstallMission][space][1b8m1rebel.tie]
[InstallMission][space][Mission.lst]
[InstallMissionVoice][space][1b8m1r01.wav][space][B8m1]
[InstallMissionVoice][space][1b8m2r01.wav][space][B8m2]
[InstallMissionVoice][space][1b8m1.lst][space][Period - Full Stop]
[InstallMissionVoice][space][1b8m2.lst][space][Period - Full Stop]
[InstallSkirmish][space][MySkirmish.skm]
[InstallFrontRes][space][lyel_4.cbm][space][Mapicons]
[InstallFrontRes][space][Squad4.cbm][space][Tour]
[InstallHighResSound][space][Aaaaaa.wav]
[InstallLowResSound][space][BomFire.wav]
[InstallMusic][space][Frconcourse.imc]
[InstallSound][space][Alarm00.wav]
[InstallResData][space][Hull_Icons.dat]
[InstallMovie][space][Ceremony.snm]
[InstallFilm][space][MyFilm.flm]
[InstallPilot][space][MyPilot.plt]
. .
; Add to a line in the craft list .
AddToCraftList 155 MyFighter.opt
AddToEquiptList 159 MyAdvancedMissile.opt
AddToEquipList 160 MyAdvancedTorpedo.opt
[AddToCraftList][space][155][space][MyFighter.opt]
[AddToEquipList][space][159][space][MyAdvancedMissile.opt]
[AddToEquipList][space][160][space][MyAdvancedTorpedo.opt]
. .
; Add lines to the top of the Resdata text file .
AddToResData Hull_Icons.dat [InstallResData][space][Hull_Icons.dat]
. .
; Set up description strings. They MUST have tabs between the resource name
; and the value or it will not work.
 
AddString SPECIES_184  MyFighter,Fighter,Flyable,Known,Skirmish,     6 ,9 ,13 ,20 ,4 ,13 ,32 ,43
AddString SPECIES_184  MyFighter2,Fighter,Flyable,Known,Skirmish,     6 ,9 ,13 ,20 ,4 ,13 ,32 ,43
AddString SPEC_184_NAME  My Fighter (M-F)
AddString SPEC_184_MANU  My Fighter Corp.
AddString SPEC_184_SIDE  My Alliance
AddString SPEC_184_DESC  It's a Fighter
AddString SPEC_184_CREW  1
AddString SPEC_185_NAME  My Fighter (M-F2)
AddString SPEC_185_MANU  My Fighter Corp.
AddString SPEC_185_SIDE  My Alliance
AddString SPEC_185_DESC  It's a Fighter
AddString SPEC_185_CREW  2
AddString STR_SQUAD1  Blue Squadron
AddString STR_SQUAD2  Phoenix Squadron
AddString STR_SQUAD3  Badger Squadron
AddString STR_SQUAD4  Darksaber Transport
AddString STR_CONFIG_VERSION  My Shipset v1 X-Wing Alliance v
AddString KSPECFTR0  m:My Fighter
AddString KSPECFTR1  m:My Fighter 2
AddString KSPECFTR0_PLURAL  My Fighter's
AddString KSPECFTR1_PLURAL  My Fighter 2's
AddString KSPECFTR0_SHORT  M-F
AddString KSPECFTR1_SHORT  M-F2

[AddString][space][SPECIES_184][Tab][MyFighter,Fighter,][Tab][6 ,8 ,13 ]
[AddString][space][SPECIES_185][Tab][MyFighter2,Fighter,][Tab][6 ,8 ,13 ]
[AddString][space][SPEC_184_NAME][Tab][MyFighter (M-F)]
[AddString][space][SPEC_184_MANU][Tab][My Fighter Corp.]
[AddString][space][SPEC_184_SIDE][Tab][My Alliance]
[AddString][space][SPEC_184_DESC][Tab][It's a Fighter]
[AddString][space][SPEC_184_CREW][Tab][1]
[AddString][space][SPEC_185_NAME][Tab][MyFighter 2 (M-F2)]
[AddString][space][SPEC_185_MANU][Tab][My Fighter Corp.]
[AddString][space][SPEC_185_SIDE][Tab][My Alliance]
[AddString][space][SPEC_185_DESC][Tab][It's a Fighter]
[AddString][space][SPEC_185_CREW][Tab][2]
[AddString][space][STR_SQUAD1][Tab][Blue Squadron]
[AddString][space][STR_SQUAD2][Tab][Phoenix Squadron]
[AddString][space][STR_SQUAD3][Tab][Badger Squadron]
[AddString][space][STR_SQUAD4][Tab][Darksaber Transport]
[AddString][space][STR_CONFIG_VERSION][Tab][X-Wing Alliance v]
[AddString][space][KSPECFTR0][Tab][m:My Fighter]
[AddString][space][KSPECFTR1][Tab][m:My Fighter 2]
[AddString][space][KSPECFTR0_PLURAL][Tab][My Fighter's]
[AddString][space][KSPECFTR1_PLURAL][Tab][My Fighter 2's]
[AddString][space][KSPECFTR0_SHORT][Tab][M-F]
[AddString][space][KSPECFTR1_SHORT][Tab][M-F2]

. .
; Patch the executable .
PatchFile XwingAlliance.exe MyOpt.ZT
PatchFile *.PLT PILOTPATCH.ZT
[PatchFile][space][XwingAlliance.exe][space][MyOpt.ZT]
[PatchFile][space][*.PLT][space][PILOTPATCH.ZT]
Top

All trademarks herein are acknowledged as the property of their respective owners. Star Wars is a registered trademark of © Lucasfilm Ltd.
Star Wars and all related names are all registered trademarks of © LucasArts Entertainment Company LEC. © Lucasfilm Ltd. & TM or ® as indicated.
Website Established November 1999
Webpage Design 1999 by Tony Denton.