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-11-14 11:53:15 +01:00
|
|
|
This is the **WIP** documentation for the
|
|
|
|
|
development branch of Evennia (v1.0-dev). The text is based on the
|
|
|
|
|
original Evennia `wiki <https://github.com.evennia/evennia/wiki>`_
|
|
|
|
|
but it's being refactored heavily. There are known conversion issues
|
|
|
|
|
and missing links. This will slowly be ironed out as this is developed.
|
|
|
|
|
|
|
|
|
|
New things will be added to this version only, but for now you are best
|
|
|
|
|
off using v0.9.5 of the docs, or the original wiki. You have been warned.
|
2020-06-15 21:50:07 +02:00
|
|
|
```
|
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
|
|
|
|
2021-06-23 20:05:25 +12:00
|
|
|
This is the manual of [Evennia](https://www.evennia.com), the open source Python
|
2020-06-20 12:16:42 +02:00
|
|
|
`MU*` creation system.
|
2020-06-19 16:44:45 +02:00
|
|
|
|
2020-07-11 00:14:13 +02:00
|
|
|
- [Evennia Introduction](./Evennia-Introduction)
|
2020-06-19 20:48:00 +02:00
|
|
|
- [Install & Setup Quickstart](Setup/Setup-Quickstart)
|
2020-07-31 18:40:48 +02:00
|
|
|
- [Starting tutorial](Howto/Starting/Part1/Starting-Part1)
|
2020-07-11 00:14:13 +02:00
|
|
|
- [How to get (and give) help](./How-To-Get-And-Give-Help)
|
2020-06-19 16:44:45 +02:00
|
|
|
|
2020-06-20 12:16:42 +02:00
|
|
|
## Main sections
|
2020-04-07 23:13:24 +02:00
|
|
|
|
2020-06-20 12:16:42 +02:00
|
|
|
- [Server Setup, Maintenance and Life](Setup/Setup-Overview) - how to run, maintain and release
|
2020-06-19 21:13:51 +02:00
|
|
|
- [Tutorials and Howto's](Howto/Howto-Overview) - projects and hints for reaching particular effects and goals
|
2020-07-11 10:41:33 +02:00
|
|
|
----
|
|
|
|
|
- [Core components](Components/Components-Overview) - the core building blocks of Evennia
|
|
|
|
|
- [Concepts](Concepts/Concepts-Overview) - larger-scale concepts and features
|
|
|
|
|
----
|
|
|
|
|
- [API](./Evennia-API) - the full API-reference, generated from source
|
2020-06-20 12:16:42 +02:00
|
|
|
- [Coding](Coding/Coding-Overview) - coding and development hints and resources
|
2020-07-12 17:36:01 +02:00
|
|
|
- [Contributions](Contribs/Contrib-Overview) - game-specific tools and code added by the community
|
2020-07-11 10:41:33 +02:00
|
|
|
----
|
|
|
|
|
- [Links](./Links) - useful links
|
2020-07-11 00:14:13 +02:00
|
|
|
- [Table of Contents](./toc) - an alphabetical listing of all regular documentation pages
|
2020-06-19 16:44:45 +02:00
|
|
|
|
2020-10-08 23:35:31 +02:00
|
|
|
Want to help improve the docs? See the page on [Contributing to the docs](./Contributing-Docs)!
|
2020-10-19 22:40:43 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
```toctree::
|
|
|
|
|
:hidden:
|
|
|
|
|
|
|
|
|
|
Evennia-Introduction
|
|
|
|
|
Setup/Setup-Quickstart
|
|
|
|
|
Howto/Starting/Part1/Starting-Part1
|
|
|
|
|
How-To-Get-And-Give-Help
|
|
|
|
|
Setup/Setup-Overview
|
|
|
|
|
Howto/Howto-Overview
|
|
|
|
|
Components/Components-Overview
|
|
|
|
|
Concepts/Concepts-Overview
|
|
|
|
|
Evennia-API
|
|
|
|
|
Coding/Coding-Overview
|
|
|
|
|
Contribs/Contrib-Overview
|
|
|
|
|
Links
|
|
|
|
|
|
|
|
|
|
```
|
