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