evennia/docs/1.0-dev/Components/Connection-Screen.html

140 lines
6.7 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" />
2020-10-15 01:31:30 +02:00
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
2020-06-15 21:52:33 +02:00
<title>Connection Screen &#8212; Evennia 1.0-dev documentation</title>
2020-07-14 00:21:00 +02:00
<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" />
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">
2020-07-14 00:21:00 +02:00
<a href="../genindex.html" title="General Index"
2020-06-15 21:52:33 +02:00
accesskey="I">index</a></li>
<li class="right" >
2020-07-14 00:21:00 +02:00
<a href="../py-modindex.html" title="Python Module Index"
2020-06-15 21:52:33 +02:00
>modules</a> |</li>
2020-10-15 01:31:30 +02:00
<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="">Connection Screen</a></li>
2020-06-15 21:52:33 +02:00
</ul>
2020-11-14 12:27:06 +01: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-13 00:36:45 +02:00
<div class="section" id="connection-screen">
<h1>Connection Screen<a class="headerlink" href="#connection-screen" title="Permalink to this headline"></a></h1>
<p>When you first connect to your game you are greeted by Evennias default connection screen.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>==============================================================
Welcome to Evennia, version Beta-ra4d24e8a3cab+!
If you have an existing account, connect to it by typing:
connect &lt;username&gt; &lt;password&gt;
If you need to create an account, type (without the &lt;&gt;&#39;s):
create &lt;username&gt; &lt;password&gt;
If you have spaces in your username, enclose it in quotes.
Enter help for more info. look will re-show this screen.
==============================================================
</pre></div>
</div>
2020-06-16 22:49:43 +02:00
<p>Effective, but not very exciting. You will most likely want to change this to be more unique for
your game. This is simple:</p>
2020-06-13 00:36:45 +02:00
<ol class="simple">
<li><p>Edit <code class="docutils literal notranslate"><span class="pre">mygame/server/conf/connection_screens.py</span></code>.</p></li>
2020-07-14 00:21:00 +02:00
<li><p><a class="reference internal" href="../Setup/Start-Stop-Reload.html"><span class="doc">Reload</span></a> Evennia.</p></li>
2020-06-13 00:36:45 +02:00
</ol>
<p>Evennia will look into this module and locate all <em>globally defined strings</em> in it. These strings
are used as the text in your connection screen and are shown to the user at startup. If more than
one such string/screen is defined in the module, a <em>random</em> screen will be picked from among those
available.</p>
<div class="section" id="commands-available-at-the-connection-screen">
<h2>Commands available at the Connection Screen<a class="headerlink" href="#commands-available-at-the-connection-screen" title="Permalink to this headline"></a></h2>
<p>You can also customize the <a class="reference internal" href="Commands.html"><span class="doc">Commands</span></a> available to use while the connection screen is
shown (<code class="docutils literal notranslate"><span class="pre">connect</span></code>, <code class="docutils literal notranslate"><span class="pre">create</span></code> etc). These commands are a bit special since when the screen is running
the account is not yet logged in. A command is made available at the login screen by adding them to
<code class="docutils literal notranslate"><span class="pre">UnloggedinCmdSet</span></code> in <code class="docutils literal notranslate"><span class="pre">mygame/commands/default_cmdset.py</span></code>. See <a class="reference internal" href="Commands.html"><span class="doc">Commands</span></a> and the
tutorial section on how to add new commands to a default command set.</p>
</div>
</div>
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">
2020-07-14 00:21:00 +02:00
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
2020-06-15 21:52:33 +02:00
</a></p>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
2020-07-14 00:21:00 +02:00
<form class="search" action="../search.html" method="get">
2020-06-15 21:52:33 +02:00
<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="../index.html">Table of Contents</a></h3>
2020-06-15 21:52:33 +02:00
<ul>
<li><a class="reference internal" href="#">Connection Screen</a><ul>
<li><a class="reference internal" href="#commands-available-at-the-connection-screen">Commands available at the Connection Screen</a></li>
</ul>
</li>
</ul>
2020-06-13 00:36:45 +02:00
2020-06-15 21:52:33 +02:00
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
2020-07-14 00:21:00 +02:00
<li><a href="../_sources/Components/Connection-Screen.md.txt"
2020-06-15 21:52:33 +02:00
rel="nofollow">Show Page Source</a></li>
</ul>
</div>
<h3>Versions</h3>
<ul>
<li><a href="Connection-Screen.html">1.0-dev (develop branch)</a></li>
2020-11-14 13:44:49 +01:00
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
2020-06-15 21:52:33 +02:00
</ul>
2020-06-14 21:48:02 +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">
2020-07-14 00:21:00 +02:00
<a href="../genindex.html" title="General Index"
2020-06-15 21:52:33 +02:00
>index</a></li>
<li class="right" >
2020-07-14 00:21:00 +02:00
<a href="../py-modindex.html" title="Python Module Index"
2020-06-15 21:52:33 +02:00
>modules</a> |</li>
2020-10-15 01:31:30 +02:00
<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="">Connection Screen</a></li>
2020-06-15 21:52:33 +02:00
</ul>
2020-11-14 12:27:06 +01: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>
2020-06-13 00:36:45 +02:00
</html>