CircleMUD v3.0 Documentation
----------------------------

This is some of the preliminary documentation for CircleMUD 3.0.  Note
that if you have WWW access, a much better source of documentation is
available on the Web: The CircleMUD Documentation Project, which can
be found at http://www.circlemud.org/~jelson/circle/cdp


Index of documents:

"The CircleMUD Builder's Manual" (version 1.14, 30 September 1996)
   building.txt.gz (gzipped ASCII text)
   building.ps.gz (gzipped postscript, 40 pages)

   This document describes all of the file formats required for world
   building (rooms, objects, mobiles, zones, and shops), and the values of
   all flags for mobile, object, and room bitvectors.  Note, this manual is
   meant to be a technical reference and not a tutorial, and is somewhat
   dense.  It is meant for area writers or anyone else who needs to
   understand the world file specifications.

"Using CircleMUD Socials"
   socials.txt (ASCII text file)

   Describes how to write socials for the MUD and how to use the act()
   codes ($n, $p, etc.)

"The Art of Debugging"
   hacker.txt.gz (gzipped ASCII text)
   hacker.ps.gz (gzipped Postscript, 4 pages)

   A short tutorial on the art and science of debugging written by Merc Diku
   MUD Coder emeritus, and all-around nice guy Michael Chastain.  This was
   originally part of the Merc DikuMUD distribution and has been included as
   part of CircleMUD with permission. 

"The CircleMUD Code Cross Reference"
   cxref-30bpl11.tar.gz
   A tar file of HTML files that make up the CircleMUD Code Cross Reference.
   Run against Circle 3.0 bpl11.

"How to Compile CircleMUD 3.0bpl11 Under Win95"
   win95.txt
   A brief set of instructions detailing the method needed to compile
   CircleMUD for Windows 95.

Contributed Documents Directory:
   contrib/

   This is a directory of documentation that CircleMUD users have submitted
and is not part of the official CircleMUD distribution; be warned that some
information might be incorrect or outdated.


-Jeremy Elson
7 Nov 1996