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