Updated HTML docs.

This commit is contained in:
Evennia docbuilder action 2026-01-12 16:26:53 +00:00
parent dbae67275a
commit 76d95c253e
87 changed files with 922 additions and 850 deletions

View file

@ -46,10 +46,6 @@
<section class="tex2jax_ignore mathjax_ignore" id="installation">
<h1>Installation<a class="headerlink" href="#installation" title="Link to this heading"></a></h1>
<div class="admonition important">
<p class="admonition-title">Important</p>
<p>If you are converting an existing game from a previous Evennia version, you will need to upgrade.</p>
</div>
<p>The fastest way to install Evennia is to use the <code class="docutils literal notranslate"><span class="pre">pip</span></code> installer that comes with Python (read on). You can also <a class="reference internal" href="Installation-Git.html"><span class="std std-doc">clone Evennia from github</span></a> or use <a class="reference internal" href="Installation-Docker.html"><span class="std std-doc">docker</span></a>. Some users have also experimented with <a class="reference internal" href="Installation-Android.html"><span class="std std-doc">installing Evennia on Android</span></a>.</p>
<p>If you are converting an existing game, please follow the <a class="reference internal" href="Installation-Upgrade.html"><span class="std std-doc">upgrade instructions</span></a>.</p>
<section id="requirements">
@ -59,7 +55,7 @@
<p>Installing Evennia doesnt make anything visible online. Apart from installation and updating, you can develop your game without any internet connection if you want to.</p>
</aside>
<ul class="simple">
<li><p>Evennia requires <a class="reference external" href="https://www.python.org/downloads/">Python</a> 3.10, 3.11 or 3.12 (recommended). Any OS that supports Python should work.</p>
<li><p>Evennia requires <a class="reference external" href="https://www.python.org/downloads/">Python</a> 3.11, 3.12 or 3.13 (recommended). Any OS that supports Python should work.</p>
<ul>
<li><p><em>Windows</em>: In the installer, make sure to select <code class="docutils literal notranslate"><span class="pre">add</span> <span class="pre">python</span> <span class="pre">to</span> <span class="pre">path</span></code>. If you have multiple versions of Python installed, use <code class="docutils literal notranslate"><span class="pre">py</span></code> command instead of <code class="docutils literal notranslate"><span class="pre">python</span></code> to have Windows automatically use the latest.</p></li>
</ul>
@ -163,7 +159,7 @@ evennia migrate
<section id="register-with-the-evennia-game-index-optional">
<h2>Register with the Evennia Game Index (optional)<a class="headerlink" href="#register-with-the-evennia-game-index-optional" title="Link to this heading"></a></h2>
<p>To let the world know that you are working on a new Evennia-based game, you may register your server with the <em>Evennia game index</em> by issuing:</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>evennia connections
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>evennia connections
</pre></div>
</div>
<p>Then, just follow the prompts. You dont have to be open for players to do this — simply mark your game as closed and “pre-alpha.”</p>