mirror of
https://github.com/evennia/evennia.git
synced 2026-03-16 21:06:30 +01:00
81 lines
2.5 KiB
Markdown
81 lines
2.5 KiB
Markdown
|
|
```{warning}
|
|
|
|
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.
|
|
```
|
|
|
|
# Evennia Documentation
|
|
|
|
This is the manual of [Evennia](https://www.evennia.com), the open source Python `MU*` creation system. Use the Search bar on the left to find or discover interesting articles.
|
|
|
|
- [Introduction](./Evennia-Introduction.md) - what is this Evennia thing?
|
|
- [Getting help and Contribute](./Contributing.md) - when you get stuck or want to chip in
|
|
|
|
## Setup
|
|
|
|
- [Setup Quickstart](Setup/Setup-Overview.md#installation-and-running) - installing Evennia and get going
|
|
- [Starting, Stopping and Reloading](Setup/Start-Stop-Reload.md) - how to manage the Evennia server
|
|
- [Configuration](Setup/Setup-Overview.md#configuration) - how to set up your server the way you like it
|
|
- [Going public](Setup/Setup-Overview.md#going-public) - taking your game online
|
|
|
|
## Tutorials and Howtos
|
|
|
|
- [The Beginner Tutorial](Howtos/Howtos-Overview.md#beginner-tutorial) - learn the basics and build a small game (in progress)
|
|
- [Tutorials and Howto's](Howtos/Howtos-Overview.md#howtos) - mixed tutorials and help articles to learn Evennia
|
|
|
|
## Developing with Evennia
|
|
|
|
- [Core components](Components/Components-Overview.md) - the core building blocks of Evennia
|
|
- [Concepts](Concepts/Concepts-Overview.md) - larger-scale concepts and features
|
|
- [Coding](Coding/Coding-Overview.md) - coding and development hints and resources
|
|
- [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
|
|
|
|
## Contributions and Info
|
|
|
|
- [Contribs](Contribs/Contribs-Overview.md) - game-specific code and snippets to use for your game
|
|
- [Documentation - how to contribute](./Contributing-Docs.md) - if you want to help out
|
|
- [Links](./Links.md) - useful external links for extra reading
|
|
- [License](./Licensing.md) - Evennia licensing FAQ
|
|
|
|
----
|
|
|
|
## All Sections
|
|
|
|
<details>
|
|
<summary>
|
|
Click here to expand the full Documentation index.
|
|
</summary>
|
|
|
|
```{toctree}
|
|
:maxdepth: 3
|
|
|
|
Evennia-Introduction
|
|
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
|
|
|
|
```
|