Games/cxhextris/README

   1 /*
   2  * hextris Copyright 1990 David Markley, dm3e@+andrew.cmu.edu, dam@cs.cmu.edu
   3  *
   4  * Permission to use, copy, modify, and distribute, this software and its
   5  * documentation for any purpose is hereby granted without fee, provided that
   6  * the above copyright notice appear in all copies and that both that
   7  * copyright notice and this permission notice appear in supporting
   8  * documentation, and that the name of the copyright holders be used in
   9  * advertising or publicity pertaining to distribution of the software with
  10  * specific, written prior permission, and that no fee is charged for further
  11  * distribution of this software, or any modifications thereof.  The copyright
  12  * holder make no representations about the suitability of this software for
  13  * any purpose.  It is provided "as is" without express or implied warranty.
  14  *
  15  * THE COPYRIGHT HOLDER DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  16  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  17  * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  18  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  19  * DATA, PROFITS, QPA OR GPA, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  20  * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  21  * PERFORMANCE OF THIS SOFTWARE.
  22  */
  23
  24 Welcome to the world of hextris...
  25
  26 If you are planning on using hextris, please send me mail so I can get
  27 you the latest updates. I'd just like to know who all the people are
  28 that are enjoying this game. Also, where this game is being enjoyed.
  29 Thanks a lot for looking at it, anyway...
  30
  31                 David (dm3e+hextris@andrew.cmu.edu)
  32
  33 If that address fails, please just send to:
  34         dm3e@andrew.cmu.edu, or
  35         dam@cs.cmu.edu
  36
  37 1) Installation
  38
  39         Before you install xhextris, you should modify these files,
  40 you should modify these variable in the Imakefile, or Makefile:
  41
  42 BIN             - So your binaries are where you want them.
  43 HEXFONTDIR      - So the hextris font is placed where you want it.
  44 HIGHSCOREDIR    - So the high score file is where you want it.
  45 HIGHSCOREEXT    - The name of the high score file.
  46
  47         You may also want to change:
  48
  49 CFLAGS          - Whatever flags you want.
  50 INCLDS          - The directories needed for all the #include statements.
  51 LIBS            - The library directories for any -l flags (-lX11)
  52
  53         Once you have changed the setting of these variables, take a
  54 look at header.h. If you see any #define(s) that you wish to change,
  55 do so. Everything depends upon header.h, so it is very troublesome to
  56 change something there later. The things you may wish to change are:
  57
  58 MAXROW          - The number of rows in your game.
  59 MAXCOLUMN       - The number of columns in your game.
  60 MAXHIGHSCORES   - The maximum number of high scores kept.
  61 MAXNAMELENGTH   - The maximum size of a users hextris nick name.
  62                 - Set by the user setting the environment variable: XHEXNAME
  63 MAXUSERIDLENGTH - The maximum size of a user id.
  64 MAXHIGHS        - The maximum number of high scores a user can have.
  65 FONTDIR         - The directory that your text font is in.
  66 FONTNAME        - The name of your text font.
  67
  68         Please also note that you will need to have the programs
  69 bdftosnf and mkfontdir in your path, for the hextris font to be
  70 installed correctly. If you do not have these available, use whatever
  71 tools you have to convert fonts from bdf format to snf format, and
  72 then set up the directory as a font directory. Modify the Makefile,
  73 or Imakefile accordingly.
  74
  75         At this point, you should have made all the modifications you
  76 needed. Please look around the code later. It's somewhat documented,
  77 and you should be able to change things with out too much mystery of
  78 what will actually happen. For now, if you changed the makefile,
  79 simply do the following:
  80
  81 make <cr>
  82
  83         BE WARNED!!! MODIFYING JUST THE MAKEFILE IS BAD!!! IF SOMEONE
  84 FOLLOWS THE REST OF THE INSTRUCTIONS HERE ABOUT IMAKE, ALL YOUR
  85 CHANGES WILL BE LOST!!!
  86
  87         If you modified the Imakefile, there are two ways to go about
  88 making xhextris:
  89
  90 1) The way not involving makefile.
  91
  92 imake -v <cr>
  93
  94 2) The way involving makefile.
  95
  96 imake -s Makefile -v <cr>
  97 make <cr>
  98
  99         If you have the build application available, of course you'll
 100 want to use the second option, and replace the make with build.
 101
 102 I apologize to the more experienced user for the detailed, and
 103 simplistic nature of this setup documentation. I wanted it to be as
 104 clear as possible to anyone, especially those just starting.
 105
 106 This is the first piece of software I've placed out on Internet, and
 107 it's not too far down on the list of C programs I've written. A game
 108 is a great way to learn C, as well as X.
 109
 110 2) Playing the game
 111
 112         To play the game, simply run it out of the area you placed it
 113 in, and use the keys described on the right side when it comes up.
 114
 115 3) Future of hextris
 116
 117         Hextris has been ported to X, and the Andrew Window Manager.
 118 The ports to mac and pc are under way. Hextris has been compiled for
 119 these system types: IBM RT, VAXstation 3100, DECstation 3100,
 120 SPARCstation 1, Sun 3/35, and macintosh running mach unix.
 121
 122         I would like to see if some big company would like to market
 123 this game on their little home/portable video game units. If you do,
 124 let me know.
 125
 126         This is the first release of Hextris (1.0), future releases
 127 will increase user friendly interfaces, and a more finished look.
 128 Proposed user friendly interfaces are:
 129
 130 The abilities to:
 131 Define the keys used to play.
 132 Define x window parameters (like -fg, -bg, -geom...etc).
 133 Define the users own set of pieces (including more/less hexes per
 134 piece).
 135
 136         In general, any suggestions would be greatly appreciated.
 137 Hextris is about one month old now (4/26/90). I'm sure it will change
 138 a lot in the near future. If you wish to be on the list of people that
 139 get the latest diffs, please send email to me.
 140
 141                 David (dm3e+hextris@andrew.cmu.edu)
 142
 143 P.S. If that address fails, please just send to:
 144         dm3e@andrew.cmu.edu, or
 145         dam@cs.cmu.edu
 146
 147
 148