evennia/docs/1.0-dev/index.html

175 lines
9 KiB
HTML
Raw Normal View History

2020-06-13 00:36:45 +02:00
<!DOCTYPE html>
2020-10-15 01:31:30 +02:00
<html>
2020-06-15 21:52:33 +02:00
<head>
<meta charset="utf-8" />
2021-05-16 00:06:01 +02:00
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
2020-06-15 21:52:33 +02:00
<title>Evennia Documentation &#8212; Evennia 1.0-dev documentation</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
2021-10-26 21:41:11 +02:00
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</script>
2020-06-13 23:31:27 +02:00
<link rel="shortcut icon" href="_static/favicon.ico"/>
2020-06-15 21:52:33 +02:00
<link rel="index" title="Index" href="genindex.html" />
2020-10-19 22:46:24 +02:00
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Evennia Introduction" href="Evennia-Introduction.html" />
2020-06-15 21:52:33 +02:00
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
2020-10-19 22:46:24 +02:00
<li class="right" >
<a href="Evennia-Introduction.html" title="Evennia Introduction"
accesskey="N">next</a> |</li>
2020-10-15 01:31:30 +02:00
<li class="nav-item nav-item-0"><a href="#">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Evennia Documentation</a></li>
2020-06-15 21:52:33 +02:00
</ul>
2021-06-23 18:58:26 +02:00
<div class="develop">develop branch</div>
2020-06-15 21:52:33 +02:00
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
2020-06-14 21:48:02 +02:00
2020-06-15 21:52:33 +02:00
<div class="admonition warning">
<p class="admonition-title">Warning</p>
2022-01-21 00:22:16 +00:00
<p>This is the <strong>WIP</strong> documentation of the
2020-11-14 11:55:52 +01:00
development branch of Evennia (v1.0-dev). The text is based on the
2021-10-26 21:41:11 +02:00
original Evennia <code class="docutils literal notranslate"><span class="pre">wiki</span> <span class="pre">&lt;https://github.com.evennia/evennia/wiki&gt;</span></code>_
2020-11-14 11:55:52 +01:00
but its being refactored heavily. There are known conversion issues
and missing links. This will slowly be ironed out as this is developed.</p>
<p>New things will be added to this version only, but for now you are best
off using v0.9.5 of the docs, or the original wiki. You have been warned.</p>
2020-06-13 00:36:45 +02:00
</div>
2021-10-26 21:41:11 +02:00
<section class="tex2jax_ignore mathjax_ignore" id="evennia-documentation">
2020-06-13 00:36:45 +02:00
<h1>Evennia Documentation<a class="headerlink" href="#evennia-documentation" title="Permalink to this headline"></a></h1>
2021-08-06 00:47:51 +02:00
<p>This is the manual of <a class="reference external" href="https://www.evennia.com">Evennia</a>, the open source Python
2020-07-14 00:21:00 +02:00
<code class="docutils literal notranslate"><span class="pre">MU*</span></code> creation system.</p>
<ul class="simple">
2021-10-26 21:41:11 +02:00
<li><p><a class="reference internal" href="Evennia-Introduction.html"><span class="doc std std-doc">Evennia Introduction</span></a></p></li>
2022-02-05 15:09:22 +00:00
<li><p><a class="reference internal" href="Setup/Installation.html"><span class="doc std std-doc">Install &amp; Setup Quickstart</span></a></p></li>
2021-10-26 21:41:11 +02:00
<li><p><a class="reference internal" href="Howto/Starting/Part1/Starting-Part1.html"><span class="doc std std-doc">Starting tutorial</span></a></p></li>
2022-01-08 16:38:41 +01:00
<li><p><a class="reference internal" href="Contributing.html"><span class="doc std std-doc">How to contribute and get help</span></a></p></li>
2020-07-14 00:21:00 +02:00
</ul>
2021-05-16 00:06:01 +02:00
<section id="main-sections">
2020-07-14 00:21:00 +02:00
<h2>Main sections<a class="headerlink" href="#main-sections" title="Permalink to this headline"></a></h2>
<ul class="simple">
2021-10-26 21:41:11 +02:00
<li><p><a class="reference internal" href="Setup/Setup-Overview.html"><span class="doc std std-doc">Server Setup, Maintenance and Life</span></a> - how to run, maintain and release</p></li>
<li><p><a class="reference internal" href="Howto/Howto-Overview.html"><span class="doc std std-doc">Tutorials and Howtos</span></a> - projects and hints for reaching particular effects and goals</p></li>
2020-07-14 00:21:00 +02:00
</ul>
<hr class="docutils" />
<ul class="simple">
2021-10-26 21:41:11 +02:00
<li><p><a class="reference internal" href="Components/Components-Overview.html"><span class="doc std std-doc">Core components</span></a> - the core building blocks of Evennia</p></li>
<li><p><a class="reference internal" href="Concepts/Concepts-Overview.html"><span class="doc std std-doc">Concepts</span></a> - larger-scale concepts and features</p></li>
2020-07-14 00:21:00 +02:00
</ul>
<hr class="docutils" />
2020-06-13 00:36:45 +02:00
<ul class="simple">
2021-10-26 21:41:11 +02:00
<li><p><a class="reference internal" href="Evennia-API.html"><span class="doc std std-doc">API</span></a> - the full API-reference, generated from source</p></li>
<li><p><a class="reference internal" href="Components/Default-Commands.html"><span class="doc std std-doc">Default Commands</span></a> - list of game commands included out of the box</p></li>
<li><p><a class="reference internal" href="Coding/Coding-Overview.html"><span class="doc std std-doc">Coding</span></a> - coding and development hints and resources</p></li>
<li><p><a class="reference internal" href="Contribs/Contrib-Overview.html"><span class="doc std std-doc">Contributions</span></a> - game-specific tools and code added by the community</p></li>
2020-06-13 00:36:45 +02:00
</ul>
2020-07-14 00:21:00 +02:00
<hr class="docutils" />
<ul class="simple">
2021-10-26 21:41:11 +02:00
<li><p><a class="reference internal" href="Links.html"><span class="doc std std-doc">Links</span></a> - useful links</p></li>
<li><p><a class="reference internal" href="toc.html"><span class="doc std std-doc">Table of Contents</span></a> - an alphabetical listing of all regular documentation pages</p></li>
2020-07-14 00:21:00 +02:00
</ul>
2021-10-26 21:41:11 +02:00
<p>Want to help improve the docs? See the page on <a class="reference internal" href="Contributing-Docs.html"><span class="doc std std-doc">Contributing to the docs</span></a>!</p>
2020-10-19 22:46:24 +02:00
<div class="toctree-wrapper compound">
</div>
2021-05-16 00:06:01 +02:00
</section>
</section>
2020-06-13 00:36:45 +02:00
2020-10-15 01:31:30 +02:00
<div class="clearer"></div>
2020-06-13 00:36:45 +02:00
</div>
</div>
</div>
2020-06-15 21:52:33 +02:00
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="#">
<img class="logo" src="_static/evennia_logo.png" alt="Logo"/>
</a></p>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
2020-07-14 00:21:00 +02:00
<p><h3><a href="#">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Evennia Documentation</a><ul>
<li><a class="reference internal" href="#main-sections">Main sections</a></li>
</ul>
</li>
</ul>
2020-10-19 22:46:24 +02:00
<h4>Next topic</h4>
<p class="topless"><a href="Evennia-Introduction.html"
title="next chapter">Evennia Introduction</a></p>
2020-06-15 21:52:33 +02:00
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="_sources/index.md.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
2021-03-06 01:37:43 +01:00
</div><h3>Links</h3>
<ul>
<li><a href="https://www.evennia.com">Home page</a> </li>
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
2021-08-06 00:47:51 +02:00
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
2021-08-06 00:53:44 +02:00
<a href="https://evennia.blogspot.com/">Blog</a>
2021-03-06 01:37:43 +01:00
</li>
</ul>
2020-06-15 21:52:33 +02:00
<h3>Versions</h3>
<ul>
<li><a href="index.html">1.0-dev (develop branch)</a></li>
</ul>
2020-06-13 00:36:45 +02:00
2020-06-15 21:52:33 +02:00
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
2020-10-19 22:46:24 +02:00
<li class="right" >
<a href="Evennia-Introduction.html" title="Evennia Introduction"
>next</a> |</li>
2020-10-15 01:31:30 +02:00
<li class="nav-item nav-item-0"><a href="#">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Evennia Documentation</a></li>
2020-06-15 21:52:33 +02:00
</ul>
2021-06-23 18:58:26 +02:00
<div class="develop">develop branch</div>
2020-06-15 21:52:33 +02:00
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2020, The Evennia developer community.
2020-10-15 01:31:30 +02:00
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
2020-06-15 21:52:33 +02:00
</div>
</body>
2021-05-16 00:06:01 +02:00
</html>