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