AweMUD Next Generation
Copyright (C) 2003,2004 AwesomePlay Productions, Inc.
Sean Middleditch <elanthis@awesomeplay.com>
Frequently Asked Questions
------------------------------------------------------


1. What is AweMUD?
   ===============

   AweMUD is a text-based MUD server for fantasy based settings.

2. What is a MUD?
   ==============

   MUD is an acronym for Multi-User-Dungeon, a multiplayer on-line game.

3. How do I play AweMUD?
   =====================

   AweMUD itself isn't a game that you play.  It is a server, that allows
   people to host their own games on-line, using a powerful MUD infrastructure.
   If you know of a game being run on an AweMUD server, you simply need to
   connect to that game with a telnet client.  The game's homepage should have
   more information on using telnet to connect.

4. How complete is AweMUD?
   =======================

   The server is currently considered alpha code.  That means it is only useful
   to developers and very brave end-users.  The server is usable, i.e.  you can
   connect and play, although there are still several key features that need to
   be implemented.  Once we hit beta, you should be able to play excellent
   games over the AweMUD server.

   For information on current features, see the ChangeLog for the current
   release.  For information on planned features, see doc/Todo.  For release
   notes, see NEWS.

5. Is there a server where I can try AweMUD?
   =========================================

   Yes, there is.  A temporary/test server is usually running on the host
   game.awemud.net on port 4747.

6. Hey, I found a bug!
   ===================

   Please report any bugs to http://bugs.awemud.net.  You may also post
   feature requests in the bug tracker, or discuss ideas on the forums,
   at http://forums.awemud.net.

7. What are the software requirements of AweMUD?
   =============================================

   In order to build AweMUD, you need very little external software.  Your
   standard build tools (compiler, make tool, UNIX shell tools, etc.) are a
   necessity.  Specifically, you need a GNU Make compatible make program, and
   the GCC C++ compiler (version 3.1 or higher), with an up-to-date STL
   implementation.

   The only external libraries required by AweMUD are the Boehm GC and Scriptix.
   Boehm GC: http://www.hpl.hp.com/personal/Hans_Boehm/gc/
   Scriptix: http://www.awemud.net/scriptix/

   When compiling and installing the Boehm GC, be sure to pass the
   --enable-cplusplus option to the ./configure script.

   In order to build the documentation, you will need a properly installed
   xsltproc with a full set of DocBook XML stylesheets.  We use the Docbook
   tools (docbook2txt, docbook2html) for performing the builds.

   If you want to work on AweMUD as a coder, you'll likely also need the GNU
   autotools, specifically automake and autoconf.  You'll also need xsltproc
   for building the scripting interface, and you'll probably need the
   dependencies for Scriptix (flex and bison).

   Most of these packages come standard with popular GNU/Linux and UNIX
   operating systems.

   If you are using Mac OS X, you must install a UNIX software support system
   such as Fink (http://fink.sourceforge.net).  If you are using Fink, ensure
   that you have pkgconfig, libtool14 and libxslt installed.  You also must
   perform additional configuration after installing Fink to compile
   applications.
   (See http://fink.sourceforge.net/faq/usage-general.php#compile-myself)
   These instructions have a slight typo, however.  Change the line
     AC_LOCAL="-I/sw/share/aclocal"
   to
     AC_LOCAL="-I /sw/share/aclocal"
   That added space after the -I is required.  If you modify the configure.in
   or other build files, you'll have to re-run the ./bootstrap script,
   otherwise the aclocal script may fail.

8. AweMUD won't compile with GCC 2.9x!
   ===================================

   AweMUD only officially supports GCC versions 3.1 and higher.

9. AweMUD doesn't work after 'make install'
   ========================================

   When you install AweMUD using the 'make install' command, you will need to
   configure the server to proper operation.

   First, you must edit the installed awemud.conf file, and set all of the path
   and system entries to be correct for your system.  For the paths section,
   you generally only need to uncomment the individual entries.  You will
   usually want to uncomment the daemon: on entry in the system section of
   awemud.conf, as well.

   When running AweMUD, you must give it the path of the configuration file on
   the command line.  For example:

   $ /usr/local/games/bin/awemud /usr/local/games/etc/awemud/awemud.conf

   Also, be careful when upgrading an old installed version of AweMUD with a
   new version.  The 'make install' command will simply over-write any files
   you have edited in the installed copy.  You should make backups before
   running the 'make install' command.

10.How can I help?
   ===============

   AweMUD is in need of all sorts of different help - testers, builders,
   programmers, and so on.

   Testers
   -------
   If you want to test AweMUD, see the Temporary Server page.  There you can
   log into a test server that is sometimes up.  If you encounter any problems,
   bugs, typos, or weird behaviour, then please submit a bug report at the
   AweMUD Project Page.

   Builders
   --------
   AweMUD could really use some nifty worlds!  Additionally, builders can help
   out as testers.  We could use any advice on features you'd like to see, or
   OLC/building interfaces you think could be improved.  If there's a problem
   blocking you from making the world you've always wanted in AweMUD, we want
   to know about, so we can smash it.

   Programmers
   -----------
   There is plenty of work to be done by programmers! Ask on the awemud-devel
   mailing list for some pointers on what needs to be done.  AweMUD also needs
   to assistance of anyone interested in porting to new platforms.  The only
   tested platform for AweMUD is Linux.  I'd love to see it running on *BSD,
   Solaris, AIX, HP-UX, other UN*X's, Win32, BeOS, MacOS X, and all the other
   wonderful systems out there! AweMUD will also probably need some work to get
   it running on non 32-bit systems.

   Writers
   -------
   AweMUD documentation sucks.  A lot.  If anyone with technical writing skills
   wants to give this a shot, you will win a meta-physical medal.  ^,^
