Warning

This is the WIP documentation of the development branch of Evennia (v1.0-dev).

Unless you are beta-testing the new version, you are likely best off using v0.9.5 of the docs (switch to it in the bottom left) or the original github wiki. You have been warned.

Evennia Documentation¶

This is the manual of Evennia, the open source Python MU* creation system. Use the Search bar on the left to find or discover interesting articles.

Introduction - what is this Evennia thing?
Contributing and Getting help - when you get stuck or want to chip in

Setup¶

Installation - getting started
Running the Game - how to start, stop and reload Evennia
Updating the Server - how to update Evennia
Configuration - how to set up Evennia the way you like it
Going Online - bringing your game online

Tutorials and Howtos¶

The Beginner Tutorial - learn the basics and build a small game (in progress)
Tutorials and Howto’s - mixed tutorials and help articles to learn Evennia

Developing with Evennia¶

Coding with Evennia - coding and development hints and resources
Core components - the core building blocks of Evennia
Core Concepts - larger-scale concepts and features
API - the full API-reference, generated from source
Default Commands - list of game commands included out of the box

Contributions and Info¶

Contribs - game-specific code and snippets to use for your game
Documentation - how to contribute - if you want to help out
Links - useful external links for extra reading
License - Evennia licensing FAQ

All Sections¶

Click here to expand the full Documentation index.

Table of Contents

Next topic

Links

Versions