Evennia is a MUD/MUX/MU* development system and server that aims to provide a functional bare-bones codebase for developers. Some of our main features are:
See the INSTALL file for help on setting up and running Evennia.
March 2012: Evennia's API has changed and simplified slightly in that the base-modules where removed from game/gamesrc. Instead admins are encouraged to explicitly create new modules under game/gamesrc/ when they want to implement their game - gamesrc/ is empty by default except for the example folders that contain template files to use for this purpose. We also added the ev.py file, implementing a new, flat API. Work is ongoing to add support for mud-specific telnet extensions, notably the MSDP and GMCP out-of-band extensions. On the community side, evennia's dev blog was started and linked on planet Mud-dev aggregator.
Nov 2011: After creating several different proof-of-concept game systems (in contrib and privately) as well testing lots of things to make sure the implementation is basically sound, we are declaring Evennia out of Alpha. This can mean as much or as little as you want, admittedly - development is still heavy but the issue list is at an all-time low and the server is slowly stabilizing as people try different things with it. So Beta it is!
Aug 2011: Split Evennia into two processes: Portal and Server. After a lot of work trying to get in-memory code-reloading to work, it's clear this is not Python's forte - it's impossible to catch all exceptions, especially in asynchronous code like this. Trying to do so results in hackish, flakey and unstable code. With the Portal-Server split, the Server can simply be rebooted while players connected to the Portal remain connected. The two communicates over twisted's AMP protocol.
May 2011: The new version of Evennia, originally hitting trunk in Aug2010, is maturing. All commands from the pre-Aug version, including IRC/IMC2 support works again. An ajax web-client was added earlier in the year, including moving Evennia to be its own webserver (no more need for Apache or django-testserver). Contrib-folder added.
Aug 2010: Evennia-griatch-branch is ready for merging with trunk. This marks a rather big change in the inner workings of the server, such as the introduction of TypeClasses and Scripts (as compared to the old ScriptParents and Events) but should hopefully bring everything together into one consistent package as code development continues.
May 2010: Evennia is currently being heavily revised and cleaned from the years of gradual piecemeal development. It is thus in a very 'Alpha' stage at the moment. This means that old code snippets will not be backwards compatabile. Changes touch almost all parts of Evennia's innards, from the way Objects are handled to Events, Commands and Permissions.
April 2010: Griatch takes over Maintainership of the Evennia project from the original creator Greg Taylor.
(Earlier revisions, with previous maintainer, go back to 2005)
This is still alpha software, but we try to give support best we can if you have questions. Make a post to the mailing list or chat us up on IRC. We also have a bug tracker if you want to report bugs. Finally, if you are willing to help with the code work, we much appreciate all help! Visit either of the following resources:
Evennia Webpage http://evennia.com
Evennia manual (wiki) http://code.google.com/p/evennia/wiki/Index
Evennia Code Page (See INSTALL text for installation) http://code.google.com/p/evennia/source/checkout
Bug tracker http://code.google.com/p/evennia/issues/list
IRC channel visit channel #evennia on the Freenode IRC network
| evennia | ev.py | ___game (start the server, settings) | ___gamesrc | ___(game-related dirs) | ___src | ___(engine-related dirs) | ||||
|---|---|---|---|---|---|---|---|---|---|---|
| ___contrib | ||||||||||
| ___docs | ||||||||||
| ___locales |
ev.py is the API file. It contains easy shortcuts to most of Evennia's functionality. Import ev into a python interpreter (like ipython) and explore what's available.
The game/ folder is where you develop your game. The root of this directory contains the settings file and the executables to start the server. Under game/gamesrc you will create the modules that will define your game.
src/ contains the Evennia library. As a normal user you should not edit anything in this folder - you will run into mercurial conflicts as we update things from our end. If you see code you like (such as that of a default command), copy&paste it into a new module in game/gamesrc/ instead. If you find that src/ doesn't support a functionality you need, issue a Feature request or a bug report appropriately. If you do add functionality or fix bugs in src yourself, please consider contributing it to Evennia main to help us improve!
contrib/ contains optional code snippets. These are potentially useful but are deemed to be too game-specific to be part of the server itself. Modules in contrib are not used unless you yourself decide to import and use them.
docs/ contain offline versions of the documentation, you can use python-sphinx to convert the raw data to nice-looking output for printing etc. The online wiki is however the most updated version of the documentation.
locales/ holds translations of the server strings to other languages than English.
Enjoy!