README revision 1.1
11.1Sjtc
21.1SjtcBog is a fairly portable simulation of Parker Brother's game of Boggle and
31.1Sjtcis similar to the 4.[23] BSD "boggle" and Sun's "boggletool".
41.1SjtcBog has not been derived from any proprietary code.
51.1SjtcIt has been tested on the Sun 3 under SunOS 3.2 and on the Atari 1040ST (MWC).
61.1Sjtc
71.1SjtcWhat You Need
81.1Sjtc
91.1SjtcYou will need curses/termcap and a large word list.
101.1SjtcThe minix word list or /usr/dict/words will do nicely.
111.1SjtcThe word list must already be sorted (you can use "sort -c" to check).
121.1Sjtc
131.1SjtcContents
141.1Sjtc
151.1Sjtc	README		- this file
161.1Sjtc	Makefile
171.1Sjtc	bog.man		- half-hearted man page (use the game's help command)
181.1Sjtc	bog.h		- configuration and header info
191.1Sjtc	bog.c		- machine independent game code
201.1Sjtc	word.c		- machine independent word list routines
211.1Sjtc	help.c		- (curses) help routine
221.1Sjtc	mach.c		- (curses) display code
231.1Sjtc	prtable.c	- ditto
241.1Sjtc	timer.c		- machine dependent (os) input polling
251.1Sjtc	mkdict.c	- convert a word list to a bog dictionary
261.1Sjtc	mkindex.c	- create an index file for the bog dictionary
271.1Sjtc	showdict.c	- print a bog dictionary to stdout
281.1Sjtc
291.1SjtcPortability
301.1Sjtc
311.1Sjtc- I've tried to make bog.c (the program logic) independent of the I/O.
321.1Sjtc  My plan was to make it straightforward to adapt the game to run under a
331.1Sjtc  windowing system (eg., Suntools, GEM).  I have no plan to actually do this.
341.1Sjtc  I've stuck to a small subset of the curses routines.
351.1Sjtc- The program runs with the input in raw mode.
361.1Sjtc- If you want the running timer you must #define TIMER in bog.h
371.1Sjtc  and insert the input polling code in timer.c for your system.  There is
381.1Sjtc  already code there for BSD, SYSV, and ATARI.
391.1Sjtc
401.1SjtcSetup
411.1Sjtc
421.1Sjtc1. Check bog.h and Makefile and edit to fit your environment
431.1Sjtc2. "make all"
441.1Sjtc   This will make all the binaries and create the dictionary and index files
451.1Sjtc3. Move "dict", "dict.ind", and "helpfile" to where you specified in bog.h
461.1Sjtc4. Play away
471.1Sjtc
481.1SjtcDistribution
491.1Sjtc
501.1SjtcYou may use this software for your enjoyment and you may share it with others.
511.1SjtcYou may not sell this software or use it for any commercial purposes
521.1Sjtcwhatsoever.  All modified versions of the software that you redistribute must
531.1Sjtcclearly indicate your changes.
541.1Sjtc
551.1SjtcIf you come across any bugs or make any changes you'd like to share please
561.1Sjtcsend mail to me rather than posting to the net.
571.1Sjtc
581.1SjtcEnjoy. [But beware: boggle can be addictive!]
591.1Sjtc
601.1Sjtc-----
611.1SjtcBarry Brachman           | UUCP:    {alberta,uw-beaver,uunet}!
621.1SjtcDept. of Computer Science|           ubc-vision!ubc-csgrads!brachman
631.1SjtcUniv. of British Columbia| Internet: brachman@cs.ubc.ca
641.1SjtcVancouver, B.C. V6T 1W5  |           brachman%ubc.csnet@csnet-relay.arpa
651.1Sjtc(604) 228-5010           | brachman@ubc.csnet
66