<p>If you have an issue not covered here, <aclass="reference external"href="https://github.com/evennia/evennia/issues/new/choose">please report it</a> so it can be fixed or a workaround found!</p>
<p>The server logs are in <codeclass="docutils literal notranslate"><spanclass="pre">mygame/server/logs/</span></code>. To easily view server logs in the terminal,
you can run <codeclass="docutils literal notranslate"><spanclass="pre">evennia</span><spanclass="pre">-l</span></code>, or start/reload the server with <codeclass="docutils literal notranslate"><spanclass="pre">evennia</span><spanclass="pre">start</span><spanclass="pre">-l</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">evennia</span><spanclass="pre">reload</span><spanclass="pre">-l</span></code>.</p>
<li><p><aclass="reference external"href="https://www.zope.org/Products/ZopeInterface">ZopeInterface</a> (v3.0+) - usually included in Twisted packages</p></li>
<li><p>Linux/Mac users may need the <codeclass="docutils literal notranslate"><spanclass="pre">gcc</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">python-dev</span></code> packages or equivalent.</p></li>
<li><p>Windows users need <aclass="reference external"href="https://aka.ms/vs/16/release/vs_buildtools.exe">MS Visual C++</a> and <em>maybe</em><aclass="reference external"href="https://pypi.python.org/pypi/pypiwin32">pypiwin32</a>.</p></li>
<li><p><aclass="reference external"href="https://www.djangoproject.com">Django</a> (v4.2+), be warned that latest dev version is usually untested with Evennia.</p></li>
<li><p>Mac users can use the <aclass="reference external"href="https://code.google.com/p/git-osx-installer/">git-osx-installer</a> or the <aclass="reference external"href="https://git-scm.com/book/en/Getting-Started-Installing-Git#Installing-on-Mac">MacPorts version</a>.</p></li>
<h2>Confusion of location (GIT installation)<aclass="headerlink"href="#confusion-of-location-git-installation"title="Permalink to this headline">¶</a></h2>
<p>When doing the <aclass="reference internal"href="Installation-Git.html"><spanclass="doc std std-doc">Git installation</span></a>, some may be confused and install Evennia in the wrong location. After following the instructions (and using a virtualenv), the folder structure should look like this:</p>
<p>The evennia code itself is found inside <codeclass="docutils literal notranslate"><spanclass="pre">evennia/evennia/</span></code> (so two levels down). Your settings file
is <codeclass="docutils literal notranslate"><spanclass="pre">mygame/server/conf/settings.py</span></code> and the <em>parent</em> setting file is <codeclass="docutils literal notranslate"><spanclass="pre">evennia/evennia/settings_default.py</span></code>.</p>
</section>
<sectionid="virtualenv-setup-fails">
<h2>Virtualenv setup fails<aclass="headerlink"href="#virtualenv-setup-fails"title="Permalink to this headline">¶</a></h2>
<p>When doing the <codeclass="docutils literal notranslate"><spanclass="pre">python3.11</span><spanclass="pre">-m</span><spanclass="pre">venv</span><spanclass="pre">evenv</span></code> step, some users report getting an error; something like:</p>
<p>You can solve this by installing the <codeclass="docutils literal notranslate"><spanclass="pre">python3.11-venv</span></code> package or equivalent for your OS. Alternatively you can bootstrap it in this way:</p>
<p>This should set up the virtualenv without <codeclass="docutils literal notranslate"><spanclass="pre">pip</span></code>. Activate the new virtualenv and then install pip from within it:</p>
<p>Either way, you should now be able to continue with the installation.</p>
</section>
<sectionid="localhost-not-found">
<h2>Localhost not found<aclass="headerlink"href="#localhost-not-found"title="Permalink to this headline">¶</a></h2>
<p>If <codeclass="docutils literal notranslate"><spanclass="pre">localhost</span></code> doesn’t work when trying to connect to your local game, try <codeclass="docutils literal notranslate"><spanclass="pre">127.0.0.1</span></code>, which is the same thing.</p>
</section>
<sectionid="linux-troubleshooting">
<h2>Linux Troubleshooting<aclass="headerlink"href="#linux-troubleshooting"title="Permalink to this headline">¶</a></h2>
<ulclass="simple">
<li><p>If you get an error when installing Evennia (especially with lines mentioning
failing to include <codeclass="docutils literal notranslate"><spanclass="pre">Python.h</span></code>) then try <codeclass="docutils literal notranslate"><spanclass="pre">sudo</span><spanclass="pre">apt-get</span><spanclass="pre">install</span><spanclass="pre">python3-setuptools</span><spanclass="pre">python3-dev</span></code>. Once installed, run <codeclass="docutils literal notranslate"><spanclass="pre">pip</span><spanclass="pre">install</span><spanclass="pre">-e</span><spanclass="pre">evennia</span></code> again.</p></li>
<li><p>When doing a <aclass="reference internal"href="Installation-Git.html"><spanclass="doc std std-doc">git install</span></a>, some not-updated Linux distributions may give errors
about a too-old <codeclass="docutils literal notranslate"><spanclass="pre">setuptools</span></code> or missing <codeclass="docutils literal notranslate"><spanclass="pre">functools</span></code>. If so, update your environment
with <codeclass="docutils literal notranslate"><spanclass="pre">pip</span><spanclass="pre">install</span><spanclass="pre">--upgrade</span><spanclass="pre">pip</span><spanclass="pre">wheel</span><spanclass="pre">setuptools</span></code>. Then try <codeclass="docutils literal notranslate"><spanclass="pre">pip</span><spanclass="pre">install</span><spanclass="pre">-e</span><spanclass="pre">evennia</span></code> again.</p></li>
<li><p>One user reported a rare issue on Ubuntu 16 is an install error on installing Twisted; <codeclass="docutils literal notranslate"><spanclass="pre">Command</span><spanclass="pre">"python</span><spanclass="pre">setup.py</span><spanclass="pre">egg_info"</span><spanclass="pre">failed</span><spanclass="pre">with</span><spanclass="pre">error</span><spanclass="pre">code</span><spanclass="pre">1</span><spanclass="pre">in</span><spanclass="pre">/tmp/pip-build-vnIFTg/twisted/</span></code> with errors like <codeclass="docutils literal notranslate"><spanclass="pre">distutils.errors.DistutilsError:</span><spanclass="pre">Could</span><spanclass="pre">not</span><spanclass="pre">find</span><spanclass="pre">suitable</span><spanclass="pre">distribution</span><spanclass="pre">for</span><spanclass="pre">Requirement.parse('incremental>=16.10.1')</span></code>. This appears possible to solve by simply updating Ubuntu with <codeclass="docutils literal notranslate"><spanclass="pre">sudo</span><spanclass="pre">apt-get</span><spanclass="pre">update</span><spanclass="pre">&&</span><spanclass="pre">sudo</span><spanclass="pre">apt-get</span><spanclass="pre">dist-upgrade</span></code>.</p></li>
<li><p>Users of Fedora (notably Fedora 24) has reported a <codeclass="docutils literal notranslate"><spanclass="pre">gcc</span></code> error saying the directory
<codeclass="docutils literal notranslate"><spanclass="pre">/usr/lib/rpm/redhat/redhat-hardened-cc1</span></code> is missing, despite <codeclass="docutils literal notranslate"><spanclass="pre">gcc</span></code> itself being installed. <aclass="reference external"href="https://gist.github.com/yograterol/99c8e123afecc828cb8c">The
confirmed work-around</a> seems to be to install the <codeclass="docutils literal notranslate"><spanclass="pre">redhat-rpm-config</span></code> package with e.g. <codeclass="docutils literal notranslate"><spanclass="pre">sudo</span><spanclass="pre">dnf</span><spanclass="pre">install</span><spanclass="pre">redhat-rpm-config</span></code>.</p></li>
<li><p>Some Mac users have reported not being able to connect to <codeclass="docutils literal notranslate"><spanclass="pre">localhost</span></code> (i.e. your own computer). If so, try to connect to <codeclass="docutils literal notranslate"><spanclass="pre">127.0.0.1</span></code> instead, which is the same thing. Use port 4000 from mud clients and port 4001 from the web browser as usual.</p></li>
<li><p>If you get a <codeclass="docutils literal notranslate"><spanclass="pre">MemoryError</span></code> when starting Evennia, or when looking at the log, this may be due to an sqlite versioning issue. <aclass="reference external"href="https://github.com/evennia/evennia/discussions/2637">A user in our forums</a> found a working solution for this. <aclass="reference external"href="https://github.com/evennia/evennia/issues/2854">Here</a> is another variation to solve it.</p></li>
<li><p>If you install with <codeclass="docutils literal notranslate"><spanclass="pre">pip</span><spanclass="pre">install</span><spanclass="pre">evennia</span></code> and find that the <codeclass="docutils literal notranslate"><spanclass="pre">evennia</span></code> command is not available, run <codeclass="docutils literal notranslate"><spanclass="pre">py</span><spanclass="pre">-m</span><spanclass="pre">evennia</span></code> once. This should add the evennia binary to your environment. If this fails, make sure you are using a <aclass="reference internal"href="Installation-Git.html#virtualenv"><spanclass="std std-doc">virtualenv</span></a>. Worst case, you can keep using <codeclass="docutils literal notranslate"><spanclass="pre">py</span><spanclass="pre">-m</span><spanclass="pre">evennia</span></code> in the places where the <codeclass="docutils literal notranslate"><spanclass="pre">evennia</span></code> command is used.</p></li>
<li><p>Install Python <aclass="reference external"href="https://www.python.org/downloads/windows/">from the Python homepage</a>. You will need to be a Windows Administrator to install packages.</p></li>
<li><p>When installing Python, make sure to check-mark <em>all</em> install options, especially the one about making Python available on the path (you may have to scroll to see it). This allows you to
just write <codeclass="docutils literal notranslate"><spanclass="pre">python</span></code> in any console without first finding where the <codeclass="docutils literal notranslate"><spanclass="pre">python</span></code> program actually sits on your hard drive.</p></li>
<li><p>If you get a <codeclass="docutils literal notranslate"><spanclass="pre">command</span><spanclass="pre">not</span><spanclass="pre">found</span></code> when trying to run the <codeclass="docutils literal notranslate"><spanclass="pre">evennia</span></code> program after installation, try closing the Console and starting it again (remember to re-activate the virtualenv if you use one!). Sometimes Windows is not updating its environment properly and <codeclass="docutils literal notranslate"><spanclass="pre">evennia</span></code> will be available only in the new console.</p></li>
<li><p>If you installed Python but the <codeclass="docutils literal notranslate"><spanclass="pre">python</span></code> command is not available (even in a new console), then
you might have missed installing Python on the path. In the Windows Python installer you get a list of options for what to install. Most or all options are pre-checked except this one, and you may even have to scroll down to see it. Reinstall Python and make sure it’s checked.</p></li>
<li><p>If your MUD client cannot connect to <codeclass="docutils literal notranslate"><spanclass="pre">localhost:4000</span></code>, try the equivalent <codeclass="docutils literal notranslate"><spanclass="pre">127.0.0.1:4000</span></code>
instead. Some MUD clients on Windows does not appear to understand the alias <codeclass="docutils literal notranslate"><spanclass="pre">localhost</span></code>.</p></li>
<li><p>Some Windows users get an error installing the Twisted ‘wheel’. A wheel is a pre-compiled binary
package for Python. A common reason for this error is that you are using a 32-bit version of Python, but Twisted has not yet uploaded the latest 32-bit wheel. Easiest way to fix this is to install a slightly older Twisted version. So if, say, version <codeclass="docutils literal notranslate"><spanclass="pre">22.1</span></code> failed, install <codeclass="docutils literal notranslate"><spanclass="pre">22.0</span></code> manually with <codeclass="docutils literal notranslate"><spanclass="pre">pip</span><spanclass="pre">install</span><spanclass="pre">twisted==22.0</span></code>. Alternatively you could check that you are using the 64-bit version of Python and uninstall any 32bit one. If so, you must then <codeclass="docutils literal notranslate"><spanclass="pre">deactivate</span></code> the virtualenv, delete the <codeclass="docutils literal notranslate"><spanclass="pre">evenv</span></code> folder and recreate it anew with your new Python.</p></li>
<li><p>If you’ve done a git installation, and your server won’t start with an error message like <codeclass="docutils literal notranslate"><spanclass="pre">AttributeError:</span><spanclass="pre">module</span><spanclass="pre">'evennia'</span><spanclass="pre">has</span><spanclass="pre">no</span><spanclass="pre">attribute</span><spanclass="pre">'_init'</span></code>, it may be a python path issue. In a terminal, cd to <codeclass="docutils literal notranslate"><spanclass="pre">(your</span><spanclass="pre">python</span><spanclass="pre">directory)\site-packages</span></code> and run the command <codeclass="docutils literal notranslate"><spanclass="pre">echo</span><spanclass="pre">"C:\absolute\path\to\evennia"</span><spanclass="pre">></span><spanclass="pre">local-vendors.pth</span></code>. Open the created file in your favorite IDE and make sure it is saved with <em>UTF-8</em> encoding and not <em>UTF-8 with BOM</em>.</p></li>
scratch), try to start with <codeclass="docutils literal notranslate"><spanclass="pre">evennia</span><spanclass="pre">ipstart</span></code> instead. If you then see an error about <codeclass="docutils literal notranslate"><spanclass="pre">system</span><spanclass="pre">cannot</span><spanclass="pre">find</span><spanclass="pre">the</span><spanclass="pre">path</span><spanclass="pre">specified</span></code>, it may be that the file <codeclass="docutils literal notranslate"><spanclass="pre">evennia\evennia\server\twistd.bat</span></code> has the wrong path to the <codeclass="docutils literal notranslate"><spanclass="pre">twistd</span></code> executable. This file is auto-generated, so try to delete it and then run <codeclass="docutils literal notranslate"><spanclass="pre">evennia</span><spanclass="pre">start</span></code> to rebuild it and see if it works. If it still doesn’t work you need to open it in a text editor like Notepad. It’s just one line containing the path to the <codeclass="docutils literal notranslate"><spanclass="pre">twistd.exe</span></code> executable as determined by Evennia. If you installed Twisted in a non-standard location this might be wrong and you should update the line to the real location.</p></li>
development. Timeout errors and the inability to run <codeclass="docutils literal notranslate"><spanclass="pre">evennia</span><spanclass="pre">connections</span></code> may be due to your anti-virus software interfering. Try disabling or changing your anti-virus software settings.</p></li>
