README

   1 #
   2 # Netris -- A free networked version of Tetris
   3 # Copyright (C) 1994,1995  Mark Weaver <Mark_Weaver@brown.edu>
   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.19 1995/07/11 07:50:45 mhw Exp $
  20 #
  21
  22 This is an unfinished developmental version of Netris, a free
  23 networked version of Tetris.  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.
  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     NetBSD-1.0
  34     NetBSD-current July 9, 1995
  35     Linux
  36     SunOS 4.1.1, 4.1.3, 5.3
  37     HP-UX
  38
  39 If Netris doesn't build on your favorite system "out-of-the-box",
  40 I encourage you to mail me context diffs to fix the problem so I
  41 can fold it into the next version.
  42
  43 See the FAQ in this directory if you have any problems.
  44
  45 INSTALLATION
  46 ============
  47 1. Run "./Configure" to create a Makefile and config.h appropriate
  48    for your system.  If you have problems running Configure with
  49    your /bin/sh, try "bash Configure".
  50 2. Try "make"
  51 3. Make sure "./netris" works properly
  52 4. Copy "./netris" to the appropriate public directory
  53
  54 Try "./Configure -h" for more options
  55
  56 RUNNING
  57 =======
  58 To start a two-player game, do the following:
  59  1. Player 1 types "netris -w".  This means "wait for challenge".
  60  2. Player 2 types "netris -c <host>" where <host> is the hostname
  61     of Player 1.  This means "challenge".  Player 1 must be waiting
  62     when this command is typed.
  63
  64 To start a one-player game, run netris with no parameters.
  65 One-player mode is a tad boring at the moment, because it never
  66 gets any faster, and there's no scoring.  This will be rectified
  67 at some point.
  68
  69 To get usage, type "netris -h".
  70 To use a port number other than the default, use the -p option.
  71 To provide compatibility with the older protocol version, use
  72   the -o option.
  73
  74 I plan on implementing a server that Netris players can connect to
  75 to find other players with similar skill across the globe.
  76
  77 The keys are:
  78  'j'    left
  79  'k'    rotate
  80  'l'    right
  81  Space  drop
  82  'm'    down faster
  83  's'    toggle spying on the other player
  84  'p'    pause
  85  'f'    make game faster
  86
  87 You can remap the keys using the -k option.  The default is:
  88     netris -k "jkl mspf"
  89
  90 This version now at least partially supports robots.  A rough description
  91 of the protocol is in "robot_desc", and a sample robot is in sr.c.