README

   1 #
   2 # Netris -- A free networked version of T*tris
   3 # Copyright (C) 1994-1996,1999  Mark H. Weaver <mhw@netris.org>
   4 #
   5 # This program is free software; you can redistribute it and/or
   6 # modify it under the terms of the GNU General Public License
   7 # as published by the Free Software Foundation; either version 2
   8 # of the License, or (at your option) any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program; if not, write to the Free Software
  17 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18 #
  19 # $Id: README,v 1.21 1999/05/16 06:56:22 mhw Exp $
  20 #
  21
  22 This is an unfinished developmental version of Netris, a free
  23 networked version of T*tris.  It is distributed under the terms
  24 of the GNU General Public License, which is described in the
  25 file "COPYING" included with this distribution.  For more
  26 information about GNU and the Free Software Foundation,
  27 check out <http://www.gnu.org/>.
  28
  29 In order to compile Netris you will need gcc.  You may be able to
  30 compile it with another ANSI C compiler, but if you attempt this
  31 you are on your own.
  32
  33 It's been built and tested on at least the following systems:
  34
  35     GNU/Linux
  36     FreeBSD 2.1.5, 2.1.6, 2.2
  37     NetBSD 1.0, 1.1
  38     SunOS 4.1.1, 4.1.3
  39     Solaris 2.3, 2.4
  40     HP-UX
  41
  42 If Netris doesn't build on your favorite system "out-of-the-box",
  43 I encourage you to mail me context diffs to fix the problem so I
  44 can fold it into the next version.
  45
  46 Netris should build cleanly on 64-bit systems such as the Alpha,
  47 although you might need to edit the definitions for netint{2,4},
  48 hton{2,4}, and ntoh{2,4} in netris.h.  Alpha users, please let me know
  49 how it goes, and send me diffs if needed!
  50
  51 See the FAQ in this directory if you have any problems.
  52
  53
  54 FIXED IN VERSION 0.52
  55 =====================
  56 Fixed a buffer overflow vulnerability discovered by
  57 Artur Byszko / bajkero <bajkero@security.hack.pl>
  58
  59
  60 NEW IN VERSION 0.5
  61 ==================
  62 Netris now specifically looks for ncurses and uses color if it's
  63 available, unless the -C option is given.  Thanks to A.P.J. van Loo
  64 <cobra@multiweb.nl> for providing code which these changes are
  65 based on.
  66
  67
  68 INSTALLATION
  69 ============
  70 1. Run "./Configure" to create a Makefile and config.h appropriate
  71    for your system.  If you have problems running Configure with
  72    your /bin/sh, try "bash Configure".
  73 2. Try "make"
  74 3. Make sure "./netris" works properly
  75 4. Copy "./netris" to the appropriate public directory
  76
  77 Try "./Configure -h" for more options
  78
  79
  80 RUNNING
  81 =======
  82 To start a two-player game, do the following:
  83  1. Player 1 types "netris -w".  This means "wait for challenge".
  84  2. Player 2 types "netris -c <host>" where <host> is the hostname
  85     of Player 1.  This means "challenge".
  86
  87 To start a one-player game, run netris with no parameters.
  88 One-player mode is a tad boring at the moment, because it never
  89 gets any faster, and there's no scoring.  This will be rectified
  90 at some point.  For now, use the "f" key (by default) to make the
  91 game go faster.  Speedups cannot be reversed for the remainder of
  92 the game.
  93
  94 Unlike standard T*tris, Netris gives you a little extra time after
  95 dropping a piece before it solidifies.  This allows you to slide the
  96 piece into a notch without waiting for it to fall the whole way down.
  97 In fact, you can even slide it off a cliff and it'll start falling
  98 again.  If you think it should automatically drop again in this case,
  99 use the -D option.
 100
 101 The keys are:
 102  'j'    left
 103  'k'    rotate
 104  'l'    right
 105  Space  drop
 106  'm'    down faster
 107  's'    toggle spying on the other player
 108  'p'    pause
 109  'f'    make game faster (irreversible)
 110  Ctrl-L redraw the screen
 111
 112 To see usage information, type "netris -h".
 113 To see distribution/warranty information, type "netris -H".
 114 To see the rules, type "netris -R".
 115 To use a port number other than the default, use the -p option.
 116
 117 You can remap the keys with "-k <keys>", where <keys> is a string
 118 containing the keys in the order listed above.  The default is:
 119     netris -k "jkl mspf^l"
 120
 121 You needn't specify all of the keys, for example -k "asd" will only
 122 change the main three keys.  "^x" notation can be used for control
 123 characters.
 124
 125 The "m" key moves the falling piece down one block, in addition to the
 126 usual step-down timer.  Use this in repetition when "drop" would go
 127 too far but you don't want to wait for the piece of fall.
 128
 129
 130 RUMORS
 131 ======
 132 At some point I may implement a server that Netris players can connect
 133 to to find other players with similar skill across the globe.
 134
 135 This version at least partially supports robots.  A rough description
 136 of the protocol is in "robot_desc", and a sample robot is in sr.c.
 137
 138 The source code should be viewed with tab stops set every 4 columns,
 139 eg, "less -x4 game.c".
 140
 141 # vi: tw=70 ai