Python MUD/MUX/MUSH/MU* development system http://www.evennia.com
Find a file
Griatch 4cc8e57774 Adds better help functionality
- expanded help command, allowing adding, deleting and appending to help the help database
 - auto-doc functionality using the __doc__ property of commands
 - markup in help text for creation of multiple help subtopics at once
 - dynamic help index (use 'help topic' to get the normal mux topic list)
 /Starkiel
2009-04-11 23:17:44 +00:00
docs Further elaboration. 2009-01-30 04:19:43 +00:00
game Ah heck, why not one more? 2009-01-30 06:45:18 +00:00
src Adds better help functionality 2009-04-11 23:17:44 +00:00
tools Should be the finishing touches on MUX help importer. 2009-01-22 17:07:33 +00:00
__init__.py Re-organization. 2007-04-03 13:42:51 +00:00
ABOUT This still mentioned asynchat, updated now that we're using Twisted. 2008-06-15 02:48:21 +00:00
CODING_STYLE Adding a coding style document. A lot of the code doesn't follow this right now, we'll need to fix that! :) 2008-06-15 03:14:56 +00:00
INSTALL Updated installation instructions slightly. 2008-12-16 03:11:49 +00:00
LICENSE It's time to take care of the legal mumbo jumbo. We're going with a Modified Clarified Artistic License. Basically, you've got free reign of the software as long as you make any of the changes to the source you make publicly available. 2007-05-18 15:36:28 +00:00
README Remove reference to the non-existant test game from the README. 2008-12-16 03:12:20 +00:00
TODO Movin the TODO list to the google code group page. 2007-04-23 15:57:34 +00:00

About Evennia
-------------
Evennia is a proof-of-concept MU* server that aims to provide a functional
base for developers. While there are quite a few codebases that do the same
(and very well in many cases), we are taking a unique spin on the problem.
Some of our flagship features include (or will one day include):

* Extensive web integration.
* The ability to build/administer through a web browser.
* Shared accounts between the website and the game.
* Optional web-based character creation.
* Extremely easy-to-manipulate SQL database back-end via Django 
  (djangoproject.com)
* Simple and easily extensible design.
* Very granular permissions. Individual and group based.

The essential points here are the web integration and the SQL backing via
Django. The Django framework has database abstraction abilities that give us
many features free, such as:

* The codebase will run transparently on MySQL, SQLite, or Postgres
* At the time of this document's writing, our SQL-backed application here
  contains 0 lines of SQL. Django's database abstraction layer is absolutely
  simple yet very powerful.
* For any model we outline for the server's use, we have the ability to
  more or less automatically generate a web-based admin interface for it with
  two lines of code. This lets you Create, Update, or Delete entries.
* On the web-based side of things, features such as automatic form validation,
  abstraction of sessions and cookies, and access to whatever game data you
  desire are all attractive.
  
Support and Development
-----------------------
Since we're so early in development, we really can't hope to offer much support.
However, if you'd like to report bugs, make suggestions, or help with the
code work, visit either or both of the following links:

* Evennia Webpage
  http://evennia.com

* Evennia Code Page
  http://code.evennia.com