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

41 lines
2.4 KiB
Markdown

# 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](https://github.com/evennia/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](http://www.evennia.com), the open source Python `MU*` creation system.
You can [Search][search] the documentation as well as browse all pages alphabetically in the
[Index](Wiki-Index). If you have trouble with unclear documentation, please let us know on our
[mailing list][group], over [IRC][chat] or by dropping a note in our quick no-registration [online
suggestion box][form]!
There is [a lengthier introduction](Evennia-Introduction) to read. You might also want to read about
[how to get and give help](How-To-Get-And-Give-Help).
- The [Getting Started](Getting-Started) page helps installing and starting Evennia for the first time.
- The [Admin Docs](Administrative-Docs) covers running and maintaining an Evennia server.
- The [Builder Docs](Builder-Docs) helps for starting to build a game world using Evennia.
- The [Developer Central](Developer-Central) describes how Evennia works and is used by coders.
- The [Tutorials & Examples](Tutorials) contains help pages on a step-by-step or tutorial format.
- The [API](api:evennia) documentation is created from the latest source code.
- The [TOC](toc) lists all regular documentation pages.
[search]: https://www.google.com/cse/publicurl?cx=010440404980795145992:6ztkvqc46je
[group]: https://groups.google.com/forum/#%21forum/evennia
[chat]: http://tinyurl.com/p22oofg
[form]: http://tinyurl.com/c4tue23
[icon_new]: https://raw.githubusercontent.com/wiki/evennia/evennia/images/bright4.png
[icon_admin]: https://raw.githubusercontent.com/wiki/evennia/evennia/images/speedometer26.png
[icon_builder]: https://raw.githubusercontent.com/wiki/evennia/evennia/images/toolbox3.png
[icon_devel]: https://raw.githubusercontent.com/wiki/evennia/evennia/images/technical.png
[icon_tutorial]: https://raw.githubusercontent.com/wiki/evennia/evennia/images/living1.png
[icon_API]: https://raw.githubusercontent.com/wiki/evennia/evennia/images/python3.png