2020-06-13 00:36:45 +02:00
|
|
|
|
2021-10-26 21:41:11 +02:00
|
|
|
```{warning}
|
2020-06-13 00:36:45 +02:00
|
|
|
|
2022-01-21 00:22:16 +00:00
|
|
|
This is the **WIP** documentation of the
|
2021-10-26 21:41:11 +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:55:52 +01:00
|
|
|
and missing links. This will slowly be ironed out as this is developed.
|
|
|
|
|
|
2021-10-26 21:41:11 +02:00
|
|
|
New things will be added to this version only, but for now you are best
|
2020-11-14 11:55:52 +01:00
|
|
|
off using v0.9.5 of the docs, or the original wiki. You have been warned.
|
2020-06-15 21:52:33 +02:00
|
|
|
```
|
2020-06-13 00:36:45 +02:00
|
|
|
|
|
|
|
|
# Evennia Documentation
|
|
|
|
|
|
2021-08-06 00:47:51 +02:00
|
|
|
This is the manual of [Evennia](https://www.evennia.com), the open source Python
|
2020-07-14 00:21:00 +02:00
|
|
|
`MU*` creation system.
|
|
|
|
|
|
2021-10-26 21:41:11 +02:00
|
|
|
- [Evennia Introduction](./Evennia-Introduction.md)
|
2022-02-05 15:09:22 +00:00
|
|
|
- [Install & Setup Quickstart](Setup/Installation.md)
|
2021-10-26 21:41:11 +02:00
|
|
|
- [Starting tutorial](Howto/Starting/Part1/Starting-Part1.md)
|
2022-01-08 16:38:41 +01:00
|
|
|
- [How to contribute and get help](./Contributing.md)
|
2020-07-14 00:21:00 +02:00
|
|
|
|
|
|
|
|
## Main sections
|
|
|
|
|
|
2021-10-26 21:41:11 +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-14 00:21:00 +02:00
|
|
|
----
|
2021-10-26 21:41:11 +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-14 00:21:00 +02:00
|
|
|
----
|
2021-10-26 21:41:11 +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-14 00:21:00 +02:00
|
|
|
----
|
2021-10-26 21:41:11 +02:00
|
|
|
- [Links](./Links.md) - useful links
|
|
|
|
|
- [Table of Contents](./toc.md) - an alphabetical listing of all regular documentation pages
|
2020-07-14 00:21:00 +02:00
|
|
|
|
2021-10-26 21:41:11 +02:00
|
|
|
Want to help improve the docs? See the page on [Contributing to the docs](./Contributing-Docs.md)!
|
2020-10-19 22:46:24 +02:00
|
|
|
|
|
|
|
|
|
2021-10-26 21:41:11 +02:00
|
|
|
```{toctree}
|
|
|
|
|
:hidden:
|
2020-10-19 22:46:24 +02:00
|
|
|
|
2021-10-26 21:41:11 +02:00
|
|
|
Evennia-Introduction
|
|
|
|
|
Setup/Setup-Quickstart.md
|
|
|
|
|
Howto/Starting/Part1/Starting-Part1.md
|
2022-01-08 16:38:41 +01:00
|
|
|
Contributing.md
|
2021-10-26 21:41:11 +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:46:24 +02:00
|
|
|
|
2021-10-26 21:41:11 +02:00
|
|
|
```
|
