evennia/docs/2.x/Concepts/Guests.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>Guest Logins &#8212; Evennia 2.x 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="Banning" href="Banning.html" />
    <link rel="prev" title="Character connection styles" href="Connection-Styles.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="Banning.html" title="Banning"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="Connection-Styles.html" title="Character connection styles"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">Evennia 2.x</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="Concepts-Overview.html" accesskey="U">Core Concepts</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Guest Logins</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="Connection-Styles.html"
                        title="previous chapter">Character connection styles</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="Banning.html"
                        title="next chapter">Banning</a></p>
  <div role="note" aria-label="source link">
    <!--h3>This Page</h3-->
    <ul class="this-page-menu">
      <li><a href="../_sources/Concepts/Guests.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="Guests.html">2.x (main branch)</a></li>
 <ul>
    <li><a href="../1.3.0/index.html">1.3.0 (v1.3.0 branch)</a></li>
  
    <li><a href="../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
  

</ul>

        </div>
      </div>
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <section class="tex2jax_ignore mathjax_ignore" 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-none notranslate"><div class="highlight"><pre><span></span>GUEST_ENABLED = True
</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 <span class="xref myst">Connection Screen</span> 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="../Components/Typeclasses.html"><span class="doc std std-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="../Components/Locks.html"><span class="doc std std-doc">permission level</span></a> for guest accounts. Defaults to <code class="docutils literal notranslate"><span class="pre">&quot;Guest&quot;</span></code>, which is the lowest permission level in the hierarchy (below <code class="docutils literal notranslate"><span class="pre">Player</span></code>).</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>
<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">&quot;Guest1&quot;</span></code> to <code class="docutils literal notranslate"><span class="pre">&quot;Guest9&quot;</span></code>.</p></li>
</ul>
</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="Banning.html" title="Banning"
             >next</a> |</li>
        <li class="right" >
          <a href="Connection-Styles.html" title="Character connection styles"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">Evennia 2.x</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="Concepts-Overview.html" >Core Concepts</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">Guest Logins</a></li> 
      </ul>
    </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>
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130. 2022-11-14 22:43:45 +01:00
			`<!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/" />`

Updated HTML docs. 2023-10-19 20:22:27 +00:00			`<title>Guest Logins — Evennia 2.x documentation</title>`
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130. 2022-11-14 22:43:45 +01: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" />`
			`<link rel="next" title="Banning" href="Banning.html" />`
Updated HTML docs. 2022-11-26 17:42:14 +00:00			`<link rel="prev" title="Character connection styles" href="Connection-Styles.html" />`
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130. 2022-11-14 22:43:45 +01:00			`</head><body>`
Updated HTML docs. 2023-10-19 20:22:27 +00:00



Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130. 2022-11-14 22:43:45 +01:00			`<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="Banning.html" title="Banning"`
			`accesskey="N">next</a> \|</li>`
			`<li class="right" >`
Updated HTML docs. 2022-11-26 17:42:14 +00:00			`<a href="Connection-Styles.html" title="Character connection styles"`
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130. 2022-11-14 22:43:45 +01:00			`accesskey="P">previous</a> \|</li>`
Updated HTML docs. 2023-10-19 20:22:27 +00:00			`<li class="nav-item nav-item-0"><a href="../index.html">Evennia 2.x</a> »</li>`
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130. 2022-11-14 22:43:45 +01:00			`<li class="nav-item nav-item-1"><a href="Concepts-Overview.html" accesskey="U">Core Concepts</a> »</li>`
			`<li class="nav-item nav-item-this"><a href="">Guest Logins</a></li>`
			`</ul>`
Updated HTML docs. 2023-06-10 08:53:19 +00:00			`</div>`
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130. 2022-11-14 22:43:45 +01:00
			`<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>`
Updated HTML docs. 2022-11-26 17:42:14 +00:00			`<p class="topless"><a href="Connection-Styles.html"`
			`title="previous chapter">Character connection styles</a></p>`
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130. 2022-11-14 22:43:45 +01:00			`<h4>Next topic</h4>`
			`<p class="topless"><a href="Banning.html"`
			`title="next chapter">Banning</a></p>`
			`<div role="note" aria-label="source link">`
			`<!--h3>This Page</h3-->`
			`<ul class="this-page-menu">`
Updated HTML docs. 2022-11-26 14:42:25 +00:00			`<li><a href="../_sources/Concepts/Guests.md.txt"`
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130. 2022-11-14 22:43:45 +01:00			`rel="nofollow">Show Page Source</a></li>`
			`</ul>`
			`</div><h3>Links</h3>`
			`<ul>`
Updated HTML docs. 2023-10-19 20:22:27 +00:00			`<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>`
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130. 2022-11-14 22:43:45 +01:00			`<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>`
Updated HTML docs. 2023-10-19 20:22:27 +00:00			`<h3>Doc Versions</h3>`
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130. 2022-11-14 22:43:45 +01:00			`<ul>`
Updated HTML docs. 2023-10-19 20:22:27 +00:00
			`<li><a href="Guests.html">2.x (main branch)</a></li>`
Updated HTML docs. 2022-11-15 20:29:38 +00:00			`<ul>`
Updated HTML docs. 2023-10-19 20:22:27 +00:00			`<li><a href="../1.3.0/index.html">1.3.0 (v1.3.0 branch)</a></li>`

			`<li><a href="../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>`

Updated HTML docs. 2022-11-15 20:29:38 +00:00
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130. 2022-11-14 22:43:45 +01:00			`</ul>`

			`</div>`
			`</div>`
			`<div class="bodywrapper">`
			`<div class="body" role="main">`

			`<section class="tex2jax_ignore mathjax_ignore" id="guest-logins">`
			`<h1>Guest Logins<a class="headerlink" href="#guest-logins" title="Permalink to this headline">¶</a></h1>`
Updated HTML docs. 2022-11-26 17:42:14 +00: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>`
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130. 2022-11-14 22:43:45 +01: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-none notranslate"><div class="highlight"><pre><span></span>GUEST_ENABLED = True`
			`</pre></div>`
			`</div>`
Updated HTML docs. 2022-11-26 22:25:00 +00: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 <span class="xref myst">Connection Screen</span> 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>
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130. 2022-11-14 22:43:45 +01: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. 2022-11-26 17:42:14 +00: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="../Components/Typeclasses.html"><span class="doc std std-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="../Components/Locks.html"><span class="doc std std-doc">permission level</span></a> for guest accounts. Defaults to <code class="docutils literal notranslate"><span class="pre">"Guest"</span></code>, which is the lowest permission level in the hierarchy (below <code class="docutils literal notranslate"><span class="pre">Player</span></code>).</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>`
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130. 2022-11-14 22:43:45 +01: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. 2022-11-26 17:42:14 +00: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">"Guest1"</span></code> to <code class="docutils literal notranslate"><span class="pre">"Guest9"</span></code>.</p></li>`
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130. 2022-11-14 22:43:45 +01:00			`</ul>`
			`</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="Banning.html" title="Banning"`
			`>next</a> \|</li>`
			`<li class="right" >`
Updated HTML docs. 2022-11-26 17:42:14 +00:00			`<a href="Connection-Styles.html" title="Character connection styles"`
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130. 2022-11-14 22:43:45 +01:00			`>previous</a> \|</li>`
Updated HTML docs. 2023-10-19 20:22:27 +00:00			`<li class="nav-item nav-item-0"><a href="../index.html">Evennia 2.x</a> »</li>`
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130. 2022-11-14 22:43:45 +01:00			`<li class="nav-item nav-item-1"><a href="Concepts-Overview.html" >Core Concepts</a> »</li>`
			`<li class="nav-item nav-item-this"><a href="">Guest Logins</a></li>`
			`</ul>`
			`</div>`
Updated HTML docs. 2023-10-19 20:22:27 +00:00


Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130. 2022-11-14 22:43:45 +01:00			`<div class="footer" role="contentinfo">`
Updated HTML docs. 2023-10-19 20:22:27 +00:00			`© Copyright 2023, The Evennia developer community.`
Revert "Updated HTML docs." This reverts commit 51d5840b8b48c2898d6c7a3bec8c7ef0caa0a130. 2022-11-14 22:43:45 +01:00			`Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.`
			`</div>`
			`</body>`
			`</html>`