home *** CD-ROM | disk | FTP | other *** search
/ Current Shareware 1994 January / SHAR194.ISO / flightsi / xp111.zip / XP.DOC < prev    next >
Text File  |  1993-11-08  |  13KB  |  292 lines
  1.                         X-Wing Editor PRO V1.11
  2.  
  3.   Welcome to XP, this is my first attempt at writing a game editor.  However
  4. so far I'm happy with the results; I've got a very simple interface, which
  5. uses the cursor, hot keys, ENTER, and ESC to navigate the entire interface.
  6.  
  7.  
  8.  
  9.                                 -= Files =-
  10.  
  11.                         XP.EXE    -  The Xwing Editor
  12.                         XP.DOC    -  This file (Documentation)
  13.                         XP.UPD    -  Revision and Future Enhancements List
  14.                         XR.COM    -  A TSR to revive ALL pilots while in XWING!
  15.                      REG-UPD.EXE  -  Updates your Registration program if you
  16.                                   -  Have prieviously registered XP.
  17.                      ORIGINAL.XPC -  The Default settings for all of the Ships
  18.                      REGISTER.ME  -  Registation Form.
  19.                      MISSION.LST  -  A listing of all of The Missions Tour 1-5
  20.  
  21.                                 -= Features =-
  22.  
  23.   Complete facility to create/edit the Pilot Files.
  24.   Quick Recover of Pilots two different ways.
  25.   Complete facility to create/edit Missions Files.
  26.   Reads All three versions of XWING and BWING!
  27.   Support all Five tours that are out.
  28.   Almost Complete facility to edit Crafts.
  29.   The Ability to remove the Copy protection from XWING & BWING.
  30.   Menu Driven, and ESC aborts whatever you are doing.
  31.   XR - The ability to revive all of your pilots inside XWING!
  32.  
  33.   Coming Soon: Tour Editor, Briefing Editor.
  34.  
  35.  
  36.  
  37.                            -= About the Author =-
  38.  
  39.   Currently I have only a few games I really Enjoy: WOLF-3D, XWING, Lemmings 2.
  40. Since their is already many great editors for WOLF3D, I decided to do one for
  41. XWING, after looking at the editors that are out there. Most of them were either
  42. a pain to use, Buggy, or incomplete.
  43.  
  44.   I spent many, many, many hours deciphering the Pilot, Mission, Briefing, and
  45. other select locations in other XWING files (The Briefing was the hardest). 
  46. There is very little I don't know about these files(See HELP), I have several
  47. programs I programmed in-house that I use to make sure that the files are
  48. deciphered correctly.  Also the "XWING Official Strategy Guide" was helpful
  49. by making sure that the first three TOD's were deciphered correctly. 
  50.  
  51.  
  52.                                 -= BUGS =-
  53.  
  54.    Hopefully you won't find any bugs, but if you manage to find a bug that I
  55. missed during the Testing cycle, Please let me know via the addresses
  56. below.  
  57.  
  58.   Notice: Version 1.11 is in beta, I have added a lot of changes in
  59.   two evenings to completly support BWING.  There may be some bugs!
  60.  
  61.  
  62.                               -= Shareware =-
  63.  
  64.   Since I spent so much time on this project (I never guessed it would take
  65. me this much time), I'm releasing it as shareware for $15. 
  66.  
  67.   What I've done to the shareware version is deactivated Tour 4 & 5 editing, 
  68. Deactivated Mission Saving, and Removed the copy protection removal function.
  69. Otherwise it's fully working version of Xwing Pro.
  70.  
  71.   XR's Limitation is only being able to activate it 3 times.
  72.  
  73.  
  74.                             -= Letting Me Know =-
  75.  
  76. If you have any questions you can Mail me a letter via:
  77.  
  78. U.S. Post Office     =  1997 Cluster Pine Rd.     Colton, Ca 92324-8400 
  79. Software Creations   =  email "Nathan Anderson" at 1-508-368-7139
  80. The Prime Connection =  email "Nathan Anderson" at 1-909-274-9634
  81.  
  82. or Phone (Voice) and leave a message, I work full time so I won't be able
  83. to respond to it until late in the afternoon or the next day: 1-909-875-3219
  84.  
  85.  
  86.                                -= XR.COM =-
  87.  
  88.   This utility, I put together so that you don't have to exit XWING to revive
  89. your pilot (Yes, I know there is a option on the main menu of XWING that allows
  90. you to revive your pilot, but it steals your score, Rating and other things.).
  91.  
  92. It defaults to ALT-R to activate itself.   You can change it by loading XR
  93. with the /Kx parameter where x is the key you want to use.  You can also unload
  94. it from memory when you are done with the game by typing XR /U.
  95.  
  96.   Upon hitting the HOTKEY, XR will beep once, then after restoring all of your
  97. pilots it will beep again.  If XR has been deactivated it will not BEEP and
  98. it will not restore any of your pilots.
  99.  
  100.   XR has been designed to restore you the same way the game does except that
  101. it will not steal your score & other stuff.
  102.  
  103.   One word of information, If hou hit the hotkey to activate XR in the pilot
  104. menu in XWING, the pilot will be fixed, however XWING will not know that until
  105. you change to another room and then return to the pilot menu.  Upon returning it
  106. reloads the information on each of the pilots.
  107.  
  108. *** Notice XR is limited in that it will only activate 3 times. By registering
  109. you will be able to activate it unlimited amount of times.
  110.  
  111.  
  112.                                -= XP.EXE =-
  113.  
  114.                             -= Command Line =-
  115.  
  116.   XP can be started be a variety of ways.  Starting XP without any parameters,
  117. will start you in the main menu.  Starting XP with a '/P' or '-P' will stick
  118. place you in a listing of pilots that you can edit.  Starting XP with a '/M'
  119. will place you into a listing of Mission files.  Starting XP with a '/O' will
  120. stick you in the Other Menu.  Starting XP with a '/T' will stick you in the 
  121. TOD menu. Starting XP with a '/B' will stick you in the Briefing Listing.
  122. Starting XP with any of the above plus the name of the file will stick you
  123. in their respected editors.  Starting XP '-P' plus a file will open the
  124. file and check to see if the pilot is dead/captured if it is it will revive
  125. the pilot and quit to DOS. Otherwise it will stick you in the pilot editor.
  126. Starting XP '-E' plus a file will force XP to stick you in the pilot editor.
  127. And last but not least, XP *.PLT or XP NA?HAN?.PLT will revive all pilots 
  128. matching the wild cards.
  129.  
  130. Summary:
  131.   XP           - Main Menu
  132.   XP /P        - Pilot file Listing
  133.   XP /M        - Mission file Listings
  134.   XP /O        - Other Menu
  135.   XP /B        - Briefing file Listings                     <NOT AVAILABLE YET>
  136.   XP /T        - Tour of Duty file Listings                 <NOT AVAILABLE YET>
  137.   XP /A        - Applies a TOD file to XWING                <NOT AVAILABLE YET>
  138.   XP /P <NAME> - Checks if pilot is dead, if so revives pilot. If Not Edits.
  139.   XP /E <NAME> - Forces XP to Edit pilot.
  140.   XP /M <NAME> - Opens Mission file and Edits it.
  141.   XP /B <NAME> - Opens Briefing file and Edits it.          <NOT AVAILABLE YET>
  142.   XP /T <NAME> - Opens Tour of Duty file and edits it.      <NOT AVAILABLE YET>
  143.   XP /A <NAME> - Applies TOD file to XWING                  <NOT AVAILABLE YET>
  144.   XP *.PLT     - Revives all Dead Pilots
  145.   XP NAT?.PLT  - Revives all pilots matching the Wild cards.
  146.  
  147.  
  148.  
  149.                                  -= Main Menu =-
  150.  
  151.   The Main Menu will give you 6 choices, you may either move the cursor up/down
  152. or hit the first letter that's highlighted to select it.
  153.  
  154. Options:
  155.   P) Pilot Editor       - Will Stick you in the Pilot Listing
  156.   M) Mission Editor     - Will Stick you in the Mission Listing
  157.   B) Briefing Editor    - Will Stick you in the Briefing Listing
  158.   O) Other Xwing Stuff  - Will Stick you in the Other Menu
  159.   T) TOD Editor         - Will Stick you in the TOD Listing
  160.   ESC) Return to DOS    - Quits XP
  161.  
  162.  
  163.                                 -= Pilot Listing =-
  164.  
  165.   The Listings are probably one of my favorite things in XP, they display
  166. fifty file names in a list that you can choose one by using the cursor keys
  167. (Up/Down/Left/Right) and the <ENTER> to select one.  Upon selecting one
  168. you will be put into the Pilot Editor.
  169.   If there are more than fifty pilot files in the directory, another option
  170. will appear.  By hitting 'N' you will go to the next page of files or by
  171. hitting 'P' you will go to the prior Page.
  172.   Also available in the Pilot Listing is the 'R' command, it will revive a
  173. dead/Captured pilot (You may notice that the names are not all the same color,
  174. if a name is in red that means the pilot is captured, if in black it means the
  175. pilot is dead, otherwise the pilot is healthy.)
  176.   And Then you may also use '2' - Change to Mission Listing, '3' - Change to
  177. Briefing Listings.
  178.  
  179.  
  180.                              -= Mission Listings =-
  181.  
  182.   This listing acts the same way that the Pilot one does except for two things
  183. One is that there is no 'Revive command, and two is if you highlight a file
  184. that is a Original Xwing Mission (Tours 1-4) it bring up a window with the
  185. mission Full Name, Mission Tour Number, and Mission Number.
  186.  
  187.  
  188.                             -= Playing your Missions =-
  189.  
  190.   Currently you have to rename one of the existing missions, and rename your
  191. mission to xwings mission name.  For a complete listing of missions see 
  192. mission.lst.  Soon I will have the TOD editor done.
  193.  
  194.  
  195.                             -= Briefing Listings =-
  196.  
  197.   Identical to the Mission Listings.  Except that its for briefings.
  198.  
  199.  
  200.                               -= Other Menu =-
  201.  
  202.   This menu is very similar to the main menu except it has two new items.
  203. 1. Remove Copy Protection - Will Remove the Copy protection from Xwing, So far I
  204. can remove it from the three versions that I have (Original V1.0, Tour 4 V1.1,
  205. and Tour 4 V1.1a with bugs removed).  When the game asks you for the copy
  206. protection you just hit <ENTER>.
  207. 2. Edit Ships - This will allow you to edit the Ships attributes (Like Speed,
  208. Firepower, Shields, ect...).
  209.  
  210.  
  211.                              -= Pilot Editor =-
  212.  
  213.   Basically these menus are self explanatory, However I will point out one thing.
  214. the "2) Edit Tours" & "3) Edit Pilot by Tours" I implemented this system twice
  215. one by a menu and the second you scroll through the names of the tours/Missions.
  216.  
  217.  
  218.                     -= Mission Editor/Briefing Editor =-
  219.  
  220.   Basically you have on the Top part of the menu 16 Crafts (On the Left) and
  221. 16 Object (on the right), by hitting <ENTER> on any one you will go into
  222. their respected editor.  By Hitting <DELETE> you will delete one, and by
  223. hitting <ENTER> on a Unused spot you will add on.
  224.  
  225. NOTICE: Currently XP doesn't support the LEVEL?.XWI files, because they have
  226.         over 16 objects and have no crafts.
  227.  
  228.  
  229.                              -= Editing Ships =-
  230.  
  231.   Most of the Information is self explanatory, however the weapon racks are 
  232. sorta confusing, The ship can have a max number of 12 mounting racks for the
  233. energy and missile type weapons.  Basically the racks are were the guns are
  234. mounted on your craft, they also control how may guns you have.  If you have
  235. a Laser configured for racks 1-5, you will have 5 Lasers.  You can also put
  236. more than one weapon on a rack, You just map multiple weapons to the same
  237. group of racks.
  238.  
  239.   Notice: When you choose more than two energy guns they work but the display
  240.           of which weapon you are using seems to get corrupted.  Also when you
  241.           pick energy weapons for torpedoes you will see the same behavior.
  242.   Warning: Please make sure that if you are going to use any energy weapons
  243.            in the 3rd & 4th energy weapon spot, please have a weapon is slot 1.
  244.            Otherwise it may crash or do other weird things.
  245.  
  246.  
  247.  
  248.  
  249.                             -= Letting Me Know =-
  250.  
  251. If you have any questions you can Mail me a letter via:
  252. U.S. Post Office     =  1997 Cluster Pine Rd.     Colton, Ca 92324-8400
  253. Software Creations   =  email "Nathan Anderson" at 1-508-368-7139
  254. The Prime Connection =  email "Nathan Anderson" at 1-909-274-9634
  255. or Phone: 1-909-875-3219
  256.  
  257.                                 -= Help =-
  258.  
  259. I'm willing to SWAP information on file formats, I currently don't know:
  260. Pilot File:   Locations 19-38
  261. Pilot File:   Locations 51-134  (I suspect it has to do with the PG's)   *
  262. Pilot File:   Locations 138-158 (I suspect it also has to do with PG's)  *
  263. Pilot File:   Locations 353-544 (I suspect it has to do with the HIST's) *
  264. Pilot File:   Locations 593-640 (I suspect it has to do with the HIST's) *
  265. Pilot File:   Locations 642-647
  266. Pilot File:   Locations 649-736
  267. Pilot File:   Locations 1561-1584
  268.  
  269. Mission File: Locations 7-8
  270. Mission File: Craft Locations  140-141
  271. Mission File: Haven't figured out the difference between Multi-Starts & Gotos
  272.               in the Cords system
  273. Mission File: Object Locations 48-49
  274. Mission File: Object Locations 64-69
  275.  
  276. Ship Editor Locations Starts at Start of Craft Info in File
  277. FLIGHT.OVL: Locations 36-39
  278. FLIGHT.OVL: Locations 46-47
  279. FLIGHT.OVL: Locations 50-51
  280. FLIGHT.OVL: Locations 56-61
  281. FLIGHT.OVL: Locations 66-69
  282. FLIGHT.OVL: Locations 92-98
  283. FLIGHT.OVL: Locations 105-107
  284. FLIGHT.OVL: Locations 204-224
  285.  
  286. * - I pretty sure what they do, but can't confirm (These locations I'm not
  287.     in need of, however any of the other spots I would love to find out)
  288.  
  289. *** XWING is tradmarked and copyrighted by Lucas Entertainments. All rights
  290. are reservered by them.  This program is in no way endorsed by Lucas.
  291.  
  292.