evennia/docs/1.0-dev/Concepts/Concepts-Overview.html
Evennia docbuilder action 3fbd6c8647 Updated HTML docs.
2022-11-20 23:39:28 +00:00

283 lines
No EOL
16 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<title>Core Concepts &#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>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Async Process" href="Async-Process.html" />
<link rel="prev" title="Bootstrap Components and Utilities" href="../Components/Bootstrap-Components-and-Utilities.html" />
</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>
<li class="right" >
<a href="Async-Process.html" title="Async Process"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../Components/Bootstrap-Components-and-Utilities.html" title="Bootstrap Components and Utilities"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Core Concepts</a></li>
</ul>
<div class="develop">develop branch</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<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>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Core Concepts</a><ul>
<li><a class="reference internal" href="#general-concepts">General concepts</a></li>
<li><a class="reference internal" href="#access">Access</a></li>
<li><a class="reference internal" href="#extending-the-server">Extending the Server</a></li>
<li><a class="reference internal" href="#text-processing">Text processing</a></li>
<li><a class="reference internal" href="#web-features">Web features</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="../Components/Bootstrap-Components-and-Utilities.html"
title="previous chapter">Bootstrap Components and Utilities</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="Async-Process.html"
title="next chapter">Async Process</a></p>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/Concepts/Concepts-Overview.md.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</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>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Blog</a>
</li>
</ul>
<h3>Versions</h3>
<ul>
<li><a href="Concepts-Overview.html">1.0-dev (develop branch)</a></li>
<ul>
<li><a href="../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
</ul>
</div>
</div>
<div class="bodywrapper">
<div class="body" role="main">
<section class="tex2jax_ignore mathjax_ignore" id="core-concepts">
<h1>Core Concepts<a class="headerlink" href="#core-concepts" title="Permalink to this headline"></a></h1>
<p>This documentation cover more over-arching concepts of Evennia, often involving many <a class="reference internal" href="../Components/Components-Overview.html"><span class="doc std std-doc">Core Components</span></a> acting together.</p>
<section id="general-concepts">
<h2>General concepts<a class="headerlink" href="#general-concepts" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="Async-Process.html">Async Process</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Async-Process.html#synchronous-versus-asynchronous">Synchronous versus Asynchronous</a></li>
<li class="toctree-l2"><a class="reference internal" href="Async-Process.html#customizing-asynchronous-operation">Customizing asynchronous operation</a></li>
<li class="toctree-l2"><a class="reference internal" href="Async-Process.html#delay">delay</a></li>
<li class="toctree-l2"><a class="reference internal" href="Async-Process.html#the-interactive-decorator">The &#64;interactive decorator</a></li>
<li class="toctree-l2"><a class="reference internal" href="Async-Process.html#assorted-notes">Assorted notes</a></li>
<li class="toctree-l2"><a class="reference internal" href="Async-Process.html#further-reading">Further reading</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Soft-Code.html">Soft Code</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Soft-Code.html#examples-of-softcode">Examples of Softcode</a></li>
<li class="toctree-l2"><a class="reference internal" href="Soft-Code.html#problems-with-softcode">Problems with Softcode</a></li>
<li class="toctree-l2"><a class="reference internal" href="Soft-Code.html#changing-times">Changing Times</a></li>
<li class="toctree-l2"><a class="reference internal" href="Soft-Code.html#our-solution">Our Solution</a></li>
<li class="toctree-l2"><a class="reference internal" href="Soft-Code.html#your-solution">Your Solution</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Using-MUX-as-a-Standard.html">Using MUX as a Standard</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Using-MUX-as-a-Standard.html#documentation-policy">Documentation policy</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Messagepath.html">Messagepath</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Messagepath.html#the-ingoing-message-path">The ingoing message path</a></li>
<li class="toctree-l2"><a class="reference internal" href="Messagepath.html#the-outgoing-message-path">The outgoing message path</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="OOB.html">OOB</a><ul>
<li class="toctree-l2"><a class="reference internal" href="OOB.html#briefly-on-input-outputcommands">Briefly on input/outputcommands</a></li>
<li class="toctree-l2"><a class="reference internal" href="OOB.html#sending-and-receiving-an-oob-message">Sending and receiving an OOB message</a></li>
<li class="toctree-l2"><a class="reference internal" href="OOB.html#supported-oob-protocols">Supported OOB protocols</a></li>
</ul>
</li>
</ul>
</div>
</section>
<section id="access">
<h2>Access<a class="headerlink" href="#access" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="Multisession-modes.html">Multisession modes</a></li>
<li class="toctree-l1"><a class="reference internal" href="Building-Permissions.html">Building Permissions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Building-Permissions.html#the-super-user">The super user</a></li>
<li class="toctree-l2"><a class="reference internal" href="Building-Permissions.html#assigning-permissions">Assigning permissions</a></li>
<li class="toctree-l2"><a class="reference internal" href="Building-Permissions.html#quelling-your-permissions">Quelling your permissions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Guest-Logins.html">Guest Logins</a></li>
<li class="toctree-l1"><a class="reference internal" href="Banning.html">Banning</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Banning.html#creating-a-ban">Creating a ban</a></li>
<li class="toctree-l2"><a class="reference internal" href="Banning.html#booting">Booting</a></li>
<li class="toctree-l2"><a class="reference internal" href="Banning.html#summary-of-abuse-handling-tools">Summary of abuse-handling tools</a></li>
</ul>
</li>
</ul>
</div>
</section>
<section id="extending-the-server">
<h2>Extending the Server<a class="headerlink" href="#extending-the-server" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="Custom-Protocols.html">Custom Protocols</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Custom-Protocols.html#adding-custom-protocols">Adding custom Protocols</a></li>
<li class="toctree-l2"><a class="reference internal" href="Custom-Protocols.html#writing-your-own-protocol">Writing your own Protocol</a></li>
<li class="toctree-l2"><a class="reference internal" href="Custom-Protocols.html#assorted-notes">Assorted notes</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Bootstrap-%26-Evennia.html">Bootstrap &amp; Evennia</a></li>
<li class="toctree-l1"><a class="reference internal" href="Bootstrap-%26-Evennia.html#what-is-bootstrap">What is Bootstrap?</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Bootstrap-%26-Evennia.html#the-layout-system">The Layout System</a></li>
<li class="toctree-l2"><a class="reference internal" href="Bootstrap-%26-Evennia.html#more-bootstrap">More Bootstrap</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="New-Models.html">New Models</a><ul>
<li class="toctree-l2"><a class="reference internal" href="New-Models.html#overview-of-database-tables">Overview of database tables</a></li>
<li class="toctree-l2"><a class="reference internal" href="New-Models.html#adding-a-new-database-table">Adding a new database table</a></li>
<li class="toctree-l2"><a class="reference internal" href="New-Models.html#defining-your-models">Defining your models</a></li>
<li class="toctree-l2"><a class="reference internal" href="New-Models.html#creating-a-new-model-instance">Creating a new model instance</a></li>
<li class="toctree-l2"><a class="reference internal" href="New-Models.html#using-the-sharedmemorymodel-parent">Using the <code class="docutils literal notranslate"><span class="pre">SharedMemoryModel</span></code> parent</a></li>
<li class="toctree-l2"><a class="reference internal" href="New-Models.html#searching-for-your-models">Searching for your models</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Zones.html">Zones</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Zones.html#zones-in-evennia">Zones in Evennia</a></li>
<li class="toctree-l2"><a class="reference internal" href="Zones.html#using-typeclasses-and-inheritance-for-zoning">Using typeclasses and inheritance for zoning</a></li>
</ul>
</li>
</ul>
</div>
</section>
<section id="text-processing">
<h2>Text processing<a class="headerlink" href="#text-processing" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="Internationalization.html">Internationalization</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Internationalization.html#changing-server-language">Changing server language</a></li>
<li class="toctree-l2"><a class="reference internal" href="Internationalization.html#translating-evennia">Translating Evennia</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Text-Encodings.html">Text Encodings</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Text-Encodings.html#how-to-customize-encodings">How to customize encodings</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Inline-Tags-and-Functions.html">In-text tags parsed by Evennia</a></li>
<li class="toctree-l1"><a class="reference internal" href="Change-Messages-Per-Receiver.html">Sending different messages depending on viewpoint and receiver</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Change-Messages-Per-Receiver.html#director-stance">Director Stance</a></li>
<li class="toctree-l2"><a class="reference internal" href="Change-Messages-Per-Receiver.html#actor-stance">Actor Stance</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Change-Messages-Per-Receiver.html#referencing-other-objects">Referencing other objects</a></li>
<li class="toctree-l1"><a class="reference internal" href="Change-Messages-Per-Receiver.html#recog-systems-and-roleplaying">Recog systems and roleplaying</a></li>
<li class="toctree-l1"><a class="reference internal" href="Clickable-Links.html">Clickable links</a></li>
<li class="toctree-l1"><a class="reference internal" href="Colors.html">Colors</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Colors.html#ansi-colours">ANSI colours</a></li>
<li class="toctree-l2"><a class="reference internal" href="Colors.html#more-reading">More reading</a></li>
</ul>
</li>
</ul>
</div>
</section>
<section id="web-features">
<h2>Web features<a class="headerlink" href="#web-features" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="Web-Features.html">Web Features</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Web-Features.html#web-site">Web site</a></li>
<li class="toctree-l2"><a class="reference internal" href="Web-Features.html#web-client">Web client</a></li>
<li class="toctree-l2"><a class="reference internal" href="Web-Features.html#the-django-admin-page">The Django Admin Page</a></li>
<li class="toctree-l2"><a class="reference internal" href="Web-Features.html#more-reading">More reading</a></li>
</ul>
</li>
</ul>
</div>
</section>
</section>
</div>
</div>
</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>
<li class="right" >
<a href="Async-Process.html" title="Async Process"
>next</a> |</li>
<li class="right" >
<a href="../Components/Bootstrap-Components-and-Utilities.html" title="Bootstrap Components and Utilities"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Core Concepts</a></li>
</ul>
<div class="develop">develop branch</div>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2022, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>