mirror of
https://github.com/evennia/evennia.git
synced 2026-03-17 05:16:31 +01:00
280 lines
No EOL
15 KiB
HTML
280 lines
No EOL
15 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html lang="en" data-content_root="../">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
|
|
<title>Core Concepts — Evennia latest documentation</title>
|
|
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d75fae25" />
|
|
<link rel="stylesheet" type="text/css" href="../_static/nature.css?v=279e0f84" />
|
|
<link rel="stylesheet" type="text/css" href="../_static/custom.css?v=e4a91a55" />
|
|
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
|
|
<script src="../_static/doctools.js?v=9bcbadda"></script>
|
|
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
|
<link rel="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="The Message path" href="Messagepath.html" />
|
|
<link rel="prev" title="Bootstrap frontend framework" href="../Components/Web-Bootstrap-Framework.html" />
|
|
</head><body>
|
|
<div class="related" role="navigation" aria-label="Related">
|
|
<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="Messagepath.html" title="The Message path"
|
|
accesskey="N">next</a> |</li>
|
|
<li class="right" >
|
|
<a href="../Components/Web-Bootstrap-Framework.html" title="Bootstrap frontend framework"
|
|
accesskey="P">previous</a> |</li>
|
|
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">Core Concepts</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="document">
|
|
<div class="documentwrapper">
|
|
<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="Link to this heading">¶</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="std std-doc">Core Components</span></a> acting together.</p>
|
|
<section id="general-concepts">
|
|
<h2>General concepts<a class="headerlink" href="#general-concepts" title="Link to this heading">¶</a></h2>
|
|
<div class="toctree-wrapper compound">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="Messagepath.html">The Message path</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="Messagepath.html#ingoing-message-path">Ingoing message path</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="Messagepath.html#outgoing-message-path">Outgoing message path</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="Messagepath.html#components-along-the-path">Components along the path</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="OOB.html">Out-of-Band messaging</a><ul>
|
|
<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>
|
|
<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#utils-delay"><code class="docutils literal notranslate"><span class="pre">utils.delay</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="Async-Process.html#utils-interactive-decorator"><code class="docutils literal notranslate"><span class="pre">@utils.interactive</span></code> decorator</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="Async-Process.html#utils-run-async"><code class="docutils literal notranslate"><span class="pre">utils.run_async</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section id="text-processing">
|
|
<h2>Text processing<a class="headerlink" href="#text-processing" title="Link to this heading">¶</a></h2>
|
|
<div class="toctree-wrapper compound">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="Tags-Parsed-By-Evennia.html">In-text tags parsed by Evennia</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="Colors.html">Colors</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="Clickable-Links.html">Clickable links</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="Inline-Functions.html">Inline functions</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="Change-Message-Per-Receiver.html">Messages varying per receiver</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="Change-Message-Per-Receiver.html#director-stance">Director Stance</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="Change-Message-Per-Receiver.html#actor-stance">Actor Stance</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="Change-Message-Per-Receiver.html#referencing-other-objects">Referencing other objects</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="Change-Message-Per-Receiver.html#recog-systems-and-roleplaying">Recog systems and roleplaying</a></li>
|
|
</ul>
|
|
</li>
|
|
<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>
|
|
<li class="toctree-l2"><a class="reference internal" href="Internationalization.html#marking-strings-in-code-for-translation">Marking Strings in Code for Translation</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>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section id="access">
|
|
<h2>Access<a class="headerlink" href="#access" title="Link to this heading">¶</a></h2>
|
|
<div class="toctree-wrapper compound">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="Connection-Styles.html">Character connection styles</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="Connection-Styles.html#changing-the-login-screen">Changing the login screen</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="Connection-Styles.html#customizing-the-login-command">Customizing the login command</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="Connection-Styles.html#multisession-mode-and-multi-playing">Multisession mode and multi-playing</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="Connection-Styles.html#character-creation-and-auto-puppeting">Character creation and auto-puppeting</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="Guests.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="Link to this heading">¶</a></h2>
|
|
<div class="toctree-wrapper compound">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="Server-Lifecycle.html">Evennia Server Lifecycle</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="Server-Lifecycle.html#when-evennia-starts-for-the-first-time">When Evennia starts for the first time</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="Server-Lifecycle.html#when-evennia-starts-and-shutdowns">When Evennia starts and shutdowns</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="Server-Lifecycle.html#when-evennia-reloads-and-resets">When Evennia reloads and resets</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="Protocols.html">Protocols</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="Protocols.html#adding-a-new-protocol">Adding a new Protocol</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="Models.html">New Models</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="Models.html#overview-of-database-tables">Overview of database tables</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="Models.html#adding-a-new-database-table">Adding a new database table</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="Models.html#defining-your-models">Defining your models</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="Models.html#referencing-existing-models-and-typeclasses">Referencing existing models and typeclasses</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="Models.html#creating-a-new-model-instance">Creating a new model instance</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="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="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>
|
|
|
|
|
|
<div class="clearer"></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sphinxsidebar" role="navigation" aria-label="Main">
|
|
<div class="sphinxsidebarwrapper">
|
|
<p class="logo"><a href="../index.html">
|
|
<img class="logo" src="../_static/evennia_logo.png" alt="Logo of Evennia"/>
|
|
</a></p>
|
|
<search 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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
|
<input type="submit" value="Go" />
|
|
</form>
|
|
</div>
|
|
</search>
|
|
<script>document.getElementById('searchbox').style.display = "block"</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="#text-processing">Text processing</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>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
<div>
|
|
<h4>Previous topic</h4>
|
|
<p class="topless"><a href="../Components/Web-Bootstrap-Framework.html"
|
|
title="previous chapter">Bootstrap frontend framework</a></p>
|
|
</div>
|
|
<div>
|
|
<h4>Next topic</h4>
|
|
<p class="topless"><a href="Messagepath.html"
|
|
title="next chapter">The Message path</a></p>
|
|
</div>
|
|
<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/docs/latest/index.html">Documentation Top</a> </li>
|
|
<li><a href="https://www.evennia.com">Evennia Home</a> </li>
|
|
<li><a href="https://github.com/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>Doc Versions</h3>
|
|
<ul>
|
|
|
|
<li>
|
|
<a href="https://www.evennia.com/docs/latest/index.html">latest (main branch)</a>
|
|
</li>
|
|
|
|
|
|
<li>
|
|
<a href="https://www.evennia.com/docs/5.x/index.html">v5.0.0 branch (outdated)</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="https://www.evennia.com/docs/4.x/index.html">v4.0.0 branch (outdated)</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="https://www.evennia.com/docs/3.x/index.html">v3.0.0 branch (outdated)</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="https://www.evennia.com/docs/2.x/index.html">v2.0.0 branch (outdated)</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="https://www.evennia.com/docs/1.x/index.html">v1.0.0 branch (outdated)</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="https://www.evennia.com/docs/0.x/index.html">v0.9.5 branch (outdated)</a>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="clearer"></div>
|
|
</div>
|
|
<div class="related" role="navigation" aria-label="Related">
|
|
<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="Messagepath.html" title="The Message path"
|
|
>next</a> |</li>
|
|
<li class="right" >
|
|
<a href="../Components/Web-Bootstrap-Framework.html" title="Bootstrap frontend framework"
|
|
>previous</a> |</li>
|
|
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">Core Concepts</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="footer" role="contentinfo">
|
|
© Copyright 2024, The Evennia developer community.
|
|
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
|
|
</div>
|
|
</body>
|
|
</html> |