netris version 0.4

[netris.git] / README

diff --git a/README b/README
index ce6613138a6027b421ac18fdd9ee9cd1a128f27d..fc7d1558be58b92f24717e99e7d010e7ca19b400 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
 #
 #

-# Netris -- A free networked version of Tetris
-# Copyright (C) 1994,1995  Mark Weaver <Mark_Weaver@brown.edu>
+# Netris -- A free networked version of T*tris
+# Copyright (C) 1994,1995,1996  Mark H. Weaver <mhw@netris.org>

 # 
 # This program is free software; you can redistribute it and/or
 # modify it under the terms of the GNU General Public License
 # 
 # This program is free software; you can redistribute it and/or
 # modify it under the terms of the GNU General Public License


@@ -16,11 +16,11 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 #
 # 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 $
+# $Id: README,v 1.20 1996/02/09 08:22:06 mhw Exp $

 #
 
 This is an unfinished developmental version of Netris, a free
 #
 
 This is an unfinished developmental version of Netris, a free

-networked version of Tetris.  It is distributed under the terms
+networked version of T*tris.  It is distributed under the terms

 of the GNU General Public License, which is described in the
 file "COPYING" included with this distribution.
 
 of the GNU General Public License, which is described in the
 file "COPYING" included with this distribution.
 


@@ -30,18 +30,32 @@ you are on your own.
 
 It's been built and tested on at least the following systems:
 
 
 It's been built and tested on at least the following systems:
 

-    NetBSD-1.0
-    NetBSD-current July 9, 1995
+    NetBSD 1.0, 1.1

     Linux
     Linux

-    SunOS 4.1.1, 4.1.3, 5.3
+    SunOS 4.1.1, 4.1.3
+    Solaris 2.3, 2.4

     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.
 
     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.
 

+Netris should build cleanly on 64-bit systems such as the Alpha,
+although you might need to edit the definitions for netint{2,4},
+hton{2,4}, and ntoh{2,4} in netris.h.  Alpha users, please let me know
+how it goes, and send me diffs if needed!
+

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

+
+NEW IN VERSION 0.4
+==================
+- Netris now attempts to make the cursor invisible for terminals that
+  support it.  Xterm no, vt220 yes, vt100 maybe?
+- Ctrl-L (by default) will now redraw the screen.
+- Various cleanup and documentation changes.
+
+

 INSTALLATION
 ============
 1. Run "./Configure" to create a Makefile and config.h appropriate
 INSTALLATION
 ============
 1. Run "./Configure" to create a Makefile and config.h appropriate


@@ -53,26 +67,27 @@ INSTALLATION
 
 Try "./Configure -h" for more options
 
 
 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
 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.
+    of Player 1.  This means "challenge".

 
 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
 
 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.
+at some point.  For now, use the "f" key (by default) to make the
+game go faster.  Speedups cannot be reversed for the remainder of
+the game.

 
 

-I plan on implementing a server that Netris players can connect to
-to find other players with similar skill across the globe.
+Unlike standard T*tris, Netris gives you a little extra time after
+dropping a piece before it solidifies.  This allows you to slide the
+piece into a notch without waiting for it to fall the whole way down.
+In fact, if you can even slide it off a cliff and it'll start falling
+again.  If you think it should automatically drop again in this case,
+use the -D option.

 
 The keys are:
  'j'    left
 
 The keys are:
  'j'    left


@@ -82,10 +97,36 @@ The keys are:
  'm'    down faster
  's'   toggle spying on the other player
  'p'   pause
  'm'    down faster
  's'   toggle spying on the other player
  'p'   pause

- 'f'   make game faster
+ 'f'   make game faster (irreversable)
+ Ctrl-L        redraw the screen

 
 

-You can remap the keys using the -k option.  The default is:
-    netris -k "jkl mspf"
+To see usage information, type "netris -h".
+To see distribution/warranty information, type "netris -H".
+To see the rules, type "netris -R".
+To use a port number other than the default, use the -p option.

 
 

-This version now at least partially supports robots.  A rough description
+You can remap the keys with "-k <keys>", where <keys> is a string
+containing the keys in the order listed above.  The default is:
+    netris -k "jkl mspf^l"
+
+You needn't specify all of the keys, for example -k "asd" will only
+change the main three keys.  "^x" notation can be used for control
+characters.
+
+The "m" key moves the falling piece down one block, in addition to the
+usual step-down timer.  Use this in repetition when "drop" would go
+too far but you don't want to wait for the piece of fall.
+
+
+RUMORS
+======
+At some point I may implement a server that Netris players can connect
+to to find other players with similar skill across the globe.
+
+This version at least partially supports robots.  A rough description

 of the protocol is in "robot_desc", and a sample robot is in sr.c.
 of the protocol is in "robot_desc", and a sample robot is in sr.c.

+
+The source code should be viewed with tab stops set every 4 columns,
+eg, "less -x4 game.c".
+
+# vi: tw=70 ai