Introduced multichannel support (it was rather just a trivial fix).
[tetrinet.git] / README
1                             Tetrinet for Linux
2                             ------------------
3                   by Andrew Church <>
5                    branch of Petr Baudis <>
7                                Version 0.10-pb0
10 For general information on Tetrinet, consult the file tetrinet.txt (the
11 text file distributed with the original Windows version).
13 The following notes apply to the Linux version of Tetrinet:
16 Distribution/license information
17 --------------------------------
18 This program is public domain, and may be modified and distributed without
19 limitation.
22 Requirements
23 ------------
24 You must be using a 50-line text display to run this version of Tetrinet;
25 Xwindows is not yet supported.  One option is to open an xterm window in
26 Xwindows and resize it to be 50 lines high.  The other option (recommended)
27 is to use a 50-line text console.
29 To get a 50-line text console, if you use LILO to boot, add the following
30 line to the top of your /etc/lilo.conf file:
32 vga = extended
34 run /sbin/lilo, and reboot.  If you use a boot disk without LILO, insert it
35 into your floppy drive, give the following command:
37 rdev -v /dev/fd0 -2
39 and reboot.
41 Another option is to use the SVGATextMode program, available on Sunsite
42 ({http,ftp}:// and other places, to switch your
43 console to 50-line mode without rebooting.  You may also use that program
44 to set up a larger display (for example, I use 100x60); Tetrinet will
45 detect this and rearrange the display to make the best use of the available
46 space.
48 NOTE: Xwindows graphics display really isn't supported, despite the
49 presence of the "xwin.c" file!  Don't be fooled!  (The file is there to
50 remind me to implement Xwindows support someday.  Note how well it's
51 working.)
54 Compilation
55 -----------
56 Type "make".  This will generate two programs: "tetrinet" and
57 "tetrinet-server".  The former is the main program; the latter is a
58 standalone server.
61 Starting the client
62 -------------------
63 Tetrinet requires two command-line arguments: your nickname and the server
64 to connect to, in that order.  For example:
66         tetrinet MyNick
68 Tetrinet will function only as long as it remains connected to the server;
69 there is no "Client Settings" option as in the Windows version.  This may
70 be remedied in a future version.
72 You can also give Tetrinet any of the following options:
74         -fancy       Use "fancy" TTY graphics.  (Note that this will slow
75                      down redraws somewhat.)
77         -log <file>  Log network traffic to the given file.  All lines
78                      start with an absolute time (seconds) in brackets.
79                      Lines sent from the client to the server are prefixed
80                      with ">>>", and lines from the server to the client
81                      are prefixed with "<<<".  This could be used with a
82                      utility program to replay a game later on (though such
83                      a program is not currently included in the Tetrinet
84                      distribution.)
86         -noslide     Do not allow pieces to "slide" after being dropped
87                      with the spacebar.  (Normally, there is a short time
88                      after pressing the spacebar during which a piece can
89                      "slide" left or right before it solidifies.)
91         -server      Start the server instead of the client.  (See
92                      "Starting the server".)
94         -slide       Opposite of -noslide; allows pieces to "slide" after
95                      being dropped.  If both -slide and -noslide are given,
96                      -slide takes precedence.  If both -windows and -slide
97                      are given, this overrides the "no sliding" part of
98                      -windows without affecting the other changes in
99                      program behavior.
101         -windows     Behave as much like the Windows version of Tetrinet as
102                      possible.  (See "Differences from Windows Tetrinet".)
103                      Implies -noslide.
106 Starting the server
107 -------------------
108 There are two ways to start the Tetrinet server.  One way is to give the
109 "-server" option to the Tetrinet program:
111         tetrinet -server
113 The other is to run the "tetrinet-server" program.  Both of these are
114 exactly equivalent.  The server can be stopped with ^C or a "kill" command.
116 If you want the server to run in the background, use an "&" after the
117 command, for example:
119         tetrinet -server &
122 Configuring the server
123 ----------------------
124 The server is configured via the ".tetrinet" file in your home directory.
125 This contains all the settings for the server in a simple format.  The
126 following is a sample .tetrinet file:
128         winlist Alcan;0;3;1 AndrewK;0;2;1
129         classic 1
130         initiallevel 1
131         linesperlevel 2
132         levelinc 1
133         averagelevels 1
134         speciallines 1
135         specialcount 1
136         specialcapacity 18
137         pieces 14 14 15 14 14 14 15
138         specials 18 18 3 12 0 16 3 12 18
139         linuxmode 0
140         ipv6_only 0
142 Note that this file is automatically re-written at the end of a game or
143 when the server is terminated.  If you want to modify parameters for a
144 running server, send the server a HUP signal, using the command:
146         kill -HUP <pid-of-server>
148 where <pid-of-server> is the process ID of the server.  A simpler
149 alternative is:
151         killall -HUP tetrinet-server
153 Three of the configuration lines require special explanation.  The winlist
154 line is, as its name suggests, the winlist for the server; each parameter
155 contains four semicolon-separated fields:
156         name ; team ; points ; games
157 "team" is a flag which is either 1 if the entry is for a team or 0 if the
158 entry is for a player.  "points" is just the number of points for the
159 player (see the main Tetrinet documentation); "games" is the number of
160 games in which that player has participated since getting on the winlist.
162 The pieces line contains percentage frequencies for each type of piece.
163 The order is: bar, square, reverse-L (green), L (purple), Z (red),
164 S (blue), and T.
166 The specials line, likewise, contains percentage frequencies for each type
167 of special.  The order is:  A, C, N, R, S, B, G, Q, O.
169 The "linuxmode" setting selects whether the client should try to remain
170 compatible with Windows clients.  This only affects the winlist display; if
171 linuxmode is set to 1, the server will send the number of games played by
172 each player as well as points won.  This is set to zero by default.
174 If the "ipv6_only" setting is set to a nonzero value, the server will only
175 listen for IPv6 connections; if zero (default), the server will listen on
176 both IPv4 and IPv6 if possible.
179 Keys
180 ----
181 The display mode can be selected by one of the following keys:
183         F1          Show Fields
184         F2          Partyline
185         F3          Winlist
187 F10 can be used to quit at any time.
189 In Partyline mode, the following commands are available.  To use a command,
190 simply type the command and arguments into the Partyline input buffer and
191 press Return (just like IRC).
193         /team [name]  Set your team name.  If a name is not given, play
194                           alone.
195         /start        Start a game (if you are the first player on the
196                           server).
197         /stop, /end   Stop the game currently in progress (either command
198                           may be used).
199         /pause        Pause the game.
200         /unpause      Unpause the game.
201         /             Quote a following slash, for example:
202                           "/ /start starts a game."
204 The following keys are used for controls on the "Show Fields" screen:
206         Up, X       Rotate piece clockwise
207         Z           Rotate piece counterclockwise
208         Left        Move piece left
209         Right       Move piece right
210         Down        Accelerate piece downward
211         Space       Drop piece (note that by default, pieces can still
212                         "slide" after dropping!)
213         D           Discard the current (leftmost) special item
214         1..6        Use the current special item on the given player
215         T           Open a window for sending a message to other players
216         Ctrl-G      Close the text input window (text there is saved for
217                         the next time you press T)
219 The following keys are used for editing text, both in the Partyline screen
220 and in the text buffer on the Show Fields screen:
222         Left        Move cursor left one space
223         Right       Move cursor right one space
224         Ctrl-A      Move cursor to beginning of line
225         Ctrl-E      Move cursor to end of line
226         Backspace,  Delete character to left of cursor
227           Delete
228         Ctrl-D      Delete character under cursor
229         Ctrl-U      Delete entire line
230         Enter       Send text (closes input window in Show Fields mode)
233 Differences from Windows Tetrinet
234 ---------------------------------
235 Although Linux Tetrinet is designed to play more or less the same as the
236 original Windows version, there are a few differences; some of these are
237 simply "missing" features in the Linux version, and some are features I
238 have introduced into the Linux version because I believe they make the game
239 more interesting or fun.  Features marked with (*) below can all be
240 disabled with the -windows command-line option to make playing against
241 Windows opponents fairer.
243   - Messages about specials (i.e. in the Attack/Defense window) are not
244     numbered.
246   - If a Block Bomb is done on someone who has two "o" (bomb) specials
247     right next to each other, one of them will be sent flying rather than
248     exploding.  (This is a bug.)
250   - Blocks scattered by a Block Bomb will only go to empty spaces on the
251     board, rather than appearing on top of already-existing blocks.
252     "Holes" will not be scattered. (*)
254   - Pieces may go over the top of the board.  In the Windows version, a
255     player loses if at any time any square goes off the top of the board.
256     In this version, a player only loses if there is no room for the next
257     piece to enter the board.
259   - Pieces dropped (with the spacebar) can still slide left and right after
260     dropping.  Idea from Mark H. Weaver's Netris. (*)  This feature alone
261     can be disabled with the -noslide command-line option.  It can also be
262     enabled with -slide even if other Linux-specific features are disabled
263     with the -windows option.
265   - Blockquakes will cause blocks to wrap around the edge of the screen
266     rather than disappearing off the edge. (*)
268   - Blockquakes will never move rows more than one block to the left or
269     right.  (Can anyone determine how quakes work in the Windows version?)
271   - Specials collected will always appear at the end of the specials bar
272     (in the Windows version, they randomly appear at the beginning or the
273     end). (*)
276 Acknowledgements
277 ----------------
278 Tetrinet was originally written by St0rmCat, who has asked not to be
279 contacted with respect to Tetrinet.