#
# Netris -- A free networked version of Tetris
# Copyright (C) 1994,1995  Mark Weaver <Mark_Weaver@brown.edu>
# 
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
# 
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
# 
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
#
# $Id: README,v 1.19 1995/07/11 07:50:45 mhw Exp $
#

This is an unfinished developmental version of Netris, a free
networked version of Tetris.  It is distributed under the terms
of the GNU General Public License, which is described in the
file "COPYING" included with this distribution.

In order to compile Netris you will need gcc.  You may be able to
compile it with another ANSI C compiler, but if you attempt this
you are on your own.

It's been built and tested on at least the following systems:

    NetBSD-1.0
    NetBSD-current July 9, 1995
    Linux
    SunOS 4.1.1, 4.1.3, 5.3
    HP-UX

If Netris doesn't build on your favorite system "out-of-the-box",
I encourage you to mail me context diffs to fix the problem so I
can fold it into the next version.

See the FAQ in this directory if you have any problems.

INSTALLATION
============
1. Run "./Configure" to create a Makefile and config.h appropriate
   for your system.  If you have problems running Configure with
   your /bin/sh, try "bash Configure".
2. Try "make"
3. Make sure "./netris" works properly
4. Copy "./netris" to the appropriate public directory

Try "./Configure -h" for more options

RUNNING
=======
To start a two-player game, do the following:
 1. Player 1 types "netris -w".  This means "wait for challenge".
 2. Player 2 types "netris -c <host>" where <host> is the hostname
    of Player 1.  This means "challenge".  Player 1 must be waiting
    when this command is typed.

To start a one-player game, run netris with no parameters.
One-player mode is a tad boring at the moment, because it never
gets any faster, and there's no scoring.  This will be rectified
at some point.

To get usage, type "netris -h".
To use a port number other than the default, use the -p option.
To provide compatibility with the older protocol version, use
  the -o option.

I plan on implementing a server that Netris players can connect to
to find other players with similar skill across the globe.

The keys are:
 'j'    left
 'k'    rotate
 'l'    right
 Space	drop
 'm'    down faster
 's'	toggle spying on the other player
 'p'	pause
 'f'	make game faster

You can remap the keys using the -k option.  The default is:
    netris -k "jkl mspf"

This version now at least partially supports robots.  A rough description
of the protocol is in "robot_desc", and a sample robot is in sr.c.