2020-06-12 21:30:49 +02:00
|
|
|
|
2021-10-21 21:04:14 +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
|
2021-10-21 21:04:14 +02:00
|
|
|
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
|
2020-11-14 11:53:15 +01:00
|
|
|
and missing links. This will slowly be ironed out as this is developed.
|
|
|
|
|
|
2021-10-21 21:04:14 +02:00
|
|
|
New things will be added to this version only, but for now you are best
|
2020-11-14 11:53:15 +01:00
|
|
|
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
|
|
|
|
2021-10-21 21:04:14 +02:00
|
|
|
- [Evennia Introduction](./Evennia-Introduction.md)
|
|
|
|
|
- [Install & Setup Quickstart](Setup/Setup-Quickstart.md)
|
|
|
|
|
- [Starting tutorial](Howto/Starting/Part1/Starting-Part1.md)
|
2022-01-08 16:30:31 +01:00
|
|
|
- [How to contribute and get help](./Contributing.md)
|
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
|
|
|
|
2021-10-21 21:04:14 +02:00
|
|
|
- [Server Setup, Maintenance and Life](Setup/Setup-Overview.md) - how to run, maintain and release
|
|
|
|
|
- [Tutorials and Howto's](Howto/Howto-Overview.md) - projects and hints for reaching particular effects and goals
|
2020-07-11 10:41:33 +02:00
|
|
|
----
|
2021-10-21 21:04:14 +02:00
|
|
|
- [Core components](Components/Components-Overview.md) - the core building blocks of Evennia
|
|
|
|
|
- [Concepts](Concepts/Concepts-Overview.md) - larger-scale concepts and features
|
2020-07-11 10:41:33 +02:00
|
|
|
----
|
2021-10-21 21:04:14 +02:00
|
|
|
- [API](./Evennia-API.md) - the full API-reference, generated from source
|
|
|
|
|
- [Default Commands](Components/Default-Commands.md) - list of game commands included out of the box
|
|
|
|
|
- [Coding](Coding/Coding-Overview.md) - coding and development hints and resources
|
|
|
|
|
- [Contributions](Contribs/Contrib-Overview.md) - game-specific tools and code added by the community
|
2020-07-11 10:41:33 +02:00
|
|
|
----
|
2021-10-21 21:04:14 +02:00
|
|
|
- [Links](./Links.md) - useful links
|
|
|
|
|
- [Table of Contents](./toc.md) - an alphabetical listing of all regular documentation pages
|
2020-06-19 16:44:45 +02:00
|
|
|
|
2021-10-21 21:04:14 +02:00
|
|
|
Want to help improve the docs? See the page on [Contributing to the docs](./Contributing-Docs.md)!
|
2020-10-19 22:40:43 +02:00
|
|
|
|
|
|
|
|
|
2021-10-21 21:04:14 +02:00
|
|
|
```{toctree}
|
|
|
|
|
:hidden:
|
2020-10-19 22:40:43 +02:00
|
|
|
|
2021-10-21 21:04:14 +02:00
|
|
|
Evennia-Introduction
|
|
|
|
|
Setup/Setup-Quickstart.md
|
|
|
|
|
Howto/Starting/Part1/Starting-Part1.md
|
2022-01-08 16:30:31 +01:00
|
|
|
Contributing.md
|
2021-10-21 21:04:14 +02:00
|
|
|
Setup/Setup-Overview.md
|
|
|
|
|
Howto/Howto-Overview.md
|
|
|
|
|
Components/Components-Overview.md
|
|
|
|
|
Concepts/Concepts-Overview.md
|
|
|
|
|
Evennia-API.md
|
|
|
|
|
Components/Default-Commands.md
|
|
|
|
|
Coding/Coding-Overview.md
|
|
|
|
|
Contribs/Contrib-Overview.md
|
|
|
|
|
Links.md
|
2020-10-19 22:40:43 +02:00
|
|
|
|
2021-10-21 21:04:14 +02:00
|
|
|
```
|
