chiark / gitweb /
New elite-cmdr tool.
[rocl] / README
diff --git a/README b/README
index 690dcbc41fd76cd4e51d8599126716193a644edd..14659d313e535860db84d298960c57b09b07da30 100644 (file)
--- a/README
+++ b/README
@@ -84,23 +84,48 @@ RIGHT ON COMMAND-LINE
        GAL is not specified.
 
 
-  elite-map [-qv] [-g GALAXY] [-d DIST] [-w WD,HT] [-a ASP] [PLANET]
+  elite-map [-qv] [-g GALAXY] [-d DIST] [-w WEIGHT] [-W WD,HT] [-a ASP]
+       [PLANET ...]
 
        Prints a map of (part of) a galaxy to the terminal.
 
        If PLANET is specified (which it usually is), a map of the area
        around PLANET in GALAXY (default standard galaxy 1) is printed,
-       showing other planets within DIST lightyears (default 7) of
-       PLANET.
+       showing other planets within a box extending about DIST
+       lightyears around the PLANETs.
 
-       If PLANET is not specified, the entire galaxy is printed.  This
-       is usually unhelpful.
+       If no PLANETs are not specified, the entire galaxy is printed.
+       This is usually unhelpful.
 
-       Planets are shown as numbers or letters.  The home PLANET is
-       shown as a `*'.  Below the map is printed a key describing the
-       planets in a strict left-to-right top-to-bottom order.
+       The `-w' option plots a route through the listed planets,
+       highlighting the waypoints.  See `elite-path' for the possible
+       weightings.
 
-       The size of the map may be controlled by the -w option -- set WD
+       Planets are shown as numbers or letters (or, occasionally a
+       sequence of letters).  If there is only one PLANET, it is shown
+       as a `*'; otherwise, they're labelled `*0', `*1', etc.  Planets
+       on the path are labelled `+0', `+1', ..., in the order you're
+       meant to visit them.  (Note that if the path doubles back on
+       itself, the planets involved /won't/ be listed twice.  Use
+       `elite-path' for a full guide on where to go, and `elite-map' to
+       visualize the route.)
+
+       The `-q' and `-v' options allow optional suppression of the key
+       below the map.  The defaults are as follows:
+
+         * A galactic map shows no key.
+
+         * A route map (with the `-w' option) shows the waypoints
+           (named PLANETs) and the planets on the path.
+
+         * An area map (around named planets) shows the names of all
+           planets shown.
+
+       The key can be made more verbose by giving the `-v' option, or
+       less verbose by `-q'.  Note that the options parser is currently
+       really shoddy, and won't let you say things like `-qqq'.
+
+       The size of the map may be controlled by the -W option -- set WD
        to the maximum allowable width, and HT to the maximum allowable
        height (in columns and rows, respectively).  The map will be
        scaled so as to fit.  The -a option sets the aspect ratio of
@@ -109,6 +134,7 @@ RIGHT ON COMMAND-LINE
        font).
 
 
+
   elite-path [-g GALAXY] [-w WEIGHT] PLANET PLANET ...
 
        Computes a route through a GALAXY (default is standard galaxy
@@ -200,6 +226,138 @@ RIGHT ON COMMAND-LINE
                        as the variables described above.
 
 
+  elite-cmdr [FILE] [-OPTION | ATTR | ATTR=VALUE | FILE] ...
+
+       A command-line Elite commander editor and viewer.  With a single
+       argument, reads a commander file and displays its contents as a
+       human readable table.  The arguments may be special options,
+       attribute names, attribute assignments, or filenames.
+
+       The special options are:
+
+       -show           Write the commander data to standard output as a
+                       human-readable table.  This is the default if no
+                       other output action is requested.
+
+       -load FILE      Read the commander file named FILE.
+
+       -save FILE      Write the modified commander data to FILE.
+
+       -reset          Reset the commander to the default `JAMESON'
+                       settings.
+
+       -dump           Write the commander data to standard output in
+                       the form of a script which can be read back by
+                       the `-read' option.
+
+       -read FILE      Read attribute/value pairs from FILE, and modify
+                       the commander accordingly.
+
+       An attribute name on its own is a request to print the current
+       value of that attribute.  An assignment ATTR=VALUE makes ATTR
+       have the requested VALUE.
+
+       The attributes, their meanings, and the acceptable values are as
+       follows:
+
+       mission         The commander's current mission.  (0 is no
+                       mission; 1 is searching for the Constrictor; 2
+                       is killed the Constrictor; 3 is waiting for the
+                       second mission; 4 is heading for Ceerdi; 5 is
+                       heading for Birera; and 6 is all missions
+                       completed.)  Must be an integer between 0 and
+                       255.
+
+       score           Current number of kills.  Must be an integer
+                       between 0 a 65535, or one of the strings
+                       `harmless', `mostly-harmless', `poor',
+                       `average', `above-average', `competent',
+                       `dangerous', `deadly', or `elite'.
+
+       credits         Number of credits.  Must be between 0 and
+                       429496729.5.
+
+       cargo           Size of cargo bay.  Must be between 4 and 255.
+
+       gal-number      Number of the current galaxy.  Note that this
+                       doesn't affect which galaxy the commander is
+                       actually in -- set gal-seed for that.  Must be
+                       between 1 and 8.
+
+       gal-seed        Which galaxy the commander is in.  May be any
+                       galaxy-spec.
+
+       world           Which world the commander is docked at.  May be
+                       any planet-spec describing a world in the
+                       correct galaxy.  (Note that, since the commander
+                       file actually stores the location as an x, y
+                       pair and chooses the closest world to those
+                       coordinates, and there are coincident pairs of
+                       worlds, it is not possible to have a commander
+                       start at some worlds.)
+
+       market-fluc     The market fluctuation byte.  Affects prices at
+                       the space station.  Must be an integer between 0
+                       and 255.
+
+       fuel            Amount of fuel.  Must be between 0 and 25.5.
+
+       energy-unit     Strength of the ship's energy unit.  May be an
+                       integer between 0 (none) and 255 (scary cheat)
+                       or one of the strings `none', `standard', or
+                       `naval'.
+
+       front-laser, rear-laser, left-laser, light-laser
+                       Strength of appropriate laser.  May be an
+                       integer between 0 (none) and 255 (scary cheat)
+                       or one of the strings `none', `pulse', `beam',
+                       `mining', or `military'.
+
+       ecm, fuel-scroop, enery-bomb, escape-pod,
+       docking-computer, gal-hyperdrive
+                       Whether the ship has various bits of equipment.
+                       One of `yes', `true', or `on' for yes, or `no',
+                       `false' or `off' for no.
+
+       missiles        Number of missiles carried.  Must be an integer
+                       between 0 and 255.
+
+       hold-ITEM, station-ITEM
+                       Quantity of some item in the ship's hold, or at
+                       the station.  Must be an integer between 0 and
+                       255.  ITEM must be one of `food', `textiles',
+                       `radioactives', `slaves', `liquor-wines',
+                       `luxuries', `narcotics', `computers',
+                       `machinery', `alloys', `firearms', `furs',
+                       `minerals', `gold', `platinum', `gem-stones', or
+                       `alien-items'.
+
+       #               A special attribute which is never printed.  Its
+                       value is ignored.  This may be used to insert
+                       comments in script files.
+
+       Anything else is assumed to be a filename, and loaded as for the
+       `-load' option.
+
+
+  elite-prices [-g GALAXY] [-s SORT] [FROM TO]
+
+       Shows minimum, average and maximum profit (in that order, in
+       credits per unit) for the various commodities, starting at one
+       kind of world and ending at another.
+
+       By default, the commodities are listed in standard order, and
+       the profits are computed going from a poor agricultural world to
+       a rich industrial one.
+
+       You can change the worlds under consideration by typing a pair
+       of planet-specs or economy types (as printed by `elite-find').
+       Any planet-specs are obviously taken relative to GALAXY.
+
+       The SORT parameter may be one of `min', `max', or `avg' to sort
+       by minimum, maximum or average profit (highest at the top).
+
+
 3. The graphical editor
 
   elite-editor [GALAXY | FILE]
@@ -286,7 +444,13 @@ RIGHT ON COMMAND-LINE
        recommend them as an upgrade for commanders who don't wish to
        cheat completely.)
 
+       One suggestion I've heard of, if Elite is too easy, is to start
+       at Lave (as usual), with no money, lasers, missiles, or fuel.
+       You can get your first money by ramming asteroids (easy but
+       unrewarding) or pirates (risky and tedious), and start trading
+       food and other cheap items.
 
+$Id: README,v 1.4 2003/03/01 17:47:07 mdw Exp $
 \f
 Local variables:
 mode: text