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