evennia/docs/4.x/api/evennia.server.html
2024-03-17 14:15:56 +01:00

217 lines
No EOL
14 KiB
HTML

<!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>evennia.server &#8212; Evennia latest 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="evennia.server.amp_client" href="evennia.server.amp_client.html" />
<link rel="prev" title="evennia.scripts.tickerhandler" href="evennia.scripts.tickerhandler.html" />
</head><body>
<div class="admonition important">
<p class="first admonition-title">Note</p>
<p class="last">You are reading an old version of the Evennia documentation. <a href="https://www.evennia.com/docs/latest/index.html">The latest version is here</a></p>.
</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"
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="evennia.server.amp_client.html" title="evennia.server.amp_client"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="evennia.scripts.tickerhandler.html" title="evennia.scripts.tickerhandler"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia latest</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" accesskey="U">evennia</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.server</a></li>
</ul>
</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>
<h4>Previous topic</h4>
<p class="topless"><a href="evennia.scripts.tickerhandler.html"
title="previous chapter">evennia.scripts.tickerhandler</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="evennia.server.amp_client.html"
title="next chapter">evennia.server.amp_client</a></p>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/api/evennia.server.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>
</div>
</div>
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-evennia.server">
<span id="evennia-server"></span><h1>evennia.server<a class="headerlink" href="#module-evennia.server" title="Permalink to this headline"></a></h1>
<p>This sub-package holds the Server and Portal programs - the “core” of
Evennia. It also contains the SessionHandler that manages all
connected users as well as defines all the connection protocols used
to connect to the game.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="evennia.server.amp_client.html">evennia.server.amp_client</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.server.connection_wizard.html">evennia.server.connection_wizard</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.server.deprecations.html">evennia.server.deprecations</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.server.evennia_launcher.html">evennia.server.evennia_launcher</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.server.initial_setup.html">evennia.server.initial_setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.server.inputfuncs.html">evennia.server.inputfuncs</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.server.manager.html">evennia.server.manager</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.server.models.html">evennia.server.models</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.server.server.html">evennia.server.server</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.server.serversession.html">evennia.server.serversession</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.server.service.html">evennia.server.service</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.server.session.html">evennia.server.session</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.server.sessionhandler.html">evennia.server.sessionhandler</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.server.signals.html">evennia.server.signals</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.server.throttle.html">evennia.server.throttle</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.server.validators.html">evennia.server.validators</a></li>
<li class="toctree-l1"><a class="reference internal" href="evennia.server.webserver.html">evennia.server.webserver</a></li>
</ul>
</div>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="evennia.server.game_index_client.html">evennia.server.game_index_client</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.game_index_client.client.html">evennia.server.game_index_client.client</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.game_index_client.service.html">evennia.server.game_index_client.service</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.server.portal.html">evennia.server.portal</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.portal.amp.html">evennia.server.portal.amp</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.portal.amp_server.html">evennia.server.portal.amp_server</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.portal.discord.html">evennia.server.portal.discord</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.portal.grapevine.html">evennia.server.portal.grapevine</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.portal.irc.html">evennia.server.portal.irc</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.portal.mccp.html">evennia.server.portal.mccp</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.portal.mssp.html">evennia.server.portal.mssp</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.portal.mxp.html">evennia.server.portal.mxp</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.portal.naws.html">evennia.server.portal.naws</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.portal.portal.html">evennia.server.portal.portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.portal.portalsessionhandler.html">evennia.server.portal.portalsessionhandler</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.portal.rss.html">evennia.server.portal.rss</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.portal.service.html">evennia.server.portal.service</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.portal.ssh.html">evennia.server.portal.ssh</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.portal.ssl.html">evennia.server.portal.ssl</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.portal.suppress_ga.html">evennia.server.portal.suppress_ga</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.portal.telnet.html">evennia.server.portal.telnet</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.portal.telnet_oob.html">evennia.server.portal.telnet_oob</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.portal.telnet_ssl.html">evennia.server.portal.telnet_ssl</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.portal.tests.html">evennia.server.portal.tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.portal.ttype.html">evennia.server.portal.ttype</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.portal.webclient.html">evennia.server.portal.webclient</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.portal.webclient_ajax.html">evennia.server.portal.webclient_ajax</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="evennia.server.profiling.html">evennia.server.profiling</a><ul>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.profiling.dummyrunner.html">evennia.server.profiling.dummyrunner</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.profiling.dummyrunner_settings.html">evennia.server.profiling.dummyrunner_settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.profiling.memplot.html">evennia.server.profiling.memplot</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.profiling.settings_mixin.html">evennia.server.profiling.settings_mixin</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.profiling.test_queries.html">evennia.server.profiling.test_queries</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.profiling.tests.html">evennia.server.profiling.tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="evennia.server.profiling.timetrace.html">evennia.server.profiling.timetrace</a></li>
</ul>
</li>
</ul>
</div>
</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="evennia.server.amp_client.html" title="evennia.server.amp_client"
>next</a> |</li>
<li class="right" >
<a href="evennia.scripts.tickerhandler.html" title="evennia.scripts.tickerhandler"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia latest</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../Evennia-API.html" >API Summary</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="evennia-api.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="evennia.html" >evennia</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">evennia.server</a></li>
</ul>
</div>
<div class="admonition important">
<p class="first admonition-title">Note</p>
<p class="last">You are reading an old version of the Evennia documentation. <a href="https://www.evennia.com/docs/latest/index.html">The latest version is here</a></p>.
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2023, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>