evennia/docs/source/index.md

36 lines
1.6 KiB
Markdown
Raw Normal View History

2020-06-12 21:30:49 +02:00
2020-06-15 21:50:07 +02:00
```warning::
2020-06-12 23:50:47 +02:00
2020-06-15 21:50:07 +02:00
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-19 16:44:45 +02:00
2020-06-12 22:36:53. There are known conversion issues and missing links.
This will slowly be ironed out as this is developed.
2020-06-15 21:50:07 +02:00
For now you are best off using the original wiki, or the less changing v0.9.1
of these docs. You have been warned.
```
2020-06-12 21:30:49 +02:00
2020-04-07 23:13:24 +02:00
# Evennia Documentation
2020-04-05 21:23:33 +02:00
2020-06-14 11:45:10 +02:00
This is the manual of [Evennia](http://www.evennia.com), the open source Python
2020-06-19 16:44:45 +02:00
`MU*` creation system.
2020-06-19 21:13:51 +02:00
- [Evennia Introduction](Evennia-Overview)
2020-06-19 20:48:00 +02:00
- [Install & Setup Quickstart](Setup/Setup-Quickstart)
2020-06-19 16:44:45 +02:00
- [Begin the starting tutorial](Howto/Starting/Starting-Introduction)
- [How to get help](How-To-Get-And-Give-Help)
## Main sections
2020-04-07 23:13:24 +02:00
2020-06-19 21:13:51 +02:00
- [Server Setup, Maintenance and Life](Setup/Setup-Overview) - how to run, maintain and release
- [Tutorials and Howto's](Howto/Howto-Overview) - projects and hints for reaching particular effects and goals
2020-06-19 22:46:19 +02:00
- [Core components](Component/Component-Overview) - the core building blocks of Evennia
- [Concepts](Concept/Concept-Overview) - larger-scale concepts and features
- [Coding](Coding/Coding-Overview) - coding and development hints and resources
- [Contributions](Contrib/Contrib-Overview) - game-specific tools and code added by the community
2020-06-19 21:13:51 +02:00
- [API](Evennia-API) - the full API-reference, generated from source
- [Table of Contents](toc) - an alphabetical listing of all regular documentation pages
2020-06-19 16:44:45 +02:00
2020-06-19 21:13:51 +02:00
Want to help improve the docs? See the page on [Contributing to the docs](Contributing-Docs)!