home *** CD-ROM | disk | FTP | other *** search
/ Game Killer / Game_Killer.bin / 264.DOCS.TXT < prev    next >
Text File  |  1991-07-08  |  19KB  |  382 lines

  1. Documentation (heh!) for the trade wars viewer programs
  2. Last revision: 6/27/91 by woody
  3.  
  4.  
  5.  
  6. Abstract:
  7. ________
  8.  
  9. The game Trade Wars is a delightful mix of economic strategy, exploration, and
  10. military conquest.  For the first two to succeed, however, requires a good
  11. working knowledge of the universe.  Unfortunately, keeping all the information
  12. about which sectors you've visited, which are ports, and which is connected to
  13. which can be a nightmare.  These two programs, "Convert" and "InfoViewer"
  14. should help to make keeping that information straight a little easier, and
  15. increase your enjoyment of the game.
  16.  
  17. The first program, "Convert", creates a data base of explored sectors, warps
  18. for each sector, if it is a port or not, and if a port, what it is selling.
  19. It is able to use the "interrogation" mode of your crai, to enable fairly rapid
  20. and simple collection of data about the universe.
  21.  
  22. The second, "InfoViewer", allows you to look at that data base in a variety of
  23. ways, from visual graphing of the data to asking questions about nearby
  24. ports and so on.
  25.  
  26. The third, "Offline", performs various inquiry tasks.  One option, "Control", is
  27. especially good if you have a map of our sectors handy.  You specify your
  28. militarized perimeter, and one spot that is inside your controlled territories.
  29. It then maps out all the sectors that can warp to your controlled area without
  30. going through your militarized perimeter.  (If you find that one can get from a
  31. spacelane to the heart of your colonies without passing through a perimeter,
  32. something is wrong...)  Another, "Dead End Count", allows you to analyze the
  33. locations of "tunnels", long chains of sectors with only one way in and one way
  34. out, that you can use for easily defensible sectors.  Yet another "Traffic 
  35. Analysis", allows you to identify the high traffic areas in your explored sectors,
  36. so that you can post guards to find out where people are traveling.
  37.  
  38.  
  39.  
  40.  
  41. What you need to run the programs:
  42. ----------------------------------
  43.  
  44. To create the data base, you need to be in a terminal program that allows
  45. ascii uploads and ascii captures.  The best situation is one that allows you
  46. to do them simultaneously, i.e. capture input while uploading a file.
  47. Second best is to have a large scrollback buffer, that allows you to take
  48. pieces out of the scrollback and append them to a file.
  49.  
  50. There are two versions of the programs, one for DOS machines and another for
  51. Macs.  (Source code available if anyone wants to port it to the Amiga or
  52. something.  Should only require minor changes to file I/O and graphics.)
  53. If you are running the DOS version, you will need the device drivers (.BGI
  54. files) suitable for your machine.
  55.  
  56.  
  57.  
  58. HOW TO CREATE AND MAINTAIN THE ORIGINAL DATA BASE:
  59. --------------------------------------------------
  60.  
  61. There are two methods to develop the data base.  Which you use depends on
  62. (i) how good you are at flinging files about and (ii) how much new information
  63. you are trying to collect.  If you just want to find out about a few sectors,
  64. use the "old" method.  If you want to collect a full set of data, use the
  65. "new" computer interrogation mode.
  66.  
  67. In both modes, you should should turn ansi off at least for the duration of
  68. the transfer.  Do this with <N> from the main computer menu.
  69.  
  70. Here is the "old" method.
  71.  
  72. First, log into the game, and invoke the computer.  Tell the computer you
  73. want the known universe report, by hitting K.  Now start an ascii download.
  74. If you have explored more than half the universe, tell the computer that you
  75. want unexplored sectors by hitting U and return.  The computer will list
  76. your unexplored sectors.  If you have explored less than half, tell the
  77. computer you want explored sectors by hitting E and return.  The computer
  78. will list your known sectors.  If you've explored a lot of sectors, there
  79. may be a [PAUSE] in the listing; just hit the space bar and go on past it.
  80. (Its okay if it shows up in your ascii download.)  When the listing is
  81. finished, turn off the download.  Your captured file must contain the line
  82. that says "You have explored the following sectors:" or "You have NOT
  83. explored the following sectors:" and at least one blank line after the
  84. sectors.  (A little more before or after is okay too.)
  85.  
  86. Now shift from your terminal program to the program "Convert".  At the first
  87. prompt, it is asking for your initial data base.  If you've already developed a
  88. data base, and are just updating it, give the name of your old base; if you
  89. don't have an existing data base, just hit a return.  Next, it will ask if it
  90. should be reading a list of explored sectors, a log of inter-warp and port
  91. information, and so on.  Choose option 1.  Next, it will ask for your "Explored
  92. Sectors" or "Unexplored Sectors" file.  Next, it will ask you to come up with
  93. the name of a file to generate: use anything you like here, but be careful that
  94. you don't accidentally overwrite something you want to keep.  (The program is
  95. smart enough to ask if you really mean to clobber a file.)  The last question
  96. the program will ask you is if you want an update on your ports: this will add
  97. a request for update for every port. The program maintains information about
  98. current trading levels for each known in the game; this will freshen that
  99. information to the current data. It probably isn't needed very often, but once
  100. in a while to update things it is useful.  (I generally use that only if I've
  101. lots of time to play around: I refresh the "interesting" ports by using an
  102. upload from the "Examine" program.)
  103.  
  104. What this step will do is create a file that you can upload to generate lots
  105. of printouts.  Essentially, what it does is create a file with I<sector
  106. number> and R<sector number> for every new sector.  The nice thing is that
  107. this will interface well with the Crai on board your ship...
  108.  
  109. Now back to Tradewars.  You are probably still in Computer mode; if not, get
  110. there.  What you want to do is upload the contents of the file you just
  111. generated with the convert program into the Crai on your ship.  If you can
  112. do that while doing an ascii download, start the download and then start the
  113. upload.  Otherwise, you may have to start the upload and then capture the
  114. results later from your scrollback buffer.  In any case, your captured file
  115. should contain all the I reports (sector nnn has warps to : xxx - yyy - zzz
  116. etc) and all the R reports (Commerce report for ...).  There will be lots of
  117. "I have no record of a port in that sector."'s: that is okay -- had to find
  118. out if there was a port there or not.  If there are a couple of ports that
  119. you are trying to keep track of, you can also call up a port report on them
  120. and store that in the downloaded file: just make sure that when you hit your
  121. R you don't just carriage return but explicitly type in the sector number.
  122.  
  123. Back to the "Convert" program.  Again, tell the program your old data file
  124. (or hit return to start fresh) and this time we are in part 2.  Tell it the
  125. name of the ascii download you just captured, and the name you want to use
  126. for your database.  The program will generate the data base.
  127.  
  128. Here is the "new" method.
  129.  
  130. First you have to get into computer interrogation mode.  To do this, you need
  131. to send ascii characters 200 through 205 to the Crai.  There is a file "on.txt"
  132. included with this package -- just do an ascii upload of on.txt, and you will see
  133. a : appear.  Alternatively, if you are on an IBM, you can hold down the alt
  134. key, then type 200, release, hold down alt, type 201, release, etc.
  135.  
  136. Now that you are in interrogation mode, start an ascii capture; I recommend
  137. using an extension of .SCT.  Type I, and the computer will immediately begin
  138. spewing out sector numbers and warps.  When that finishes, stop the capture,
  139. and start another capture, this type using an extention of .PRT.  Type R,
  140. and the computer will begin spewing out port information.  When that finishes,
  141. stop the capture and run the program Convert.
  142.  
  143. There are two new options in convert: option 8, which parses the .SCT 
  144. report you prepared, and option 9 which parses the .PRT report.  Invoke them,
  145. then exit Convert and your data base is complete.
  146.  
  147. This "new" method does not identify class 0 ports, nor does it identify the
  148. star dock (as the old method did from logs).  That information is not
  149. available from interrogation mode, so you will have to add it manually using
  150. the edit mode of convert.
  151.  
  152.  
  153. STRUCTURE OF THE DATA BASE
  154. ========= == === ==== ====
  155.  
  156. The database is in plain text, so you can examine it yourself if you like.
  157. Information is divided into several categories.  First, are the lines
  158. ::Tradewars Data file::
  159. SpaceDock is   200
  160.  or whatever the corresponding sector is if you have visited the space dock,
  161. or possibly SpaceDock is 0 if you haven't visited the space dock sector.
  162.  
  163. Next is a line of the form
  164. 7  <- number of notes
  165. where the integer represents how many "Notes" you've stored for the game.
  166. A note has the form
  167.    13 Don't Go Near This Sector!!!!
  168. i.e. a sector number, and a short bit of text.  You can add or delete notes
  169. in the "Examine" program, as well as display those sectors for which you've
  170. recorded notes.  
  171.  
  172. Next is a line of the form
  173. 105  <- number of Port Infos
  174. followed by lines of the form
  175.   120    3000    3280   -2530 100  32 100
  176. The first integer is the sector number for the port; next are the levels
  177. for the three goods "Fuel Ore", "Organics", and "Equipment".  A positive
  178. number means that the port is selling the stuff, and a negative number means
  179. the port is buying up to that much of the stuff.  (Remember that the larger
  180. the magnitude of the number, the better the price you get -- ports are more
  181. willing to stretch when the numbers are higher!)  The last three numbers
  182. are percentages of maximum use: a value of 100 means the port is fully
  183. refreshed for that good, 0 means they are all sold out or not interested
  184. in buying anything.
  185.  
  186. A special note: if a port doesn't show up on the R report, but has port 
  187. information stored for it, the previous sales levels are preserved, but
  188. the port usages are all set to zero.  This allows you to identify ports that
  189. have been captured by the Ferrengi or opposing players.
  190.  
  191.  
  192. The sectors are in no special order (actually, in order of appearance from 
  193. the logs over time) but there must be as many lines as specified in the 
  194. <- number of Port Infos...
  195.  
  196. Next is a line of the form
  197. Sector data starts here...
  198. followed by lines of the form
  199.  
  200.     1  6    2    3    4    5    6    7  8     2
  201.  
  202. <sector> <number of warps> <warp1> ... <warpn> <port code> <etc code>
  203. Here, for example, is a report for sector 1: it has six warps, to positions
  204. 2 through 7, a port code of 8 (which actually corresponds to class 0)
  205. and an "etc" code of 2.  A "Port Code" corresponds to -1, if the sector
  206. is not a port, 0 through 7 based upon a three bit representation of selling
  207. or buying (for example, sector 120 is selling Ore, selling Organics, and
  208. buying Equipment, so its port code would be 1 * 1 + 1 * 2 + 0 * 4 = 3; don't
  209. worry about it, the program handles figuring out port codes and so on).  The
  210. "etc" code tells about various pieces of information, again depending on bit
  211. representation: currently the codes in use are
  212.   NoteExists = 1;
  213.   IsPort     = 2;
  214.   HasFighters= 4;
  215.   SpaceLane  = 8;
  216.   Stardock   = 128;
  217. but others will probably follow.  (Note that the Stardock is also a port; so
  218. its etc code is 128 + 2 = 130; if a random port had a note attached, its
  219. code would be 2 + 1 = 3.)
  220.  
  221.  
  222.  
  223. HOW TO USE THE DATA BASE VIEWER
  224. --- -- --- --- ---- ---- ------
  225.  
  226. Its pretty well impossible to draw a decent map with all 1000 sectors, so
  227. the data base viewer doesn't try to do that.  Run "Examine", and tell it the
  228. name of your data base.  You will be presented with a list of options.  In
  229. version 0.88, you get to choose from the following list:
  230.  
  231. Choose one of 
  232.   <A>dd note
  233.   <B>usiest ports
  234.   <D>elete note
  235.   Closest place to buy <F>ighters, shields, and holds
  236.   Note <I>nformation
  237.   <L>ength of path between two sectors
  238.   <N>earest port
  239.   <P>aired ports
  240.   <Q>uit
  241.   Nearest <S>ectors
  242.   <T>ranswarp menu
  243.   Nearest <U>nexplored sectors
  244.   <V>iew space in graphic format
  245.  
  246. Here is what the commands will do:
  247.   <A>dd note
  248.   <D>elete note
  249.   Note <I>nformation
  250.  
  251. These manage the notes that you may have stored on your universe.  Typical
  252. notes might be "enemy base here!", "great trading spot", "Fedspace", or
  253. whatever.  Option "A" will add a note to a sector, option "D" will delete a
  254. note from a sector, and option "I" will present you with a list of the notes
  255. you've made, sorted by distance from a current sector.
  256.  
  257.   <B>usiest ports
  258. This will offer a display of your ports, sorted by usage.  First to appear
  259. will be all class 0 ports, and any ports with a usage field of 0.  (In 
  260. particular, any port that has been previously scanned, but for which you
  261. can not now obtain a scan will appear here.)  Then will occur all ports
  262. sorted by fraction of maximum use.  
  263.  
  264.   Closest place to buy <F>ighters, shields, and holds
  265.  
  266. Invoke this option, and you will be asked for your current sector.  The
  267. computer will then display the path from that sector to any place it knows of
  268. to buy fighters: if the only class 0 port you know is Terra, that is the
  269. only one it will display, but if you know the others, it will display a
  270. shortest path to that sector.
  271.  
  272.   <L>ength of path between two sectors
  273.  
  274. You specify two sectors, and it will tell you the shortest way it knows of
  275. to get between those two sectors.  Note that this may NOT be the actual
  276. shortest path, if there are sectors you have not yet explored that might
  277. give you a better route.  It gives you the shortest path YOU'VE EXPLORED
  278. between those two sectors.
  279.  
  280.   <N>earest port
  281.   Nearest <S>ectors
  282.   Nearest <U>nexplored sectors
  283.  
  284. These displays will give you information about what is close to your current
  285. position.  Information displayed includes if the sector has been explored,
  286. any notes, if its a port, its status (SSB for example, means selling Ore,
  287. selling Organics, and buying Equipment) and levels of production.  If you
  288. ask for the "Nearest Port" report, only ports are listed.  I find the
  289. "Nearest Unexplored sectors" report VERY useful for exploration purposes: I
  290. can just head toward the nearest unexplored sector easily this way.
  291.  
  292.   <P>aired ports
  293.  
  294. This is one of my favorites.  What it does is go through the data base and
  295. find ports that are adjacent (i.e. you can warp between them using normal
  296. space in one turn) and are compatible (i.e. at port A you can buy a good
  297. that is sold at port B, and you can sell a good that is bought at port B).
  298. You can be selective (greedy) and only specify ports that are compatible in
  299. the very profitable Organic-Equipment trade, or ask for all compatible
  300. pairs.  The program offers you the opportunity to have the results sent to a
  301. text file, which you can then print later (if you can't run the program
  302. simultaneously with your terminal emulator, you can get hard copy of the
  303. "hot sectors") and you can have the results sent to a text file that are
  304. compatible for upload (i.e. part 2 of the "Convert" program so you can keep
  305. an eye on trading levels at these critical ports).  Displayed to the screen
  306. is an integer "factor" -- this number is based upon levels of goods
  307. available in the critical trades, and will give a rough estimate of how good
  308. a deal you are going to get.
  309.  
  310.   <T>ranswarp menu
  311.  
  312. This drops down to a submenu that deals with locations of deployed fighters
  313. and using a transwarp drive.  Most submenu items are pretty obvious: you
  314. specify where you have deployed fighters, or tell the data base that some
  315. #%!%@$ has shot up your deployed fighters, or list the places the data base
  316. knows you've deployed your fighters.  The only thing that needs mentioning
  317. is the shortest route submenu item: you specify where you are, and where you
  318. want to go.  It figures out, based upon where your fighters are located, the
  319. fastest route to get there (using a transwarp jump and then normal
  320. autopilot).  It may say to transwarp to your current sector -- that just
  321. means the shortest route lies through normal space.
  322.  
  323.   <V>iew space in graphic format
  324.  
  325. Viewing the data will attempt a graphic display on your screen of space:
  326. you tell it about how many rows across and columns up and down of sectors to
  327. use (maximums are given in the program: hit a return, and you get a default
  328. value that is about 3/4 of maximum); you tell it the base sector you want in
  329. the center of the screen (has to be a sector you've visited!); and you tell
  330. it how large a radius to display (all sectors it is aware of no more than
  331. that distance away from your base sector).  It will try to display the
  332. collection of warps that make up space.  Ordinary, visited sectors are
  333. displayed as circles, ports as rectangles.  (Unexplored sectors just have
  334. their numbers floating in space, and if you have color are in yellow.)
  335. Lines between sectors means there is a warp connecting one with the other.
  336. Dashed lines means that you don't know if the warp is two way or not: if one
  337. end of the sector is unexplored, you will have a dashed line.  If both ends
  338. are explored, then the warp really is one way!  (Try graphing around the
  339. StarDock and around the class 0 ports.)  Don't try to graph too many sectors
  340. at once: the screen gets too busy, and you won't be able to tell what
  341. connects to what.
  342.  
  343. Note:
  344.  
  345.   <E>dit data base
  346.  
  347. This allows you to go in an mark a sector as unexplored, create or destroy a
  348. port, and define the location of the star dock.  You might want to do the
  349. former if you think something has gone wrong with your data; the next
  350. because someone has either shot up a star port or built one.  You might need
  351. to tell the data base where the star dock is located if your sysop has
  352. redefined the name of the port where stardock is located; the program looks
  353. for "StarGate Alpha" -- and if its not there, or been moved, the program
  354. won't find it and you will have to tell it directly.
  355.  
  356. -- has been moved to the Convert program.
  357.  
  358.  
  359. FEEDBACK
  360. ________
  361.  
  362.  
  363. Best place for info is 415-376-1554; leave mail to number 1.
  364.  
  365.  
  366.  
  367. ACKNOWLEDGEMENTS
  368. ________________
  369.  
  370. Thanks, of course, to the Martins for such a great game!
  371.  
  372.  
  373. COPYRIGHT AND LICENSING STUFF
  374. -----------------------------
  375.  
  376. Copyright 1991 by Robert Weaver.  All Rights Reserved.  You may not
  377. distribute this for any fee beyond reasonable costs of distribution.
  378. Permission is granted to distribute this document and the related
  379. executables and source code provided this notice is preserved, and anyone
  380. you give the executable has the ability to obtain this documentation and the
  381. accompanying source.
  382.