home *** CD-ROM | disk | FTP | other *** search
/ Multimedia Magazine 7 / Multimedia-No7-11-1995.iso / APPLICAT / EDUCATE / VPADDONS / VPUT250.ZIP / VPUTIL.DOC < prev    next >
Text File  |  1994-11-13  |  51KB  |  1,024 lines

  1.  
  2. VPUTIL - VGA Planets support utility.      (c) 1993-94  Sysma Automatisering
  3.  
  4.  
  5.  
  6. Disclaimer of Warranties
  7. ========================
  8.  
  9. The program is delivered to you as is. Although copyrighted,
  10. Sysma Automatisering shall not be liable for any damage whatsoever arising
  11. out of your use of this program, either in it's original form or any altered
  12. form, even if you have been advised of the possibility of such damages.
  13.  
  14. Although distributed freely, this is copyrighted material. You are hereby
  15. granted the rights to use and/or modify the program for your personal use.
  16. You may (re)distribute this program or your own modifications, PROVIDED you
  17. distribute the complete set of original files with your own modified ones
  18. and you distribute them without charging any money or any other form of
  19. compensation.
  20.  
  21.  
  22. History
  23. =======
  24.  
  25. 12/11/94   Version 2.50   Added support for VPHOST's new message transponder.
  26. 15/10/94   Version 2.40   Fixed a bug with ship to enemy ship cargo transfer.
  27.                           Whenever only one enemy ship was available, the
  28.                           cargo was beamed into thin air.
  29.                           Added spec viewers for engines, beam weapons and
  30.                           torpedoes.
  31.                           Added 16 bits DPMI version, named VPUTILX.EXE
  32. 20/06/94   Version 2.36   Supplies from Bovinoids are now added to the
  33.                           Projected Resources.
  34.                           Gravity Wells are now taken into account when ETA's
  35.                           are to be determined.
  36.                           Fuel usage has now a separate line for the usage
  37.                           of the next turn only.
  38. 18/05/94   Version 2.35   Added a link with VCR.EXE, so that battles can be
  39.                           watched from within VPUTIL.
  40.                           VPUTIL will now try to open the result file, if the
  41.                           normal player data files are not found.
  42.                           VPUTIL now searches the startup directory for the
  43.                           global data files, if they cannot be found in either
  44.                           the game or the current directory.
  45.                           Fixed the bug that with transporting clans to an
  46.                           enemy vessel the system would not accept any clans.
  47. 30/04/94   Version 2.31   Added a list of ships to the planet detailed screen
  48.                           of all your ships currently on route to that planet.
  49.                           Added a projected resource screen to the planet
  50.                           screen to show accumulated resource totals within
  51.                           the next 10 turns.
  52. 28/04/94   Version 2.30   Changed fuel usage printout of the engines from
  53.                           real burn to relative percentages.
  54.                           Added a report mode to the hull reports, to show
  55.                           which players have hulls in their respective lists.
  56.                           Changed native tax rates to show 0 MC, regardless
  57.                           of the tax rate for Amorphous natives.
  58.                           Ship defense statistics now report correctly the
  59.                           number of mines that can be swept, instead of the
  60.                           rate of just one engine.
  61.                           Ship defense statistics now also report the number
  62.                           of mine units a ship can lay, if any.
  63.                           Ships can now choose other ships as waypoint.
  64.                           Added the same scoring screen as PLANETS.EXE uses,
  65.                           to report known amounts of the various players.
  66. 17/02/94   Version 2.20   Allowed Colonists to beam to enemy vessels. (It turned
  67.                           out that PLANETS also allows this, strangly enough).
  68.                           Added view/edit/usage of HCONFIG.HST.
  69.                           Added a turn file decompiler.
  70.                           Extended the ship defense statistics with the
  71.                           actual mine sweep rates, using HCONFIG data.
  72.                           Fixed a few presentation glitches.
  73. 24/01/94   Version 2.10   Added a FAST turn file compile command.
  74.                           Fixed a few presentation glitches.
  75. 18/01/94   Version 2.00   Finally completed the beta-test program. This is
  76.                           the official GA release. Improved some detailed
  77.                           screens slightly, improved the speed of several
  78.                           parts, and reduced the size of the code.
  79.                           Implemented transfer of cargo to foreign ships.
  80.                           Removed the bug that with the F6 function while in a
  81.                           ship screen and selecting an enemy ship would lock
  82.                           up the system.
  83.                           Added a battle specification browser.
  84. 18/12/93   Version 1.99h  Fixed a few minor bugs and a serious one concerning
  85.                           transporting cargo to/from other ships. Under some
  86.                           rare conditions this could lead to random cargo
  87.                           values.
  88.                           Added the feature that VPUTIL looks for global data
  89.                           files (ie. race.nm, etc.) in your specified path and
  90.                           only if it does not find a complete set, it looks in
  91.                           the current directory. This enables you to play
  92.                           several games with different universes more easily.
  93. 05/11/93   Version 1.99g  Corrected the error of specifying the wrong ship
  94.                           when entering an intercept mission. Added beaming
  95.                           cargo down on the surface of a foreign planet (or
  96.                           jettison cargo into deep space).
  97.                           Finally figured out the last details concerning data
  98.                           encryption. This made it possible to write a new,
  99.                           FAST unpack routine, which is embedded in this
  100.                           program as of now. Running PLANETS itself is now
  101.                           reduced to only once for every game directory you
  102.                           use, instead of once every turn.
  103.                           Added password protection of the data files.
  104. 15/09/93   Version 1.99f  Finally added selction of waypoints, and completed
  105.                           the implementation of the Intercept and Tow missions.
  106.                           Added the cargo transported between own planets and
  107.                           ships, and enabled the selection of ships at the
  108.                           same location with the F6 key.
  109. 24/08/93   Version 1.99e  Added a read only flag, which prevents changes to be
  110.                           written back. This option is implemented, because
  111.                           several players use Windows or OS/2 to run this
  112.                           program and PLANETS concurrently. When both
  113.                           programs write back data, this can cause problems.
  114.                           Usage of this flag should prevent this.
  115. 05/08/93   Version 1.99d  The setting of the warp factor has now taken into
  116.                           account the damage of a ship. The mining rate of
  117.                           the mining survey has been corrected for the
  118.                           Lizard player. Buying a torpedo had a serious bug.
  119.                           Payment was as if a fighter was bought. This has
  120.                           been corrected. The amount of tax collected by the
  121.                           Federation is now reported correctly.
  122. 03/08/93   Version 1.99c  A few minor bugs, mostly related to presentation of
  123.                           information in the reports, have been fixed.
  124. 31/07/93   Version 1.99b  Memory allocation and read/write logic changed again.
  125.                           Allocation is now based upon single records and
  126.                           therefore no limitation exists anymore.
  127.                           An interactive interface has been added which can
  128.                           replace almost any action inside PLANETS. Since this
  129.                           system can access AND update any ship or planet data,
  130.                           the show commands have been removed. The commands
  131.                           to raise tech levels have also been removed, for
  132.                           the same reason.
  133.                           Note that this version, although stable, is still in
  134.                           beta testing. It is neither complete, nor tested
  135.                           thorough enough to be guaranteed to work under all
  136.                           circumstances. It is therefore advisable to make a
  137.                           backup of your result and/or data files before using
  138.                           this program.
  139. 16/04/93   Version 1.6    Totally revamped the read/write logic and memory
  140.                           structures. Now only more than 400 bases can cause
  141.                           a memory allocation error. Since this is an
  142.                           impossible situation anyway, the program should work
  143.                           fine under all circumstances.
  144.                           Added the feature of reading the data directly from
  145.                           the result file, ie. before unpack has been used.
  146. 15/04/93   Version 1.5    Finally tracked down the implementation of the
  147.                           checksum generating system. This eliminates the
  148.                           possibility of not being able to write back changed
  149.                           data files.
  150. 14/04/93   Version 1.3    Corrected the bug that whenever tech level increase
  151.                           was specified at or below the current level, the
  152.                           current level got reset to tech level 0.
  153.                           Corrected the bug that whenever changing a tech level
  154.                           without specifying the planet Id, the first planet
  155.                           instead of the planet with the base was taken. This
  156.                           would then result in corrupted data files.
  157.                           Also adjusted the close range scanner reports to
  158.                           eliminate ships oribiting planets you do not own.
  159.                           Added the planetary information report.
  160. 12/04/93   Version 1.2    Corrected the galaxy enenmy ship scan for VGA Planets
  161.                           version 2.x data files bug, and added some more
  162.                           reports.
  163. 11/04/93   Version 1.1    Fixed some minor bugs, added reports of the
  164.                           various data in the game and added extra detailed
  165.                           information displays. Removed the 'Change planetary
  166.                           friendly codes' command, as it turned out that this
  167.                           command effectively canceled out the race advantage
  168.                           of the Bird Man.
  169. 10/04/93   Version 1.0    First public release of the program. Further
  170.                           enhancements are already planned, but we are
  171.                           awaiting feedback and bug reports of this version
  172.                           first.
  173.  
  174.  
  175. Introduction
  176. ============
  177.  
  178. This utility is designed to support and enhance the client part of the game
  179. VGA Planets versions 3.0 only (ie. Planets.Exe). VGA Planets is a strategic
  180. space war/economy simulation game for up to eleven players. The unique feature
  181. of the game is that it plays the turns off-line. This means that there is a
  182. game server (or Host) somewhere where the entire game universe exists. The
  183. game server executes the commands the players provide each game turn and
  184. provides the results, tailored to every player.
  185.  
  186. Each player gets the results meant for him and uses the game client program
  187. (Planets.Exe) to view the results of the previous set of commands and to issue
  188. new ones. Because each player gets only results from the host concerning his
  189. own ships and planets, it is not possible to see enemy ships or planets when
  190. the game rules don't permit this.
  191.  
  192. Build into the game is an E-mail facility, which enables the possibility to
  193. send messages to other players. This E-mail facility is also used by the
  194. automated host program to report information back to you regarding the previous
  195. issued commands. You can use this E-mail facility just as you like. A good
  196. purpose would be to perform diplomacy with it. Messages you send to a player X
  197. don't arrive by player Y if you so choose.
  198.  
  199. At certain planets there are starbases in orbit. These starbases are very
  200. important, as they act as your space ship factory and as a space ship
  201. repair/refit location. At every starbase a set of four technology levels are
  202. maintained. The levels are for space ship hulls (ie. the frame to build a
  203. space ship), transwarp drive engines, beam weapons and photon torpedoes. The
  204. higher a techonoly level, the more powerfull the parts concerned become.
  205.  
  206.  
  207. Purpose
  208. =======
  209.  
  210. For every version of VGA Planets there exist both a shareware copy and a
  211. registered equivalent. The shareware version limits all technology levels to
  212. level 6, whereas the registered version allows technology levels upto level 10,
  213. plus several other nice additional features.
  214.  
  215. The main purpose of this program is to provide players with additional
  216. features not found in PLANETS itself, while maintaining the same features of
  217. both the shareware and the registered version of Planets itself. The
  218. autodetection logic build into the program will prevent shareware players from
  219. accessing registered user features.
  220.  
  221. Features supported by VPUTIL can be divided into three categories:
  222.  
  223. 1. The report generator. This part provides the players with different reports
  224.    covering all data available to the player.
  225. 2. Check and correct facilities.
  226. 3. An interactive, menu driven user interface, enabling easier access to the
  227.    most important commands also available within PLANETS.
  228.    The keywords here are consistancy in operation, full undo facility, extra
  229.    viewers and convenient shortcut keys.
  230.  
  231. As of version 1.99g, VPUTIL comes with autodetection of registered players.
  232. Whenever VPUTIL is run on data previously accessed by a registered PLANETS
  233. copy, it will enable the same features registered PLANETS users enjoy, such
  234. as tech levels upto 10 on all starbases. If, however, the game data was last
  235. accessed by the shareware PLANETS copy, access to all extended features is
  236. prohibited. There is no hidden or secret command line option or keystroke
  237. sequence to trigger the registered features on a shareware game.
  238.  
  239. VPUTIL can be used as a complete replacement of the PLANETS program, except
  240. for writing messages to other players. Note that, when you stop using PLANETS
  241. and you are a registered user, VPUTIL writes a shareware signature to your
  242. player data files if you used UNPACK to unpack your result files. However,
  243. using the unpack command of VPUTIL (or the stand alone VPUNPACK program)
  244. will eliminate this problem.
  245.  
  246. Normally, UNPACK writes just the data files and the PLANETS program takes care
  247. of creating the essential encrypted data plus the signature. This is also the
  248. reason why you cannot use MAKETURN immediately after UNPACK. The UNPACK program
  249. does in fact eliminate any encrypted data plus the signature, left over from
  250. the last turn. The unpack routine of both VPUNPACK and VPUTIL, on the other
  251. hand, update this information when found and always write the data back. If
  252. no data from a previous turn is found, a shareware signature is assumed.
  253.  
  254.  
  255. DPMI protected mode version
  256. ============================
  257.  
  258. Usage of the protected mode version is identical to the real mode VPUTIL
  259. command, described in the next sections. However, there are several additional
  260. points to keep in mind.
  261.  
  262. VPUTILX is the 16 bits DPMI version, and requires at least a 286 machine
  263. with 2 MB of RAM installed. It calls and uses RTM.EXE as it's DPMI service
  264. provider. RTM detects and uses an already present DPMI server (such as HIMEM
  265. or QEMM), but if a server is not yet installed, it installs it's own server
  266. DPMI16BI.OVL, which must be locateable in the current directory, or via the
  267. PATH.
  268.  
  269.  
  270. The message transponder
  271. =======================
  272.  
  273. As of version 2.00 of VPHOST, a message transponder is included. The purpose
  274. of this transponder is to send any binary information from the host to the
  275. players, or vice versa. Typically this transponder is used to pass information
  276. from the host the the players that is not normally included in the result
  277. file format currently in use.
  278.  
  279. Players may receive data via the transponder in any of three ways. The host
  280. may have instructed VPHOST to send information manually, the player itself
  281. may have requested information, or VPHOST may have initiated the transponder
  282. itself based upon some internal processing condition.
  283.  
  284. The transponder sends the information in specially formatted messages, which
  285. are not readable directly. The unpack result file routine of VPUTIL (version
  286. 2.50 upwards) and VPUNPACK (version 2.20 upwards) are capable of both
  287. recognizing this special format and processing the messages. This means that
  288. you normally would never see these messages, except for the results they
  289. produce on your game data.
  290.  
  291. However, there may be occasions that you DO see these messages. If this
  292. happens, one of two things may have gone wrong. The first one is that you
  293. used an older version of either VPUNPACK or VPUTIL. At the bottom of each
  294. transponder message is the lowest version needed for either program that is
  295. capable of processing that particular message. Check it against your current
  296. versions and upgrade to the listed versions if yours are out of date.
  297.  
  298. If, on the other hand, your current versions are up to date, the message
  299. could not be processed for integrity reasons. Some transponder messages need
  300. access to VGA PLANETS's global data files for modifications. The transponder
  301. processor refuses to process any of these messages when the global data
  302. files are not in the same directory as your game data itself. When it is
  303. present in your game directory, the processor automatically assumes that
  304. these are copies of the originals and that it is safe to make changes.
  305.  
  306. Note that currently it is recommended to have your global data files copied
  307. in your game directory, since different games may use different global
  308. data files, ie. different ship specs, different star charts, etc. VPUTIL and
  309. VPUNPACK automatically recognize and use global data files whenever they
  310. are found in the game directory. However, ALL of the global data files need
  311. to be present in order to enable this feature.
  312.  
  313. The transponder is activated by sending special formatted messages to
  314. yourself. The first line of the message contains the command, which is
  315. always preceded by the keyword 'Request: '. Note that the colon and space
  316. are mandatory, and that there should not be any spaces between the keyword and
  317. the colon. After the keyword the command may be specified. Any parameters
  318. should be placed on the next line(s).
  319.  
  320. When the first line of the message is not in this format, the transponder
  321. ignores it and simply sends the message back unaltered.
  322.  
  323. The following commands are currently supported:
  324. RaceNames         All the race names currently stored at the host in the
  325.                   RACE.NM file. Your RACE.NM file will be updated.
  326. TurnLog           Send the turn file activity log that is maintained by VPHOST.
  327.                   This command will produce the Players.Log file in your game
  328.                   directorty, containing the information in readable ASCII.
  329. Configuration     Send the host configuration files HCONFIG.HST and
  330.                   VPCONFIG.HST. These files will be created/overwritten in
  331.                   your game directory.
  332. NewName           Define a new name for your race. The second line must
  333.                   contain the full imperial name (30 chars max), the third
  334.                   line must contain the plural name (20 chars max) and the
  335.                   fourth line must contain the adjective form (12 chars max).
  336.  
  337. Any of these requests may be send by using the send request menu from
  338. within the interactive user interface's main menu. Each of the menu options
  339. creates the correct request message. The NewName request takes the race
  340. name that is currently stored in your RACE.NM file, so alter the entries
  341. first by using the Host configuration menu, before sending this request with
  342. the request menu.
  343.  
  344.  
  345. Memory requirements
  346. ===================
  347.  
  348. VPUTIL by itself requires about 250 Kb of memory to run. However, data files
  349. are also needed for all commands to execute. The global data files account
  350. for about 23 Kb of memory. The player data, of course, vary greatly in size,
  351. depending on the number of assets a player owns, and how many messages are
  352. send. As a rule of thumb, the memory needed to store the player data is
  353. roughly twice the size of the result file.
  354.  
  355. So, for a typical mid game result file of about 40 Kb, the total amount of
  356. memory needed to run VPUTIL properly would be 225 + 23 + 80 = 328 Kb of
  357. free DOS memory. Typically, machines running MS DOS 5.0 or higher can have
  358. 500 to 600 Kb of free memory, depending on the number of device drivers and
  359. other resident programs. This should cause no problems. If you run into
  360. memory problems, kill some resident programs, or try to load less device
  361. drivers.
  362.  
  363. If you want to watch your battles from within VPUTIL (possible as of version
  364. 2.35), you need another 120 Kb of memory. This is because VPUTIL spawns the
  365. VCR program as a child process, instead of an overlay process. Again, with
  366. a normal configured system running MS DOS 5.0 or higher this should not cause
  367. any problems, since the requirements for a typical result file would raise to
  368. about 448 Kb.
  369.  
  370. Note that the above does not apply completely to the protected mode version
  371. of VPUTIL. The program and all of it's data will by default load in the
  372. available extended memory, leaving only the DPMI server/service provider in
  373. low (ie. 640 KB) memory. Only when not enough extended memory is available,
  374. (parts of) VPUTIL and it's data are loaded low.
  375.  
  376.  
  377. Commands
  378. ========
  379.  
  380. In this section the available commands of VPUTIL will be covered. The general
  381. command line syntax is to issue one command and zero or more appropriate flags.
  382. A quick overview of the commands and flags follows below.
  383.  
  384. The commands are:                    The flags are:
  385.  
  386. mm  Interactive Main Menu            -wPath  Specify work dir for player data
  387. rh  Report space ship hulls          -p??    Specify player Id
  388. re  Report space ship engines        -tm??   Specify minimal Tech Level
  389. rw  Report space ship beam weapons   -t??    Specify (maximal) Tech Level
  390. rt  Report space ship torpedoes      -sc     Show Cost/Cargo/Colonists
  391. ra  Report deep space scan           -sl     Show Location
  392. rc  Report close range scan          -sw     Show Waypoints
  393. rs  Report own space ships           -sr     Show resources
  394. rp  Report all planets               -sn     Show natives
  395. rb  Report fought battles            -so     Show hulls in one list
  396. cw  Check waypoints of space ships   -r??    Specify nearby range
  397. cp  Compile player turn files        -rf     Access result file directly.
  398. un  Unpack player result files       -ro     Read Only access
  399. uc  Uncompile player turn files      -rt     Decompile turn file directly
  400. sb  Watch all the battles            -pw???  Specify password
  401.  
  402. There are five flags vaild for every command, so they will be listed here. All
  403. other flags and the meaning will be covered with the commands on which they
  404. act.
  405.  
  406.    -wPath
  407.    ------
  408.  
  409.    Specifies the directory 'Path' in which the player data files can be found.
  410.    VPUTIL will also look for the global data files in this specified directory.
  411.    If it finds a complete set there, it will use them. Otherwise the current
  412.    directory is assumed to contain these global data files. The latter is
  413.    consistent with the behaviour of both PLANETS and HOST. The first
  414.    possibility is an extention to allow games with different universes to
  415.    be played and kept apart simultaniously.
  416.    If neither the specified directory nor the current directory contain a
  417.    complete set of global data files, the startup directory (ie. the
  418.    directory containing VPUTIL) is searched for these files.
  419.  
  420.    -p??
  421.    ----
  422.  
  423.    Specifies the player number (ranging from 1 to 11) on which to perform the
  424.    specified command. This flag may be omitted if there are only data files of
  425.    one player in the specified directory.
  426.  
  427.    -pw???
  428.    ------
  429.  
  430.    Specify the current password for the requested player's data files, if
  431.    these have been protected by a password. Failing to specify the correct
  432.    password results in a fatal error and immediately aborts the requested
  433.    command. Note that in order for this option to operate, a password may
  434.    not contain any spaces, since spaces are considered separators between
  435.    commands and options on the command line.
  436.  
  437.    -rf
  438.    --
  439.  
  440.    Use the player result file (Player??.Rst) as the source of all player data
  441.    instead of the normal data files generated by UNPACK. Using this option
  442.    implies read-only access, since this data is used by MAKETURN to determine
  443.    the data you have changed in order to generate the commands in the turn
  444.    file send to the host. Tampering with this result file therefore would
  445.    imply that incorrect commands would be send to the host.
  446.    If only a player result file is present for the specified player, this
  447.    option may be omitted, as the system will automatically use this result
  448.    file.
  449.  
  450.    -ro
  451.    ---
  452.  
  453.    This flag, when specified, blocks any changes you make to be written to
  454.    the data files.
  455.  
  456.    -rt
  457.    ---
  458.  
  459.    This flag, when specifies, overrules the current state of your game data
  460.    and instead falls back to the state of the last turn file created. This
  461.    is, of course, only possible whenever you have a turn file created for
  462.    your current turn. It may be used with or without the -rf flag.
  463.    The effect of this flag is to allow you access to the game data as the
  464.    uncompile command would give you, without actually performing a real
  465.    uncompile action.
  466.    Note that using this flag also implies read only access, just as with
  467.    the -rf flag.
  468.  
  469.  
  470. Command cw
  471. ==========
  472.  
  473. This command checks the waypoints of all your space ships which have been given
  474. movement orders. Due to the implementation of the way the movement commands
  475. are given with the mouse, it happens frequently that the waypoint, originally
  476. set to a planet, moves slightly off due to an unintended mouse movement.
  477.  
  478. This command checks all your space ships to see if they have movement orders
  479. and if the specified waypoint is within a radius of n light years of a planet.
  480. If both conditions are true, the waypoint is adjusted to point to that planet.
  481. If a space ship is within the radius, but has no movement orders (ie. the
  482. warp factor is 0), it is left alone.
  483.  
  484.    -r??
  485.    ----
  486.  
  487.    Specifies the range around a planet which triggers the waypoint adjustment.
  488.    Any of your ships within the given range around a planet will be given a
  489.    waypoint to that planet. If a ship falls within range of more than one
  490.    planet, the nearest planet will be used. If not specified, the range
  491.    defaults to 5 light years.
  492.  
  493. Command rh
  494. ==========
  495.  
  496. This command generates a report of all the possible space ship hulls a race
  497. can build. The report comes in two parts, hull capabilities and hull costs.
  498.  
  499.    -t??
  500.    ----
  501.  
  502.    Specifies upto which technology level the space ship hulls should be
  503.    included in the report. If omitted, technology level 10 is assumed.
  504.  
  505.    -tm??
  506.    -----
  507.  
  508.    Specifies from which technology level the space ship hulls should be
  509.    included in the report. If omiiied, technology level 1 is assumed. If both
  510.    this flag and the previous one are specified, a subrange of technology
  511.    levels can be created. If in this case the value for this flag is larger
  512.    than the value for the previous one, this flag is treated as if it was
  513.    not specified.
  514.  
  515.    -sc
  516.    ---
  517.  
  518.    Generate a report with the building cost of the space ship hulls, instead
  519.    of the hull specifications.
  520.  
  521.    -so
  522.    ---
  523.  
  524.    Generate a report showing which races have a hull in their arsenal. This
  525.    switch overrules the -sc switch if both are specified.
  526.  
  527.    -sl
  528.    ---
  529.  
  530.    Generate the report as one continuous list, instead of compiling a list
  531.    on a per race basis. This switch can be used together with the -so or -sc
  532.    switch.
  533.  
  534. Command re
  535. ==========
  536.  
  537. This command generates a report of all the possible space ship engines every
  538. race can mount on a space ship hull. The report shows both the cost and the
  539. fuel usage factors for every possible warp factor.
  540.  
  541.    -t??
  542.    ----
  543.  
  544.    Specifies upto which technology level the space ship hulls should be
  545.    included in the report. If omitted, technology level 10 is assumed.
  546.  
  547.    -tm??
  548.    -----
  549.  
  550.    Specifies from which technology level the space ship hulls should be
  551.    included in the report. If omiiied, technology level 1 is assumed. If both
  552.    this flag and the previous one are specified, a subrange of technology
  553.    levels can be created. If in this case the value for this flag is larger
  554.    than the value for the previous one, this flag is treated as if it was
  555.    not specified.
  556.  
  557. Command rw
  558. ==========
  559.  
  560. This command generates a report of all the possible beam weapons every race
  561. can mount on a space ship hull. The report shows both the cost and the beam
  562. weapon effectiveness for both kill (crew) power and space hull destructive
  563. (explosive) power.
  564.  
  565.    -t??
  566.    ----
  567.  
  568.    Specifies upto which technology level the space ship hulls should be
  569.    included in the report. If omitted, technology level 10 is assumed.
  570.  
  571.    -tm??
  572.    -----
  573.  
  574.    Specifies from which technology level the space ship hulls should be
  575.    included in the report. If omiiied, technology level 1 is assumed. If both
  576.    this flag and the previous one are specified, a subrange of technology
  577.    levels can be created. If in this case the value for this flag is larger
  578.    than the value for the previous one, this flag is treated as if it was
  579.    not specified.
  580.  
  581. Command rt
  582. ==========
  583.  
  584. This command generates a report of all the possible torpedo launchers every
  585. race can mount on a space ship hull. The report shows both the cost and the
  586. torpedo effectiveness for both kill (crew) power and space hull destructive
  587. (explosive) power. The last cost value is the cost to build one torpedo to
  588. be launched with the launcher. No cost for raw materials is given, since these
  589. values are 1 Duranium, 1 Tritanium and 1 Molybdenum for all possible torpedoes.
  590.  
  591.    -t??
  592.    ----
  593.  
  594.    Specifies upto which technology level the space ship hulls should be
  595.    included in the report. If omitted, technology level 10 is assumed.
  596.  
  597.    -tm??
  598.    -----
  599.  
  600.    Specifies from which technology level the space ship hulls should be
  601.    included in the report. If omiiied, technology level 1 is assumed. If both
  602.    this flag and the previous one are specified, a subrange of technology
  603.    levels can be created. If in this case the value for this flag is larger
  604.    than the value for the previous one, this flag is treated as if it was
  605.    not specified.
  606.  
  607. Command ra
  608. ==========
  609.  
  610. This command generates a report of the known information about all the space
  611. ships that are visible in the galaxy star chart (as red dots).
  612.  
  613. Command rp
  614. ==========
  615.  
  616. This command generates a report of all your own planets plus the planets which
  617. are within your scanning range. The report comes in four parts, the planet's
  618. core resources, the native population, the planet's colonists and the planet's
  619. surface resources.
  620.  
  621.    -sr
  622.    ---
  623.  
  624.    Show the resources in the planet's core, instead of the resources on the
  625.    planet's surface.
  626.  
  627.    -sc
  628.    ---
  629.  
  630.    Show the colonist information + building structures, instead of the
  631.    resources on the planet's surface. This flag overrules the sr flag when
  632.    both are specified.
  633.  
  634.    -sn
  635.    ---
  636.  
  637.    Show the native population information, instead of the resources on the
  638.    planet's surface. This flag overrules both the sr and the sc flag when any
  639.    combination of these flags is specified.
  640.  
  641. Command rc
  642. ==========
  643.  
  644. This command generates a report of the results of the close range subspace
  645. scans that were performed by your starbases and space ships. The report comes
  646. in two parts, the space ship class and direction information and the space
  647. ship locations. Note that enemy ships are still hidden from your scans whenever
  648. they are orbiting planets you don't own, but are within your scan range.
  649.  
  650.    -sl
  651.    ---
  652.  
  653.    Show the locations of the space ships, instead of the space ship class and
  654.    bearing information.
  655.  
  656. Command rs
  657. ==========
  658.  
  659. This command generates a report of the status of your own space ships. The
  660. report comes in four parts, the space ship's class and status, the space ship's
  661. locations, the space ship's cargo and the space ship's waypoint settings.
  662.  
  663.    -sl
  664.    ---
  665.  
  666.    Show the locations of your space ships, instead of the ship's class and
  667.    status.
  668.  
  669.    -sw
  670.    ---
  671.  
  672.    Show the waypoint settings of your space ships, instead of the ship's class
  673.    and status. This flag overrules the sl flag when both are specified.
  674.  
  675.    -sc
  676.    ---
  677.  
  678.    Show the cargo bay contents of your space ships, instead of the ship's
  679.    class and status. This flag overrules both the sl and the sw flag when any
  680.    combination of these flags is specified.
  681.  
  682. Command un
  683. ==========
  684.  
  685. This command unpacks player result files, in the directory spefified. This
  686. command executes up to 20 times as fast as the original UNPACK utility, and it
  687. does NOT delete the original result (.RST) file upon completion. If no player
  688. is specified, all result files will be unpacked.
  689.  
  690. This command will put the shareware signature in the encrypted data, if you
  691. unpack to a directory which has no signature yet. A signature is automatically
  692. created whenever you leave PLANETS. Changing anything or not is not relevant
  693. in this case.
  694.  
  695. This is nothing to worry about when you are a registered user, since it is
  696. allowed to switch between registered and shareware versions of PLANETS,
  697. provided you did not change anything with PLANETS or any other tool to your
  698. unpacked data. So if you are a registered user, simply start with your
  699. registered copy and all will be fine.
  700.  
  701. Note that changing anything to your player data, no matter which tool or
  702. utility you use, will commit you for the current turn to the PLANETS version
  703. with the same signature. So if you unpack to a blank directory and run VPUTIL
  704. with the mm command directly, you are committed (for the current turn) to the
  705. shareware version of PLANETS. However, if a signature was already present
  706. during unpacking, it will be retained and all essential data, needed for the
  707. MAKETURN utility will be updated as well.
  708.  
  709. Note, however, that this is a special feature of this command and not a standard
  710. feature of the original UNPACK utility. The UNPACK utility does not update
  711. some of the essential encrypted data, needed by MAKETURN to function properly.
  712. If you use the standard UNPACK utility, you MUST run PLANETS before running
  713. MAKETURN, since only PLANETS in the standard VGA Planets 3.0 package will
  714. create this data. Note also that VPUTIL is capable of creating this data upon
  715. termination, but only with a shareware signature.
  716.  
  717. Command cp
  718. ==========
  719.  
  720. This command compiles player turn files, and as such is a replacement for the
  721. standard MAKETURN program. This command can compile the turn files upto 20
  722. times faster than the MAKETURN program, depending om the hardware you use.
  723. Just as with the unpack command, this command achieves it's performance by
  724. processing the data files in memory, instead of using heavy disk access.
  725. If no player Id is specified, all players are assumed.
  726.  
  727. Just as with MAKETURN, when you play different races with the same registered
  728. PLANETS program, this command will place the necessary data in the turn file
  729. so the host will accept them as coming from one machine. This prevents the
  730. Tim Continuum from striking.
  731.  
  732. Command uc
  733. ==========
  734.  
  735. This command rolls back any changes made to the universe data since the last
  736. time a turn file was compiled. It uses the same technique for this as the
  737. host does. The universe is reset to the same state as was stored in the
  738. result file, and then all commands stored in the turn file are executed.
  739. Provided there was no error, this produces the same universe state as was
  740. present at the time the turn file was compiled. The result file does not
  741. have to be present in order for this command to function.
  742.  
  743. Command sb
  744. ==========
  745.  
  746. This command will call up the VCR program with all of your battles fed to
  747. it. You are able to watch the battles in exactly the same way as you would
  748. have, had you requested your battles from within PLANETS itself. After you
  749. terminate the VCR program, you are returned directly to the command shell.
  750.  
  751. Command mm
  752. ==========
  753.  
  754. This command enables the interactive system of VPUTIL. On screen appears a
  755. main menu from which you can choose an action. Selecting an action can be
  756. achieved using the arrow keys. Selecting an action is done with the ENTER key.
  757. With the ESCAPE key you will return to the command prompt of DOS.
  758.  
  759. General notes for using this system. You don't have to sell supply units
  760. manually before buying new objects. This system handles this automatically. If
  761. max. values apply to certain fields, these values are shown on the right of the
  762. field in green. It is not possible to build more than the max. allowed value.
  763. You can undo all build commands simply by lowering the value again. Undo is
  764. possible upto the value as was stored in the result file. In numeric fields
  765. you can enter a desired value directly.
  766.  
  767. When you want to browse through ships, planets or VCRs, and there is more than
  768. one available to choose from, a list is shown instead of the window with the
  769. detailed information. Simply pressing the ENTER key on a selected ship, planet
  770. or VCR brings you to that object. From then on you will be browsing in the
  771. detailed information. Pressing the END or ESCAPE key returns you to the list.
  772. In the list view all function keys which are available in the detailed windows
  773. are still operating. When using one of them, the action is performed on the
  774. currently selected ship or planet.
  775.  
  776. When entering a new value in a field, the value is accepted whenever one of
  777. the specified special keys (except the ESCAPE key) is pressed. The ENTER
  778. key acts as an ARROW DOWN key by advancing to the next field, if possible.
  779. Fields which hold one value out of a set (such as orders) can be activated
  780. with the ENTER key. A menu with items to choose from will be presented. A
  781. new value is entered by selecting the correct item and pressing the ENTER key.
  782. Pressing the ESCAPE key leaves the original value unchanged.
  783.  
  784.    -r???
  785.    -----
  786.  
  787.    Specify the range to target which is considered nearby. Any distance
  788.    shorter or equal to the specified range is nearby. For any other distance
  789.    the position will be marked as Deep Space. This option is only relevant
  790.    to your own and enemy space ships. If not specified, the range defaults
  791.    to 5 light years.
  792.  
  793. General key assignments within the interactive system:
  794.  
  795. ENTER       Select an action and executes it.
  796. ESCAPE      Abort current action and return to the previous level.
  797. ARROW KEYS  Move around within current level and highlight a selection.
  798. END         End current action and return to the previous level.
  799. PAGEUP      Go to the previous page of information.
  800. PAGEDOWN    Go to the next page of information.
  801.  
  802. Key assignments within the Planet Detailed Screen:
  803.  
  804. F2          Show scoring information.
  805. F3          Show detailed scoring information of current planet.
  806. F4          Show detailed scoring information of current starbase.
  807. F5          Show the configuration menu. From this menu browsers for the
  808.             various HCONFIG settings may be called. When in a browser,
  809.             the PAGEUP and PAGEDOWN keys allow direct access to the other
  810.             browsers.
  811. SHIFT F5    Show the global specifications menu. From this menu browsers
  812.             for the hull specs, beam weapon specs, engine specs and
  813.             torpedo specs may be called. When in a browser, the PAGEUP and
  814.             PAGEDOWN keys allow direct access to the other browsers.
  815. F6          Show a list of space ships in orbit of the planet.
  816. Shift F6    Show a list of ships that are actively on route to this planet.
  817. F7          Show a mining survey.
  818. Shift F7    Show a projected resource screen, showing how much resources will
  819.             be present over the given number of turns. Cargo of ships that are
  820.             on route is added at the time of arrival, calculated from their ETA.
  821. F8          Show the defense strength of the current planet/starbase.
  822. F9          If a starbase is present, manage it's inventory and build new
  823.             ships. Otherwise, build or cancel building a starbase.
  824. F10         Show a menu with the above commands.
  825. +           Increment the value of current field (if possible).
  826. -           Decrement the value of current field (if possible).
  827. Alt M       Build max. possible mines.
  828. Alt F       Build max. possible factories.
  829. Alt D       Build max. possible defense posts.
  830. Alt R       Randomize the friendly code.
  831. Alt C       Sell all supplies and convert them to MC's.
  832. Alt S       Undo selling of supplies.
  833. m           Build one mine (same as in PLANETS).
  834. f           Build one factory (same as in PLANETS).
  835. d           Build one defense post (same as in PLANETS).
  836. TAB         Moves to the first field of the next section.
  837. Shift TAB   Moves to the first field of the previous section.
  838.  
  839. Key assignments within the Space Ship Detailed Screen:
  840.  
  841. F2          Show scoring information.
  842. F3          Show detailed scoring information of current space ship.
  843. F5          Show the configuration menu.
  844. SHIFT F5    Show the global specifications menu.
  845. F6          Show a list of space ships at the same location.
  846. F7          Show a window with the possible capabilities of the hull.
  847. F8          Show the defense strength of the current space ship.
  848. F9          Manage the ship's cargo bay.
  849. F10         Show a menu with the above commands.
  850. Alt R       Randomize the friendly code.
  851. Alt U       Unload all cargo from a Trans 1 or Trans 2 field.
  852. Alt M       Load all cargo to a Trans 1 or Trans 2 field.
  853. +           Increment the value of current field (if possible).
  854. -           Decrement the value of current field (if possible).
  855. TAB         Moves to the first field of the next section.
  856. Shift TAB   Moves to the first field of the previous section.
  857.  
  858. Note: To beam cargo to an enemy ship, use the column under Trans 2. When more
  859.       than one enemy ship is present at the same location, you must first
  860.       select an enemy ship by moving the highlight bar to the 'Transporter 2'
  861.       field and press ENTER. Once a ship has been selected, the Trans 2
  862.       column will be enabled.
  863.  
  864. Key assignments within the Space Ship Transport Cargo Screen:
  865.  
  866. Alt M       Load selected item to max. allowed value.
  867. Alt U       Unload selected item to min. allowed value.
  868. +           Increment the value of current field (if possible).
  869. -           Decrement the value of current field (if possible).
  870.  
  871. Note: To change the transport target to another ship (or back to the planet),
  872.       move the highlight bar to the transport target field and press ENTER.
  873.  
  874. Key assignments within the Enemy Ship Detailed Screen:
  875.  
  876. F2          Show scoring information.
  877. F5          Show the configuration menu.
  878. SHIFT F5    Show the global specifications menu.
  879. F6          Show a list of space ships at the same location.
  880. F7          Show a window with the possible capabilities of the hull.
  881. F10         Show a menu with the above commands.
  882.  
  883. Key assignments within the Starbase Inventory Screen:
  884.  
  885. F7          Show a window with the specs of the selected item. When engines,
  886.             beam weapons or torpedoes are current, a list containing specs for
  887.             all available items is shown.
  888. SHIFT F7    Call up the hull specs browser. Just as when this browser is
  889.             called from the main menu, the current race is selected, but
  890.             with the PAGEUP and PAGEDOWN keys other races may be called up.
  891. TAB         Toggle between the inventory list and the inventory pages.
  892. SHIFT TAB   Same as TAB key.
  893. INSERT      Add the selected component to the space ship to be created. When
  894.             another element of the same page was already selected, it will
  895.             be disassembled, before the new part is put in place. In case of
  896.             a previous selected hull, the entire ship is dismanteled. This
  897.             command adds the max allowed for the selected parts. If this is
  898.             too many, you may remove single elements with the DELETE key. If
  899.             there are not enough parts in stock, they will be build.
  900. DELETE      Delete a component from the space ship to be created.
  901. +           Add a component to the starbase stock.
  902. -           Remove a component from the starbase stock.
  903. PAGEUP      Advance to the previous components page.
  904. PAGEDOWN    Advance to the next components page.
  905.  
  906. Key assignments within the Battle Specifications Screen:
  907.  
  908. F7          Show a window with the possible capabilities of the hull. This
  909.             action is not available in list modus.
  910. F8          Watch the selected battle played with VCR.
  911. SHIFT F8    Watch all the battles played with VCR.
  912. PAGEUP      Advance to the previous battle.
  913. PAGEDOWN    Advance to the next battle.
  914.  
  915. Included configuration editor
  916. -----------------------------
  917.  
  918. The editor consists of five screens, with each screen convering a particular
  919. set of options.
  920.  
  921. Screen 1:   Ratio editor for each race. It handles the ground combat attack
  922.             and defense factors, and the mining and tax rates.
  923. Screen 2:   Race advantages editor. Configure which racial abilities are
  924.             enabled or disabled.
  925. Screen 3:   Generic options. Edit options not bound to one particular race.
  926. Screen 4:   Enter racial names for each race.
  927. Screen 5:   Editor for VPHOST's extra features. If actions with equivalents
  928.             in the original HOST program are disabled, the original HOST
  929.             program will perform those actions. Otherwise, VPHOST will take
  930.             over those operations.
  931.  
  932. General notes you should be aware of:
  933. ------------------------------------
  934.  
  935. When using the cargo transporter, it is possible that the system allows for
  936. less cargo or fuel than is theoretically possible. This is caused by the
  937. second beam transporter (ie. the transporter to enemy ships). Because the
  938. system does not know if the host can actually perform this beam command,
  939. cargo present in this transporter is still considered part of the cargo of
  940. your ship, thus taking up space. This is to prevent loading cargo ABOVE the
  941. specified limits.
  942.  
  943. The battle browser may occasionally report the wrong ship as the ship used.
  944. This is because the host transmits a Picture Id instead of a Hull Id. When
  945. more than one ship use the same picture, this may lead to confusion. VPUTIL,
  946. however, does it's best to determine which ship was actually used in battle,
  947. matching the current mass, mounted beam weapons, torpedo launchers and
  948. fighter bays as closely as possible with the stored hull specifications.
  949.  
  950. If a HCONFIG.HST file is found in the game data directory, some fields are
  951. used to determine the actual tax income, mining rate and fuel usage (for
  952. cloaked ships only). When no such file is found, or the file contains less
  953. fields than the most recent HOST version uses, internal defaults are used
  954. instead. These defaults are the same as for the most recent HOST version.
  955.  
  956. With the host 3.1x versions, a configuration table is used for each player
  957. to determine the actual tax and mining ratios, instead of the per race
  958. build in fixed ratios the host 3.00x versions used. VPUTIL provides access
  959. to the HCONFIG.HST file (ie. the HOST 3.1x configuration file) to retrieve
  960. these values in order to calculate the various ratios correctly. It also
  961. implies that in your local HCONFIG.HST file the same values must be stored
  962. as your game host uses. The same holds true for the cloaked fuel usage rate,
  963. also a new HOST 3.1x feature. This value is now taken into account when
  964. the fuel usage is calculated. This means that even a stationary ship can
  965. now have a fuel usage !
  966.  
  967. Differences between shareware and registered mode:
  968. -------------------------------------------------
  969.  
  970. Registered players can transfer fighters in deep space between any of their
  971. carriers, if they are located at the same location, just as with PLANETS
  972. itself. VPUTIL allows this feature for torpedo ships as well. Note that in
  973. order to use this new feature, the torpedo launchers of the ships must be of
  974. the same type. Shareware players may not transfer fighters or torpedoes
  975. directly ships.
  976.  
  977. When selecting a waypoint for one of your ships, the system prompts for a
  978. max. range first. The max. possible range is 750 for registered users, 200
  979. for shareware players. However, if the HOST program is NOT patched, it is
  980. not capable to handle waypoint displacements of more than 200 light years
  981. in either x or y direction. In this case, you can use this feature only to
  982. determine fuel usage over a longer distance.
  983.  
  984. Registered players are allowed to fix a foreign ship at one of your own
  985. starbases. Note that this only applies for damage repairs, not refitting with
  986. either fighters or torpedoes. Shareware players may only fix ships they own
  987. by themselves.
  988.  
  989. Registered players are allowed to raise all tech levels to level 10. Raising
  990. tech levels is limited to level 6 for shareware players.
  991.  
  992. Registered players can see the actual state value for happyness states for
  993. both their colonists and the natives. Shareware players can only view the
  994. state category.
  995.  
  996.  
  997. Comments
  998. ========
  999.  
  1000. When you have comments or find bugs, please do not hesitate to contact us.
  1001. Also, if you have ideas on how to expand the program or have suggestions for
  1002. new commands or options, please contact us.
  1003.  
  1004.  
  1005.  
  1006. Our email address is:
  1007.  
  1008. FIDO:      'Jan Peter Dijkstra' at 2:283/323.0 or 2:283/323.12
  1009. INTERNET:  jan-peter@saluton.xs4all.nl
  1010.            j.p.dijkstra@sysma6.cnt.antenna.nl
  1011.  
  1012.  
  1013. We can also be contacted by mail. Our mail address is:
  1014.  
  1015. Sysma Automatisering
  1016. tav. J.P. Dijkstra
  1017. Fazantstraat 169
  1018. 7523 DP  Enschede
  1019. The Netherlands
  1020.  
  1021. Phone: +31 53 337410
  1022. Fax:   +31 53 311090
  1023.  
  1024.