This is the file README for the QuakeWorld Modem Protocol version 0.3 alpha

What does it do ?

qw_mp forwards UDP frames from one host to another. Only one port
is supported. It is mainly designed to work in conjunction with
QuakeWorld as IP forwarder via modem instead of PPP or SLIP. It
also compress datastream using gzip's methods. Compression rate
is usually 45-35% of original size, so if you connected to your
provider at 28800 bps and your "rate" parameter in QuakeWorld was
set to "2400" you can safely set it to "5000". It effectively
improves gameplay quality. But your provider should have connection
to QW Server wide enough. Also I noticed that "rate" "5000" not
means 5000 chars-per-second, it is really ~2000 cps. You also can
improve pings by disabling of V.42 compression. Disabling of V.42 is
not recommended. (qw_mp now does packet checking, but disabling of V.42
can only degrade performance on high speeds).

How to use qw_mp ?

qw_mp can be run in three modes:
1. Forwarder (provider's host)
  $ qw_mp -s destination_server:destination_port
 destination_server may be dotted IP address, e.g. 204.204.211.103, or
 hostname, e.g. quake.somehost.com. destination_port is decimal number.

NOTE: you must have header netdb.h to compile qw_mp with hostname resolving
      capability. Otherwise only dotted IP addresses will be accepted.

2. Fake-server (your host)
  $ qw_mp [-p port]
  then type `connect your_host_addr' in QuakeWorld's console.

3. Reconnect Requestor
  when disconnected in QuakeWorld type
  $ qw_mp [-s your_host_addr:your_host_port] -r destination_server:destination_port

qw_mp support even more parameters:
1. -i and -o
    -i file_name -- input pipe name
    -o file_name -- output pipe name
  Designed for qw_mp testing - both Forwarder and Fake-server are run on
 your host.
2. -d and -o
    -d modem_device -- name of modem device
    -c chat_program -- name of chat program (if exits with 0 errorlevel
                        qw_mp tries to set up connection).
3. -t seconds.
  You can choose interval between ACK packets. Normally it set to 1 sec.
 Length of ACK pakcet is 6 bytes. If you have reliable connection you can
 increase this value, but 1 sec is usually acceptable.

Modem transfer protocol is more reliable in this version, but running it
without error-correction protocol is not recommended. Hardware error-correction
is always better than software. Thus gzip compression is better than V.42bis.

Please send all comments and bug reports to this e-mail:
   Valery Shchedrin <valery@forthpick.kiev.ua>

qw_mp is free software, you can redistribute it and/or modify it under
the terms of the GNU General Public License, a copy of which is
provided under the name COPYING.

Many thanks to all creators of gzip for their reliable and good
compressor, to creators of Quake & QuakeWorld for their cool game.

