evennia/docs/source/index.md
2020-06-12 23:50:47 +02:00

2.4 KiB

VERSION WARNING

This is the experimental and unstable documentation for the development branch of Evennia (v1.0-dev). It's based on converted docs from the evennia wiki at 2020-06-12 22:36:53. There are known conversion issues. This will slowly be ironed out as this is developed.

For now you are best off using the original wiki, or the less changing v0.9.1 of these docs. You have been warned.

Evennia Documentation

This is the manual of Evennia, the open source Python MU* creation system. You can Search the documentation as well as browse all pages alphabetically in the Index. If you have trouble with unclear documentation, please let us know on our mailing list, over IRC or by dropping a note in our quick no-registration online suggestion box!

There is a lengthier introduction to read. You might also want to read about how to get and give help.

  • The Getting Started page helps installing and starting Evennia for the first time.
  • The Admin Docs covers running and maintaining an Evennia server.
  • The Builder Docs helps for starting to build a game world using Evennia.
  • The Developer Central describes how Evennia works and is used by coders.
  • The Tutorials & Examples contains help pages on a step-by-step or tutorial format.
  • The API documentation is created from the latest source code.
  • The TOC lists all regular documentation pages.