home *** CD-ROM | disk | FTP | other *** search
/ Atari FTP / ATARI_FTP_0693.zip / ATARI_FTP_0693 / Games / larn12s.arc / LARN.DOC < prev    next >
Text File  |  1987-10-29  |  14KB  |  426 lines
  1.                                                            ST LARN v12.0
  2.  
  3.  
  4.  
  5.                  ST LARN version 12.0 for Atari ST(tm) computers
  6.                  -----------------------------------------------
  7.  
  8.                              by Howard Chu
  9.                                 350 Thompson, #327
  10.                                 Ann Arbor, MI 48104
  11.                                 October 28, 1987
  12.  
  13.  
  14.   Table of contents
  15.   -----------------
  16.  
  17.        
  18.  
  19.   Introduction....................................................2
  20.   Files Supplied..................................................2
  21.   Configuration...................................................3
  22.   Command line options............................................5
  23.   TERMCAP.........................................................6
  24.   WIZARD mode.....................................................7
  25.        
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.                                                            ST LARN v12.0
  68.  
  69.  
  70.   Introduction
  71.   ------------
  72.  
  73.        LARN is a dungeon type adventure game similar in concept to ROGUE or
  74.   HACK but with a much different feel.  LARN is copyrighted 1986 by Noah
  75.   Morgan (USENET: panda!condor!noah) at GenRad Inc. Bolton MA.  This version
  76.   is a port of his game to the Atari STs by Howard Chu.
  77.  
  78.  
  79.  
  80.   Files supplied
  81.   --------------
  82.  
  83.        The following files should be include in this LARN12.ARC file:
  84.  
  85.        LARN.DOC
  86.             This documentation
  87.  
  88.        LARN.TTP
  89.             The executable file.
  90.  
  91.        LARN.FTN
  92.             Fortune cookie messages.
  93.  
  94.        LARN.HLP
  95.             A help file which can be read with the "?" command in LARN.
  96.  
  97.        LARN.MAZ
  98.             Some maze levels are precalculated and stored here.
  99.  
  100.        TERMCAP
  101.             A file describing the escape sequences to send to the terminal to
  102.             change video modes.  The supplied TERMCAP file describes both
  103.             standard and 50 line screens.  See the TERMCAP section for details
  104.             on changing TERMCAP.
  105.  
  106.                                                            ST LARN v12.0
  107.  
  108.  
  109.  
  110.  
  111.   Configuration
  112.   -------------
  113.  
  114.        ST LARN is configured to your system by options placed in the file
  115.   LARN.OPT.  When ST LARN starts up, it looks in the current directory for
  116.   this file, then in directories along your PATH.  For a hard disk system I
  117.   suggest creating a \GAMES directory and putting LARN.TTP, LARN.OPT and
  118.   TERMCAP in there, then put \GAMES on your PATH.  For a system that only
  119.   has single sided floppy drives, put these 3 files on a single disk.
  120.  
  121.        Now create a LARN directory and put the included files LARN.FTN,
  122.   LARN.MAZ, and LARN.HLP in there.  LARN will create other files in this
  123.   directory, including the score file (LARN.SCR), a file to identify the
  124.   person playing (LARN.PID) and a file listing all the people who have played
  125.   to date (LARN.LOG).  Also, save games (LARN.SAV) and checkpoint games
  126.   (LARN.CKP) will go in here.
  127.  
  128.        For systems with hard disks, create the subdirectory "LARN" in the
  129.   \GAMES directory.  Your "larndir" is now "\GAMES\LARN".  For 360K floppy
  130.   systems you can have "larndir" as "A:\", but you will have to save games on
  131.   another drive (see "savefile" option below).
  132.  
  133.        Here are the options that can be put in LARN.OPT.  Options that are
  134.   followed with a colon, ":", take at least one argument.  Options without a
  135.   colon are boolean, meaning you select that option merely by mentioning it.
  136.  
  137.  
  138.   These options are only in ST LARN:
  139.  
  140.        larndir:       directory
  141.             Sets "directory" to be the place LARN looks for files.  For hard
  142.             disks set this to be \GAMES\LARN.  For 360K floppy drives, use A:\
  143.             
  144.             If "larndir" is not specified, the current directory is assumed.
  145.  
  146.        cmdshell:      filename
  147.             This is the full path name of the command shell you wish to invoke
  148.             with the LARN command `!'. The default is "\bin\msh.prg". The
  149.             program will be invoked with no arguments, and with an empty
  150.             environment list.
  151.  
  152.        ramlevels:     number
  153.             This number is the maximum number of levels ST LARN will keep in
  154.             memory.  The number can be between 1 and 14.  Normally, ST LARN
  155.             will use as much memory as available, but you may want to use
  156.             less so there will be enough memory to start up a subshell with
  157.             the LARN command `!', or to run a multi-tasking kernel, or a print
  158.             spooler, or some other memory intensive application.  If there
  159.             isn't enough memory for the command shell, LARN will clear the
  160.             screen and prompt with "$" until return is struck, then go back
  161.             to the game.
  162.             
  163.             If "ramlevels" is not specified, a value of 14 is used.  If
  164.             "number" is less than 14, LARN will use a swapfile to store the
  165.             oldest levels.  Note that a level takes about 8K of memory.
  166.  
  167.        swapfile:      filename
  168.             This is the name of the swap file that will be used if ramlevels
  169.             is less than 14.  If all the levels fit in memory, no swap file
  170.             will be used.  You may want to put the swapfile on a RAMdisk.
  171.             
  172.  
  173.  
  174.  
  175.  
  176.                                                            ST LARN v12.0
  177.  
  178.  
  179.             If "swapfile" is not specified, LARN.SWP in directory larndir
  180.             will be used.
  181.  
  182.        graphics:      wallc     floorc
  183.             In UNIX LARN, the wall character is a # and the floor character
  184.             is a blank (which makes it almost impossible to tell where you've
  185.             been).  In PC LARN, the default wall character is also a # but
  186.             the default floor character is a period.
  187.             
  188.             This option allows you to change these characters to something
  189.             you like.  I use 240 (a graphic block) and 250 (a central dot).
  190.             Since almost all normal ASCII characters are used for something
  191.             already, you should only choose numbers that are in the graphics
  192.             character set (ie those with decimal values greater than 128).
  193.  
  194.  
  195.  
  196.  
  197.  
  198.                                                            ST LARN v12.0
  199.  
  200.  
  201.   The following are options found in UNIX LARN as well:
  202.  
  203.        enable-checkpointing
  204.             With this option, the game is saved every 400 moves.  If your
  205.             system crashes it is possible to recover from the last checkpoint
  206.             file (LARN.CPK in the LARN directory) with the command "larn ++".
  207.  
  208.        monster:       name
  209.             Sets the name of a monster.  If the name has a space in it,
  210.             enclose it in double quotes (eg "tooth fairy").
  211.  
  212.        name:          yourname
  213.             Sets the name of the player.  If you want a space in your name,
  214.             enclose it in double quotes (eg "Mad Max").
  215.  
  216.        no-introduction
  217.             Skip displaying the opening messages.
  218.  
  219.        no-beep
  220.             Disable sound from the speaker.
  221.  
  222.        savefile:      filename
  223.             The filename to use for saving the game.  The default is LARN.SAV
  224.             in the LARN directory.  For a 2-floppy system you might try
  225.             B:\LARN.SAV if the LARN directory is on the A disk drive.
  226.  
  227.  
  228.   Command line options
  229.   --------------------
  230.  
  231.        There are several command line options that can modify the behavior of
  232.   LARN.  These are:
  233.  
  234.        -o optionfile  Use this as the option file rather than LARN.OPT.  As
  235.                       with LARN.OPT, the current directory then directories
  236.                       along your path are searched for this file which
  237.                       supplies configuration information.
  238.  
  239.        -s             Show scores.
  240.  
  241.        -l             Show log file.
  242.  
  243.        -i             Show all scores including inventories.
  244.  
  245.        -c             Create a new score file.  You have to know the Wizard's
  246.                       password to do this.  Erasing LARN.SCR has the same
  247.                       effect.
  248.  
  249.        -n             No welcoming message.  Prevents printing of the short
  250.                       introduction to LARN.  Putting the "no-introduction"
  251.                       configuration option in LARN.OPT has the same effect.
  252.  
  253.        -#             Where # is a number from 0 to 9.  This sets the
  254.                       difficulty of LARN to this level.  Normally, LARN
  255.                       starts out with difficulty 0 and increases in
  256.                       difficulty by 1 when you win at the current level.
  257.                       Thus the game automatically gets more difficult.
  258.  
  259.        -h             A help screen that shows the command line arguments.
  260.  
  261.  
  262.  
  263.  
  264.                                                            ST LARN v12.0
  265.  
  266.  
  267.        ++             Restore a game from a checkpoint file.  If you have
  268.                       checkpointing enabled (with the "enable-checkpointing"
  269.                       configuration option in LARN.OPT) then LARN writes a
  270.                       checkpoint file every 400 moves.  Should your system
  271.                       crash you can recover the game from the checkpoint file
  272.                       with this command line option
  273.  
  274.        For example:  "larn -n -o bobslarn.opt" starts up LARN with no
  275.   introductory message and uses bobslarn.opt file for configuration options.
  276.   "larn ++" tries to restore LARN from a checkpoint file.
  277.  
  278.   KEYBOARD
  279.   --------
  280.  
  281.        LARN redefines the keypad to issue movement commands.  The cursor pad
  282.   is also redefined, in a similar fashion.  The correspondance between keypad
  283.   and game command is:
  284.  
  285.             Cursor Pad                 Command
  286.              Help  Undo            help(?) nothing   
  287.  
  288.             Ins  Up  Clr      inventory(i) up(k) nothing
  289.  
  290.            Left Down Right       left(h) down(j) right(l)
  291.  
  292.             
  293.               Keypad                   Command
  294.               7  8  9         u+l(y)    up(k)    u+r(u)
  295.                \ | /                 \    |    /
  296.               4 -5- 6        left(h)   nothing   right(l)
  297.                / | \                 /    |    \
  298.               1  2  3         d+l(b)    down(j)  d+r(n)
  299.               0               inventory(i)
  300.             
  301.        The letter in () is the game command letter. "u+l" means up and
  302.        left.  The keypad "7" is translated to the command for moving one
  303.        space up and left.  With shift the commands are the same as the
  304.        uppercase letters.
  305.  
  306.   TERMCAP
  307.   -------
  308.  
  309.        LARN uses the UNIX "termcap" to select escape sequences to be sent to
  310.   the terminal driver to change video modes. Since LARN uses standard I/O
  311.   calls, it is possible to redirect all I/O to an auxiliary device and play
  312.   the game from a remote terminal, which is why the Atari screen control
  313.   commands weren't hardwired into the code.  When LARN starts up, it checks
  314.   in the environment for the variable called "TERM".  The shell command:
  315.        set TERM st52l
  316.   will give the environment variable "TERM" the value "st52l".  By default,
  317.   LARN assumes the value of TERM is "st52". (The st52l entry just allows
  318.   use of the hi-res 50 line screen hack for monochrome systems. LARN only
  319.   needs a 24 line by 80 column screen, so its use isn't necessary.)
  320.  
  321.        Then LARN looks in the file called "TERMCAP" for a terminal definition
  322.   with the same name as the value of TERM.  LARN first looks for TERMCAP in
  323.   the current directory, then in directory "\ETC" (the normal UNIX place),
  324.   then in directories along your PATH.
  325.  
  326.        The TERMCAP file uses 2 letter codes to describe each escape sequence
  327.   and \E to mean ESC (the escape character is decimal 27).  Each entry is
  328.   enclosed in colons.  For example, to use inverse video on a monochrome
  329.   display, we want to send the sequence "ESCp".  This looks like
  330.   ":so=\Ep:" as a termcap entry.
  331.  
  332.        The following sequences are used by LARN:
  333.  
  334.        ti   terminal initialization.  You could have something like:
  335.                  :ti=\Eb0\Ec1
  336.             which would mean to select white background and black foreground.
  337.  
  338.        te   terminal end.  To reset your terminal to white on black:
  339.                  :te=\Eb1\Ec0:
  340.  
  341.        so   stand out.  Select inverse video:
  342.                  :so=\Ep:
  343.  
  344.        se   standout end.  Back to normal:
  345.                  :se=\Eq:
  346.  
  347.        al   insert line.
  348.                  :al=\EL:
  349.  
  350.        dl   delete line.
  351.                  :dl=\EM:
  352.  
  353.        If you want to make your own TERMCAP entry, copy the "st52" entry,
  354.   replace the name (eg use "vt100" or "ansi" or whatever), then replace
  355.   the sequences with whatever you please.  Your best source would be the
  356.   /etc/termcap file on your closest Unix system. The Atari ST screen
  357.   control sequences are listed on page 406 of the Mark Williams C manual.
  358.   (release 2.0) I don't know where else they'd be listed, but I've put
  359.   all the useful ones into the included TERMCAP file already.
  360.  
  361.  
  362.  
  363.                                                            ST LARN v12.0
  364.  
  365.  
  366.  
  367.        Remember to change the environment variable "TERM" to reflect which
  368.   TERMCAP entry you want!  You should probably put a "setenv TERM=..." line
  369.   in your PROFILE file. (Assuming Mark Williams MicroShell. Use PROFILE.G
  370.   for Gulam.)
  371.  
  372.  
  373.   WIZARD mode
  374.   -----------
  375.  
  376.        There is a WIZARD mode for testing features of the game.  To get into
  377.   WIZARD mode, type in an underscore "_" and answer the prompt for the
  378.   password with "pvnert(x)".  Wizards are non-scoring characters that get
  379.   enlightenment, everlasting expanded awareness and one of every object in
  380.   the game.
  381.  
  382.        
  383.  
  384.        
  385.  
  386.        
  387.  
  388.        
  389.  
  390.        
  391.  
  392.        I hope you enjoy this version of LARN.  Please refer any inquires on
  393.   this Atari ST implementation to:
  394.  
  395.                  H. Y. Chu
  396.                  350 Thompson, #327
  397.                  Ann Arbor, MI 48104
  398.                  UUCP:     ...{uunet, rutgers}!umix!hyc
  399.                  ARPA:     hyc@umix.cc.umich.edu
  400.        
  401.  
  402.  
  403.  
  404.  
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.  
  412.  
  413.  
  414.  
  415.  
  416.  
  417.  
  418.  
  419.  
  420.  
  421.  
  422.  
  423.  
  424.  
  425.  
  426.