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