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 NEW IN VERSION 0.5
  55 ==================
  56 Netris now specifically looks for ncurses and uses color if it's
  57 available, unless the -C option is given.  Thanks to A.P.J. van Loo
  58 <cobra@multiweb.nl> for providing code which these changes are
  59 based on.
  60
  61
  62 INSTALLATION
  63 ============
  64 1. Run "./Configure" to create a Makefile and config.h appropriate
  65    for your system.  If you have problems running Configure with
  66    your /bin/sh, try "bash Configure".
  67 2. Try "make"
  68 3. Make sure "./netris" works properly
  69 4. Copy "./netris" to the appropriate public directory
  70
  71 Try "./Configure -h" for more options
  72
  73
  74 RUNNING
  75 =======
  76 To start a two-player game, do the following:
  77  1. Player 1 types "netris -w".  This means "wait for challenge".
  78  2. Player 2 types "netris -c <host>" where <host> is the hostname
  79     of Player 1.  This means "challenge".
  80
  81 To start a one-player game, run netris with no parameters.
  82 One-player mode is a tad boring at the moment, because it never
  83 gets any faster, and there's no scoring.  This will be rectified
  84 at some point.  For now, use the "f" key (by default) to make the
  85 game go faster.  Speedups cannot be reversed for the remainder of
  86 the game.
  87
  88 Unlike standard T*tris, Netris gives you a little extra time after
  89 dropping a piece before it solidifies.  This allows you to slide the
  90 piece into a notch without waiting for it to fall the whole way down.
  91 In fact, if you can even slide it off a cliff and it'll start falling
  92 again.  If you think it should automatically drop again in this case,
  93 use the -D option.
  94
  95 The keys are:
  96  'j'    left
  97  'k'    rotate
  98  'l'    right
  99  Space  drop
 100  'm'    down faster
 101  's'    toggle spying on the other player
 102  'p'    pause
 103  'f'    make game faster (irreversible)
 104  Ctrl-L redraw the screen
 105
 106 To see usage information, type "netris -h".
 107 To see distribution/warranty information, type "netris -H".
 108 To see the rules, type "netris -R".
 109 To use a port number other than the default, use the -p option.
 110
 111 You can remap the keys with "-k <keys>", where <keys> is a string
 112 containing the keys in the order listed above.  The default is:
 113     netris -k "jkl mspf^l"
 114
 115 You needn't specify all of the keys, for example -k "asd" will only
 116 change the main three keys.  "^x" notation can be used for control
 117 characters.
 118
 119 The "m" key moves the falling piece down one block, in addition to the
 120 usual step-down timer.  Use this in repetition when "drop" would go
 121 too far but you don't want to wait for the piece of fall.
 122
 123
 124 RUMORS
 125 ======
 126 At some point I may implement a server that Netris players can connect
 127 to to find other players with similar skill across the globe.
 128
 129 This version at least partially supports robots.  A rough description
 130 of the protocol is in "robot_desc", and a sample robot is in sr.c.
 131
 132 The source code should be viewed with tab stops set every 4 columns,
 133 eg, "less -x4 game.c".
 134
 135 # vi: tw=70 ai