mirror of
https://github.com/evennia/evennia.git
synced 2026-03-16 21:06:30 +01:00
66 lines
3.2 KiB
Markdown
66 lines
3.2 KiB
Markdown
# Evennia MUD/MU\* Creation System
|
|
|
|
|
|
|
|
*Evennia* is a modern library for creating online multiplayer text games
|
|
(MUD, MUSH, MUX, MOO etc) in pure Python. It allows game creatores to
|
|
design and flesh out their games with great freedom.
|
|
|
|
http://www.evennia.com is the main hub tracking all things Evennia.
|
|
The extensive documentation is found
|
|
[here](https://github.com/evennia/evennia/wiki). Evennia is made
|
|
available under the [BSD license](https://github.com/evennia/evennia/wiki/Licensing).
|
|
|
|
|
|
## 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 an online text-based
|
|
game. 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.
|
|
|
|
Due to our Django and Twisted foundations, web integration is
|
|
easy since the same code that powers the game may also be used to run
|
|
its web presence.
|
|
|
|
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](https://github.com/evennia/evennia/wiki/Evennia-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](https://github.com/evennia/evennia/wiki/Getting-Started) page
|
|
is the way to go. Otherwise you could browse the [Documentation wiki](https://github.com/evennia/evennia/wiki) or why not come join
|
|
the [Evennia Community](http://www.evennia.com). Welcome!
|