mirror of https://github.com/evennia/evennia.git synced 2026-03-16 21:06:30 +01:00

Python MUD/MUX/MUSH/MU* development system http://www.evennia.com

based django engine game-development game-engine gamedev hacktoberfest moo mud multiplayer mush mux python text text-based text-based-adventure twisted webclient webserver

Find a file

Griatch 573847d80a Better handles very slow mud clients not sending line breaks together with their data input; this avoids a race condition where Evennia is much faster than the client. See #606 .		2014-10-24 10:26:59 +02:00
contrib	Deprecated the code= keyword of contrib/menusystem - this is replaced with a callback keyword where a function object is supplied rather than a code string. Code still works, but will give a deprecation warning in log. Cleaned up the code and fixed dynamic yes/no allocation. Should handle the remaining issues of #596 .	2014-10-23 01:27:31 +02:00
docs	One more trailing reference to that file fixed.	2014-09-28 12:56:56 -05:00
game	Some cleanup of the launcher.	2014-10-08 14:35:06 +02:00
locale	Updated the i18n readme file.	2014-08-20 10:40:15 +02:00
src	Better handles very slow mud clients not sending line breaks together with their data input; this avoids a race condition where Evennia is much faster than the client. See #606 .	2014-10-24 10:26:59 +02:00
.gitignore	Leftover news app cleanup, .gitignore updated.	2014-06-29 08:29:41 -05:00
__init__.py	PEP8 cleanup of the entire codebase. Unchanged are many cases of too-long lines, partly because of the rewrite they would require but also because splitting many lines up would make the code harder to read. Also the third-party libraries (idmapper, prettytable etc) were not cleaned.	2013-11-14 19:31:17 +01:00
CHANGELOG.txt	updated changelog.	2014-09-17 12:13:41 +02:00
CODING_STYLE.txt	Changing all text files to explicitly have .txt endings. This helps online code browsers to properly identify the files.	2012-09-02 13:05:47 +02:00
ev.py	Fixed __version__ reporting in ev.py.	2014-09-24 15:22:05 +02:00
INSTALL.txt	Remove references to migrate when first starting.	2014-09-28 12:28:43 -05:00
LICENSE.txt	Changed Evennia from "Modified Artistic License" to the more permissive BSD license.	2012-10-28 15:21:26 +01:00
README.md	Update README.md	2014-06-27 10:46:16 +02:00
requirements.txt	Updated the requirements.txt file to latest dependency versions	2014-09-22 13:25:07 +02:00
sitecustomize.py	Cleaning some unnecessary whitespace, overall cleanup of various source codes.	2012-03-30 23:47:22 +02:00
VERSION.txt	Made version string more terse by using the short hash instead of the full one.	2014-02-15 16:58:14 +01:00

README.md

Evennia MUD/MU* Creation System

Evennia is a Python-based MUD/MU* server/codebase using modern technologies. It is made available as open source under the very friendly BSD license. Evennia allows creators to design and flesh out text-based massively-multiplayer online games with great freedom.

http://www.evennia.com is the main hub tracking all things Evennia. The documentation wiki is found here.

Features and Philosophy

Evennia aims to supply a bare-bones MU* codebase that allows vast flexibility for game designers while taking care of all the gritty networking and database-handling behind the scenes. Evennia offers an easy API for handling persistent objects, time-dependent scripting and all the other low-level features needed to create a MU*. The idea is to allow the mud-coder to concentrate solely on designing the parts and systems of the mud that makes it uniquely fit their ideas.

Coding in Evennia is primarily done by normal Python modules, making the codebase extremely flexible. The code is heavily documented and you use Python classes to represent your objects, scripts and players. The database layer is abstracted away.

Evennia offers extensive connectivity options. A single server instance may offer connections over Telnet, SSH, SSL and HTTP. The latter is possible since Evennia is also its own web server: A default website as well as a browser-based comet-style mud client comes as part of the package (screenshot). Due to our Django and Twisted foundations, web integration is a snap since the same code that powers the game may also be used to run its web presence (you may use a third-party webserver too if you prefer though). Evennia in-game channels can also be interlinked with external IRC and IMC2 channels so players can chat with people "outside" the game.

Whereas Evennia is intended to be customized to almost any level you like, we do offer some defaults you can build from. The code base comes with basic classes for objects, exits, rooms and characters. There is also a default command set for handling administration, building, chat channels, poses and so on. This is enough to run a 'Talker' or some other social-style game out of the box. Stock Evennia is however deliberately void of any game-world-specific systems. So you won't find any AI codes, mobs, skill systems, races or combat stats in the default distribution (we might expand our contributions folder with optional plugins in the future though).

If this piqued your interest, there is also a lengthier introduction to Evennia to read.

Current Status

The codebase is currently in Beta. While development continues, Evennia is already stable enough to be suitable for prototyping and development of your own games.

More Information

To learn how to get your hands on the code base, the Getting started page is the way to go. Otherwise you could browse the Documentation wiki or why not come join the Evennia Community. Welcome!