xref: /netbsd-src/games/boggle/README (revision d4f96eeaffab232fd77852c5b03967ceda475d79)
1*d4f96eeaScgd$NetBSD: README,v 1.2 1995/03/21 12:14:21 cgd Exp $
286ef2669Sjtc
386ef2669SjtcBog is a fairly portable simulation of Parker Brother's game of Boggle and
486ef2669Sjtcis similar to the 4.[23] BSD "boggle" and Sun's "boggletool".
586ef2669SjtcBog has not been derived from any proprietary code.
686ef2669SjtcIt has been tested on the Sun 3 under SunOS 3.2 and on the Atari 1040ST (MWC).
786ef2669Sjtc
886ef2669SjtcWhat You Need
986ef2669Sjtc
1086ef2669SjtcYou will need curses/termcap and a large word list.
1186ef2669SjtcThe minix word list or /usr/dict/words will do nicely.
1286ef2669SjtcThe word list must already be sorted (you can use "sort -c" to check).
1386ef2669Sjtc
1486ef2669SjtcContents
1586ef2669Sjtc
1686ef2669Sjtc	README		- this file
1786ef2669Sjtc	Makefile
1886ef2669Sjtc	bog.man		- half-hearted man page (use the game's help command)
1986ef2669Sjtc	bog.h		- configuration and header info
2086ef2669Sjtc	bog.c		- machine independent game code
2186ef2669Sjtc	word.c		- machine independent word list routines
2286ef2669Sjtc	help.c		- (curses) help routine
2386ef2669Sjtc	mach.c		- (curses) display code
2486ef2669Sjtc	prtable.c	- ditto
2586ef2669Sjtc	timer.c		- machine dependent (os) input polling
2686ef2669Sjtc	mkdict.c	- convert a word list to a bog dictionary
2786ef2669Sjtc	mkindex.c	- create an index file for the bog dictionary
2886ef2669Sjtc	showdict.c	- print a bog dictionary to stdout
2986ef2669Sjtc
3086ef2669SjtcPortability
3186ef2669Sjtc
3286ef2669Sjtc- I've tried to make bog.c (the program logic) independent of the I/O.
3386ef2669Sjtc  My plan was to make it straightforward to adapt the game to run under a
3486ef2669Sjtc  windowing system (eg., Suntools, GEM).  I have no plan to actually do this.
3586ef2669Sjtc  I've stuck to a small subset of the curses routines.
3686ef2669Sjtc- The program runs with the input in raw mode.
3786ef2669Sjtc- If you want the running timer you must #define TIMER in bog.h
3886ef2669Sjtc  and insert the input polling code in timer.c for your system.  There is
3986ef2669Sjtc  already code there for BSD, SYSV, and ATARI.
4086ef2669Sjtc
4186ef2669SjtcSetup
4286ef2669Sjtc
4386ef2669Sjtc1. Check bog.h and Makefile and edit to fit your environment
4486ef2669Sjtc2. "make all"
4586ef2669Sjtc   This will make all the binaries and create the dictionary and index files
4686ef2669Sjtc3. Move "dict", "dict.ind", and "helpfile" to where you specified in bog.h
4786ef2669Sjtc4. Play away
4886ef2669Sjtc
4986ef2669SjtcDistribution
5086ef2669Sjtc
5186ef2669SjtcYou may use this software for your enjoyment and you may share it with others.
5286ef2669SjtcYou may not sell this software or use it for any commercial purposes
5386ef2669Sjtcwhatsoever.  All modified versions of the software that you redistribute must
5486ef2669Sjtcclearly indicate your changes.
5586ef2669Sjtc
5686ef2669SjtcIf you come across any bugs or make any changes you'd like to share please
5786ef2669Sjtcsend mail to me rather than posting to the net.
5886ef2669Sjtc
5986ef2669SjtcEnjoy. [But beware: boggle can be addictive!]
6086ef2669Sjtc
6186ef2669Sjtc-----
6286ef2669SjtcBarry Brachman           | UUCP:    {alberta,uw-beaver,uunet}!
6386ef2669SjtcDept. of Computer Science|           ubc-vision!ubc-csgrads!brachman
6486ef2669SjtcUniv. of British Columbia| Internet: brachman@cs.ubc.ca
6586ef2669SjtcVancouver, B.C. V6T 1W5  |           brachman%ubc.csnet@csnet-relay.arpa
6686ef2669Sjtc(604) 228-5010           | brachman@ubc.csnet
67