mirror of
https://github.com/evennia/evennia.git
synced 2026-03-22 15:56:30 +01:00
147 lines
No EOL
8 KiB
HTML
147 lines
No EOL
8 KiB
HTML
|
|
<!DOCTYPE html>
|
|
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>Guest Logins — Evennia 0.9.5 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="IRC" href="IRC.html" />
|
|
<link rel="prev" title="Connection Screen" href="Connection-Screen.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="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> »</li>
|
|
<li class="nav-item nav-item-1"><a href="Administrative-Docs.html" accesskey="U">Administrative Docs</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">Guest Logins</a></li>
|
|
</ul>
|
|
<div class="develop">develop branch</div>
|
|
</div>
|
|
|
|
<div class="document">
|
|
<div class="documentwrapper">
|
|
<div class="bodywrapper">
|
|
<div class="body" role="main">
|
|
|
|
<div class="section" id="guest-logins">
|
|
<h1>Guest Logins<a class="headerlink" href="#guest-logins" title="Permalink to this headline">¶</a></h1>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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">
|
|
<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">"typeclasses.accounts.Guest"</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">"Guests"</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">"#2</span></code> (Limbo).</p></li>
|
|
<li><p><code class="docutils literal notranslate"><span class="pre">GUEST_HOME</span></code> - guest home locations. Defaults to Limbo as well.</p></li>
|
|
<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">"Guest1"</span></code> to <code class="docutils literal notranslate"><span class="pre">"Guest9"</span></code>.</p></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
<div class="clearer"></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<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="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>
|
|
<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>
|
|
<li><a href="../1.0-dev/index.html">1.0-dev (develop branch)</a></li>
|
|
<li><a href="Guest-Logins.html">0.9.5 (master branch)</a></li>
|
|
</ul>
|
|
|
|
</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>
|
|
<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> »</li>
|
|
<li class="nav-item nav-item-1"><a href="Administrative-Docs.html" >Administrative Docs</a> »</li>
|
|
<li class="nav-item nav-item-this"><a href="">Guest Logins</a></li>
|
|
</ul>
|
|
<div class="develop">develop branch</div>
|
|
</div>
|
|
<div class="footer" role="contentinfo">
|
|
© Copyright 2020, The Evennia developer community.
|
|
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
|
</div>
|
|
</body>
|
|
</html> |