1. Marcin Kasperski
  2. track/chessd/freeics/server

Overview

============================================================================
= FreeICS - A Free Internet Chess Server                                   =
============================================================================

Copyright (C) 1993 Richard V. Nash
Copyright (C) 1993-1998 The Gnu ICS development team at Onenet:
              DAV, foxbat, grimm, Hawk, hersco, loon, mann, 
              Shane, Sparky, vek, Dave Herscovici
Copyright (C) 1995-2000 The GICS development team:
              Klaus Knopper, Ulrich Schlechte, Oliver Brausch
Copyright (C) 1995-2002 Richard Archer
 
$Id$
 
FreeICS 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.
 
FreeICS 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 FreeICS; if not, write to the Free Software Foundation, 
Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA


============================================================================
= About FreeICS                                                            =
============================================================================

What is FreeICS?
----------------

FreeICS is a free implementation of an internet chess server.

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 FreeICS
------------------

In 1993 Richard Nash wrote the original code called FICS. This code 
was enhanced by the admins of the Onenet (now freechess.org) ICS server.
They released snapshots of the FICS code up until 1998 when they 
decided to cease distribution of their server code and the FICS source.

The German ICS server development team continued development of the 
FICS code based on the 1.6.2 release. GICS released their enhancements 
to FICS under the GPL. FreeICS used the GICS code as a base.

The Australian ICS server (ZICS) team has also made enhancements to 
the original FICS code, largely based on the 1.6.2 release. The ZICS
changes were merged into the GICS code in August 2002 to form FreeICS.


Where is FreeICS?
-----------------

The FreeICS project is hosted by Sourceforge:
http://sourceforge.net/projects/freeics/

The most recent version of FreeICS is usually only available by CVS.


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

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

You will need to create the directory structure for the runtime files 
required by the server (i.e. player files, help files, news files etc).
There should be a tar file in the distribution containing this data.

The file config.h contains most of the configurable options for FreeICS.
It is liberally commented, and it *will* need to be edited.


Building FreeICS
----------------

Edit the Makefile to suit your OS.

'make' should compile the binaries. There is no make install option. 
You will need to manually move the binaries to wherever you want them.

If freeics doesn't compile, please have a hack at it and submit your
patches back to the project. If you are porting to a new OS, please 
use $ifdef's wisely.

Running FreeICS
---------------

usage: fics [-p port]
  -p gives port number that should be listened on

The distribution includes a shell (bash) script which launches FreeICS.
This may be configured to be run from inittab. This way the server will 
restart if it is shutdown or *gasp* crashes.

The following inittab entry is known to work on a RedHat Linux box:
# keep the freeics server up and running
z1:2345:respawn:su chess -c "/home/freeics/scripts/freeics_autorun.bash"

Connect to the server using username: Knopper. No password.
Change the password, add a new user for yourself, make yourself admin.

You can use the fics_addplayer program or the addplayer command while
logged into your server as an admin.

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