evennia/docs/source/index.md

  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.

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

Setup

• Installation and running - getting started!
• Starting, Stopping and Reloading - how to manage the Evennia server
• Configuration - how to set up your server the way you like it
• Going public - taking 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

• Core components - the core building blocks of Evennia
• 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
• Coding - coding and development hints and resources

Contributions and Info

• Contribs - game-specific code and snippets to use for your game
• How to contribute to these docs - if you want to help out
• MU- and Evennia Links - useful external links for extra reading
• BSD License - Evennia licensing FAQ

---

All Sections

Click here to expand the full Documentation index.

:maxdepth: 3

Evennia-Introduction
Setup/Setup-Overview
Howtos/Howtos-Overview
Components/Components-Overview
Concepts/Concepts-Overview
Coding/Coding-Overview
Contribs/Contribs-Overview
Contributing
Contributing-Docs
Licensing
Links

:hidden:

Glossary
Evennia-API
Licensing
Unimplemented