evennia/docs/source/index.md

82 lines
2.5 KiB
Markdown
Raw Normal View History

```{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
2022-11-19 20:49:24 +01:00
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.
2022-11-24 00:01:57 +01:00
- [Introduction](./Evennia-Introduction.md) - what is this Evennia thing?
2022-11-19 20:49:24 +01:00
- [Getting help and Contribute](./Contributing.md) - when you get stuck or want to chip in
2022-11-19 01:48:49 +01:00
## Setup
2022-11-24 00:01:57 +01:00
- [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
2022-11-19 20:49:24 +01:00
- [Configuration](Setup/Setup-Overview.md#configuration) - how to set up your server the way you like it
2022-11-19 20:24:11 +01:00
- [Going public](Setup/Setup-Overview.md#going-public) - taking your game online
2022-11-21 00:33:36 +01:00
## Tutorials and Howtos
2022-11-21 08:33:32 +01:00
- [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
2022-11-24 00:01:57 +01:00
- [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
2022-11-19 01:48:49 +01:00
## Contributions and Info
- [Contribs](Contribs/Contribs-Overview.md) - game-specific code and snippets to use for your game
2022-11-24 00:01:57 +01:00
- [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
2022-11-19 01:48:49 +01:00
<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
```