Home | History | Annotate | Line # | Download | only in larn
README revision 1.1
      1  1.1  cgd Larn is a dungeon type game program.  Larn is a adventure/action game similar
      2  1.1  cgd in concept to rogue or hack, but with a much different feel. 
      3  1.1  cgd Try it, you'll like it!
      4  1.1  cgd 
      5  1.1  cgd You will have to edit the Makefile to reflect your configuration.  Define
      6  1.1  cgd LARNHOME as the place where the larn auxiliary files will reside, and
      7  1.1  cgd BINDIR as the place where the larn executable should be placed.  Type
      8  1.1  cgd "make" to compile, or "make all" to compile and install ("make install"
      9  1.1  cgd does just the install).
     10  1.1  cgd 
     11  1.1  cgd Here's a list of what is in each of the various source files:
     12  1.1  cgd 
     13  1.1  cgd Fixed.Bugs		 this is a list of the things that were changed
     14  1.1  cgd 				since ver 11.0
     15  1.1  cgd Makefile		 makefile script to compile the program
     16  1.1  cgd Make.lint		 makefile script to run larn sources through lint
     17  1.1  cgd README			 this is what you are now reading
     18  1.1  cgd bill.c          code for the letters of praise if player wins
     19  1.1  cgd config.c        data definitions for the installation dependent data --
     20  1.1  cgd                     savefilenames, where the scorefiles are, etc.
     21  1.1  cgd create.c        code to create the dungeon and all objects
     22  1.1  cgd data.c          data definitions for the game -- no code here
     23  1.1  cgd diag.c          code to produce diagnostic data for wizards, & savegame stuff
     24  1.1  cgd display.c       code to update the display on the screen
     25  1.1  cgd fortune.c		code for the fortune cookies
     26  1.1  cgd global.c        code for globally used functions that are specific to larn
     27  1.1  cgd header.h        constant and structure definitions
     28  1.1  cgd help.c          code for the help screens in the game of larn
     29  1.1  cgd .holidays		data file which lists upcoming holidays
     30  1.1  cgd io.c    	    code to handle file and terminal i/o
     31  1.1  cgd .larn.help.uue	larn help file (UUENCODED)
     32  1.1  cgd .larnmaze		data file for pre-made mazes
     33  1.1  cgd .larnopts		a sample .larnopts option data file
     34  1.1  cgd .lfortune		data file which contains the hints
     35  1.1  cgd main.c          code for the main command control and parsing
     36  1.1  cgd monster.c       code to handle attack and defense modes with monsters
     37  1.1  cgd moreobj.c		code for the fountains, altars, thrones
     38  1.1  cgd movem.c         code to move the monsters around the dungeon
     39  1.1  cgd nap.c           code to sleep for less than a second
     40  1.1  cgd object.c        code to handle objects in the dungeon
     41  1.1  cgd regen.c			code to regenerate the player and advance game time
     42  1.1  cgd savelev.c	code to get/put a level from level storage into working
     43  1.1  cgd 		level memory
     44  1.1  cgd scores.c        code to process and manage the scoreboard
     45  1.1  cgd signal.c        code to handle UNIX signals that are trapped
     46  1.1  cgd store.c         code for the larn thrift shoppe, bank, trading post, lrs
     47  1.1  cgd tok.c           code for the input front end and options file processing
     48  1.1  cgd 
     49  1.1  cgd To find out how to play the game, run it and type in a '?' to get the help
     50  1.1  cgd screens.  By the way, the wizards password is "pvnert(x)" and to become wizard
     51  1.1  cgd type in an underscore, you are then prompted for the password.  Wizards are
     52  1.1  cgd non-scoring characters that get enlightenment, everlasting expanded 
     53  1.1  cgd awareness, and one of every object in the game.  They help the author to debug
     54  1.1  cgd the game.
     55  1.1  cgd 
     56  1.1  cgd Note regarding the wizard id:  If you are using userid's, then WIZID must be
     57  1.1  cgd set to the userid of the person who can become wizard.  If you are using
     58  1.1  cgd player id's, WIZID must be set to the playerid (edit file .playerids if needed)
     59  1.1  cgd of the player who can become wizard.
     60  1.1  cgd 
     61  1.1  cgd You may want to clear out the scoreboard.  The command "larn -c" will make a
     62  1.1  cgd new scoreboard.  It will prompt you for the wizards password.
     63  1.1  cgd 
     64  1.1  cgd BUGS & FIXES:
     65  1.1  cgd 
     66  1.1  cgd James McNamara has volunteered to maintain the latest sources, and provide
     67  1.1  cgd latest bug fixes to anyone who asks.  Both James and I will field requests for
     68  1.1  cgd sources, for those who ask.
     69  1.1  cgd 
     70  1.1  cgd 			  ___	Prince of Gems (alias Noah Morgan)
     71  1.1  cgd 			 /.  \	USENET: panda!condor!noah
     72  1.1  cgd 			 \   /	at GenRad Inc.  Bolton MA
     73  1.1  cgd 			  \ /
     74  1.1  cgd 			   v
     75  1.1  cgd 
     76  1.1  cgd Below is some additional info about the installation of larn:
     77  1.1  cgd 
     78  1.1  cgd Install: Notes on the game LARN installation.
     79  1.1  cgd Larn is copyrighted 1986 by Noah Morgan.
     80  1.1  cgd This file (below) originally by James D. McNamara, last update 7/27/86 by nm
     81  1.1  cgd 
     82  1.1  cgd THIS DISTRIBUTION:
     83  1.1  cgd 
     84  1.1  cgd 	You should receive six (6) shar files, which are:
     85  1.1  cgd 
     86  1.1  cgd 	larn.part-1
     87  1.1  cgd 	larn.part-2
     88  1.1  cgd 	larn.part-3
     89  1.1  cgd 	larn.part-4
     90  1.1  cgd 	larn.part-5
     91  1.1  cgd 	larn.part-6
     92  1.1  cgd 
     93  1.1  cgd I.	Use /bin/sh (or your system equivalent) to "unravel" shar files
     94  1.1  cgd 	larn.part-1, ..., larn.part-6.  I suggest you do this directly
     95  1.1  cgd 	into $LARNHOME (See Section III.).  Notable files:
     96  1.1  cgd 
     97  1.1  cgd 	README	-	The author's how-to.
     98  1.1  cgd 	MANIFEST -	Files you should have.
     99  1.1  cgd 
    100  1.1  cgd III.	Edit a copy of "Makefile" and leave the edited version in $LARNHOME.
    101  1.1  cgd 
    102  1.1  cgd All the "configuration" options are tidily near the top of the "Makefile."
    103  1.1  cgd Here are the ones you probably will want to edit:
    104  1.1  cgd 
    105  1.1  cgd LARNHOME	I specified (literally) the directory, with path from root,
    106  1.1  cgd 	where "larn" will reside.  This included where I put the *.c files,
    107  1.1  cgd 	it is where the *.o files ended up, as well as all data and *.h files.
    108  1.1  cgd 	i suspect the *.c and intallation-documentation files can be moved off,
    109  1.1  cgd 	but the data and bits must all remain here for execution.
    110  1.1  cgd 
    111  1.1  cgd BINDIR		I specified (literally) the directory, with path from root,
    112  1.1  cgd 	where the executable "larn" will reside.  The "Makefile" will dump
    113  1.1  cgd 	the "a.out", named "larn", in this directory.  My BINDIR was not
    114  1.1  cgd 	my LARNHOME, so $BINDIR/larn was the ONLY file dumed here.  You'll
    115  1.1  cgd 	probably have to chmod it for public execute, etc.
    116  1.1  cgd 
    117  1.1  cgd 
    118  1.1  cgd OPTIONS		This is how *I* specified them... they are documented in-line:
    119  1.1  cgd 	OPTIONS = -DWIZZARD -DWIZID=157 -DEXTRA -DBSD -DSAVEINHOME
    120  1.1  cgd 
    121  1.1  cgd IV.	Compile the bugger.  Read "README" before you do.  You have a couple
    122  1.1  cgd 	of options here:
    123  1.1  cgd 
    124  1.1  cgd 	make			- will not install, suspect good for updates.
    125  1.1  cgd 	make all		- compile (and) intall
    126  1.1  cgd 	make install		- just install
    127  1.1  cgd 
    128  1.1  cgd 	I did "make" and then "make install" -- seems to work "ok", but
    129  1.1  cgd 	"make all" probably safer, if I had known.  Note that "Makefile"
    130  1.1  cgd 	is the default file for "make."
    131  1.1  cgd 
    132  1.1  cgd V.	Execute and have fun.  If wizard code "ok", larn -c will refresh the
    133  1.1  cgd 	scoreboard.  Play and win (or get killed) to put somebody on the
    134  1.1  cgd 	scoreboard.
    135  1.1  cgd 
    136  1.1  cgd VI.	BUGS and FIXES.
    137  1.1  cgd 
    138  1.1  cgd 	Please forward any bug-fixes in these regards to me (or Noah), so I may
    139  1.1  cgd 	compile a fix-list for other installers.  Thanks.
    140  1.1  cgd 
    141  1.1  cgd Regards,
    142  1.1  cgd ===============================================================================
    143  1.1  cgd James D. McNamara                    CSNET:   jim@bu-cs
    144  1.1  cgd                                      ARPANET: jim%bu-cs@csnet-relay
    145  1.1  cgd                                      UUCP:    ...harvard!bu-cs!jim
    146  1.1  cgd                                      BITNET:  jim%bu-cs%csnet-relay.arpa@wiscvm
    147  1.1  cgd ===============================================================================
    148  1.1  cgd 
    149