
==============
=  Kmud 0.5  =
==============


Introduction
============
Kmud is a free graphical mud client for Linux/Unix under KDE. It is an useful and easy
to use program for all people that want a nice graphical interface instead of a simple
telnet for playing MUDs. The goal is to be the best mud client under KDE.
Kmud is published under the GNU General Public License.

Features
========
 - connection wizard / profiles
 - automapper
 - aliases
 - triggers
 - delimited input for entering several commands
 - input history (with intelligent browsing)
 - split screen in view history scrollback
 - numpad walking
 - speed walking
 - ansi/vt100 support with color customising
 - alternative input line & multiline input
 - logging facility
 - auto reconnect
 - MCCP (mud client compression protocol) support
 - plugin interface


How to obtain Kmud
==================
You can download Kmud from the Homepage at
http://www.kmud.de or via anoymous ftp from ftp://ftp.kmud.de/pub/kmud

If you really want the latest snapshot (no matter if it compiles or not),
you can checkout Kmud from the CVS-server.
Just enter the following lines:

cvs -d :pserver:anonymous@barney.cs.uni-potsdam.de:/home/cvs/kmud login
CVS password: ano
cvs -d :pserver:anonymous@barney.cs.uni-potsdam.de:/home/cvs/kmud checkout kmud

A snapshot of the development version in the CVS is made every night at 04:00:00 MET.
You can download it at ftp://ftp.kmud.de/pub/kmud/kmud-snapshot.tar.gz

Dont forget to do a "make -f Makefile.dist" when got Kmud from the CVS or as the
daily snapshot.

Requirements
============
You need Qt 1.44 and the KDE 1.1.x libs to be installed to compile Kmud correctly.

Compilation and installation
============================
In order to compile and install Kmud on your system, type the following in
the base directory of the Kmud distribution:

% ./configure
% make
% make install

Since Kmud uses autoconf you should have not trouble compiling it.
Should you run into problems please report them to bugs@kmud.de or to
the Kmud mailinglist at kmud@kmud.de. See the homepage (see above) how to subscribe to
that list.

Plugin development
==================
If you want to write a plugin for Kmud, please see the README file in the kmud/plugins
directory.


