Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-01 21:47:17 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated HTML docs.

Browse source
This commit is contained in:
Evennia docbuilder action 2022-12-01 17:28:38 +00:00
parent 92245573f7
commit 2aff0c29f4
33 changed files with 110 additions and 161 deletions
Download patch file Download diff file Expand all files Collapse all files

8
docs/1.0-dev/Setup/Installation-Git.html
View file

@ -146,7 +146,9 @@ not recognize <code class="docutils literal notranslate"><span class="pre">local
</section>
<section id="virtualenv">
<h2>Virtualenv<a class="headerlink" href="#virtualenv" title="Permalink to this headline"></a></h2>
<p>A Python <a class="reference external" href="https://docs.python.org/3/library/venv.html">virtual environment</a> allows you to install Evennia in its own little folder, separate from the rest of the system. You also won’t need any extra permissions. It’s optional to use a virtualenv, but it’s highly recommended. Python supports this natively:</p>
<p>A Python <a class="reference external" href="https://docs.python.org/3/library/venv.html">virtual environment</a> allows you to install Evennia and all its dependenceis in its own little isolated folder, separate from the rest of the system. This also means you can install without any extra permissions - it all goes into a folder on your drive.</p>
<p>It’s optional to use a virtualenv, but it’s highly recommended. Not only is this common Python praxis, it will make your life easier and avoid clashes with other Python programs you may have.</p>
<p>Python supports virtualenv natively:</p>
<aside class="sidebar">
<p class="sidebar-title">Using py on Windows</p>
<p>If you have older versions of Python installed on Windows, you should instead use <code class="docutils literal notranslate"><span class="pre">py</span></code> here instead of <code class="docutils literal notranslate"><span class="pre">python</span></code>. The <code class="docutils literal notranslate"><span class="pre">py</span></code> launcher automatically selects the latest python version among those you installed.</p>
@ -158,13 +160,15 @@ python -m venv evenv <span class="o">(</span>Windows<span class="o">)</spa
<p>This will create a new folder <code class="docutils literal notranslate"><span class="pre">evenv</span></code> in your current directory.
Activate it like this:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">source</span> <span class="n">evenv</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">activate</span> <span class="p">(</span><span class="n">Linux</span><span class="p">,</span> <span class="n">Mac</span><span class="p">)</span>
<span class="n">evenv</span>\<span class="n">Scripts</span>\<span class="n">activate</span> <span class="p">(</span><span class="n">Windows</span> <span class="n">Console</span><span class="p">)</span>
<span class="o">.</span>\<span class="n">evenv</span>\<span class="n">scripts</span>\<span class="n">activate</span> <span class="p">(</span><span class="n">Windows</span> <span class="n">PS</span> <span class="n">Shell</span><span class="p">,</span>
<span class="n">Git</span> <span class="n">Bash</span> <span class="n">etc</span><span class="p">)</span>
</pre></div>
</div>
<p>The text <code class="docutils literal notranslate"><span class="pre">(evenv)</span></code> should appear next to your prompt to show that the virtual
environment is active. You <em>don’t</em> need to actually be in or near the <code class="docutils literal notranslate"><span class="pre">evenv</span></code> folder for
environment is enabled. You do <em>not</em> need to actually be in or near the <code class="docutils literal notranslate"><span class="pre">evenv</span></code> folder for
the environment to be active.</p>
<div class="admonition important">
<p class="admonition-title">Important</p>

77
docs/1.0-dev/Setup/Setup-Overview.html
View file

@ -112,76 +112,15 @@
<h2>Installation and running<a class="headerlink" href="#installation-and-running" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="Installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Installation.html#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation.html#install-with-pip">Install with <code class="docutils literal notranslate"><span class="pre">pip</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation.html#initialize-a-new-game">Initialize a new game</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation.html#start-the-new-game">Start the new game</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation.html#restarting-and-stopping">Restarting and stopping</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation.html#see-server-logs">See server logs</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation.html#server-configuration">Server configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation.html#register-with-the-evennia-game-index-optional">Register with the Evennia Game Index (optional)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation.html#the-next-steps">The Next steps</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Installation-Git.html">Installing with GIT</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Installation-Git.html#summary">Summary</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Git.html#virtualenv">Virtualenv</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Git.html#linux-install">Linux Install</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Git.html#mac-install">Mac Install</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Git.html#windows-install">Windows Install</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Installation-Docker.html">Installing with Docker</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Installation-Docker.html#running-your-game-as-a-docker-image">Running your game as a docker image</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Docker.html#create-your-own-game-image">Create your own game image</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Docker.html#how-it-works">How it Works</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Docker.html#additional-creature-comforts">Additional Creature Comforts</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Installation-Troubleshooting.html">Installation Troubleshooting</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Installation-Troubleshooting.html#check-your-requirements">Check your Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Troubleshooting.html#confusion-of-location-git-installation">Confusion of location (GIT installation)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Troubleshooting.html#virtualenv-setup-fails">Virtualenv setup fails</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Troubleshooting.html#localhost-not-found">Localhost not found</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Troubleshooting.html#linux-troubleshooting">Linux Troubleshooting</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Troubleshooting.html#mac-troubleshooting">Mac Troubleshooting</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Troubleshooting.html#windows-troubleshooting">Windows Troubleshooting</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Installation-Android.html">Installing on Android</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Installation-Android.html#install-termux">Install Termux</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Android.html#prerequisites">Prerequisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Android.html#running-evennia">Running Evennia</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Android.html#caveats">Caveats</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Android.html#troubleshooting">Troubleshooting</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Installation-Upgrade.html">Upgrading an existing installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Installation-Upgrade.html#evennia-v0-9-5-to-1-0">Evennia v0.9.5 to 1.0</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="Installation-Git.html">Installing with GIT</a></li>
<li class="toctree-l1"><a class="reference internal" href="Installation-Docker.html">Installing with Docker</a></li>
<li class="toctree-l1"><a class="reference internal" href="Installation-Troubleshooting.html">Installation Troubleshooting</a></li>
<li class="toctree-l1"><a class="reference internal" href="Installation-Android.html">Installing on Android</a></li>
<li class="toctree-l1"><a class="reference internal" href="Installation-Upgrade.html">Upgrading an existing installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="Installation-Non-Interactive.html">Non-interactive setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="Running-Evennia.html">Start Stop Reload</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Running-Evennia.html#starting-evennia">Starting Evennia</a></li>
<li class="toctree-l2"><a class="reference internal" href="Running-Evennia.html#reloading">Reloading</a></li>
<li class="toctree-l2"><a class="reference internal" href="Running-Evennia.html#stopping">Stopping</a></li>
<li class="toctree-l2"><a class="reference internal" href="Running-Evennia.html#foreground-mode">Foreground mode</a></li>
<li class="toctree-l2"><a class="reference internal" href="Running-Evennia.html#resetting">Resetting</a></li>
<li class="toctree-l2"><a class="reference internal" href="Running-Evennia.html#rebooting">Rebooting</a></li>
<li class="toctree-l2"><a class="reference internal" href="Running-Evennia.html#status-and-info">Status and info</a></li>
<li class="toctree-l2"><a class="reference internal" href="Running-Evennia.html#killing-linux-mac-only">Killing (Linux/Mac only)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Running-Evennia.html#django-options">Django options</a></li>
<li class="toctree-l2"><a class="reference internal" href="Running-Evennia.html#advanced-handling-of-evennia-processes">Advanced handling of Evennia processes</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Updating-Evennia.html">Updating Evennia</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Updating-Evennia.html#if-you-installed-with-pip">If you installed with <code class="docutils literal notranslate"><span class="pre">pip</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="Updating-Evennia.html#if-you-installed-with-git">If you installed with <code class="docutils literal notranslate"><span class="pre">git</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="Updating-Evennia.html#if-you-installed-with-docker">If you installed with <code class="docutils literal notranslate"><span class="pre">docker</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="Updating-Evennia.html#resetting-your-database">Resetting your database</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Running-Evennia.html">Start Stop Reload</a></li>
<li class="toctree-l1"><a class="reference internal" href="Updating-Evennia.html">Updating Evennia</a></li>
</ul>
</div>
</section>