-------------------------------------------------------------------------------
nhtsclient README
-------------------------------------------------------------------------------

Info
----

nhtsclient is a ncurses-based client for the realtime multiplayer trading game
Holsham Traders. In the game you are a trader and send your transporters
from town to town and try to make as much money as possible by buying and
selling goods.

Read the documentation of htsserver, the Holsham Traders server application,
for more information about the game.


Release Notes
-------------

nhtsclient is still in a very early development stage. There's only a few
things which actually work...

From now on, you need at least GLib 1.3.2 to be able to compile nhtsclient.

You should remove all files from previous installations, especially the whole
directory ~/.nhtsclient, because we don't use it anymore.


Requirements
------------

 * htsserver 0.5.9 or better:
    http://htsserver.sourceforge.net

 * The ncurses library (curses might work aswell):
    ftp://ftp.gnu.org/pub/gnu/ncurses/

 * libmikmod 3.1.7 or better (for optional sound support):
    http://www.multimania.com/miodrag/mikmod/

 * GLib 1.3.2 or better:
    ftp://ftp.gtk.org/pub/gtk/v1.3/


Compiling and Installing
------------------------

 * Install GLib 1.3.x
    * Extract the GLib archive
    * Run ./configure with the --prefix=<PREFIX> argument, so you needn't
      replace your stable GLib 1.2.x with the beta stage GLib 1.3.x!
      The 1.3.x series is incompatible with the 1.2.x series, therefore
      your other applications wouldn't run/compile anymore.
    * make
    * make install

 * Add <PREFIX>/lib to the environment variable LD_LIBRARY_PATH:

     export LD_LIBRARY_PATH=<PREFIX>/lib

   Alternatively you can add <PREFIX>/lib to your global /etc/ld.so.conf and
   run ldconfig, but you need root permissions for this.

 * Set the environment-variable GLIB_CONFIG to <PREFIX>/bin/glib-config-2.0:

     export GLIB_CONFIG=<PREFIX>/bin/glib-config-2.0

   Alternatively, you can create a symbolic link <PREFIX>/bin/glib-config,
   which points to <PREFIX>/bin/glib-config-2.0:

     ln -s <PREFIX>/bin/glib-config-2.0 <PREFIX>/bin/glib-config

   This is necessary, because configure only searches for glib-config
   and *not* for glib-config-2.0 by default.

 * Install nhtsclient
    * Extract the nhtsclient archive
    * Edit src/defaults.h to set some compile-time options. (optional)
    * ./configure --help                 (to see the options you have)
    * ./configure --with-glib-prefix=<PREFIX>
    * make
    * make install


See INSTALL for more information.

If you have problems compiling, please send a bug-report.


Quickstart
----------

 * Find out where a Holsham traders server (htsserver) is running, or start
   your own.
 * Run nhtsclient.
 * Press 'C' to connect to the server. Use 1919 as the port.
   If the server runs on your own computer (i.e. localhost), you can just
   press 'c' and you won't be prompted for a server and a port.
 * Press 'a' to add a new player.
 * Press 'l' to login to the server with your newly created player.
 * Have fun.

 Press '?' for a short help screen.


License
-------

nhtsclient - a ncurses-based client for the trading game Holsham Traders
Copyright (C) 1999-2001 Uwe Hermann

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

See COPYING for details.


Mailinglists
------------

There are two mailing-lists at the moment:

 * nhtsclient-devel:

   Mailing-list for use by developers and contributors.

   http://lists.sourceforge.net/mailman/listinfo/nhtsclient-devel

 * nhtsclient-cvs:

   Information about every commit to the CVS-repository is automatically
   sent to this list. It should not be used for discussions. Its purpose
   is to keep you up-to-date with current development.

   http://lists.sourceforge.net/mailman/listinfo/nhtsclient-cvs


Homepage
--------

The official nhtsclient homepage is:
 http://nhtsclient.sourceforge.net/

You should also check the nhtsclient project-page on SourceForge:
 http://sourceforge.net/projects/nhtsclient/

--
Uwe Hermann <uh1763@hermann-uwe.de>
