Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-05 07:27:17 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/0.9.5/Guest-Logins.html

147 lines
8 KiB
HTML
Raw Normal View History

Updated HTML docs
2020-06-13 00:36:45 +02:00
<!DOCTYPE html>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<html>
Updated HTML docs
2020-06-15 21:52:33 +02:00
<head>
<meta charset="utf-8" />
Updated HTML docs
2020-10-15 01:31:30 +02:00
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
Updated HTML docs
2020-10-11 22:19:29 +02:00
<title>Guest Logins &#8212; Evennia 0.9.5 documentation</title>
Updated HTML docs
2020-06-15 21:52:33 +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>
Updated HTML docs
2020-06-13 23:31:27 +02:00
<link rel="shortcut icon" href="_static/favicon.ico"/>
Updated HTML docs
2020-06-15 21:52:33 +02:00
<link rel="index" title="Index" href="genindex.html" />
Updated HTML docs
2020-10-15 01:31:30 +02:00
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="IRC" href="IRC.html" />
<link rel="prev" title="Connection Screen" href="Connection-Screen.html" />
Updated HTML docs
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>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<li class="right" >
<a href="IRC.html" title="IRC"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="Connection-Screen.html" title="Connection Screen"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Evennia 0.9.5</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="Administrative-Docs.html" accesskey="U">Administrative Docs</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Guest Logins</a></li>
Updated HTML docs
2020-06-15 21:52:33 +02:00
</ul>
Updated HTML docs
2020-11-14 11:55:52 +01:00
<div class="develop">develop branch</div>
Updated HTML docs
2020-06-15 21:52:33 +02:00
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
Updated HTML docs
2020-06-13 00:36:45 +02:00
<div class="section" id="guest-logins">
<h1>Guest Logins<a class="headerlink" href="#guest-logins" title="Permalink to this headline"></a></h1>
Updated HTML docs
2020-10-11 22:19:29 +02:00
<p>Evennia supports <em>guest logins</em> out of the box. A guest login is an anonymous, low-access account
and can be useful if you want users to have a chance to try out your game without committing to
creating a real account.</p>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<p>Guest accounts are turned off by default. To activate, add this to your <code class="docutils literal notranslate"><span class="pre">game/settings.py</span></code> file:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">GUEST_ENABLED</span> <span class="o">=</span> <span class="kc">True</span>
</pre></div>
</div>
Updated HTML docs
2020-10-11 22:19:29 +02:00
<p>Henceforth users can use <code class="docutils literal notranslate"><span class="pre">connect</span> <span class="pre">guest</span></code> (in the default command set) to login with a guest account.
You may need to change your <a class="reference internal" href="Connection-Screen.html"><span class="doc">Connection Screen</span></a> to inform them of this
possibility. Guest accounts work differently from normal accounts - they are automatically <em>deleted</em>
whenever the user logs off or the server resets (but not during a reload). They are literally re-
usable throw-away accounts.</p>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<p>You can add a few more variables to your <code class="docutils literal notranslate"><span class="pre">settings.py</span></code> file to customize your guests:</p>
<ul class="simple">
Updated HTML docs
2020-10-11 22:19:29 +02:00
<li><p><code class="docutils literal notranslate"><span class="pre">BASE_GUEST_TYPECLASS</span></code> - the python-path to the default <a class="reference internal" href="Typeclasses.html"><span class="doc">typeclass</span></a> for guests.
Defaults to <code class="docutils literal notranslate"><span class="pre">&quot;typeclasses.accounts.Guest&quot;</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">PERMISSION_GUEST_DEFAULT</span></code> - <a class="reference internal" href="Locks.html"><span class="doc">permission level</span></a> for guest accounts. Defaults to <code class="docutils literal notranslate"><span class="pre">&quot;Guests&quot;</span></code>,
which is the lowest permission level in the hierarchy.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">GUEST_START_LOCATION</span></code> - the <code class="docutils literal notranslate"><span class="pre">#dbref</span></code> to the starting location newly logged-in guests should
appear at. Defaults to <code class="docutils literal notranslate"><span class="pre">&quot;#2</span></code> (Limbo).</p></li>
Updated HTML docs
2020-06-13 00:36:45 +02:00
<li><p><code class="docutils literal notranslate"><span class="pre">GUEST_HOME</span></code> - guest home locations. Defaults to Limbo as well.</p></li>
Updated HTML docs
2020-10-11 22:19:29 +02:00
<li><p><code class="docutils literal notranslate"><span class="pre">GUEST_LIST</span></code> - this is a list holding the possible guest names to use when entering the game. The
length of this list also sets how many guests may log in at the same time. By default this is a list
of nine names from <code class="docutils literal notranslate"><span class="pre">&quot;Guest1&quot;</span></code> to <code class="docutils literal notranslate"><span class="pre">&quot;Guest9&quot;</span></code>.</p></li>
Updated HTML docs
2020-06-13 00:36:45 +02:00
</ul>
</div>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<div class="clearer"></div>
Updated HTML docs
2020-06-13 00:36:45 +02:00
</div>
</div>
</div>
Updated HTML docs
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="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>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<h4>Previous topic</h4>
<p class="topless"><a href="Connection-Screen.html"
title="previous chapter">Connection Screen</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="IRC.html"
title="next chapter">IRC</a></p>
Updated HTML docs
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/Guest-Logins.md.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</div>
<h3>Versions</h3>
<ul>
Updated HTML docs
2020-07-14 00:21:00 +02:00
<li><a href="../1.0-dev/index.html">1.0-dev (develop branch)</a></li>
Updated HTML docs
2020-10-11 22:19:29 +02:00
<li><a href="Guest-Logins.html">0.9.5 (master branch)</a></li>
Updated HTML docs
2020-06-15 21:52:33 +02:00
</ul>
Updated HTML docs
2020-06-13 00:36:45 +02:00
Updated HTML docs
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>
Updated HTML docs
2020-10-15 01:31:30 +02:00
<li class="right" >
<a href="IRC.html" title="IRC"
>next</a> |</li>
<li class="right" >
<a href="Connection-Screen.html" title="Connection Screen"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Evennia 0.9.5</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="Administrative-Docs.html" >Administrative Docs</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Guest Logins</a></li>
Updated HTML docs
2020-06-15 21:52:33 +02:00
</ul>
Updated HTML docs
2020-11-14 11:55:52 +01:00
<div class="develop">develop branch</div>
Updated HTML docs
2020-06-15 21:52:33 +02:00
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2020, The Evennia developer community.
Updated HTML docs
2020-10-15 01:31:30 +02:00
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
Updated HTML docs
2020-06-15 21:52:33 +02:00
</div>
</body>
Updated HTML docs
2020-06-13 00:36:45 +02:00
</html>
Reference in a new issue Copy permalink