home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / games / tinymud2.zip / README < prev    next >
Text File  |  1990-09-02  |  6KB  |  179 lines
  1. This is TinyMUD version 1.5.4, a user-extendible
  2. multi-user adventure game.
  3.  
  4. See the file copyright.h for information on the copyright under which
  5. TinyMUD 1.5.4 is distributed.  See the file CHANGES for a list of
  6. changes made in each release.
  7.  
  8.  
  9. Compiling TinyMUD:
  10.  
  11. The code is written in ANSI C, and is known to compile and run under
  12. Mach (a variant of 4.3BSD Unix) on a Sun-3 and uVax-2 using GCC, on on
  13. an IBM RT using hc, and on a DECstation 3100 using the MipsCo C
  14. compiler.  It has also been compiled on a Vax running a fairly generic
  15. 4.2BSD system, and on a NeXT machine.
  16.  
  17. I do not expect that it will work well on non-BSD systems, although
  18. most of the BSD-isms are concentrated in interface.c and in a few
  19. calls here and there to bzero() and such.  Please let me know if you
  20. manage to port TinyMUD to another type of system.
  21.  
  22.  
  23. Programs contained in the distribution:
  24.  
  25. netmud
  26.  
  27.  This is the actual server program; it is invoked as 
  28.  
  29.     netmud source-file dump-file [port [log-file]]
  30.  
  31.  If port is not specified it defaults to 4201.  The initial database
  32. will be read in from source-file, which must contain at least the two
  33. objects in minimal.db to work well.  The file small.db, which contains
  34. the core of the original TinyMUD universe, may be a better place to
  35. start a new universe from.  The netmud process will write a checkpoint
  36. out to dump-file every 3600 seconds; the interval can be changed by
  37. setting DUMP_INTERVAL in config.h.
  38.  
  39.  
  40. netmud.conc & concentrate
  41.  
  42.  This is the same as netmud, but allows up to 3600 users at one time.
  43. The concentrate program listens on the external port and mulitplexes
  44. up to 60 connections into the server program.  There can be up to 60
  45. concentrators, although in practice you'll seldom need more than a
  46. half-dozen.  It is invoked as follows (ext-port is the port number
  47. users telnet to, int-port is the port number the server uses to
  48. communicate with the concetrators):
  49.  
  50.     netmud.conc  source-file dump-file [ext-port int-port [log-file]]
  51.  
  52. sanity-check
  53.  
  54.  Usage: sanity-check < source-file
  55.  
  56.  Performs several simple consistency checks on the specified database
  57.  file.  Also useful for detecting surplus WIZARDs and people with
  58.  excess pocket change.
  59.  
  60.  
  61. extract
  62.  
  63.  This is the program that was used to create the file small.db
  64. distributed with TinyMUD.  It is used to extract a part of a database
  65. as a connected whole.
  66.  
  67. Examples:
  68.  
  69.  extract < source-file > output-file
  70.  
  71.  Extracts location #0, player #1, and all objects owned by player #1;
  72.  these objects are renumbered into a contiguous block starting at 0 and
  73.  are written out as a new database file that preserves all of their
  74.  inter-relationships.  Some objects may become "orphaned" as a result
  75.  of having their home or location disappear; these objects are moved to
  76.  location #0.  With some combinations of command line arguments it is
  77.  possible to include an object without including its owner; in this
  78.  case player #1 "inherits" the object.  Exits are only extracted if
  79.  both their source and destination rooms are extracted.
  80.  
  81.  extract 2 < source-file > output-file
  82.  
  83.  Extracts location #0, object #1 and anything it owns, and object #2
  84.  and anything it owns.
  85.  
  86.  extract number2 < source-file > output-file
  87.  
  88.  Same as above, but (assuming player #2 is named number2) extracts
  89.  players by name.
  90.  
  91.  extract 2 -5 < source-file > output-file.
  92.  
  93.  As above, but does not extract object #5 even if it is owned by #1 or
  94.  #2.
  95.  
  96.  extract 2 5991 195 -198 3391 -12 12915 < source-file > object-file
  97.  
  98.  Extracts #0, #1, #2, #195, #3391, #5991, #12915 and anything they
  99.  own, except #12 and #198.
  100.  
  101. The keyword "all" can be specified as an argument to include
  102. everything by default, e.g.:
  103.  
  104.  extract all -198
  105.  
  106.  Extracts everything except object #198 and anything it owns.
  107.  
  108.  extract all -198 5
  109.  
  110.  Extracts everything except object #198 and anything it owns, but
  111.  includes object #5 even if #198 owns it.
  112.  
  113.  Other keywords: players reachable norecycle a<num> b<num>.
  114.  
  115.  Players: specifies that all players are kept (but not necessarily
  116.  what they own).
  117.  
  118.  Reachable: specifies that rooms not reachable by some combination of
  119.  exits from room #0 are not extracted unless specifically included.
  120.  
  121.  Norecycle: specifies that players, objects, and things in the 
  122.  recycling center (defined as the home of player 'Recycler') are not
  123.  kept unless specifically included.  'Norecycle' overrides 'players',
  124.  so
  125.  
  126.     extract players norecycle 
  127.  
  128.  would extract only those players not in the recycling center.
  129.  
  130.  a<num> (above) includes all objects with id numbers greater than
  131.  or equal to <num>
  132.  
  133.  b<num> (below) includes all objects with id numbers less than
  134.  or equal to <num>
  135.  
  136.  Putting it all together, here is how the Daytime Islandia DB is
  137.  built from the previous night's database:
  138.  
  139.     extract norecycle reachable players b1370 \
  140.     -274 -560 -809 1384 1403 1404 1406 1505 \
  141.     Tinker Lynx Tygling Three Janitor Mav \
  142.     $WINNER \
  143.     < islandia.db.new > day.db
  144.     
  145.  Whichs keeps: all players not in the recycling center, all objects
  146.  below 1370 except for 274, 560, and 809, and also includes 1403, 1404,
  147.  1406, 1505, everything owned by Tinker, Lynx, Tygling, Three, Janitor,
  148.  Mav, and everything owned by the lottery winner (name specified by
  149.  Shell variable WINNER). 
  150.  
  151. dump
  152.  
  153.  Usage: dump [owner] < db-file
  154.  
  155.  With no arguments, prints out every object in db-file.  With one
  156.  argument (a number) prints out every object with that owner.
  157.  
  158.  
  159. decompress
  160.  
  161.  Usage: decompress < compressed-db-file > uncompressed-db-file
  162.  
  163.  Removes compression from a database file that has been generated by
  164.  netmud using the -DCOMPRESS compile-time option.  
  165.  
  166.  
  167. restart-cmu, restart-day, restart-night
  168.  
  169.  The shell scripts used at CMU to restart the TinyMUD
  170.  server.  Useful for making sure that back versions of the database are
  171.  always available.
  172.  
  173.  
  174. I hope that you enjoy using TinyMUD.  
  175.  
  176. --Jim Aspnes, March 29th, 1990.             1.5.3
  177. --Scott Goehring, April 3rd, 1990.        1.5.3A
  178. --Michael Mauldin & Russ Smith, June 25, 1990.    1.5.4
  179.