XMB (X-wing Mission Builder) Version 3.02 Mission Builder for X-wing Space Combat Simulator (C) Copyright September 1994 by Neal Westfall CIS:[70222,1164] Internet: nwestfal@silicon.csci.csusb.edu AOL: XMBOwner The first hint of the Imperial ambush occurred when Gray 3 & 4 exploded seconds after emerging from hyperspace. Commander Nika Callo, commanding officer for Gray Squadron, paled as his scanners registered over three dozen TIE fighters encircling his nine X-Wing strike force. Where did they come from, he thought. Nika banked his X-Wing hard over into a spiralling dive. Dozens of green lasers streaked past his cockpit as he barely evaded laser fire from three TIE fighters. Nika opened wide the power feeds to his lasers and shields, accepting the speed loss for greater endurance and firepower. Off in the distance, Nika could see the unmistakable formation of a Imperial Nebulon B frigate escorted by the four Corellian Corvettes. Obviously, Gray Squad was going to have to trade survival for the Corvettes today. This is gonna be tough, he thought. We may actually not be able to get them all. Bemused by the sardonic thought, Nika almost didn't see the approaching TIE Interceptor on his scanners. Almost... Welcome to the "rock'm, sock'm, let-your-X-Wing-do-the- talkin'" world of Star Wars. For seventeen years, millions of people have thrilled to George Lucas' epic story of good versus evil. In 1993, LucasArts released the X-Wing Flight Simulator and fans 'round the world rejoiced at the chance to take on the forces of the Empire in their own homes. The X-Wing simulator offers Star Wars fans the opportunity to fly the most advanced starfighters in the Rebel Alliance. The X-Wing Mission Builder (XMB) allows you, the player, to custom design scenarios for whatever level of skill and complexity YOU desire! Wanna fly the Death Star Trench in a Y-Wing? Destroy Cruisers and Corvettes in a X-Wing? Take on Star Destroyers in a A-Wing? Fight the TIE Advanced in a B-Wing? The XMB takes you to a galaxy, far, far away for hours on nonstop action and adventure! OVERVIEW: XMB is a utility for the popular LucasArts Entertainment game X-wing. It allows you to effortlessly edit or completely redesign X-wing mission files and briefing files. It has been implemented using Borland's Turbo Vision interface library to facilitate ease of use. Editing missions is as easy as picking up the ships with the mouse and moving them. A briefing editor is provided as well, so you can provide briefing files with your missions. Context sensitive help is available at the touch of a button. XMB is actually two programs in one. The first, Mission Editor, allows the user to edit existing X-Wing missions while the second, the Briefing Editor, provides the means to create professional style briefings for your mission. IMPORTANT!: XMB modifies data files which are distributed with X-wing and Imperial Pursuit. It is strongly advised that before using this program, you back up all of your mission and briefing files. Copy all files in the mission directory to another directory or onto a floppy disk. The author of this program makes no representations or warranties as to the suitability of fitness for any particular purpose of the provided software or documentation. The program is provided "as is" to the user provided the user understands this and accepts these terms. No warranties or guarantees are expressed or implied. The author cannot be held responsible for any damage resulting from the use or misuse of the software. The author has no affiliation with LucasArts Games, and the program in no way should be thought of as sponsered, sanctioned, or authorized by LucasArts Games in any respect whatsoever. REVISION HISTORY: This is version 3.02 of XMB. As of September, 1994, this is the one you want. Earlier versions are substandard and should not concern you if you have this version! XMB has gone through an evolutionary process, the first being released sometime in 1993. The program has come a long way since then. XMB is near the end of it's development cycle, since TIE fighter is now out and demand is high for a TIE mission editor. FILES IN THIS DISTRIBUTION: XMB.EXE - main program file. XMBHELP.HLP - program help file. XMB.DOC - this file. XMB.ICO - Microsoft Windows 3.1 icon. DESUPLY2.XWI - sample edited mission. DESUPLY2.BRF - sample edited briefing file. DESUPLY2.TXT - readme for desuply2 mission/briefing. ENDOR.BRF - another sample briefing - lots of animation seq. MISSIONS.TXT - file names for missions. You can copy the sample mission and briefing files over one of your existing missions to play it. I created this mission during the testing of the program. To replace X-wing Historic Mission 1 with this one, do the following: copy DESUPLY2.* WAISTEM.* Make sure you have backed up the old mission if you want to restore it. INSTALLATION: Copy all files in the archive to your XWING mission directory or anywhere in your path. To start the program, just change to your XWING mission directory and type 'XMB' and the program will load. For example: copy *.* C:\GAMES\XWING\MISSION cd C:\GAMES\XWING\MISSION Type 'XMB' and you're ready to go! MENUS: XMB is very user friendly. Many of the commands listed here can be accessed by using the [TAB] key, the [ALT] key, or double- clicking on the command button with a mouse. Context sensitive help is available for nearly all commands and options. System Menu (small box at top left next to File menu) About: "About" details the program credits and version number. Calculator: "Calculator" is a handy little calculator with many basic math functions. File Menu New: Create new mission or briefing. User is prompted to open new file. Press [ENTER] to open Mission file, press [TAB] or double-click on Briefing to create mission briefing. Open [F3]: Open Mission or Briefing file. Select file from list or search sub-directories by choosing '\'. NOTE: XMB allows user to have multiple mission and briefing files open at one time. Save [F2]: Save current mission or briefing file. Save As: Save active mission or briefing with new name. Save All: Save all open mission and briefing files. Convert: Perform a file conversion between mission and briefing files. XMB can convert .XWI and .BRF files in both directions. This mainly allows you to use your mission file as a base from which to build your briefing files. DOS: User is shelled out to DOS prompt. All XMB files are kept open, but not saved. Type "EXIT" to return to XMB. Exit [ALT-X]: Exit XMB. You are prompted to save any open files. Options Menu Toggle: Toggles group number display on/off on map icons. Useful for keeping track of the various ship groups. Window Menu: Windowing options for switching back and forth between different missions. These options allow the user to toggle between the mission and briefing files, allowing for ease of mission design. Size/Move [CTRL]+F5: Allows user to resize or move the active window. Next [F6]: Allows user to move the next open mission/ briefing file. Previous [SHIFT]+F6: Moves user back one file. Close [ALT]+F3: Closes active window; prompts user to save file before closing the window. MISSION EDITOR: Ships Pressing 'S' or [ALT]-S lists all active ship groups. Each group is listed in the following order: Group # Group Name # Units Type Unit Example: 1 Alpha 3 TIE Fighter 2 Rogue 2 X-Wing 3 Marauder 1 Star Destroyer There can only be 16 groups active at any one time in X- Wing. Due to program limitations, there is also a limit of how many Rebel ships will be active. (NOTE: The X-Wing program allows a maximum of 12 pilots to be active during the mission. Additional ships will be present during the actual mission, but not during pilot selection!) Create A New Unit: Press the [INS] key creates a new unit. Press [ENTER] to create new unit or press [TAB] or click on 'N' to decline unit creation. If "yes", scroll down to new unit. The unit will appear on the grid. (Unit will appear in a box with "???" inside.) Using the mouse, move unit to desired location on map grid. Then, follow Unit Creation/Editing guidelines below. Delete Existing Unit: Press the [DEL] key to delete an existing unit. Be sure the correct unit is selected!!! Unit Creation/Editing: To create or edit a unit, press [INS] and answer 'Y' to "Add New Ship Group". Use the arrow keys to select the Group and press F8 to enter the Ship Group Information screen. Designation: Name of Unit (ie. Alpha, Beta, Rogue, Ajax, etc.) Cargo: Type of cargo on board unit. Leave blank if none. Alternate Cargo: Alternate cargo load. Only available on one ship. Leave blank if none. Special Ship: Which ship in unit carries Alternate Cargo. Leave blank if none. Ship Type: Type of ship unit is composed of. Press F8 for a list of available ship types. Use the arrow keys to select ship type and press [ENTER]. IFF: Determines whose side the unit is on. Default: Some units are automatically assigned to either Alliance or Imperial forces. Alliance: Used mainly for assigning Freighters, Cargo Containers, and Nebulon B Frigates to the Rebel Alliance starfleet. Will register in green on sensor displays. Imperial: Used mainly for assigning Freighters, Cargo Containers, and Nebulon B Frigates to Imperial forces. Will register in red on sensor displays. Neutral: Can be used for any nonaligned forces(!). Units assigned as neutral will register in blue on sensor displays. Cripple: Predetermines how restricted the unit is at the start of play. This option is used mainly for primary targets. Number of vessels: Type in number from 1 to 16. Waves: How follow up waves of this unit will arrive after departure or destruction of 1st group. Not recommended for Rebel starfighters. Vessel: Which vessel in group is player's. This is usually a fighter in the first Rebel group. Note: This option must be used at some point during Rebel starfighter unit creation. Failure to specify personal vessel will cause the X-Wing program to crash! Speed: Percentage of maximum speed at beginning of play. Type in number from 0 to 9 (0=100 percent, 9=90 percent). Arrival Parameters: The arrival parameters determines when a unit arrives and departs based on the following conditions. (NOTE: this dialogue gives the player enormous flexibility in controlling the arrival and departure of the various ship groups. Creative use of the Arrival Parameters can make for a lively game session.) Arrive via Hyperspace: Unit arrives during play via hyperspace. Arrival may be conditional on other conditions listed below. Depart via Hyperspace: Unit departs during play via hyperspace. Departure may be conditional on other conditions listed below. Arrival Time: Time after beginning of mission that unit will appear. Or, after ship group (see below) performs its designated conditions. Mothership: Home ship for this group. Normally, a group will arrive via this unit and return to it if instructed to. After Ship Group: Ship group will arrive or depart based on this units actions. (See Conditions below.) Condition: Ship group arrive conditions None: Arrives: Destroyed: Engaged: Boarded: Identified: Disabled: Waypoints: Points in space the unit travels to and from. Used primarily for ship groups (read: targets), this option gives the player a moving target to hunt down and destroy. If waypoints are listed for starfighter groups with no objectives or hyperspace departure orders, the group will circle endlessly at the last coordinates listed. Note: be careful when positioning units near the fringes, strange things happen out there! Enable: Activates waypoint. 1st Waypoint and Hyperspace waypoint must be active, otherwise unit will circle aimlessly. Optional for 2nd, 3rd, Alternate 1st, and Initial 2nd. Initial Waypoint: Initial Waypoint must be enabled at all times. Coordinates are based on unit's starting position. If unit is moved on map grid, coordinates are automatically updated by program. 1st, 2nd, 3rd Waypoint: additional travel points for unit. 2nd and 3rd can be considered optional. Alternate Initial: X-Wing allows for two alternate initial waypoints. Use of these can make a scenario very lively! Objective: In order for unit goals to be successful, the ship group must perform one of the twenty different criteria. Only units whose disabling/destruction/identification will influence the outcome of the scenario need have this active. Assignment: This defines the units offensive and defensive role in the mission. Options with a checkmark next to them require that Primary and Secondary target groups be listed. Using either the [TAB] key or mouse button, type in the number of the group to be targeted. Press F8 for a list of available ship groups. Capital ships use only the "CAP:" instructions at the bottom of the list. ***X-Reference: Only in registered version of XMB. This useful screen lists the item's name, group number, and unit type. It also lists which other ship groups arrival is dependant on it, who it is the mothership for, and which groups it is the Primary and Secondary Command Target for. Formation: There are 12 different formations available. These formations regulate the distance and placement of individual ships if the unit has more than one vessel in it. Available formations are: Vic, Finger Four, Line Astern, Line Abreast, Echelon Right, Echelon Left, Double Astern, Diamond, Stack, Spread, Hi-Low, and Spiral. Pilot Skill: The relative combat skill level of the unit's pilot(s). The higher the ranker, the more effective the unit is overall. Pilot rankings are: Rookie, Officer, Veteran, Ace, Top Ace. Markings: Used for designating color schemes for unit's markings. Objects: Pressing 'J' or [ALT]-J, or simply double-clicking on "Object" lists all active ship groups. Each group is listed in the following order: Group # Designation # Object Type Example: 1 Alderaan 1 Gray Inhabitable 2 4 Mine, Type 2 3 2 Com Sat There can only be 16 groups active at any one time in X- Wing. Create A New Unit: Press the [INS] key creates a new unit. Press [ENTER] to create new unit or press [TAB] or click on 'N' to decline unit creation. if "yes", scroll down to new unit. The unit will appear on the grid. (Unit will appear in a box with "???" inside.) Using the mouse, move unit to desired location on map grid. Then, follow Unit Creation/Editing guidelines below. Delete Existing Unit: Press the [DEL] key to delete an existing unit. Be sure the correct unit is selected!!! Object Creation/Editing: Designation: Name of object. Not needed for mines, com sats, and buoys. Object Type: Select one of 32 different object types. Objects available include: mines, com sat, buoy, nav sat, asteroids, planets, and the Death Star(!). (Of all the objects, only the mines, com sat, nav sat, and buoy can be attacked.) IFF (Identify Friend or Foe): Identifies whether the object belongs to the Alliance, Empire, or is neutral. Layout: Flat On Edge Broadside Must be Destroyed: Check if item destruction is a mission objective. Quantity: Number of objects in unit. If object is a mine, number is squared for total # of mines in unit. Only 1 planet will be assigned to unit. X-Y-Z: Coordinates for unit location. If unit is moved on map grid, coordinates are automatically updated by program. BRIEFING EDITOR: The Briefing Editor allows the user to create professional style presentations for their homemade scenarios. These tools represent hours of time researching the X-Wing .BRF files and how they work, and are as up-to-date as possible. (NOTE: If the Briefing Editor is not used to update the Missions corresponding .BRF file, the original briefing will appear every time the mission is run. While not wholly necessary for experienced players who are familiar with the scenarios they have created, it is a must for newer players who wish to fully experience the Star Wars adventure!) A number of the commands used in the Briefing Editor are the same as those in the Mission Editor. There are some significant differences as explained in the text below, however. To access the appropriate command, either press [ALT]+ the highlighted character or use the [TAB] button to access the appropriate function. Help is always available by pressing [F1]. Coordinate Set: Select one of two coordinate sets. X-wing briefing files allow for multiple coordinate sets. Most of the stock briefings contain 2 coordinate sets. The first coordinate set usually contains the same coordinates as the initial ship positions found in the mission files. This first set is generally ignored. The second set usually contains the coordinates which are used. They generally are tweaked for the desired effect on the briefing map. When creating briefings, it is recommended that you convert your mission file over to .BRF format. Then you can load the briefing. Leave the first coordinate set alone, switch to the second set. Then you can tweak the locations so you can get the desired visual effect for your briefing file. *Note: Some of the stock briefings only contain 1 coordinate set, or in rare cases contain 3 coordinate sets. XMB was designed to support only 2, since that is all that's really needed. When loading such files, XMB will add in the second set or throw away any extra sets. Type: Space: Select for combat in outer space. Surface: Click here to fight above the Death Star. Completion Message: Allows the user to type in up to three lines of text when "Mission Completed" signal is received. Each line is separate. To avoid confusion, each remark should be limited to 72 characters or less per statement. Note that this is not really used in briefing files. It is provided in XMB only for completeness. Ships & Objects: Lists all ship groups and objects to appear on the Animated Map page. Press [INS] to create a new ship/object group. Unit Creation: This command box is a shortened version of the Mission Briefing Unit Creation box. Unit detail items include: Type Unit: Enter Unit type. Exact unit type will appear next to group code. IFF: Select Neutral, Alliance or Imperial to determine unit allegiance. Quantity: Number of ships/objects per group. Cripple: Select None for no crippling, No Missiles for units with missile racks, 1/2 Missiles to reduce the number of missiles available to each ship, or No Shields. Only one option can be selected. Designation: The name of the unit. Cargo: What type, if any, cargo is carried by the unit. This option is generally reserved for all non-starfighter ships. Alternate Cargo: What type, if any, of other cargo is carried by unit. This option is generally reserved for all non- starfighter ships. Alternate Vessel: Number of the ship which carries the alternate cargo. Location: X, Y and Z spatial coordinates for unit. If the unit is moved on the map page, these numbers will be updated accordingly. Personal: Set which ship in the group is the player's vessel. This should only be set in one group, and must be a rebel starfighter. This is also necessary to get the proper launch sequence cutscene. Map Page Setup Animation Pages: The Animation Pages command box is the heart of the X-Wing Briefing Editor. The differences between the Animated Map Pages and Full Text are minimal, but important. The Animated Map Pages allow the user to manipulate the map that players will see when they start the scenario. There are far more commands available for the AMP section than for Full Text. The Full Text Page is just that. These are the blue text pages which give the player additional background information. At present, XMB does not allow the user to switch text colors. Insert: Add new page after last entry. Add: Add new page before current entry. Delete: Delete highlighted page. Edit: Edit Animation Pages. Clock Period: Total time length of animation page. Time units, however, are not seconds, but program "ticks." Coordinate Set: Designate which of two possible coordinate ranges to use. Either one can be used without impairing program performance. Most of the time you probably will want to use the second coordinate set, since that seems to be the convention used by the stock briefings. Page Type: Select MAP for map showing all units/ objects. Or, choose FULL TEXT to display briefing text. Animation Commands: Insert: Enter new command before current command. Clock Ticks: Input number between 0 and Clock Period when Command will be executed. (Note: It is not necessary for commands to be in clock order, but to avoid confusion, it is best to enter them in sequence. If commands are not in clock order, unpredictable results can occur during the animation sequence.) ` Command: Enter Command to be executed. Press [F8] for a list of available commands. Parameter: This command is dependant upon several different factors. The Parameter is can be one of two things: 1) Unit number and X, Y Coordinates (used exclusively by Map Pages) or 2) X,Y Coordinates for map or text placement. Press [F8] for a list of available options. The "Locate" option will appear whenever a Tag or Box option is used. This will require the user to enter X, Y coordinates for the Tag or Box to be positioned. Add: This is identical to "Insert," except that the command is placed AFTER the highlighted command. Clock Ticks: Input number between 0 and Clock Period when Command will be executed. (Note: It is not necessary for commands to be in clock order, but to avoid confusion, it is best to enter them in sequence.) ` Command: Enter Command to be executed. Press [F8] for a list of available commands. Parameter: This command is dependant upon several different factors. The Parameter is can be one of two things: 1) Unit number and X, Y Coordinates (used exclusively by Map Pages) or 2) X,Y Coordinates for map or text placement. Press [F8] for a list of available options. The "Locate" option will appear whenever a Tag or Box option is used. This will require the user to enter X, Y coordinates for the Tag or Box to be positioned. Delete: Delete highlighted command. Edit: Edit highlighted command. Returns user to "Insert/Add" screen. Done: Return to previous screen. Help: Activates context sensitive help box. Done: Returns to main menu box. Help: Displays additional information. Briefing Map Tags: Insert: Insert new unit/group tag before highlighted tag. Unit names can range from "X-W Red (You)" to "Tie Fighter" to "Death Star." It is recommended that descriptors be kept to 12 or less letters. Add: Add new unit/object tag after current tag. Unit names can range from "X-W Red (You)" to "Tie Fighter" to "Death Star." It is recommended that descriptors be kept to 12 or less letters. Edit: Edit the current tag. Delete: Delete marked tag. Done: Return to main screen. Help: Displays context sensitive help screen. Briefing Text: This option allows you to write the script for the map pages. There is no specific order in which the briefing text should be entered. It is only necessary to keep track of which items are used in where. It is important to remember a few things when writing the briefing text. That is, Map Page tags should be kept short, roughly 20 characters per line. Also, scenario titles, such as "OP 01 Death Star," should always start with a '>' character (thus becoming ">OP 01 Death Star". Check other .BRF files for examples of briefing text is used. Insert: Enter new text block before current item. Add: Enter new text block after current item. Edit: Allows full editing of current block. Delete: Remove current item from list. Done: Return to main screen. Help: Displays context sensitive help screen. Q: How do I know what my unit's coordinates are? How do I set 1st, 2nd, 3rd and Hyperspace waypoints? A: Picture a square composed of four of 10 x 10 grids (see below for example). Each of the small blocks equals 10 KM per side. Upper Right is the 0,0 to 100,100; Lower Right is 0,0 to 100,-100; Upper Left is 0,0 to -100,100; and Lower Left is 0,0 to -100,-100. These basic grids provide you with a close approximation of the X,Y locations. A imaginary Z grid exists to provide elevation (a relative thing in space) differences between units. Setting waypoints becomes simple once you understand the grid system. Once you have placed your unit on the map, consider where you want it to travel to next. Plot those coordinates, including the Z-axis coordinate if used, and list them in the appropriate coordinate row. NOTE: The coordinate system is extremely flexible, allowing the user to designate coordinates from -99.99,-99.99,-99.99 to 99.99,99.99,99.99 rather than restrict the unit to whole number reference points. Example: Upper right quadrant 0,0-100,100 grid 10 20 30 40 50 60 70 80 90 0,100---------------------------------------------------100,100 | | | | | | | | | | | | | | | | | | | | | | 0,90 --------------------------------------------------- 90,100 | | | | | | | | | | | | | | | | | | | | | | 0,80 --------------------------------------------------- 80,100 | | | | | | | | | | | | | | | | | | | | | | 0,70 --------------------------------------------------- 70,100 | | | | | | | | | | | | | | | | | | | | | | 0,60 --------------------------------------------------- 60,100 | | | | | | | | | | | | | | | | | | | | | | 0,50 --------------------------------------------------- 50,100 | | | | | | | | | | | | | | | | | | | | | | 0,40 --------------------------------------------------- 40,100 | | | | | | | | | | | | | | | | | | | | | | 0,30 --------------------------------------------------- 30,100 | | | | | | | | | | | | | | | | | | | | | | 0,20 --------------------------------------------------- 20,100 | | | | | | | | | | | | | | | | | | | | | | 0,10 --------------------------------------------------- 10,100 | | | | | | | | | | | | | | | | | | | | | | 0,0 --------------------------------------------------- 0,100 | | | | | | | | | | | | | | | | | | | 0,0 --------------------------------------------------- 0,100 More help and extensive documentation is available via the online help system. Most of the available help is context sensitive, so pressing F1 will give you info on the current field you're editing, with links to other related topics. There is also an index for navigating the help system. REGISTERING/GETTING UPDATES Registration of XMB is $15.00 (US). When you register, you will receive the latest registered version on disk, along with XPLT, the pilot utility, and some new missions and tours to try out. The registered version of the program has consistency checkers for both the mission and briefing files, which will help you track down problems with your missions and briefings very quickly. Registered users can receive an updated copy of the program by sending $2.00 to the address below to cover shipping costs. Send registration fee to: Neal Westfall 3061 Oregon St. Rialto, Ca 92376 Compuserve members can register online via SWREG. The program ID is 1352. It is an extra fee of $3.00 to cover Compu$erve's cut. The total fee for online registration is $18.00. If you would like me to E-mail it to you via Compuserve instead of mailing it to you, please indicate as such and include your CIS account number. Please note that this costs me about the same as sending a disk. I can be reached via Compuserve at 70222,1164. For those with Internet access, the address is nwestfal@silicon.csci.csusb.edu. ACKNOWLEGEMENTS XMB was developed using Borland's Pascal with Objects 7.0 and Dave Baldwin's excellent Dialog Design program. Much of the information was gleaned from the pages of Rusel DeMaria's book, "X-wing: The Official Strategy Guide", published by Prima Publishing. A must have guide for every X-wing pilot. Written by the same author who wrote the original "Farlander Papers". Most of the hard part of the briefing files were decyphered by Tim Scott and Robert Delinsky. Thanks to both of these guys who both presented me with the detailed goods. Also thanks to Chris Gomez who wrote the bulk of this document file. Thanks to: Tim Scott (tscott@plains.nodak.edu) Robert Delinsky (70651.3316@compuserve.com) Chris Gomez (70621.1044@compuserve.com) Thanks to all the folks in Compuserve's FSFORUM for their patience in waiting for version 3.0, which was never supposed to take this long to come out. Especially thanks to all who registered the program. X-wing, Imperial Pursuit, Star Wars, and any other references to Star Wars stuff are trademarks of LucasArts and Lucasfilm, LTD. Neal Westfall CI$: 70222,1164 Email: nwestfal@silicon.csci.csusb.edu AOL: XMBOwner