evennia/docs/source/index.md

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?
• Evennia in Pictures - a visual overview of Evennia
• 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
• Coding with Evennia - resources and hints for coding and development

The Evennia Library

• Core components - the core building blocks of Evennia
• Core Concepts - larger-scale concepts and features
• API - the full API-reference, generated from source

Contributions and Info

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

---

All Sections

Click here to expand the full Documentation index.

:maxdepth: 3

Evennia-Introduction
Evennia-In-Pictures
Setup/Running-Evennia
Setup/Updating-Evennia
Setup/Setup-Overview

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

:hidden:

Evennia-API
Licensing
Unimplemented