= Mute Project =

The mute framework is a generic server/client code base that is tailored for 
creating MUD or mult-user client/server games. The server features several 
extenable points and has an easy to setup xml configuration file for creating 
the different services and for tuning performance. 

The basic idea of the server framework is to provide 3 different points where
you can plugin in your own code. These include the following:
 * '''Protocol''' -  handles the reading/writing of data to/from the socket connection
 * '''Event''' - represents a single request/response; very similar to a Http Request or Http Response objects from the java servlet world.
 * '''Controller''' - handles the processing of Event objects

More information can be found at the official [http://snarkydog.com/mute mute website].

=== Any Examples? ===

Currently the FargoChat system is using the mute framework to handle all of the server processing. 

=== Where to Start? ===

Documentation that can be found in the "docs" directory of the mute project.
 * the [http://svn.snarkydog.com/mute/ SVN] repository for the mute project
 * the Mute java api reference documentation 
 * the Mute step-by-step tutorial (ha ha yeah right)
 * Also the [http://trac.snarkydog.com/roadmap Project Roadmap] has more details on upcoming releases

=== What's Next? ===

Ideas and coding that should be done before next version is released sometime in 2011
 * Better XmlException errors, include locator info?
 * Improve the HTTP controller?
 * Use java annotations to control parsing (ignoring properties, using converters)
 * JMX management of internal objects? (Service, Server, threads)?
 * Finish documentation