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
|
|
|
|
2022-02-06 19:27:15 +01:00
|
|
|
This is the **WIP** documentation of the development branch of Evennia (v1.0-dev).
|
|
|
|
|
|
|
|
|
|
Unless you are beta-testing the new version, you are likely best
|
|
|
|
|
off using v0.9.5 of the docs (switch to it in the bottom left)
|
|
|
|
|
or the original github 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)
|
2022-01-08 16:30:31 +01:00
|
|
|
- [How to contribute and get help](./Contributing.md)
|
2020-06-19 16:44:45 +02:00
|
|
|
|
2022-11-10 23:15:54 +01:00
|
|
|
## Setup
|
2020-04-07 23:13:24 +02:00
|
|
|
|
2022-11-10 23:15:54 +01:00
|
|
|
- [Installation](Setup/Installation.md)
|
|
|
|
|
- [Starting, Stopping and Reloading](Setup/Start-Stop-Reload.md) - how to manage the Evennia server
|
2022-11-10 23:22:48 +01:00
|
|
|
- [Configurations](Setup/Setup-Overview.md) - how to run, maintain and release
|
2022-11-10 23:15:54 +01:00
|
|
|
|
|
|
|
|
## Howtos and Tutorials
|
|
|
|
|
|
|
|
|
|
- [The Beginner Tutorial](Howtos/Beginner-Tutorial/Beginner-Tutorial-Intro.md) - learn the basics and build a small game (in progress)
|
|
|
|
|
- [Tutorials and Howto's](Howtos/Howtos-Overview.md) - mixed tutorials to learn Evennia
|
|
|
|
|
|
|
|
|
|
## Developing with Evennia
|
2022-02-06 19:27:15 +01: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
|
|
|
|
|
- [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
|
2022-11-10 23:15:54 +01:00
|
|
|
|
|
|
|
|
## Contributions and Info
|
|
|
|
|
|
|
|
|
|
- [Contribs](Contribs/Contribs-Overview.md) - game-specific code and snippets to use for your game
|
2022-02-06 19:27:15 +01:00
|
|
|
- [How to contribute to these docs](./Contributing-Docs.md) - if you want to help out
|
2022-11-10 23:15:54 +01:00
|
|
|
- [Links](./Links.md) - useful links
|
|
|
|
|
- [Licensing](./Licensing.md) - Evennia licensing info (BSD)
|
|
|
|
|
|
|
|
|
|
----
|
2020-06-19 16:44:45 +02:00
|
|
|
|
2022-02-06 19:27:15 +01:00
|
|
|
## All Sections
|
2020-10-19 22:40:43 +02:00
|
|
|
|
2022-02-06 19:27:15 +01:00
|
|
|
<details>
|
|
|
|
|
<summary>
|
|
|
|
|
Click here to expand the full list of Documentation sections.
|
|
|
|
|
</summary>
|
2020-10-19 22:40:43 +02:00
|
|
|
|
2021-10-21 21:04:14 +02:00
|
|
|
```{toctree}
|
2022-02-06 19:27:15 +01:00
|
|
|
:maxdepth: 3
|
2020-10-19 22:40:43 +02:00
|
|
|
|
2021-10-21 21:04:14 +02:00
|
|
|
Evennia-Introduction
|
2022-02-06 19:27:15 +01:00
|
|
|
Setup/Setup-Overview
|
|
|
|
|
Howtos/Howtos-Overview
|
|
|
|
|
Components/Components-Overview
|
|
|
|
|
Concepts/Concepts-Overview
|
|
|
|
|
Coding/Coding-Overview
|
|
|
|
|
Contribs/Contribs-Overview
|
|
|
|
|
Contributing
|
|
|
|
|
Contributing-Docs
|
|
|
|
|
Licensing
|
|
|
|
|
Links
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
</details>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```{toctree}
|
|
|
|
|
:hidden:
|
|
|
|
|
|
|
|
|
|
Glossary
|
|
|
|
|
Evennia-API
|
|
|
|
|
Licensing
|
|
|
|
|
Unimplemented
|
2020-10-19 22:40:43 +02:00
|
|
|
|
2021-10-21 21:04:14 +02:00
|
|
|
```
|
