evennia/evennia/trunk
Greg Taylor 2f2ea1b344 Lots of good stuff with this one:
* Added object methods, get_name() and get_ansiname().
* ANSI pretty much works as expected with objects.
* You can now use @open, @link, and @unlink like in MUX.
* Added a word_wrap() function to functions_general.py.
2006-12-25 03:30:41 +00:00
..
apps Lots of good stuff with this one: 2006-12-25 03:30:41 +00:00
doxygen Small tweak and addition of Doxygen config file. 2006-12-05 22:37:45 +00:00
__init__.py More re-arrangements. 2006-11-20 18:56:23 +00:00
ABOUT More re-arrangements. 2006-11-20 18:56:23 +00:00
ansi.py Lots of good stuff with this one: 2006-12-25 03:30:41 +00:00
cmdhandler.py Changing command functions from do_ to cmd_. Reads a little easier. 2006-12-05 23:38:57 +00:00
commands_general.py Lots of good stuff with this one: 2006-12-25 03:30:41 +00:00
commands_staff.py Lots of good stuff with this one: 2006-12-25 03:30:41 +00:00
commands_unloggedin.py Adaptations for SQLite. 2006-12-23 23:05:59 +00:00
events.py Converted the game configuration stuff to its own module. 2006-12-22 06:17:17 +00:00
functions_db.py Lots of good stuff with this one: 2006-12-25 03:30:41 +00:00
functions_general.py Lots of good stuff with this one: 2006-12-25 03:30:41 +00:00
gameconf.py Converted the game configuration stuff to its own module. 2006-12-22 06:17:17 +00:00
global_defines.py You can now @destroy objects and players. Fine-tuning of misc. stuff also. 2006-12-22 00:51:26 +00:00
manage.py More re-arrangements. 2006-11-20 18:56:23 +00:00
prepenv.sh More re-arrangements. 2006-11-20 18:56:23 +00:00
README Updating the README. 2006-12-05 19:36:45 +00:00
scheduler.py Converted the game configuration stuff to its own module. 2006-12-22 06:17:17 +00:00
server.py Getting ready for ANSI handling, some SQLite3 optimizations (hopefully). 2006-12-24 06:38:08 +00:00
session.py Finishing up the session manager transition. Uh, yeah, we now have a session manager instead of referencing the server for a session list. Much much better. 2006-12-22 01:42:24 +00:00
session_mgr.py Finishing up the session manager transition. Uh, yeah, we now have a session manager instead of referencing the server for a session list. Much much better. 2006-12-22 01:42:24 +00:00
sessions.py Converted the game configuration stuff to its own module. 2006-12-22 06:17:17 +00:00
settings.py Adaptations for SQLite. 2006-12-23 23:05:59 +00:00
TODO Converted the game configuration stuff to its own module. 2006-12-22 06:17:17 +00:00
urls.py More re-arrangements. 2006-11-20 18:56:23 +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.
  
Installation
------------
At this point in time, the codebase is changing so rapidly that writing
installation instructions is pretty much pointless. When we get to that stage
in development, we'll make sure to update this. But for the really determined
(or stubborn), here's a rough outline:

* Install Django.
* Copy the Evennia source somewhere.
* Set up your apache2.conf to point mod-python to the settings.py file if you
  want the web features.
* Edit settings.py with your database info.
* Run 'python manage.py syncdb' 
* Run prepenv.sh. This will start the MU* server on port 4000 by default. You
  may change this via the web interface or by editing the config table in SQL.
  
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 Code Page
  http://code.google.com/p/evennia/
  
* Evennia Google Group
  http://groups-beta.google.com/group/evennia?hl=en