evennia/docs/source/index.md

45 lines
2.2 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-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.
```
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
`MU*` creation system. Want to help improve the docs? See the page on
2020-06-17 16:49:39 +02:00
[Contributing to the docs](Contributing-Docs)!
2020-04-07 23:13:24 +02:00
2020-06-17 16:49:39 +02:00
There is [a lengthier Evennia introduction](Evennia-Introduction) you may want
to read. It's also good to know [how to get help](How-To-Get-And-Give-Help).
2020-04-07 23:13:24 +02:00
2020-06-19 15:44:51 +02:00
- [Starting Tutorial](Howto/Starting/Starting-Introduction)
- The [Getting Started](Setup/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.
2020-06-19 15:44:51 +02:00
- The [API](Evennia-API) documentation is created from the latest source code.
2020-06-12 22:42:46 +02:00
- The [TOC](toc) lists all regular documentation pages.
2020-06-12 22:38:11 +02:00
2020-04-07 23:13:24 +02:00
[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