
This is CoolMud 2.2.1 updated for newer systems.  

COOLMUD is a network-accessible, multi-user, programmable, interactive 
system designed for the construction of text-based adventure games, 
conferencing systems, and other collaborative software.

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

Required software:
 You need yacc and WinGDBM to compile these sources.  Linux, BSD and Cygwin 
 have packages available.  For the native windows environment I used the 
 following:
    BYacc - see http://gnuwin32.sourceforge.net/packages/byacc.htm
    WinGDBM - see http://sourcery.dyndns.org/wiki.cgi?MudPortsProject or
                  ftp://sourcery.dyndns.org/pub/ports/

 The makefiles assume that yacc reside somewhere in the system path
 and the WinGDBM headers and libraries and been installed in the
 directory you extracted this distribution to.
 
---------------------------------------------------------------------------

This release was compiled and tested on the following platforms:

* Microsoft Windows XP Service Pack 2 
  CYGWIN_NT-5.1 1.5.19s(0.136/4/2) using gcc 3.3.3 (cygming special)
  Borland C++ 5.5.1 for Win32 (free compiler release)
  Microsoft Visual C/C++ v7.1 (Visual C++ Toolkit 2003)

* FreeBSD 5.3-BETA4 
  gcc version 3.4.2 [FreeBSD] 20040728

* Gentoo Linux 2.6.10-gentoo-r6
  gcc version 3.3.5 20050130 (Gentoo Linux 3.3.5-r1, ssp-3.3.5-1, pie-8.7.7.1)

* Debian Linux 2.6.8-1-38  
  gcc version 3.3.5 (Debian 1:3.3.5=5)

* SuSE Linux 2.6.4-52-default
  gcc version 3.3.3 (SuSE Linux)

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

Pre Installation

 * Edit the src/config.h file and change any parameters you may want.
  
 * For Linux, FreeBSD or Cygwin you will want to make sure the LIBS definition 
   in the Makefile points to the correct dbm link library on your system.
 
 * For Borland or VisualC install the wingdbm package and copy ndbm.h and 
   ndbm.lib to the source directory.

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

Installation

  * For Linux and Cygwin - type 'make'.   

  * For FreeBSD - type 'gmake'.
  
  * For Windows using Borland - ensure the Borland compiler bin directory 
    is in your path, then type 'make -fMakefile.bor'.
    - All executables will be linked with the RTL and without debugging symbols.
      To link a static executable  - use 'make -f Makefile.bor -DSTATIC'
      To include debugging symbols - use 'make -f Makefile.bor -DDEBUG'
      Or for both                  - use 'make -f Makefile.bor -DDEBUG -DSTATIC'

  * For Windows using Digital Mars - ensure the Digital Mars bin directory 
    is in your path, then type 'make -fMakefile.dgm'.

  * For Windows using Microsoft Visual C - ensure your Visual C bin directory
    is in your path and your INCLUDE and LIB environment variables are setup
    correctly.
    - With Visual C++ 6.0 you may need to run the vcvars32.bat file.
    - With Visual C++ Toolkit 2003 and Platform SDK you may need to use both the
      setenv.cmd and vsvars32.bat
    Then type 'nmake -f makefile.vc'
    - To link with debugging information type 'set DEBUG=1' and then use
      'nmake -f makefile.vc'

  * For Windows using LCC - ensure the LCC bin directory is in your path, 
    then type 'make -f Makefile.lcc'.  

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

Post Installation

  * NOTE: The Borland pre-compiler cannot handle the COOL source code, so 
    I've included precompiled versions of the west and east database which
    Makefile.bor will build.  If you have gcc or cl you can use those as 
    pre-compilers (see Makefile and Makefile.vc).
    
  * You may want to edit and change the bin/east.cfg and bin/west.cfg files.
  
  * To start the servers change to the bin directory and start them with:
    cm west
    cm east
    
  * The default admin is Wizard and password is potrzebie. 

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

This code and my changes are released under the original conditions of the 
CoolMUD which are found in COPYRIGHT and COPYING, excepting files os.h and 
os.c which are distributed under less restrictive licenses noted therein.  

Enjoy.

Jon Lambert - aka Tyche
jlsysinc@alltel.net
