home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / games / larn.zip / LARN.DOC < prev    next >
Text File  |  1990-10-14  |  15KB  |  361 lines
  1.                                                            PC LARN v12.0
  2.  
  3.                  PC LARN version 12.0 for MSDOS(tm) computers
  4.                  --------------------------------------------
  5.  
  6.                              by Don Kneller
  7.                                 2 Panoramic Way #204
  8.                                 Berkeley, CA 94704
  9.                                 October 20, 1986
  10.   Table of contents
  11.   -----------------
  12.  
  13.   Introduction....................................................2
  14.   System requirements.............................................2
  15.   Configuration...................................................3
  16.   Command line options............................................5
  17.   TERMCAP.........................................................6
  18.   WIZARD mode.....................................................7
  19.        
  20.  
  21.                                                            PC LARN v12.0
  22.  
  23.  
  24.   Introduction
  25.   ------------
  26.  
  27.        LARN is a dungeon type adventure game similar in concept to ROGUE or
  28.   HACK but with a much different feel.  LARN is copyrighted 1986 by Noah
  29.   Morgan (USENET: panda!condor!noah) at GenRad Inc. Bolton MA.  This version
  30.   is a port of his game into the MSDOS environment by Don Kneller.
  31.  
  32.  
  33.   System requirements
  34.   -------------------
  35.  
  36.        PC LARN requires:
  37.  
  38.        - MSDOS or PCDOS 2.x or above.
  39.  
  40.        - at least 256K of RAM.
  41.  
  42.        - disk storage capacity of at least 360K, although twice that much is
  43.          preferred if you want to "checkpoint" your game to prevent
  44.          accidental lose due to a system failure.
  45.  
  46.        - the ANSI.SYS device driver must be installed (although the NANSI.SYS
  47.          driver is *strongly* preferred and has been included in this
  48.          distribution).  You should install either ANSI.SYS or NANSI.SYS, but
  49.          not both.  To install NANSI.SYS, put the line "device=NANSI.SYS" in
  50.          your CONFIG.SYS file.  See the TERMCAP section for further details.
  51.  
  52.  
  53.   Files supplied
  54.   --------------
  55.  
  56.        The following files should be include in this LARN12.ARC file:
  57.  
  58.        LARN.DOC
  59.             This documentation
  60.  
  61.        LARN.EXE
  62.             The executable file.
  63.  
  64.        LARN.FTN
  65.             Fortune cookie messages.
  66.  
  67.        LARN.HLP
  68.             A help file which can be read with the "?" command in LARN.
  69.  
  70.        LARN.MAZ
  71.             Some maze levels are precalculated and stored here.
  72.  
  73.        NANSI.DOC
  74.             The documentation for:
  75.  
  76.        NANSI.SYS
  77.             A new ANSI.SYS that is *much* faster than ANSI.SYS and supports
  78.             the line insert and line delete escape sequence that LARN uses.
  79.             This excellent product is written by Daniel Kegel.  See the
  80.             TERMCAP section and NANSI.DOC for more details.
  81.  
  82.        TERMCAP
  83.             A file describing the escape sequences to send to the terminal to
  84.  
  85.  
  86.  
  87.  
  88.                                                            PC LARN v12.0
  89.  
  90.  
  91.             change video modes.  The supplied TERMCAP file is for monochrome
  92.             systems.  See the TERMCAP section for details on changing
  93.             TERMCAP.
  94.  
  95.  
  96.   Configuration
  97.   -------------
  98.  
  99.        PC LARN is configured to your system by options placed in the file
  100.   LARN.OPT.  When PC LARN starts up, it looks in the current directory for
  101.   this file, then in directories along your PATH.  This is the same behavior
  102.   DOS uses when trying to find executable files.  For a hard disk system I
  103.   suggest creating a \GAMES directory and putting LARN.EXE, LARN.OPT and
  104.   TERMCAP in there, then put \GAMES on your PATH.  For a 2-floppy system, put
  105.   COMMAND.COM on new disk and put these 3 files on this disk.
  106.  
  107.        Now create a LARN directory and put the included files LARN.FTN,
  108.   LARN.MAZ, and LARN.HLP in there.  LARN will create other files in this
  109.   directory, including the score file (LARN.SCR), a file to identify the
  110.   person playing (LARN.PID) and a file listing all the people who have played
  111.   to date (LARN.LOG).  Also, save games (LARN.SAV) and checkpoint games
  112.   (LARN.CKP) will go in here.
  113.  
  114.        For systems with hard disks, create the subdirectory "LARN" in the
  115.   \GAMES directory.  Your "larndir" is now "\GAMES\LARN".  For 2-floppy
  116.   systems you can have "larndir" as "A:", but you will have to save games on
  117.   another drive (see "savefile" option below).
  118.  
  119.        Here are the options that can be put in LARN.OPT.  Options that are
  120.   followed with a colon, ":", take at least one argument.  Options without a
  121.   colon are boolean, meaning you select that option merely by mentioning it.
  122.  
  123.  
  124.   These options are only in PC LARN:
  125.  
  126.        larndir:       directory
  127.             Sets "directory" to be the place LARN looks for files.  For hard
  128.             disks set this to be \GAMES\LARN.  For 2-floppy systems, use A:
  129.             
  130.             If "larndir" is not specified, the current directory is assumed.
  131.  
  132.        ramlevels:     number
  133.             This number is the maximum number of levels PC LARN will keep in
  134.             memory.  The number can be between 1 and 14.  Normally, PC LARN
  135.             will use as much memory as available, but you may want to use
  136.             less so there will be enough memory to start up a second copy of
  137.             COMMAND.COM with the LARN command `!'.  If there isn't enough
  138.             memory for COMMAND.COM, LARN will clear the screen and prompt
  139.             with "A>" until return is struck, then go back to the game.
  140.             
  141.             If "ramlevels" is not specified, a value of 14 is used.  If
  142.             "number" is less than 14, LARN will use a swapfile to store the
  143.             oldest levels.  Note that a level takes about 8K of memory.
  144.  
  145.        swapfile:      filename
  146.             This is the name of the swap file that will be used if ramlevels
  147.             is less than 14.  If all the levels fit in memory, no swap file
  148.             will be used.  You may want to put the swapfile on a RAMdisk.
  149.             
  150.  
  151.                                                            PC LARN v12.0
  152.  
  153.  
  154.             If "swapfile" is not specified, LARN.SWP in directory larndir
  155.             will be used.
  156.  
  157.        graphics:      wallc     floorc
  158.             In UNIX LARN, the wall character is a # and the floor character
  159.             is a blank (which makes it almost impossible to tell where you've
  160.             been).  In PC LARN, the default wall character is also a # but
  161.             the default floor character is a period.
  162.             
  163.             This option allows you to change these characters to something
  164.             you like.  I use 176 (a graphic block) and 249 (a central dot).
  165.             Since almost all normal ASCII characters are used for something
  166.             already, you should only choose numbers that are in the graphics
  167.             character set (ie those with decimal values greater than 128).
  168.  
  169.        keypad
  170.             This enables the keypad for use with LARN.  A *BIOS* call is used
  171.             to read the keypad.  The correspondance between keypad and game
  172.             command is:
  173.             
  174.                    Keypad                   Command
  175.                    7  8  9         u+l(y)    up(k)    u+r(u)
  176.                     \ | /                 \    |    /
  177.                    4 -5- 6        left(h)   nothing   right(l)
  178.                     / | \                 /    |    \
  179.                    1  2  3         d+l(b)    down(j)  d+r(n)
  180.                  Ins             inventory(i)
  181.             
  182.             The letter in () is the game command letter. "u+l" means up and
  183.             left.  The keypad "7" is translated to the command for moving one
  184.             space up and left.  With shift the commands are the same as the
  185.             uppercase letters.
  186.  
  187.        cursor:        start-line     end-line
  188.             Normally, LARN uses the standard DOS cursor (the flashing
  189.             underscore) to show where your player is located.  This can be
  190.             difficult to see.  This option results in a *BIOS* call to change
  191.             the cursor size.  For a monochrome display, the normal value of
  192.             start-line and end-line is 11 and 12.  Values of 4 and 9 give a
  193.             larger cursor which is not too obtrusive.
  194.             
  195.             If "cursor" is not specified, no BIOS call is made.
  196.  
  197.        rawio
  198.             This option causes the input and output of your computer to be
  199.             switched to "raw" mode.  The advantage of this is faster output
  200.             and better handling of special characters ^S and ^P.
  201.             
  202.  
  203.                                                            PC LARN v12.0
  204.  
  205.  
  206.   The following are options found in UNIX LARN as well:
  207.  
  208.        enable-checkpointing
  209.             With this option, the game is saved every 400 moves.  If your
  210.             system crashes it is possible to recover from the last checkpoint
  211.             file (LARN.CKP in the LARN directory) with the command "larn ++".
  212.  
  213.        monster:       name
  214.             Sets the name of a monster.  If the name has a space in it,
  215.             enclose it in double quotes (eg "tooth fairy").
  216.  
  217.        name:          yourname
  218.             Sets the name of the player.  If you want a space in your name,
  219.             enclose it in double quotes (eg "Mad Max").
  220.  
  221.        no-introduction
  222.             Skip displaying the opening messages.
  223.  
  224.        no-beep
  225.             Disable sound from the speaker.
  226.  
  227.        savefile:      filename
  228.             The filename to use for saving the game.  The default is LARN.SAV
  229.             in the LARN directory.  For a 2-floppy system you should use
  230.             B:LARN.SAV if the LARN directory is on the A disk drive.
  231.  
  232.  
  233.   Command line options
  234.   --------------------
  235.  
  236.        There are several command line options that can modify the behavior of
  237.   LARN.  These are:
  238.  
  239.        -o optionfile  Use this as the option file rather than LARN.OPT.  As
  240.                       with LARN.OPT, the current directory then directories
  241.                       along your path are searched for this file which
  242.                       supplies configuration information.
  243.  
  244.        -s             Show scores.
  245.  
  246.        -l             Show log file.
  247.  
  248.        -i             Show all scores including inventories.
  249.  
  250.        -c             Create a new score file.  You have to know the Wizard's
  251.                       password to do this.  Erasing LARN.SCR has the same
  252.                       effect.
  253.  
  254.        -n             No welcoming message.  Prevents printing of the short
  255.                       introduction to LARN.  Putting the "no-introduction"
  256.                       configuration option in LARN.OPT has the same effect.
  257.  
  258.        -#             Where # is a number from 0 to 9.  This sets the
  259.                       difficulty of LARN to this level.  Normally, LARN
  260.                       starts out with difficulty 0 and increases in
  261.                       difficulty by 1 when you win at the current level.
  262.                       Thus the game automatically gets more difficult.
  263.  
  264.        -h             A help screen that shows the command line arguments.
  265.  
  266.  
  267.                                                            PC LARN v12.0
  268.  
  269.  
  270.        ++             Restore a game from a checkpoint file.  If you have
  271.                       checkpointing enabled (with the "enable-checkpointing"
  272.                       configuration option in LARN.OPT) then LARN writes a
  273.                       checkpoint file every 400 moves.  Should your system
  274.                       crash you can recover the game from the checkpoint file
  275.                       with this command line option
  276.  
  277.        For example:  "larn -n -o bobslarn.opt" starts up LARN with no
  278.   introductory message and uses bobslarn.opt file for configuration options.
  279.   "larn ++" tries to restore LARN from a checkpoint file.
  280.  
  281.  
  282.   TERMCAP
  283.   -------
  284.  
  285.        LARN uses the UNIX "termcap" to select escape sequences to be sent to
  286.   the terminal driver (either ANSI.SYS or NANSI.SYS) to change video modes.
  287.   When LARN starts up, it checks in the environment for the variable called
  288.   "TERM".  The DOS command:
  289.        set TERM=ibmpc-ega
  290.   will give the environment variable "TERM" the value "ibmpc-ega".  By
  291.   default, LARN assumes the value of TERM is "ibmpc-mono".
  292.  
  293.        Then LARN looks in the file called "TERMCAP" for a terminal definition
  294.   with the same name as the value of TERM.  LARN first looks for TERMCAP in
  295.   the current directory, then in directory "\ETC" (the normal UNIX place),
  296.   then in directories along your PATH.
  297.  
  298.        The TERMCAP file uses 2 letter codes to describe each escape sequence
  299.   and \E to mean ESC (the escape character is decimal 27).  Each entry is
  300.   enclosed in colons.  For example, to start underscore mode on a monochrome
  301.   display, we want to send the sequence "ESC[4m".  This looks like
  302.   ":us=\E4m:" as a termcap entry.
  303.  
  304.        The following sequences are used by LARN:
  305.  
  306.        ti   terminal initialization.  You could have something like:
  307.                  :ti=\E44;37m:
  308.             which would mean to select blue background and white foreground.
  309.  
  310.        te   terminal end.  To reset your terminal to white on black:
  311.                  :te=\E0m:
  312.  
  313.        so   stand out.  Select red foreground, keeping the blue background:
  314.                  :so=\E31m:
  315.  
  316.        se   standout end.  Back to white on blue:
  317.                  :se=\E44;37m:
  318.  
  319.        al   insert line.  This is *not* available in ANSI.SYS, so remove this
  320.             entry if you're using ANSI.
  321.  
  322.        dl   delete line.  This is *not* available in ANSI.SYS, so remove this
  323.             entry if you're using ANSI.
  324.  
  325.        If you want to make your own TERMCAP entry, copy the "ibmpc-mono"
  326.   entry, replace the name (eg use "ibmpc-color" or "ibmpc-ega" or whatever),
  327.   then replace the sequences with whatever you please.  The possible escape
  328.   sequences are listed in Chapter 13 of the DOS 2.0 manual.  I don't know
  329.   where they are for DOS 3.1 since they aren't in the DOS manual.  The
  330.  
  331.  
  332.                                                            PC LARN v12.0
  333.  
  334.  
  335.   NANSI.DOC file has a table of character attributes that you can use with
  336.   NANSI.SYS.  They are the same as used by ANSI.SYS.
  337.  
  338.        Remember to change the environment variable "TERM" to reflect which
  339.   TERMCAP entry you want!  You should probably put a "set TERM=..." line in
  340.   your AUTOEXEC.BAT file.
  341.  
  342.  
  343.   WIZARD mode
  344.   -----------
  345.  
  346.        There is a WIZARD mode for testing features of the game.  To get into
  347.   WIZARD mode, type in an underscore "_" and answer the prompt for the
  348.   password with "pvnert(x)".  Wizards are non-scoring characters that get
  349.   enlightenment, everlasting expanded awareness and one of every object in
  350.   the game.
  351.  
  352.        I hope you enjoy this version of LARN.  Please refer any inquires on
  353.   this MSDOS implementation to:
  354.  
  355.                  D. G. Kneller
  356.                  2 Panoramic Way #204
  357.                  Berkeley, CA 94704
  358.                  UUCP:     ...ucbvax!ucsfcgl!kneller
  359.                  ARPA:     kneller@cgl.ucsf.edu
  360.                  BITNET:   kneller@ucsfcgl.bitnet
  361.