mirror of
https://github.com/evennia/evennia.git
synced 2026-04-03 22:47:16 +02:00
Updated HTML docs.
This commit is contained in:
Evennia docbuilder action
parent
a6076aff42
commit
64849b32e2
146 changed files with 1903 additions and 2426 deletions
|
|
@ -195,7 +195,7 @@ This is how it can look:</p>
|
|||
<li><p>Changing locks to make tweeting open to more people</p></li>
|
||||
<li><p>Echo your tweets to an in-game channel</p></li>
|
||||
</ul>
|
||||
<p>Rather than using an explicit command you can set up a Script to send automatic tweets, for example to post updated game stats. See the <a class="reference internal" href="../Howtos/Tutorial-Tweeting-Game-Stats.html"><span class="doc std std-doc">Tweeting Game Stats tutorial</span></a> for help.</p>
|
||||
<p>Rather than using an explicit command you can set up a Script to send automatic tweets, for example to post updated game stats. See the <a class="reference internal" href="../Howtos/Web-Tweeting-Game-Stats.html"><span class="doc std std-doc">Tweeting Game Stats tutorial</span></a> for help.</p>
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
|
|
|||
|
|
@ -16,7 +16,9 @@
|
|||
<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" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="next" title="Tutorials and Howto’s" href="../Howtos/Howtos-Overview.html" />
|
||||
<link rel="prev" title="Configuring HAProxy" href="Config-HAProxy.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
<h3>Navigation</h3>
|
||||
|
|
@ -27,7 +29,14 @@
|
|||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../Howtos/Howtos-Overview.html" title="Tutorials and Howto’s"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="Config-HAProxy.html" title="Configuring HAProxy"
|
||||
accesskey="P">previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="Setup-Overview.html" accesskey="U">Server Setup and Life</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Configuring an Apache Proxy</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
|
|
@ -75,6 +84,12 @@
|
|||
</li>
|
||||
</ul>
|
||||
|
||||
<h4>Previous topic</h4>
|
||||
<p class="topless"><a href="Config-HAProxy.html"
|
||||
title="previous chapter">Configuring HAProxy</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="../Howtos/Howtos-Overview.html"
|
||||
title="next chapter">Tutorials and Howto’s</a></p>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
|
|
@ -288,7 +303,14 @@ Not confirmed, but worth trying if there are trouble.</p>
|
|||
<li class="right" >
|
||||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../Howtos/Howtos-Overview.html" title="Tutorials and Howto’s"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="Config-HAProxy.html" title="Configuring HAProxy"
|
||||
>previous</a> |</li>
|
||||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-1"><a href="Setup-Overview.html" >Server Setup and Life</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">Configuring an Apache Proxy</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@
|
|||
<link rel="shortcut icon" href="../_static/favicon.ico"/>
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="next" title="Tutorials and Howto’s" href="../Howtos/Howtos-Overview.html" />
|
||||
<link rel="next" title="Configuring an Apache Proxy" href="Config-Apache-Proxy.html" />
|
||||
<link rel="prev" title="Security Hints and Practices" href="Security-Practices.html" />
|
||||
</head><body>
|
||||
<div class="related" role="navigation" aria-label="related navigation">
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../Howtos/Howtos-Overview.html" title="Tutorials and Howto’s"
|
||||
<a href="Config-Apache-Proxy.html" title="Configuring an Apache Proxy"
|
||||
accesskey="N">next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="Security-Practices.html" title="Security Hints and Practices"
|
||||
|
|
@ -74,8 +74,8 @@
|
|||
<p class="topless"><a href="Security-Practices.html"
|
||||
title="previous chapter">Security Hints and Practices</a></p>
|
||||
<h4>Next topic</h4>
|
||||
<p class="topless"><a href="../Howtos/Howtos-Overview.html"
|
||||
title="next chapter">Tutorials and Howto’s</a></p>
|
||||
<p class="topless"><a href="Config-Apache-Proxy.html"
|
||||
title="next chapter">Configuring an Apache Proxy</a></p>
|
||||
<div role="note" aria-label="source link">
|
||||
<!--h3>This Page</h3-->
|
||||
<ul class="this-page-menu">
|
||||
|
|
@ -350,7 +350,7 @@ uncommented in the config file, it will now start as a background process.</p>
|
|||
<a href="../py-modindex.html" title="Python Module Index"
|
||||
>modules</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="../Howtos/Howtos-Overview.html" title="Tutorials and Howto’s"
|
||||
<a href="Config-Apache-Proxy.html" title="Configuring an Apache Proxy"
|
||||
>next</a> |</li>
|
||||
<li class="right" >
|
||||
<a href="Security-Practices.html" title="Security Hints and Practices"
|
||||
|
|
|
|||
|
|
@ -119,11 +119,8 @@
|
|||
|
||||
<section class="tex2jax_ignore mathjax_ignore" id="installing-with-docker">
|
||||
<h1>Installing with Docker<a class="headerlink" href="#installing-with-docker" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Evennia releases <a class="reference external" href="https://hub.docker.com/r/evennia/evennia/">docker images</a> which makes
|
||||
running an Evennia-based game in a Docker container easy.</p>
|
||||
<p>First, install the <code class="docutils literal notranslate"><span class="pre">docker</span></code> program so you can run the Evennia container. You can get it freely from
|
||||
<a class="reference external" href="https://www.docker.com/">docker.com</a>. Linux users can likely also get it through their normal
|
||||
package manager.</p>
|
||||
<p>Evennia releases <a class="reference external" href="https://hub.docker.com/r/evennia/evennia/">docker images</a> as part of regular commits and releases. This makes running an Evennia-based game in a Docker container easy.</p>
|
||||
<p>First, install the <code class="docutils literal notranslate"><span class="pre">docker</span></code> program so you can run the Evennia container. You can get it freely from <a class="reference external" href="https://www.docker.com/">docker.com</a>. Linux users can likely also get it through their normal package manager.</p>
|
||||
<p>To fetch the latest evennia docker image, run:</p>
|
||||
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>docker pull evennia/evennia
|
||||
</pre></div>
|
||||
|
|
@ -142,11 +139,7 @@ the docker container:</p>
|
|||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>evennia<span class="p">|</span>docker /usr/src/game $
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>This is a normal shell prompt. We are in the <code class="docutils literal notranslate"><span class="pre">/usr/src/game</span></code> location inside the docker container.
|
||||
If you had anything in the folder you started from, you should see it here (with <code class="docutils literal notranslate"><span class="pre">ls</span></code>) since we
|
||||
mounted the current directory to <code class="docutils literal notranslate"><span class="pre">usr/src/game</span></code> (with <code class="docutils literal notranslate"><span class="pre">-v</span></code> above). You have the <code class="docutils literal notranslate"><span class="pre">evennia</span></code> command
|
||||
available and can now proceed to create a new game as per the normal <a class="reference internal" href="Installation.html"><span class="doc std std-doc">game setup</span></a>
|
||||
instructions (no virtualenv needed).</p>
|
||||
<p>This is a normal shell prompt. We are in the <code class="docutils literal notranslate"><span class="pre">/usr/src/game</span></code> location inside the docker container. If you had anything in the folder you started from, you should see it here (with <code class="docutils literal notranslate"><span class="pre">ls</span></code>) since we mounted the current directory to <code class="docutils literal notranslate"><span class="pre">usr/src/game</span></code> (with <code class="docutils literal notranslate"><span class="pre">-v</span></code> above). You have the <code class="docutils literal notranslate"><span class="pre">evennia</span></code> command available and can now proceed to create a new game as per the normal <a class="reference internal" href="Installation.html"><span class="doc std std-doc">game setup</span></a> instructions (no virtualenv needed).</p>
|
||||
<p>You can run Evennia from inside this container if you want to, it’s like you are root in a little
|
||||
isolated Linux environment. To exit the container and all processes in there, press <code class="docutils literal notranslate"><span class="pre">Ctrl-D</span></code>. If you
|
||||
created a new game folder, you will find that it has appeared on-disk.</p>
|
||||
|
|
@ -165,8 +158,7 @@ on your drive.</p></li>
|
|||
</ul>
|
||||
<section id="running-your-game-as-a-docker-image">
|
||||
<h2>Running your game as a docker image<a class="headerlink" href="#running-your-game-as-a-docker-image" title="Permalink to this headline">¶</a></h2>
|
||||
<p>If you run the <code class="docutils literal notranslate"><span class="pre">docker</span></code> command given in the previous section from your game dir you can then
|
||||
easily start Evennia and have a running server without any further fuss.</p>
|
||||
<p>If you run the <code class="docutils literal notranslate"><span class="pre">docker</span></code> command given in the previous section from your game dir you can then easily start Evennia and have a running server without any further fuss.</p>
|
||||
<p>But apart from ease of install, the primary benefit to running an Evennia-based game in a container is to simplify its deployment into a public production environment. Most cloud-based hosting
|
||||
providers these days support the ability to run container-based applications. This makes deploying
|
||||
or updating your game as simple as building a new container image locally, pushing it to your Docker Hub account, and then pulling from Docker Hub into your AWS/Azure/other docker-enabled hosting account. The container eliminates the need to install Python, set up a virtualenv, or run pip to install dependencies.</p>
|
||||
|
|
@ -197,14 +189,11 @@ enter it and run commands).</p>
|
|||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span> docker build -t mydhaccount/mygame .
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>(don’t forget the period at the end, it will use the <code class="docutils literal notranslate"><span class="pre">Dockerfile</span></code> from the current location). Here
|
||||
<code class="docutils literal notranslate"><span class="pre">mydhaccount</span></code> is the name of your <code class="docutils literal notranslate"><span class="pre">dockerhub</span></code> account. If you don’t have a dockerhub account you can build the image locally only (name the container whatever you like in that case, like just <code class="docutils literal notranslate"><span class="pre">mygame</span></code>).</p>
|
||||
<p>Docker images are stored centrally on your computer. You can see which ones you have available
|
||||
locally with <code class="docutils literal notranslate"><span class="pre">docker</span> <span class="pre">images</span></code>. Once built, you have a couple of options to run your game.</p>
|
||||
<p>(don’t forget the period at the end, it will use the <code class="docutils literal notranslate"><span class="pre">Dockerfile</span></code> from the current location). Here <code class="docutils literal notranslate"><span class="pre">mydhaccount</span></code> is the name of your <code class="docutils literal notranslate"><span class="pre">dockerhub</span></code> account. If you don’t have a dockerhub account you can build the image locally only (name the container whatever you like in that case, like just <code class="docutils literal notranslate"><span class="pre">mygame</span></code>).</p>
|
||||
<p>Docker images are stored centrally on your computer. You can see which ones you have available locally with <code class="docutils literal notranslate"><span class="pre">docker</span> <span class="pre">images</span></code>. Once built, you have a couple of options to run your game.</p>
|
||||
<section id="run-container-from-your-game-image-for-development">
|
||||
<h3>Run container from your game image for development<a class="headerlink" href="#run-container-from-your-game-image-for-development" title="Permalink to this headline">¶</a></h3>
|
||||
<p>To run the container based on your game image locally for development, mount the local game
|
||||
directory as before:</p>
|
||||
<p>To run the container based on your game image locally for development, mount the local game directory as before:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>docker run -it --rm -p 4000:4000 -p 4001:4001 -p 4002:4002 -v $PWD:/usr/src/game --user $UID:$GID
|
||||
mydhaccount/mygame
|
||||
</pre></div>
|
||||
|
|
@ -256,10 +245,8 @@ container will get a new container id to reference.</p>
|
|||
</section>
|
||||
<section id="how-it-works">
|
||||
<h2>How it Works<a class="headerlink" href="#how-it-works" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">evennia/evennia</span></code> docker image holds the evennia library and all of its dependencies. It also has an <code class="docutils literal notranslate"><span class="pre">ONBUILD</span></code> directive which is triggered during builds of images derived from it. This
|
||||
<code class="docutils literal notranslate"><span class="pre">ONBUILD</span></code> directive handles setting up a volume and copying your game directory code into the proper location within the container.</p>
|
||||
<p>In most cases, the Dockerfile for an Evennia-based game will only need the <code class="docutils literal notranslate"><span class="pre">FROM</span> <span class="pre">evennia/evennia:latest</span></code> directive, and optionally a <code class="docutils literal notranslate"><span class="pre">MAINTAINER</span></code> directive if you plan to publish
|
||||
your image on Docker Hub and would like to provide contact info.</p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">evennia/evennia</span></code> docker image holds the evennia library and all of its dependencies. It also has an <code class="docutils literal notranslate"><span class="pre">ONBUILD</span></code> directive which is triggered during builds of images derived from it. This <code class="docutils literal notranslate"><span class="pre">ONBUILD</span></code> directive handles setting up a volume and copying your game directory code into the proper location within the container.</p>
|
||||
<p>In most cases, the Dockerfile for an Evennia-based game will only need the <code class="docutils literal notranslate"><span class="pre">FROM</span> <span class="pre">evennia/evennia:latest</span></code> directive, and optionally a <code class="docutils literal notranslate"><span class="pre">MAINTAINER</span></code> directive if you plan to publish your image on Docker Hub and would like to provide contact info.</p>
|
||||
<p>For more information on Dockerfile directives, see the <a class="reference external" href="https://docs.docker.com/engine/reference/builder/">Dockerfile Reference</a>.</p>
|
||||
<p>For more information on volumes and Docker containers, see the Docker site’s <a class="reference external" href="https://docs.docker.com/engine/tutorials/dockervolumes/">Manage data in
|
||||
containers</a> page.</p>
|
||||
|
|
@ -317,8 +304,7 @@ working directory to be your game directory and run</p>
|
|||
<span class="o">-</span> <span class="o">.</span><span class="p">:</span><span class="o">/</span><span class="n">usr</span><span class="o">/</span><span class="n">src</span><span class="o">/</span><span class="n">game</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>With this file in the game directory next to the <code class="docutils literal notranslate"><span class="pre">Dockerfile</span></code>, starting the container is as simple
|
||||
as</p>
|
||||
<p>With this file in the game directory next to the <code class="docutils literal notranslate"><span class="pre">Dockerfile</span></code>, starting the container is as simple as</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">docker</span><span class="o">-</span><span class="n">compose</span> <span class="n">up</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -147,39 +147,44 @@ not recognize <code class="docutils literal notranslate"><span class="pre">local
|
|||
<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>
|
||||
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span> python3.11 -m venv evenv (linux/mac)
|
||||
python -m venv venv evenv (Windows)
|
||||
<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>
|
||||
</aside>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python3.11 -m venv evenv <span class="o">(</span>linux/mac<span class="o">)</span>
|
||||
python -m venv evenv <span class="o">(</span>Windows<span class="o">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<blockquote>
|
||||
<div><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> 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>
|
||||
</div></blockquote>
|
||||
<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>
|
||||
<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)
|
||||
<code class="docutils literal notranslate"><span class="pre">.\evenv\scripts\activate</span></code> (Windows with PS Shell, Git Bash etc)</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
|
||||
the environment to be active.</p>
|
||||
<blockquote>
|
||||
<div><p>Remember that you need to re-activate the virtualenv like this <em>every time</em> you
|
||||
start a new terminal/console. Otherwise the <code class="docutils literal notranslate"><span class="pre">evennia</span></code> command will not be available.</p>
|
||||
</div></blockquote>
|
||||
<div class="admonition important">
|
||||
<p class="admonition-title">Important</p>
|
||||
<p>Remember that you need to (re-)activate the virtualenv like this <em>every time</em> you
|
||||
start a new terminal/console (or restart your computer). Until you do, the <code class="docutils literal notranslate"><span class="pre">evennia</span></code> command will not be available.</p>
|
||||
</div>
|
||||
</section>
|
||||
<section id="linux-install">
|
||||
<h2>Linux Install<a class="headerlink" href="#linux-install" title="Permalink to this headline">¶</a></h2>
|
||||
<p>For Debian-derived systems (like Ubuntu, Mint etc), start a terminal and
|
||||
install the requirements:</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="mf">.11</span> <span class="n">python3</span><span class="mf">.11</span><span class="o">-</span><span class="n">venv</span> <span class="n">python3</span><span class="mf">.11</span><span class="o">-</span><span class="n">dev</span> <span class="n">gcc</span>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo apt-get update
|
||||
sudo apt-get install python3.11 python3.11-venv python3.11-dev gcc
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>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>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>mkdir muddev
|
||||
<span class="nb">cd</span> muddev
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Next we fetch Evennia itself:</p>
|
||||
|
|
@ -191,6 +196,9 @@ contains the source code though, it is not <em>installed</em> yet.</p>
|
|||
<p>At this point it’s now optional but recommended that you initialize and activate a <a class="reference internal" href="#virtualenv"><span class="std std-doc">virtualenv</span></a>.</p>
|
||||
<p>Next, install Evennia (system-wide, or 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> folder, and likely the <code class="docutils literal notranslate"><span class="pre">evenv</span></code> virtualenv folder) and do</p>
|
||||
<aside class="sidebar">
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">-e</span> </code> means that we install evennia in editable mode. If you want to develop on Evennia itself, it means that changes you do to the code is immediately reflected on your running server (you don’t have to reinstall every time you make a change).</p>
|
||||
</aside>
|
||||
<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>
|
||||
|
|
|
|||
|
|
@ -112,20 +112,18 @@
|
|||
|
||||
<section class="tex2jax_ignore mathjax_ignore" id="installation-troubleshooting">
|
||||
<h1>Installation Troubleshooting<a class="headerlink" href="#installation-troubleshooting" title="Permalink to this headline">¶</a></h1>
|
||||
<p>If you have an issue not covered here, <a class="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>If you have an issue not covered here, <a class="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 <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>
|
||||
you can run <code class="docutils literal notranslate"><span class="pre">evennia</span> <span class="pre">-l</span></code>, or start/reload the server with <code class="docutils literal notranslate"><span class="pre">evennia</span> <span class="pre">start</span> <span class="pre">-l</span></code> or <code class="docutils literal notranslate"><span class="pre">evennia</span> <span class="pre">reload</span> <span class="pre">-l</span></code>.</p>
|
||||
<section id="check-your-requirements">
|
||||
<h2>Check your Requirements<a class="headerlink" href="#check-your-requirements" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Any system that supports Python3.9+ should work. We’ll describe how to install
|
||||
everything in the following sections.</p>
|
||||
<p>Any system that supports Python3.9+ should work.</p>
|
||||
<ul class="simple">
|
||||
<li><p>Linux/Unix</p></li>
|
||||
<li><p>Windows (Win7, Win8, Win10, Win11)</p></li>
|
||||
<li><p>Mac OSX (>10.5 recommended)</p></li>
|
||||
<li><p><a class="reference external" href="https://www.python.org">Python</a> (v3.9, 3.10 and 3.11 are tested)</p></li>
|
||||
<li><p><a class="reference external" href="https://twistedmatrix.com">Twisted</a> (v22.0+)</p>
|
||||
<li><p><a class="reference external" href="https://www.python.org">Python</a> (v3.9, 3.10 and 3.11 are tested. 3.11 is recommended)</p></li>
|
||||
<li><p><a class="reference external" href="https://twistedmatrix.com">Twisted</a> (v22.3+)</p>
|
||||
<ul>
|
||||
<li><p><a class="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 <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>
|
||||
|
|
|
|||
|
|
@ -116,17 +116,16 @@ over things manually.</p>
|
|||
<h2>Evennia v0.9.5 to 1.0<a class="headerlink" href="#evennia-v0-9-5-to-1-0" title="Permalink to this headline">¶</a></h2>
|
||||
<section id="upgrading-the-evennia-library">
|
||||
<h3>Upgrading the Evennia library<a class="headerlink" href="#upgrading-the-evennia-library" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Prior to 1.0, all Evennia installs were <a class="reference internal" href="Installation-Git.html"><span class="doc std std-doc">Git-installs</span></a>. These instructions
|
||||
assume that you have a cloned <code class="docutils literal notranslate"><span class="pre">evennia</span></code> repo and use a virtualenv (best practices).</p>
|
||||
<p>Prior to 1.0, all Evennia installs were <a class="reference internal" href="Installation-Git.html"><span class="doc std std-doc">Git-installs</span></a>. These instructions assume that you have a cloned <code class="docutils literal notranslate"><span class="pre">evennia</span></code> repo and use a virtualenv (best practices).</p>
|
||||
<ul class="simple">
|
||||
<li><p>Make sure to stop Evennia 0.9.5 entirely with <code class="docutils literal notranslate"><span class="pre">evennia</span> <span class="pre">stop</span></code>.</p></li>
|
||||
<li><p>Make sure to stop Evennia 0.9.5 entirely with <code class="docutils literal notranslate"><span class="pre">evennia</span> <span class="pre">stop</span></code> from your game dir.</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">deactivate</span></code> to leave your active virtualenv.</p></li>
|
||||
<li><p>Make a <em>backup</em> of your entire <code class="docutils literal notranslate"><span class="pre">mygame</span></code> folder, just to be sure!</p></li>
|
||||
<li><p>Install Python 3.11 (recommended). Follow the <a class="reference internal" href="Installation-Git.html"><span class="doc std std-doc">Git-installation</span></a> for your OS if needed.</p></li>
|
||||
<li><p>Delete the old virtualenv <code class="docutils literal notranslate"><span class="pre">evenv</span></code> folder, or rename it (in case you want to keep using 0.9.5 for a while).</p></li>
|
||||
<li><p>Make <em>new</em> <code class="docutils literal notranslate"><span class="pre">evenv</span></code> virtualenv (see the <a class="reference internal" href="Installation-Git.html#virtualenv"><span class="std std-doc">virtualenv instructions</span></a> for help)</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">cd</span></code> into your <code class="docutils literal notranslate"><span class="pre">evennia/</span></code> root folder (you want to see the <code class="docutils literal notranslate"><span class="pre">docs/</span></code> and <code class="docutils literal notranslate"><span class="pre">bin/</span></code> directories as well as a nested <code class="docutils literal notranslate"><span class="pre">evennia/</span></code> folder)</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">pull</span></code></p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">checkout</span> <span class="pre">develop</span></code> TODO - only until 1.0 release.</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">.</span></code></p></li>
|
||||
<li><p>If you want the optional extra libs (needed by some contribs), do <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">-e</span> <span class="pre">.[extra]</span></code></p></li>
|
||||
<li><p>Test that you can run the <code class="docutils literal notranslate"><span class="pre">evennia</span></code> command.</p></li>
|
||||
|
|
@ -134,12 +133,10 @@ assume that you have a cloned <code class="docutils literal notranslate"><span c
|
|||
</section>
|
||||
<section id="upgrading-your-game-dir">
|
||||
<h3>Upgrading your game dir<a class="headerlink" href="#upgrading-your-game-dir" title="Permalink to this headline">¶</a></h3>
|
||||
<p>If you don’t have anything you want to keep in your existing game dir, you can just start a new onew
|
||||
using the normal <a class="reference internal" href="Installation.html"><span class="doc std std-doc">install instructions</span></a>. If you want to keep/convert your existing
|
||||
game dir, continue below.</p>
|
||||
<p>If you don’t have anything you want to keep in your existing game dir, you can just start a new one using the normal <a class="reference internal" href="Installation.html"><span class="doc std std-doc">install instructions</span></a>. If you want to keep/convert your existing game dir, continue below.</p>
|
||||
<ul class="simple">
|
||||
<li><p>First, make a backup of your exising game dir! If you use version control, make sure to commit your current state.</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">cd</span></code> to your existing 0.9.5-based game folder (like <code class="docutils literal notranslate"><span class="pre">mygame</span></code>.)</p></li>
|
||||
<li><p>First, make a <em>backup</em> of your exising game dir! If you use version control, make sure to commit your current state.</p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">cd</span></code> to your existing 0.9.5-based game folder (like <code class="docutils literal notranslate"><span class="pre">mygame</span></code>).</p></li>
|
||||
<li><p>If you have changed <code class="docutils literal notranslate"><span class="pre">mygame/web</span></code>, <em>rename</em> the folder to <code class="docutils literal notranslate"><span class="pre">web_0.9.5</span></code>. If you didn’t change anything (or don’t have anything you want to keep), you can <em>delete</em> it entirely.</p></li>
|
||||
<li><p>Copy <code class="docutils literal notranslate"><span class="pre">evennia/evennia/game_template/web</span></code> to <code class="docutils literal notranslate"><span class="pre">mygame/</span></code> (e.g. using <code class="docutils literal notranslate"><span class="pre">cp</span> <span class="pre">-Rf</span></code> or a file manager). This new <code class="docutils literal notranslate"><span class="pre">web</span></code> folder <em>replaces the old one</em> and has a very different structure.</p></li>
|
||||
<li><p>It’s possible you need to replace/comment out import and calls to the deprecated
|
||||
|
|
|
|||
|
|
@ -239,7 +239,7 @@ registering your server with the <em>Evennia game index</em>.</p>
|
|||
<section id="the-next-steps">
|
||||
<h2>The Next steps<a class="headerlink" href="#the-next-steps" title="Permalink to this headline">¶</a></h2>
|
||||
<p>You are good to go!</p>
|
||||
<p>Next, why not head into the <a class="reference internal" href="../Howtos/Beginner-Tutorial/Part1/Beginner-Tutorial-Part1-Intro.html"><span class="doc std std-doc">Starting Tutorial</span></a> to learn how to start making your new game!</p>
|
||||
<p>Next, why not head into the <a class="reference internal" href="../Howtos/Beginner-Tutorial/Beginner-Tutorial-Overview.html"><span class="doc std std-doc">Starting Tutorial</span></a> to learn how to start making your new game!</p>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
|
|
|||
|
|
@ -148,8 +148,7 @@ remote hosting later in this document.</p>
|
|||
<p>Evennia will by default accept incoming connections on all interfaces (<code class="docutils literal notranslate"><span class="pre">0.0.0.0</span></code>) so in principle anyone knowing the ports to use and has the IP address to your machine should be able to connect to your game.</p>
|
||||
<aside class="sidebar">
|
||||
<p class="sidebar-title">Closing the log view</p>
|
||||
<p>If you need to close the log-view, use <code class="docutils literal notranslate"><span class="pre">Ctrl-C</span></code>. Use just <code class="docutils literal notranslate"><span class="pre">evennia</span> <span class="pre">--log</span></code> on its own to
|
||||
start tailing the logs again.</p>
|
||||
<p>If you need to close the log-view, use <code class="docutils literal notranslate"><span class="pre">Ctrl-C</span></code>. Use just <code class="docutils literal notranslate"><span class="pre">evennia</span> <span class="pre">--log</span></code> on its own to start tailing the logs again.</p>
|
||||
</aside>
|
||||
<ul class="simple">
|
||||
<li><p>Make sure Evennia is installed and that you have activated the virtualenv. Start the server with <code class="docutils literal notranslate"><span class="pre">evennia</span> <span class="pre">start</span> <span class="pre">--log</span></code>. The <code class="docutils literal notranslate"><span class="pre">--log</span></code> (or <code class="docutils literal notranslate"><span class="pre">-l</span></code>) will make sure that the logs are echoed to the terminal.</p></li>
|
||||
|
|
|
|||
|
|
@ -258,6 +258,11 @@
|
|||
<li class="toctree-l2"><a class="reference internal" href="Config-HAProxy.html#putting-it-all-together">Putting it all together</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="Config-Apache-Proxy.html">Configuring an Apache Proxy</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="Config-Apache-Proxy.html#running-apache-as-a-proxy-in-front-of-evennia">Running Apache as a proxy in front of Evennia</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="Config-Apache-Proxy.html#run-apache-instead-of-the-evennia-webserver">Run Apache instead of the Evennia webserver</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue