<h1>Installation<aclass="headerlink"href="#installation"title="Permalink to this headline">¶</a></h1>
<p>The Evennia server is installed, run and maintained from the terminal (console/CMD on Windows). Starting the server
doesn’t make anything visible online. Once you download everything you can in fact develop your game in complete
isolation if you want, without needing any access to the internet.</p>
<p>Evennia requires <aclass="reference external"href="https://www.python.org/downloads/">Python</a> 3.9 or 3.10.
Using a <aclass="reference internal"href="../Glossary.html#virtualenv"><spanclass="std std-doc">Python virtualenv</span></a> is highly recommended in order to keep your
Evennia installation independent from the system libraries. Don’t install Evennia as
administrator or superuser.</p>
<divclass="admonition warning">
<pclass="admonition-title">Warning</p>
<p>pip install evennia is not yet available in develop branch. Use the <aclass="reference internal"href="Installation-Git.html"><spanclass="doc std std-doc">git installation</span></a>.</p>
<p>If you are converting an existing game from a previous version, <aclass="reference internal"href="Installation-Upgrade.html"><spanclass="doc std std-doc">see here</span></a>.</p>
<p>Once installed, make sure the <codeclass="docutils literal notranslate"><spanclass="pre">evennia</span></code> command works. Use <codeclass="docutils literal notranslate"><spanclass="pre">evennia</span><spanclass="pre">-h</span></code> for usage help. If you are using a
virtualenv, make sure it’s active whenever you need to use the <codeclass="docutils literal notranslate"><spanclass="pre">evennia</span></code> command.</p>
<p>Alternatively, you can <aclass="reference internal"href="Installation-Git.html"><spanclass="doc std std-doc">install Evennia from github</span></a> or use <aclass="reference internal"href="Installation-Docker.html"><spanclass="doc std std-doc">docker</span></a>.
Check out <aclass="reference internal"href="Installation-Troubleshooting.html"><spanclass="doc std std-doc">installation troubleshooting</span></a> if you run into problems. Some
users have also experimented with <aclass="reference internal"href="Installation-Android.html"><spanclass="doc std std-doc">installing Evennia on Android</span></a>.</p>
<h2>Initialize a new game<aclass="headerlink"href="#initialize-a-new-game"title="Permalink to this headline">¶</a></h2>
<p>Use <codeclass="docutils literal notranslate"><spanclass="pre">cd</span></code> to enter a folder where you want to do your game development. Here (and in
the rest of the Evennia documentation) we call this folder <codeclass="docutils literal notranslate"><spanclass="pre">mygame</span></code>, but you should of course
<p>This will create a new folder <codeclass="docutils literal notranslate"><spanclass="pre">mygame</span></code> (or whatever you chose) in your current location. This
contains empty templates and all the default settings needed to start the server.</p>
<p>This will create the default database (Sqlite3). The database file ends up as <codeclass="docutils literal notranslate"><spanclass="pre">mygame/server/evennia.db3</span></code>. If you
ever want to start from a fresh database, just delete this file and re-run <codeclass="docutils literal notranslate"><spanclass="pre">evennia</span><spanclass="pre">migrate</span></code> again.</p>
<div><p>You can also <aclass="reference internal"href="Installation-Non-Interactive.html"><spanclass="doc std std-doc">automate</span></a> the creation of the super user.</p>
<p>If all went well, the server is now up and running. Point a legacy MUD/telnet client to <codeclass="docutils literal notranslate"><spanclass="pre">localhost:4000</span></code> or
a web browser at <aclass="reference external"href="http://localhost:4001">http://localhost:4001</a> to play your new (if empty) game!</p>
<p>Log in as a new account or use the superuser you just created.</p>
</section>
<sectionid="restarting-and-stopping">
<h2>Restarting and stopping<aclass="headerlink"href="#restarting-and-stopping"title="Permalink to this headline">¶</a></h2>
<p>You can restart the server without disconnecting players:</p>
<p>Full stop of the server (use <codeclass="docutils literal notranslate"><spanclass="pre">evennia</span><spanclass="pre">start</span></code> to restart):</p>
<p>You can start viewing the log immediately when running <codeclass="docutils literal notranslate"><spanclass="pre">evennia</span></code> commands, such as</p>
<p>To exit the log tailing, enter <codeclass="docutils literal notranslate"><spanclass="pre">Ctrl-C</span></code> (<codeclass="docutils literal notranslate"><spanclass="pre">Cmd-C</span></code> for Mac). This will not affect the server.</p>
<h2>Server configuration<aclass="headerlink"href="#server-configuration"title="Permalink to this headline">¶</a></h2>
<p>The server configuration file is <codeclass="docutils literal notranslate"><spanclass="pre">mygame/server/settings.py</span></code>. It’s empty by default. Copy and change
only the settings you want from the <aclass="reference internal"href="Settings-Default.html"><spanclass="doc std std-doc">default settings file</span></a>.</p>
<h2>Register with the Evennia Game Index (optional)<aclass="headerlink"href="#register-with-the-evennia-game-index-optional"title="Permalink to this headline">¶</a></h2>
<p>You can optionally let the world know that you are working on a new Evennia-based game by
registering your server with the <em>Evennia game index</em>. You don’t have to be
open for players to do this - you just mark your game as closed and “pre-alpha”.</p>
<p>See <aclass="reference internal"href="Evennia-Game-Index.html"><spanclass="doc std std-doc">here</span></a> for more instructions and please <aclass="reference external"href="http:///games.evennia.com">check out the index</a>
beforehand to make sure you don’t pick a game name that is already taken - be nice!</p>
<p>Evennia comes with a small <aclass="reference internal"href="../Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Tutorial-World.html"><spanclass="doc std std-doc">Tutorial World</span></a> to experiment and learn from. After logging
<p>Next, why not head into the <aclass="reference internal"href="../Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Part1-Intro.html"><spanclass="doc std std-doc">Starting Tutorial</span></a>
