== Introduction
The ZNMud Engine a mud server written in Ruby based on the TeensyMUD engine.  The
original focus was to make a Zombie game but make it extensible so it could be used
for anything.  We have added a large combat system and each character/mobile is a
series of connected body parts... so we can have dismemberment :D

Any feature changes that don't break anything will be included into the main branch.
There is international support so we need translators.  Any contribution is welcome
including art and music.

== Download
The latest release can be found at http://znmud.com

== Documentation
The majority of the documentation is on the wiki http://wiki.znmud.com

== System Dependencies
=== Required
[Ruby 1.8.4] Can be obtained at the home of Ruby, http://www.ruby-lang.org.  It runs on most p
platforms.
[Log4r] All logging done through this now. Install from Ruby Gems, or http://log4r.sourceforge
.net/
[gettext] http://www.yotabanana.com/hiki/ruby-gettext.html?ruby-gettext

== Quick Start

First edit config.yaml to fit your needs.

Then you can just run: ruby ./znmud

Then connect to localhost (or your IP) on port 4000.  Type: ruby ./znmud --help for more options

== Server setup (Unix)

Verify autorun.sh fits your needs/ port settings etc.  Then you can just run:

 * nohup ./autorun.sh &>/dev/null &

There are a series of commands within the mud to control the behavior of this service:

* shutdown
* reboot
* reboot pause  (Wait 60 seconds before restarting)
* reboot update (Shutdown, update svn and restart)

== Contributors
:include:CONTRIBUTORS

== ZNMud Engine Specific License
GPL
:include:COPYING
Any direct derivative works from Teensy mud are under the Teensy Mud License (TML)
:include:LICENSE