Begin
File:           konnmuck.tgz
Description:    MUD client for Photon
Keywords:       MUD, client
Version:        0.90
Entered-date:   30.04.2000
Author:         Klaus Schneider
Ported-by:      (none)
Original-site:  ftp://ds2.etech.fh-hamburg.de/pub/qnx/photon/konnmuck.tar.gz
Copying-policy: GPL
Supplemental:

                      KonnMuck MUD Client for Photon
                     (c) 1997,2000 by Klaus Schneider


KonnMuck is a client program for text-based MUDs for the Photon MicroGUI.
The current version is 0.90.

Now you may want to know what a MUD is because you have never heard about 
such a thing. Well, MUD stands for MultiUserDungeon. It is a virtual reality, 
an interactive roleplaying game in the internet.
There, you can find players from all over the world playing their characters.
Together with them, you can look around, have adventures or just talk or do 
mostly anything you can imagine.

This program implements Input/Output handling, session logging, automatic 
login, and a list where you can set up your prefered MUDs to connect to 
within only a few mouse klicks. The application can be configured via an 
easy to use configuration file.


The archive contains the following files:
-----------------------------------------

 README         - this readme file
 COPYING        - copying conditions
Binaries:
 konnmuck       - the executable
 konnreceive    - the receive program for konnmuck, called by konnmuck
 konnconnect    - the connect program for konnmuck, called by konnmuck
 konnmuck.en_GB - English translation of KonnMuck, must be installed into
                  the /usr/photon/translations directory
Source files:
 abapp.dfn      - the PhAB file
 konnmuck.ldb   - the language database file
 src/           - this directory contains the C source files
 wgt/           - this directory contains the widgets
 cfgdatei/      - a kind of library used to read the configuration file


Configuration file:
-------------------

It is called ".konnmuck.cfg" and is located in your home directory. A sample 
configuration file will be created if none is found. There will also be a 
dialog window where you can select your prefered language (until now, the 
only languages available are English and German; if you translate my 
application into another language, please send the translations to 
me - thanks).
Just look into the default configuration file to understand how it works, 
it is well commented and easy to understand (I hope).


COPYING CONDITIONS:
-------------------

See file COPYING.


Build instructions:
-------------------

At first, you have to parse the cfgdatei (configuration file reading) 
"library".
 (cd cfgdatei && make)
This will create the source and header files using lex and yacc.

Now, you can start PhAB and load the KonnMuck application. Use the 
"Generate" button in the Build & Run - Dialog to create the PhAB 
header files. Then, go into the source directory and type:
 make
This will build the executables.


History:
--------

NEW IN VERSION 0.90 (30.04.2000):
The full source code is available now!

New in version 0.20 (17.01.1998):
Now, there is a scrollbar available in the output window. Also, a minor 
bug in the "registration" stuff has been fixed: sometimes the program
seemed to "forget" a previous registration. The .konnmuck.data file now
has a new data structure. (But don't worry, the old one will be correctly 
converted if you start the new version for the first time. If it doesn't,
it is a bug!)

New in version 0.15:
A new feature has been added: you now can send commands stored in a file
to the MUD you are currently connected to. That prevents you from typing
in all commands. For example, if you want to transfer a longer description,
this saves connection time.
Just create a file with one command each line, just as you would type them
manually, and then, click on "Send file" in the "Connection" menu, select
the file you want to send and click on "Send". Ready.
In addition, some minor changes have been made, for example the correct
setting of the menu state.

New in version 0.14:
The bug to look for the connect and receive programs in the wrong
directory has been fixed. Also, the "receive" program is named
"konnreceive" and "connect" "konnconnect" to prevent troubles with
programs that happen to be named "connect" or "receive".

New in version 0.13:
All commands are saved in a list so that you can get them within two
mouse clicks.


PLEASE SEND ANY COMMENTS, BUG REPORTS OR OTHER QUESTIONS TO
klaus@ds3.etech.fh-hamburg.de

This program also has a web page at
http://ds2.etech.fh-hamburg.de/~klaus/konnmuck/
(German version) or 
http://ds2.etech.fh-hamburg.de/~klaus/konnmuck/konnmuck.engl.shtml
(English version).

If you wish to receive email when a new version is released, 
just fill out the form at 
http://ds2.etech.fh-hamburg.de/~klaus/konnmuck/register.html

-----------------------------------------------------------------------------

P.S.: You ask why the default language is German and nearly all comments 
      in the source files are German as well? Well, it is just because 
      I am a German-speaking person, so I developed my application in German. 
      When I decided to make it accessable to others, I translated it.

End
