mirror of
https://github.com/evennia/evennia.git
synced 2026-03-18 22:06:30 +01:00
535 lines
No EOL
52 KiB
HTML
535 lines
No EOL
52 KiB
HTML
|
||
<!DOCTYPE html>
|
||
|
||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<title>Getting Started — Evennia 1.0-dev 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" />
|
||
</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="nav-item nav-item-0"><a href="index.html">Evennia 1.0-dev documentation</a> »</li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
<div class="body" role="main">
|
||
|
||
<div class="section" id="getting-started">
|
||
<h1>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h1>
|
||
<p>This will help you download, install and start Evennia for the first time.</p>
|
||
<blockquote>
|
||
<div><p>Note: You don’t need to make anything visible to the ‘net in order to run and
|
||
test out Evennia. Apart from downloading and updating you don’t even need an
|
||
internet connection until you feel ready to share your game with the world.</p>
|
||
</div></blockquote>
|
||
<ul class="simple">
|
||
<li><p><a class="reference external" href="/Getting-Started.html#quick-start">Quick Start</a></p></li>
|
||
<li><p><a class="reference external" href="/Getting-Started.html#requirements">Requirements</a></p></li>
|
||
<li><p><a class="reference external" href="/Getting-Started.html#linux-install">Linux Install</a></p></li>
|
||
<li><p><a class="reference external" href="/Getting-Started.html#mac-install">Mac Install</a></p></li>
|
||
<li><p><a class="reference external" href="/Getting-Started.html#windows-install">Windows Install</a></p></li>
|
||
<li><p><a class="reference internal" href="Running-Evennia-in-Docker.html"><span class="doc">Running in Docker</span></a></p></li>
|
||
<li><p><a class="reference external" href="/Getting-Started.html#where-to-go-next">Where to Go Next</a></p></li>
|
||
<li><p><a class="reference external" href="/Getting-Started.html#troubleshooting">Troubleshooting</a></p></li>
|
||
<li><p><a class="reference internal" href="Glossary.html"><span class="doc">Glossary of terms</span></a></p></li>
|
||
</ul>
|
||
<div class="section" id="quick-start">
|
||
<h2>Quick Start<a class="headerlink" href="#quick-start" title="Permalink to this headline">¶</a></h2>
|
||
<p>For the impatient. If you have trouble with a step, you should jump on to the
|
||
more detailed instructions for your platform.</p>
|
||
<ol class="simple">
|
||
<li><p>Install Python, GIT and python-virtualenv. Start a Console/Terminal.</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">cd</span></code> to some place you want to do your development (like a folder
|
||
<code class="docutils literal notranslate"><span class="pre">/home/anna/muddev/</span></code> on Linux or a folder in your personal user directory on Windows).</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">clone</span> <span class="pre">https://github.com/evennia/evennia.git</span></code></p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">virtualenv</span> <span class="pre">evenv</span></code></p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">source</span> <span class="pre">evenv/bin/activate</span></code> (Linux, Mac), <code class="docutils literal notranslate"><span class="pre">evenv\Scripts\activate</span></code> (Windows)</p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">-e</span> <span class="pre">evennia</span></code></p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">evennia</span> <span class="pre">--init</span> <span class="pre">mygame</span></code></p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">cd</span> <span class="pre">mygame</span></code></p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">evennia</span> <span class="pre">migrate</span></code></p></li>
|
||
<li><p><code class="docutils literal notranslate"><span class="pre">evennia</span> <span class="pre">start</span></code> (make sure to make a superuser when asked)
|
||
Evennia should now be running and you can connect to it by pointing a web browser to <code class="docutils literal notranslate"><span class="pre">http://localhost:4001</span></code> or a MUD telnet client to <code class="docutils literal notranslate"><span class="pre">localhost:4000</span></code> (use <code class="docutils literal notranslate"><span class="pre">127.0.0.1</span></code> if your OS does not recognize <code class="docutils literal notranslate"><span class="pre">localhost</span></code>).</p></li>
|
||
</ol>
|
||
<p>We also release <a class="reference internal" href="Running-Evennia-in-Docker.html"><span class="doc">Docker images</span></a>
|
||
based on <code class="docutils literal notranslate"><span class="pre">master</span></code> and <code class="docutils literal notranslate"><span class="pre">develop</span></code> branches.</p>
|
||
</div>
|
||
<div class="section" id="requirements">
|
||
<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2>
|
||
<p>Any system that supports Python3.7+ should work. We’ll describe how to install
|
||
everything in the following sections.</p>
|
||
<ul class="simple">
|
||
<li><p>Linux/Unix</p></li>
|
||
<li><p>Windows (Vista, Win7, Win8, Win10)</p></li>
|
||
<li><p>Mac OSX (>=10.5 recommended)</p></li>
|
||
<li><p><a class="reference external" href="http://www.python.org">Python</a> (v3.7, 3.8 are tested)</p>
|
||
<ul>
|
||
<li><p><a class="reference external" href="http://pypi.python.org/pypi/virtualenv">virtualenv</a> for making isolated
|
||
Python environments. Installed with <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">virtualenv</span></code>.</p></li>
|
||
</ul>
|
||
</li>
|
||
<li><p><a class="reference external" href="http://git-scm.com/">GIT</a> - version control software for getting and
|
||
updating Evennia itself - Mac users can use the
|
||
<a class="reference external" href="http://code.google.com/p/git-osx-installer/">git-osx-installer</a> or the
|
||
<a class="reference external" href="http://git-scm.com/book/en/Getting-Started-Installing-Git#Installing-on-Mac">MacPorts version</a>.</p></li>
|
||
<li><p><a class="reference external" href="http://twistedmatrix.com">Twisted</a> (v19.0+)</p>
|
||
<ul>
|
||
<li><p><a class="reference external" href="http://www.zope.org/Products/ZopeInterface">ZopeInterface</a> (v3.0+) - usually included in Twisted packages</p></li>
|
||
<li><p>Linux/Mac users may need the <code class="docutils literal notranslate"><span class="pre">gcc</span></code> and <code class="docutils literal notranslate"><span class="pre">python-dev</span></code> packages or equivalent.</p></li>
|
||
<li><p>Windows users need <a class="reference external" href="https://aka.ms/vs/16/release/vs_buildtools.exe">MS Visual C++</a> and <em>maybe</em> <a class="reference external" href="https://pypi.python.org/pypi/pypiwin32">pypiwin32</a>.</p></li>
|
||
</ul>
|
||
</li>
|
||
<li><p><a class="reference external" href="http://www.djangoproject.com">Django</a> (v2.2.x), be warned that latest dev
|
||
version is usually untested with Evennia)</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="linux-install">
|
||
<h2>Linux Install<a class="headerlink" href="#linux-install" title="Permalink to this headline">¶</a></h2>
|
||
<p>If you run into any issues during the installation and first start, please
|
||
check out <a class="reference external" href="/Getting-Started.html#linux-troubleshooting">Linux Troubleshooting</a>.</p>
|
||
<p>For Debian-derived systems (like Ubuntu, Mint etc), start a terminal and
|
||
install the <a class="reference external" href="/Getting-Started.html#requirements">dependencies</a>:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">update</span>
|
||
<span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">python3</span> <span class="n">python3</span><span class="o">-</span><span class="n">pip</span> <span class="n">python3</span><span class="o">-</span><span class="n">dev</span> <span class="n">python3</span><span class="o">-</span><span class="n">setuptools</span> <span class="n">python3</span><span class="o">-</span><span class="n">git</span> <span class="n">python3</span><span class="o">-</span><span class="n">virtualenv</span> <span class="n">gcc</span>
|
||
|
||
<span class="c1"># If you are using an Ubuntu version that defaults to Python3, like 18.04+, use this instead:</span>
|
||
<span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">update</span>
|
||
<span class="n">sudo</span> <span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">python3</span><span class="o">.</span><span class="mi">7</span> <span class="n">python3</span><span class="o">-</span><span class="n">pip</span> <span class="n">python3</span><span class="o">.</span><span class="mi">7</span><span class="o">-</span><span class="n">dev</span> <span class="n">python3</span><span class="o">-</span><span class="n">setuptools</span> <span class="n">virtualenv</span> <span class="n">gcc</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Note that, the default Python version for your distribution may still not be Python3.7 after this. This is ok - we’ll specify exactly which Python to use later.
|
||
You should make sure to <em>not</em> be <code class="docutils literal notranslate"><span class="pre">root</span></code> after this step, running as <code class="docutils literal notranslate"><span class="pre">root</span></code> is a
|
||
security risk. Now create a folder where you want to do all your Evennia
|
||
development:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">mkdir</span> <span class="n">muddev</span>
|
||
<span class="n">cd</span> <span class="n">muddev</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Next we fetch Evennia itself:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">evennia</span><span class="o">/</span><span class="n">evennia</span><span class="o">.</span><span class="n">git</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>A new folder <code class="docutils literal notranslate"><span class="pre">evennia</span></code> will appear containing the Evennia library. This only
|
||
contains the source code though, it is not <em>installed</em> yet. To isolate the
|
||
Evennia install and its dependencies from the rest of the system, it is good
|
||
Python practice to install into a <em>virtualenv</em>. If you are unsure about what a
|
||
virtualenv is and why it’s useful, see the <a class="reference external" href="/Glossary.html#virtualenv">Glossary entry on
|
||
virtualenv</a>.</p>
|
||
<p>Run <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">-V</span></code> to see which version of Python your system defaults to.</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># If your Linux defaults to Python3.7+:</span>
|
||
<span class="n">virtualenv</span> <span class="n">evenv</span>
|
||
|
||
<span class="c1"># If your Linux defaults to Python2 or an older version </span>
|
||
<span class="c1"># of Python3, you must instead point to Python3.7+ explicitly:</span>
|
||
<span class="n">virtualenv</span> <span class="o">-</span><span class="n">p</span> <span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">python3</span><span class="o">.</span><span class="mi">7</span> <span class="n">evenv</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>A new folder <code class="docutils literal notranslate"><span class="pre">evenv</span></code> will appear (we could have called it anything). This
|
||
folder will hold a self-contained setup of Python packages without interfering
|
||
with default Python packages on your system (or the Linux distro lagging behind
|
||
on Python package versions). It will also always use the right version of Python.
|
||
Activate the virtualenv:</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>
|
||
</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.</p>
|
||
<blockquote>
|
||
<div><p>Remember that you need to activate the virtualenv like this <em>every time</em> you
|
||
start a new terminal to get access to the Python packages (notably the
|
||
important <code class="docutils literal notranslate"><span class="pre">evennia</span></code> program) we are about to install.</p>
|
||
</div></blockquote>
|
||
<p>Next, install Evennia into your active virtualenv. Make sure you are standing
|
||
at the top of your mud directory tree (so you see the <code class="docutils literal notranslate"><span class="pre">evennia/</span></code> and <code class="docutils literal notranslate"><span class="pre">evenv/</span></code>
|
||
folders) and run</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="o">-</span><span class="n">e</span> <span class="n">evennia</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>For more info about <code class="docutils literal notranslate"><span class="pre">pip</span></code>, see the <a class="reference external" href="/Glossary.html#pip">Glossary entry on pip</a>. If
|
||
install failed with any issues, see <a class="reference external" href="/Getting-Started.html#linux-troubleshooting">Linux Troubleshooting</a>.</p>
|
||
<p>Next we’ll start our new game, here called “mygame”. This will create yet
|
||
another new folder where you will be creating your new game:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">evennia</span> <span class="o">--</span><span class="n">init</span> <span class="n">mygame</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Your final folder structure should look like this:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">./</span><span class="n">muddev</span>
|
||
<span class="n">evenv</span><span class="o">/</span>
|
||
<span class="n">evennia</span><span class="o">/</span>
|
||
<span class="n">mygame</span><span class="o">/</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>You can <a class="reference external" href="/Server-Conf.html#settings-file">configure Evennia</a> extensively, for example
|
||
to use a <a class="reference internal" href="Choosing-An-SQL-Server.html"><span class="doc">different database</span></a>. For now we’ll just stick
|
||
to the defaults though.</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">mygame</span>
|
||
<span class="n">evennia</span> <span class="n">migrate</span> <span class="c1"># (this creates the database)</span>
|
||
<span class="n">evennia</span> <span class="n">start</span> <span class="c1"># (create a superuser when asked. Email is optional.)</span>
|
||
</pre></div>
|
||
</div>
|
||
<blockquote>
|
||
<div><p>Server logs are found in <code class="docutils literal notranslate"><span class="pre">mygame/server/logs/</span></code>. To easily view server logs
|
||
live in the terminal, use <code class="docutils literal notranslate"><span class="pre">evennia</span> <span class="pre">-l</span></code> (exit the log-view with Ctrl-C).</p>
|
||
</div></blockquote>
|
||
<p>Your game should now be running! Open a web browser at <code class="docutils literal notranslate"><span class="pre">http://localhost:4001</span></code>
|
||
or point a telnet client to <code class="docutils literal notranslate"><span class="pre">localhost:4000</span></code> and log in with the user you
|
||
created. Check out <a class="reference external" href="/Getting-Started.html#where-to-go-next">where to go next</a>.</p>
|
||
</div>
|
||
<div class="section" id="mac-install">
|
||
<h2>Mac Install<a class="headerlink" href="#mac-install" title="Permalink to this headline">¶</a></h2>
|
||
<p>The Evennia server is a terminal program. Open the terminal e.g. from
|
||
<em>Applications->Utilities->Terminal</em>. <a class="reference external" href="http://blog.teamtreehouse.com/introduction-to-the-mac-os-x-command-line">Here is an introduction to the Mac terminal</a>
|
||
if you are unsure how it works. If you run into any issues during the
|
||
installation, please check out <a class="reference external" href="/Getting-Started.html#mac-troubleshooting">Mac Troubleshooting</a>.</p>
|
||
<ul class="simple">
|
||
<li><p>Python should already be installed but you must make sure it’s a high enough version.
|
||
(<a class="reference external" href="http://docs.python-guide.org/en/latest/starting/install/osx/">This</a> discusses
|
||
how you may upgrade it). Remember that you need Python3.7, not Python2.7!</p></li>
|
||
<li><p>GIT can be obtained with
|
||
<a class="reference external" href="http://code.google.com/p/git-osx-installer/">git-osx-installer</a> or via
|
||
MacPorts <a class="reference external" href="http://git-scm.com/book/en/Getting-Started-Installing-Git#Installing-on-Mac">as described
|
||
here</a>.</p></li>
|
||
<li><p>If you run into issues with installing <code class="docutils literal notranslate"><span class="pre">Twisted</span></code> later you may need to
|
||
install gcc and the Python headers.</p></li>
|
||
</ul>
|
||
<p>After this point you should not need <code class="docutils literal notranslate"><span class="pre">sudo</span></code> or any higher privileges to install anything.</p>
|
||
<p>Now create a folder where you want to do all your Evennia development:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">mkdir</span> <span class="n">muddev</span>
|
||
<span class="n">cd</span> <span class="n">muddev</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Next we fetch Evennia itself:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">evennia</span><span class="o">/</span><span class="n">evennia</span><span class="o">.</span><span class="n">git</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>A new folder <code class="docutils literal notranslate"><span class="pre">evennia</span></code> will appear containing the Evennia library. This only
|
||
contains the source code though, it is not <em>installed</em> yet. To isolate the
|
||
Evennia install and its dependencies from the rest of the system, it is good
|
||
Python practice to install into a <em>virtualenv</em>. If you are unsure about what a
|
||
virtualenv is and why it’s useful, see the <a class="reference external" href="/Glossary.html#virtualenv">Glossary entry on virtualenv</a>.</p>
|
||
<p>Run <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">-V</span></code> to check which Python your system defaults to.</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># If your Mac defaults to Python3:</span>
|
||
<span class="n">virtualenv</span> <span class="n">evenv</span>
|
||
|
||
<span class="c1"># If your Mac defaults to Python2 you need to specify the Python3.7 binary explicitly:</span>
|
||
<span class="n">virtualenv</span> <span class="o">-</span><span class="n">p</span> <span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">your</span><span class="o">/</span><span class="n">python3</span><span class="o">.</span><span class="mi">7</span> <span class="n">evenv</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>A new folder <code class="docutils literal notranslate"><span class="pre">evenv</span></code> will appear (we could have called it anything). This
|
||
folder will hold a self-contained setup of Python packages without interfering
|
||
with default Python packages on your system. Activate the virtualenv:</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>
|
||
</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 the virtual
|
||
environment is active.</p>
|
||
<blockquote>
|
||
<div><p>Remember that you need to activate the virtualenv like this <em>every time</em> you
|
||
start a new terminal to get access to the Python packages (notably the
|
||
important <code class="docutils literal notranslate"><span class="pre">evennia</span></code> program) we are about to install.</p>
|
||
</div></blockquote>
|
||
<p>Next, install Evennia into your active virtualenv. Make sure you are standing
|
||
at the top of your mud directory tree (so you see the <code class="docutils literal notranslate"><span class="pre">evennia/</span></code> and <code class="docutils literal notranslate"><span class="pre">evenv/</span></code>
|
||
folders) and run</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="o">--</span><span class="n">upgrade</span> <span class="n">pip</span> <span class="c1"># Old pip versions may be an issue on Mac.</span>
|
||
<span class="n">pip</span> <span class="n">install</span> <span class="o">--</span><span class="n">upgrade</span> <span class="n">setuptools</span> <span class="c1"># Ditto concerning Mac issues.</span>
|
||
<span class="n">pip</span> <span class="n">install</span> <span class="o">-</span><span class="n">e</span> <span class="n">evennia</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>For more info about <code class="docutils literal notranslate"><span class="pre">pip</span></code>, see the <a class="reference external" href="/Glossary.html#pip">Glossary entry on pip</a>. If
|
||
install failed with any issues, see <a class="reference external" href="/Getting-Started.html#mac-troubleshooting">Mac Troubleshooting</a>.</p>
|
||
<p>Next we’ll start our new game. We’ll call it “mygame” here. This creates a new
|
||
folder where you will be creating your new game:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">evennia</span> <span class="o">--</span><span class="n">init</span> <span class="n">mygame</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Your final folder structure should look like this:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">./</span><span class="n">muddev</span>
|
||
<span class="n">evenv</span><span class="o">/</span>
|
||
<span class="n">evennia</span><span class="o">/</span>
|
||
<span class="n">mygame</span><span class="o">/</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>You can <a class="reference external" href="/Server-Conf.html#settings-file">configure Evennia</a> extensively, for example
|
||
to use a <a class="reference internal" href="Choosing-An-SQL-Server.html"><span class="doc">different database</span></a>. We’ll go with the
|
||
defaults here.</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">mygame</span>
|
||
<span class="n">evennia</span> <span class="n">migrate</span> <span class="c1"># (this creates the database)</span>
|
||
<span class="n">evennia</span> <span class="n">start</span> <span class="c1"># (create a superuser when asked. Email is optional.)</span>
|
||
</pre></div>
|
||
</div>
|
||
<blockquote>
|
||
<div><p>Server logs are found in <code class="docutils literal notranslate"><span class="pre">mygame/server/logs/</span></code>. To easily view server logs
|
||
live in the terminal, use <code class="docutils literal notranslate"><span class="pre">evennia</span> <span class="pre">-l</span></code> (exit the log-view with Ctrl-C).</p>
|
||
</div></blockquote>
|
||
<p>Your game should now be running! Open a web browser at <code class="docutils literal notranslate"><span class="pre">http://localhost:4001</span></code>
|
||
or point a telnet client to <code class="docutils literal notranslate"><span class="pre">localhost:4000</span></code> and log in with the user you
|
||
created. Check out <a class="reference external" href="/Getting-Started.html#where-to-go-next">where to go next</a>.</p>
|
||
</div>
|
||
<div class="section" id="windows-install">
|
||
<h2>Windows Install<a class="headerlink" href="#windows-install" title="Permalink to this headline">¶</a></h2>
|
||
<p>If you run into any issues during the installation, please check out
|
||
<a class="reference external" href="/Getting-Started.html#windows-troubleshooting">Windows Troubleshooting</a>.</p>
|
||
<blockquote>
|
||
<div><p>If you are running Windows10, consider using the Windows Subsystem for Linux
|
||
(<a class="reference external" href="https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux">WSL</a>) instead.
|
||
You should then follow the Linux install instructions above.</p>
|
||
</div></blockquote>
|
||
<p>The Evennia server itself is a command line program. In the Windows launch
|
||
menu, start <em>All Programs -> Accessories -> command prompt</em> and you will get
|
||
the Windows command line interface. Here is <a class="reference external" href="http://www.bleepingcomputer.com/tutorials/windows-command-prompt-introduction/">one of many tutorials on using the Windows command line</a>
|
||
if you are unfamiliar with it.</p>
|
||
<ul class="simple">
|
||
<li><p>Install Python <a class="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. You want Python version <strong>3.7.0</strong> (latest verified version), usually
|
||
the 64-bit version (although it doesn’t matter too much). <strong>When installing, 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)</strong>. This allows you to
|
||
just write <code class="docutils literal notranslate"><span class="pre">python</span></code> in any console without first finding where the <code class="docutils literal notranslate"><span class="pre">python</span></code>
|
||
program actually sits on your hard drive.</p></li>
|
||
<li><p>You need to also get <a class="reference external" href="http://git-scm.com/downloads">GIT</a> and install it. You
|
||
can use the default install options but when you get asked to “Adjust your PATH
|
||
environment”, you should select the second option “Use Git from the Windows
|
||
Command Prompt”, which gives you more freedom as to where you can use the
|
||
program.</p></li>
|
||
<li><p>Finally you must install the <a class="reference external" href="https://aka.ms/vs/16/release/vs_buildtools.exe">Microsoft Visual C++ compiler for
|
||
Python</a>. Download and run the linked installer and
|
||
install the C++ tools. Keep all the defaults. Allow the install of the “Win10 SDK”, even if you are on Win7 (not tested on older Windows versions). If you later have issues with installing Evennia due to a failure to build the “Twisted wheels”, this is where you are missing things.</p></li>
|
||
<li><p>You <em>may</em> need the <a class="reference external" href="https://pypi.python.org/pypi/pypiwin32">pypiwin32</a> Python headers. Install these only if you have issues.</p></li>
|
||
</ul>
|
||
<p>You can install Evennia wherever you want. <code class="docutils literal notranslate"><span class="pre">cd</span></code> to that location and create a
|
||
new folder for all your Evennia development (let’s call it <code class="docutils literal notranslate"><span class="pre">muddev</span></code>).</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">mkdir</span> <span class="n">muddev</span>
|
||
<span class="n">cd</span> <span class="n">muddev</span>
|
||
</pre></div>
|
||
</div>
|
||
<blockquote>
|
||
<div><p>Hint: If <code class="docutils literal notranslate"><span class="pre">cd</span></code> isn’t working you can use <code class="docutils literal notranslate"><span class="pre">pushd</span></code> instead to force the
|
||
directory change.</p>
|
||
</div></blockquote>
|
||
<p>Next we fetch Evennia itself:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">evennia</span><span class="o">/</span><span class="n">evennia</span><span class="o">.</span><span class="n">git</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>A new folder <code class="docutils literal notranslate"><span class="pre">evennia</span></code> will appear containing the Evennia library. This only
|
||
contains the source code though, it is not <em>installed</em> yet. To isolate the
|
||
Evennia install and its dependencies from the rest of the system, it is good
|
||
Python practice to install into a <em>virtualenv</em>. If you are unsure about what a
|
||
virtualenv is and why it’s useful, see the <a class="reference external" href="/Glossary.html#virtualenv">Glossary entry on virtualenv</a>.</p>
|
||
<p>In your console, try <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">-V</span></code> to see which version of Python your system
|
||
defaults to.</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">virtualenv</span>
|
||
|
||
<span class="c1"># If your setup defaults to Python3.7:</span>
|
||
<span class="n">virtualenv</span> <span class="n">evenv</span>
|
||
|
||
<span class="c1"># If your setup defaults to Python2, specify path to python3.exe explicitly:</span>
|
||
<span class="n">virtualenv</span> <span class="o">-</span><span class="n">p</span> <span class="n">C</span><span class="p">:</span>\<span class="n">Python37</span>\<span class="n">python</span><span class="o">.</span><span class="n">exe</span> <span class="n">evenv</span>
|
||
|
||
<span class="c1"># If you get an infinite spooling response, press CTRL + C to interrupt and try using:</span>
|
||
<span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">venv</span> <span class="n">evenv</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>A new folder <code class="docutils literal notranslate"><span class="pre">evenv</span></code> will appear (we could have called it anything). This
|
||
folder will hold a self-contained setup of Python packages without interfering
|
||
with default Python packages on your system. Activate the virtualenv:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># If you are using a standard command prompt, you can use the following:</span>
|
||
<span class="n">evenv</span>\<span class="n">scripts</span>\<span class="n">activate</span><span class="o">.</span><span class="n">bat</span>
|
||
|
||
<span class="c1"># If you are using a PS Shell, Git Bash, or other, you can use the following:</span>
|
||
<span class="o">.</span>\<span class="n">evenv</span>\<span class="n">scripts</span>\<span class="n">activate</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 the virtual
|
||
environment is active.</p>
|
||
<blockquote>
|
||
<div><p>Remember that you need to activate the virtualenv like this <em>every time</em> you
|
||
start a new console window if you want to get access to the Python packages
|
||
(notably the important <code class="docutils literal notranslate"><span class="pre">evennia</span></code> program) we are about to install.</p>
|
||
</div></blockquote>
|
||
<p>Next, install Evennia into your active virtualenv. Make sure you are standing
|
||
at the top of your mud directory tree (so you see the <code class="docutils literal notranslate"><span class="pre">evennia</span></code> and <code class="docutils literal notranslate"><span class="pre">evenv</span></code>
|
||
folders when you use the <code class="docutils literal notranslate"><span class="pre">dir</span></code> command) and run</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="o">-</span><span class="n">e</span> <span class="n">evennia</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>For more info about <code class="docutils literal notranslate"><span class="pre">pip</span></code>, see the <a class="reference external" href="/Glossary.html#pip">Glossary entry on pip</a>. If
|
||
the install failed with any issues, see <a class="reference external" href="/Getting-Started.html#windows-troubleshooting">Windows Troubleshooting</a>.
|
||
Next we’ll start our new game, we’ll call it “mygame” here. This creates a new folder where you will be
|
||
creating your new game:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">evennia</span> <span class="o">--</span><span class="n">init</span> <span class="n">mygame</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Your final folder structure should look like this:</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">path</span>\<span class="n">to</span>\<span class="n">muddev</span>
|
||
<span class="n">evenv</span>\
|
||
<span class="n">evennia</span>\
|
||
<span class="n">mygame</span>\
|
||
</pre></div>
|
||
</div>
|
||
<p>You can <a class="reference external" href="/Server-Conf.html#settings-file">configure Evennia</a> extensively, for example
|
||
to use a <a class="reference internal" href="Choosing-An-SQL-Server.html"><span class="doc">different database</span></a>. We’ll go with the
|
||
defaults here.</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">mygame</span>
|
||
<span class="n">evennia</span> <span class="n">migrate</span> <span class="c1"># (this creates the database)</span>
|
||
<span class="n">evennia</span> <span class="n">start</span> <span class="c1"># (create a superuser when asked. Email is optional.)</span>
|
||
</pre></div>
|
||
</div>
|
||
<blockquote>
|
||
<div><p>Server logs are found in <code class="docutils literal notranslate"><span class="pre">mygame/server/logs/</span></code>. To easily view server logs
|
||
live in the terminal, use <code class="docutils literal notranslate"><span class="pre">evennia</span> <span class="pre">-l</span></code> (exit the log-view with Ctrl-C).</p>
|
||
</div></blockquote>
|
||
<p>Your game should now be running! Open a web browser at <code class="docutils literal notranslate"><span class="pre">http://localhost:4001</span></code>
|
||
or point a telnet client to <code class="docutils literal notranslate"><span class="pre">localhost:4000</span></code> and log in with the user you
|
||
created. Check out <a class="reference external" href="/Getting-Started.html#where-to-go-next">where to go next</a>.</p>
|
||
</div>
|
||
<div class="section" id="where-to-go-next">
|
||
<h2>Where to Go Next<a class="headerlink" href="#where-to-go-next" title="Permalink to this headline">¶</a></h2>
|
||
<p>Welcome to Evennia! Your new game is fully functioning, but empty. If you just
|
||
logged in, stand in the <code class="docutils literal notranslate"><span class="pre">Limbo</span></code> room and run</p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nd">@batchcommand</span> <span class="n">tutorial_world</span><span class="o">.</span><span class="n">build</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>to build <a class="reference internal" href="Tutorial-World-Introduction.html"><span class="doc">Evennia’s tutorial world</span></a> - it’s a small solo quest to explore. Only run the instructed <code class="docutils literal notranslate"><span class="pre">@batchcommand</span></code> once. You’ll get a lot of text scrolling by as the tutorial is built. Once done, the <code class="docutils literal notranslate"><span class="pre">tutorial</span></code> exit will have appeared out of Limbo - just write <code class="docutils literal notranslate"><span class="pre">tutorial</span></code> to enter it.</p>
|
||
<p>Once you get back to <code class="docutils literal notranslate"><span class="pre">Limbo</span></code> from the tutorial (if you get stuck in the tutorial quest you can do <code class="docutils literal notranslate"><span class="pre">@tel</span> <span class="pre">#2</span></code> to jump to Limbo), a good idea is to learn how to <a class="reference internal" href="Start-Stop-Reload.html"><span class="doc">start, stop and reload</span></a> the Evennia server. You may also want to familiarize yourself with some <a class="reference internal" href="Glossary.html"><span class="doc">commonly used terms in our Glossary</span></a>. After that, why not experiment with <a class="reference internal" href="Building-Quickstart.html"><span class="doc">creating some new items and build some new rooms</span></a> out from Limbo.</p>
|
||
<p>From here on, you could move on to do one of our <a class="reference internal" href="Tutorials.html"><span class="doc">introductory tutorials</span></a> or simply dive headlong into Evennia’s comprehensive <a class="reference external" href="https://github.com/evennia/evennia/wiki">manual</a>. While Evennia has no major game systems out of the box, we do supply a range of optional <em>contribs</em> that you can use or borrow from. They range from dice rolling and alternative color schemes to barter and combat systems. You can find the <a class="reference external" href="https://github.com/evennia/evennia/blob/master/evennia/contrib/README.md">growing list of contribs here</a>.</p>
|
||
<p>If you have any questions, you can always ask in <a class="reference external" href="http://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">the developer chat</a> <code class="docutils literal notranslate"><span class="pre">#evennia</span></code> on <code class="docutils literal notranslate"><span class="pre">irc.freenode.net</span></code> or by posting to the <a class="reference external" href="https://groups.google.com/forum/#%21forum/evennia">Evennia forums</a>. You can also join the <a class="reference external" href="https://discord.gg/NecFePw">Discord Server</a>.</p>
|
||
<p>Finally, if you are itching to help out or support Evennia (awesome!) have an
|
||
issue to report or a feature to request, <a class="reference internal" href="How-To-Get-And-Give-Help.html"><span class="doc">see here</span></a>.</p>
|
||
<p>Enjoy your stay!</p>
|
||
</div>
|
||
<div class="section" id="troubleshooting">
|
||
<h2>Troubleshooting<a class="headerlink" href="#troubleshooting" title="Permalink to this headline">¶</a></h2>
|
||
<p>If you have issues with installing or starting Evennia for the first time,
|
||
check the section for your operating system below. If you have an issue not
|
||
covered here, <a class="reference external" href="https://github.com/evennia/evennia/issues">please report it</a>
|
||
so it can be fixed or a workaround found!</p>
|
||
<p>Remember, the server logs are in <code class="docutils literal notranslate"><span class="pre">mygame/server/logs/</span></code>. To easily view server logs in the terminal,
|
||
you can run <code class="docutils literal notranslate"><span class="pre">evennia</span> <span class="pre">-l</span></code>, or (in the future) start the server with <code class="docutils literal notranslate"><span class="pre">evennia</span> <span class="pre">start</span> <span class="pre">-l</span></code>.</p>
|
||
<div class="section" id="linux-troubleshooting">
|
||
<h3>Linux Troubleshooting<a class="headerlink" href="#linux-troubleshooting" title="Permalink to this headline">¶</a></h3>
|
||
<ul class="simple">
|
||
<li><p>If you get an error when installing Evennia (especially with lines mentioning
|
||
failing to include <code class="docutils literal notranslate"><span class="pre">Python.h</span></code>) then try <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">apt-get</span> <span class="pre">install</span> <span class="pre">python3-setuptools</span> <span class="pre">python3-dev</span></code>.
|
||
Once installed, run <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">-e</span> <span class="pre">evennia</span></code> again.</p></li>
|
||
<li><p>Under some not-updated Linux distributions you may run into errors with a
|
||
too-old <code class="docutils literal notranslate"><span class="pre">setuptools</span></code> or missing <code class="docutils literal notranslate"><span class="pre">functools</span></code>. If so, update your environment
|
||
with <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">--upgrade</span> <span class="pre">pip</span> <span class="pre">wheel</span> <span class="pre">setuptools</span></code>. Then try <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">-e</span> <span class="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; <code class="docutils literal notranslate"><span class="pre">Command</span> <span class="pre">"python</span> <span class="pre">setup.py</span> <span class="pre">egg_info"</span> <span class="pre">failed</span> <span class="pre">with</span> <span class="pre">error</span> <span class="pre">code</span> <span class="pre">1</span> <span class="pre">in</span> <span class="pre">/tmp/pip-build-vnIFTg/twisted/</span></code> with errors like <code class="docutils literal notranslate"><span class="pre">distutils.errors.DistutilsError:</span> <span class="pre">Could</span> <span class="pre">not</span> <span class="pre">find</span> <span class="pre">suitable</span> <span class="pre">distribution</span> <span class="pre">for</span> <span class="pre">Requirement.parse('incremental>=16.10.1')</span></code>. This appears possible to solve by simply updating Ubuntu with <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">apt-get</span> <span class="pre">update</span> <span class="pre">&&</span> <span class="pre">sudo</span> <span class="pre">apt-get</span> <span class="pre">dist-upgrade</span></code>.</p></li>
|
||
<li><p>Users of Fedora (notably Fedora 24) has reported a <code class="docutils literal notranslate"><span class="pre">gcc</span></code> error saying the directory <code class="docutils literal notranslate"><span class="pre">/usr/lib/rpm/redhat/redhat-hardened-cc1</span></code> is missing, despite <code class="docutils literal notranslate"><span class="pre">gcc</span></code> itself being installed. <a class="reference external" href="https://gist.github.com/yograterol/99c8e123afecc828cb8c">The confirmed work-around</a> seems to be to install the <code class="docutils literal notranslate"><span class="pre">redhat-rpm-config</span></code> package with e.g. <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">dnf</span> <span class="pre">install</span> <span class="pre">redhat-rpm-config</span></code>.</p></li>
|
||
<li><p>Some users trying to set up a virtualenv on an NTFS filesystem find that it fails due to issues with symlinks not being supported. Answer is to not use NTFS (seriously, why would you do that to yourself?)</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="mac-troubleshooting">
|
||
<h3>Mac Troubleshooting<a class="headerlink" href="#mac-troubleshooting" title="Permalink to this headline">¶</a></h3>
|
||
<ul class="simple">
|
||
<li><p>Mac users have reported a critical <code class="docutils literal notranslate"><span class="pre">MemoryError</span></code> when trying to start Evennia on Mac with a Python version below <code class="docutils literal notranslate"><span class="pre">2.7.12</span></code>. If you get this error, update to the latest XCode and Python2 version.</p></li>
|
||
<li><p>Some Mac users have reported not being able to connect to <code class="docutils literal notranslate"><span class="pre">localhost</span></code> (i.e. your own computer). If so, try to connect to <code class="docutils literal notranslate"><span class="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>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="windows-troubleshooting">
|
||
<h3>Windows Troubleshooting<a class="headerlink" href="#windows-troubleshooting" title="Permalink to this headline">¶</a></h3>
|
||
<ul class="simple">
|
||
<li><p>If you installed Python but the <code class="docutils literal notranslate"><span class="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 <code class="docutils literal notranslate"><span class="pre">localhost:4000</span></code>, try the equivalent <code class="docutils literal notranslate"><span class="pre">127.0.0.1:4000</span></code> instead. Some MUD clients on Windows does not appear to understand the alias <code class="docutils literal notranslate"><span class="pre">localhost</span></code>.</p></li>
|
||
<li><p>If you run <code class="docutils literal notranslate"><span class="pre">virtualenv</span> <span class="pre">evenv</span></code> and get a <code class="docutils literal notranslate"><span class="pre">'virtualenv'</span> <span class="pre">is</span> <span class="pre">not</span> <span class="pre">recognized</span> <span class="pre">as</span> <span class="pre">an</span> <span class="pre">internal</span> <span class="pre">or</span> <span class="pre">external</span> <span class="pre">command,</span> <span class="pre">operable</span> <span class="pre">program</span> <span class="pre">or</span> <span class="pre">batch</span> <span class="pre">file.</span></code> error, you can <code class="docutils literal notranslate"><span class="pre">mkdir</span> <span class="pre">evenv</span></code>, <code class="docutils literal notranslate"><span class="pre">cd</span> <span class="pre">evenv</span></code> and then <code class="docutils literal notranslate"><span class="pre">python</span> <span class="pre">-m</span> <span class="pre">virtualenv</span> <span class="pre">.</span></code> as a workaround.</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 <code class="docutils literal notranslate"><span class="pre">18.1</span></code> failed, install <code class="docutils literal notranslate"><span class="pre">18.0</span></code> manually with <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">twisted==18.0</span></code>. Alternatively you could try to get a 64-bit version of Python (uninstall the 32bit one). If so, you must then <code class="docutils literal notranslate"><span class="pre">deactivate</span></code> the virtualenv, delete the <code class="docutils literal notranslate"><span class="pre">evenv</span></code> folder and recreate it anew (it will then use the new Python executable).</p></li>
|
||
<li><p>If your server won’t start, with no error messages (and no log files at all when starting from scratch), try to start with <code class="docutils literal notranslate"><span class="pre">evennia</span> <span class="pre">ipstart</span></code> instead. If you then see an error about <code class="docutils literal notranslate"><span class="pre">system</span> <span class="pre">cannot</span> <span class="pre">find</span> <span class="pre">the</span> <span class="pre">path</span> <span class="pre">specified</span></code>, it may be that the file <code class="docutils literal notranslate"><span class="pre">evennia/evennia/server/twistd.bat</span></code> has the wrong path to the <code class="docutils literal notranslate"><span class="pre">twistd</span></code> executable. This file is auto-generated, so try to delete it and then run <code class="docutils literal notranslate"><span class="pre">evennia</span> <span class="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 <code class="docutils literal notranslate"><span class="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>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</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>
|
||
<p><h3><a href="index.html">Table of Contents</a></h3>
|
||
<ul>
|
||
<li><a class="reference internal" href="#">Getting Started</a><ul>
|
||
<li><a class="reference internal" href="#quick-start">Quick Start</a></li>
|
||
<li><a class="reference internal" href="#requirements">Requirements</a></li>
|
||
<li><a class="reference internal" href="#linux-install">Linux Install</a></li>
|
||
<li><a class="reference internal" href="#mac-install">Mac Install</a></li>
|
||
<li><a class="reference internal" href="#windows-install">Windows Install</a></li>
|
||
<li><a class="reference internal" href="#where-to-go-next">Where to Go Next</a></li>
|
||
<li><a class="reference internal" href="#troubleshooting">Troubleshooting</a><ul>
|
||
<li><a class="reference internal" href="#linux-troubleshooting">Linux Troubleshooting</a></li>
|
||
<li><a class="reference internal" href="#mac-troubleshooting">Mac Troubleshooting</a></li>
|
||
<li><a class="reference internal" href="#windows-troubleshooting">Windows Troubleshooting</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
<div role="note" aria-label="source link">
|
||
<!--h3>This Page</h3-->
|
||
<ul class="this-page-menu">
|
||
<li><a href="_sources/Getting-Started.md.txt"
|
||
rel="nofollow">Show Page Source</a></li>
|
||
</ul>
|
||
</div>
|
||
<h3>Versions</h3>
|
||
<ul>
|
||
<li><a href="Getting-Started.html">1.0-dev (develop branch)</a></li>
|
||
<li><a href="../0.9.1/Getting-Started.html">0.9.1 (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="nav-item nav-item-0"><a href="index.html">Evennia 1.0-dev documentation</a> »</li>
|
||
</ul>
|
||
</div>
|
||
<div class="footer" role="contentinfo">
|
||
© Copyright 2020, The Evennia developer community.
|
||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.4.
|
||
</div>
|
||
</body>
|
||
</html> |