evennia/docs/source/index.md

VERSION WARNING

This is the experimental and unstable documentation for the development branch of Evennia (v1.0-dev). It's based on converted docs from the evennia wiki at 2020-06-12 22:36:53. There are known conversion issues. This will slowly be ironed out as this is developed.

For now you are best off using the original wiki, or the less changing v0.9.1 of these docs. You have been warned.

  - Extra features
  - Another feature 

  Third feature: 
    Stuff to do 

  Fourth feature:
    Even more.

Evennia Documentation

This is the manual of Evennia, the open source Python MU* creation system. A link to the feature-request

  This is a particular note.

```warning:: This is an important thing!
  Especially this.

  More text here!

  And here.

  This in particular

  This feature was added here

  Use this thing instead.

     :emphasize-lines: 6-7,12
     :caption: An example code-block with everything turned on.
     :name: Full code-block example

     # Comment line
     from evennia import Command 

     class MyCommand(Command):
       """
       Usage: 
          cmd x
       """
       key = "cmd"

       def func(self):
         self.caller.msg(self.args)

     # Comment line
     import System
     System.run_emphasis_line
     # Long lines in code blocks create a auto horizontal scrollbar
     System.exit!

There is a lengthier introduction to read. You might also want to read about how to get and give help.

• The Getting Started page helps installing and starting Evennia for the first time.
• The Admin Docs covers running and maintaining an Evennia server.
• The Builder Docs helps for starting to build a game world using Evennia.
• The Developer Central describes how Evennia works and is used by coders.
• The Tutorials & Examples contains help pages on a step-by-step or tutorial format.
• The API documentation is created from the latest source code.
• The TOC lists all regular documentation pages.