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