Home | History | Annotate | Line # | Download | only in boggle
README revision 1.1
      1  1.1  jtc 
      2  1.1  jtc Bog is a fairly portable simulation of Parker Brother's game of Boggle and
      3  1.1  jtc is similar to the 4.[23] BSD "boggle" and Sun's "boggletool".
      4  1.1  jtc Bog has not been derived from any proprietary code.
      5  1.1  jtc It has been tested on the Sun 3 under SunOS 3.2 and on the Atari 1040ST (MWC).
      6  1.1  jtc 
      7  1.1  jtc What You Need
      8  1.1  jtc 
      9  1.1  jtc You will need curses/termcap and a large word list.
     10  1.1  jtc The minix word list or /usr/dict/words will do nicely.
     11  1.1  jtc The word list must already be sorted (you can use "sort -c" to check).
     12  1.1  jtc 
     13  1.1  jtc Contents
     14  1.1  jtc 
     15  1.1  jtc 	README		- this file
     16  1.1  jtc 	Makefile
     17  1.1  jtc 	bog.man		- half-hearted man page (use the game's help command)
     18  1.1  jtc 	bog.h		- configuration and header info
     19  1.1  jtc 	bog.c		- machine independent game code
     20  1.1  jtc 	word.c		- machine independent word list routines
     21  1.1  jtc 	help.c		- (curses) help routine
     22  1.1  jtc 	mach.c		- (curses) display code
     23  1.1  jtc 	prtable.c	- ditto
     24  1.1  jtc 	timer.c		- machine dependent (os) input polling
     25  1.1  jtc 	mkdict.c	- convert a word list to a bog dictionary
     26  1.1  jtc 	mkindex.c	- create an index file for the bog dictionary
     27  1.1  jtc 	showdict.c	- print a bog dictionary to stdout
     28  1.1  jtc 
     29  1.1  jtc Portability
     30  1.1  jtc 
     31  1.1  jtc - I've tried to make bog.c (the program logic) independent of the I/O.
     32  1.1  jtc   My plan was to make it straightforward to adapt the game to run under a
     33  1.1  jtc   windowing system (eg., Suntools, GEM).  I have no plan to actually do this.
     34  1.1  jtc   I've stuck to a small subset of the curses routines.
     35  1.1  jtc - The program runs with the input in raw mode.
     36  1.1  jtc - If you want the running timer you must #define TIMER in bog.h
     37  1.1  jtc   and insert the input polling code in timer.c for your system.  There is
     38  1.1  jtc   already code there for BSD, SYSV, and ATARI.
     39  1.1  jtc 
     40  1.1  jtc Setup
     41  1.1  jtc 
     42  1.1  jtc 1. Check bog.h and Makefile and edit to fit your environment
     43  1.1  jtc 2. "make all"
     44  1.1  jtc    This will make all the binaries and create the dictionary and index files
     45  1.1  jtc 3. Move "dict", "dict.ind", and "helpfile" to where you specified in bog.h
     46  1.1  jtc 4. Play away
     47  1.1  jtc 
     48  1.1  jtc Distribution
     49  1.1  jtc 
     50  1.1  jtc You may use this software for your enjoyment and you may share it with others.
     51  1.1  jtc You may not sell this software or use it for any commercial purposes
     52  1.1  jtc whatsoever.  All modified versions of the software that you redistribute must
     53  1.1  jtc clearly indicate your changes.
     54  1.1  jtc 
     55  1.1  jtc If you come across any bugs or make any changes you'd like to share please
     56  1.1  jtc send mail to me rather than posting to the net.
     57  1.1  jtc 
     58  1.1  jtc Enjoy. [But beware: boggle can be addictive!]
     59  1.1  jtc 
     60  1.1  jtc -----
     61  1.1  jtc Barry Brachman           | UUCP:    {alberta,uw-beaver,uunet}!
     62  1.1  jtc Dept. of Computer Science|           ubc-vision!ubc-csgrads!brachman
     63  1.1  jtc Univ. of British Columbia| Internet: brachman (a] cs.ubc.ca
     64  1.1  jtc Vancouver, B.C. V6T 1W5  |           brachman%ubc.csnet (a] csnet-relay.arpa
     65  1.1  jtc (604) 228-5010           | brachman (a] ubc.csnet
     66