evennia/docs/source/index.md

49 lines
2.4 KiB
Markdown
Raw Normal View History

2020-10-13 18:48:21 +02:00
```important::
2020-10-13 18:48:21 +02:00
This is the v0.9.5 documentation of Evennia, originally converted from the old
`evennia wiki <https://github.com/evennia/evennia/wiki>`_ at 2020-10-11 18:06:03.062022.
While we will fix outright mistakes, minor typos and visual conversion issues will **not** be
addressed in this version.
A new and refactored version of the docs is being prepared for version 1.0 of Evennia.
```
2020-06-12 22:38:11 +02:00
# Evennia Documentation
2020-10-11 19:31:05 +02:00
This is the manual of [Evennia](http://www.evennia.com), the open source Python `MU*` creation
system.
2020-10-11 20:43:57 +02:00
You can Search the documentation on the left. If you have trouble with unclear documentation, please
let us know on our [mailing list][group], over [IRC][chat] or by making a new [documentation issue](github:issue).
2020-07-12 20:01:44 +02:00
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).
2020-10-11 19:31:05 +02:00
- The [Getting Started](./Getting-Started) page helps installing and starting Evennia for the first
time.
2020-07-12 20:01:44 +02:00
- 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-10-13 18:48:21 +02:00
- The [Documentation-Contributing](./Contributing-Docs) page helps with how to write and contribute to these docs.
2020-10-13 09:58:15 +02:00
- The [API](./Evennia-API) documentation is created from the latest source code.
2020-10-11 20:43:57 +02:00
- The [TOC](./toc) lists all regular documentation pages.
[group]: https://groups.google.com/forum/#%21forum/evennia
[chat]: http://tinyurl.com/p22oofg
[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
2020-10-14 21:20:36 +02:00
```toctree::
:hidden:
Getting-Started
Administrative-Docs
Developer-Central
Tutorials
Contributing-Docs
```