Overview

============================================================================
= Mame - Tournament Director for the Free Internet Chess Server            =
============================================================================

Copyright (C) 1995 Fred Baumgarten
Copyright (C) 1995-1998 Michael A. Long
Copyright (C) 1995-2002 Richard Archer

$Id$

Mame 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.

Mame 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 mame; if not, write to the Free Software Foundation, 
Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA


============================================================================
= About mame                                                               =
============================================================================

What is mame?
-------------

Mame stands for "manage me". It is a tournament director program for 
internet chess servers.

It is a C program designed to run in a well-behaved *nix environment.
It is known to work well on several varieties of Linux.


History of mame
---------------

Mame development commenced in 1995. At that time there was no freely 
available TD program. Tomato - used at FICS and written by darkside 
was not released to the public. Thus Mame was born.

Mame was originally written by Fred Baumgarten and was later enhanced 
by Michael Long (FICS) and Richard Archer (ZICS).


Where is mame?
--------------

Mame is now part of the freeics project. It is hosted on Sourceforge:
http://sourceforge.net/projects/freeics/


============================================================================
= Installation instructions                                                =
============================================================================

Configuration
-------------

A single installation of mame can run a TD on multiple ICS servers.
The server hostname must be the passed to mame as -h hostname. 
Each server must have a config directory, e.g.
/home/mame/hostname

This directory can contain several files:
managers.txt     - a list of manager handles (one per line)
news             - a news file
playerdb.txt     - the player database (currently not implemented)
mame.log         - a log of the current session
mame.log.archive - a log of previous sessions

You must configure mame so that it can find it's data files:

Edit mame.h and change MAME_DATA_PATH to the path on your system.

Edit the Makefile and change DATA_DIR= /home/mame/hostname
You may also wish to change the SBIN_DIR in the Makefile.

Edit mame_start.sh and change MAME_DATA_PATH and MAME_HOSTNAME.
Also change MAME_EXE if you changed SBIN_DIR.

You will need to manually create an additional /home/mame/hostname
directory and a new mame_start.sh file for each additional server to
which you wish mame to connect.


Building mame
-------------

make
make install

This will build the mame program and install it into SBIN_DIR and also 
create an initial data directory. Add yourself to managers.txt.

If you run into problems building mame, please have a hack at the code
and submit any required changes back to the project.


Running mame
------------

usage: mame [-h host] [-p port] [-c channel]
  -h gives host name to connect to
  -p gives port number that should be connected
  -c gives channel number, where mame should work

The distribution includes a shell (bash) script which launches mame.
This may be configured to be run from inittab. This way it will reconnect 
if the server restarts, mame is told to quit or *gasp* mame crashes.

The following inittab entry is known to work on a RedHat Linux box:
# keep mame tournament manager logged on
m1:2345:respawn:su chess -c "/home/mame/bin/mame_start.sh"


============================================================================
= Have fun!!!                                                              =
============================================================================