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