mirror of
https://github.com/evennia/evennia.git
synced 2026-03-23 08:16:30 +01:00
Updated HTML docs
This commit is contained in:
Evennia docbuilder action
parent
2362e4fd72
commit
72b06ea80f
31 changed files with 134 additions and 148 deletions
|
|
@ -60,22 +60,19 @@ better match with the vanilla Evennia install.</p>
|
|||
<h2>Installing Evennia<a class="headerlink" href="#installing-evennia" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Firstly, set aside a folder/directory on your drive for everything to follow.</p>
|
||||
<p>You need to start by installing <a class="reference external" href="https://www.evennia.com">Evennia</a> by following most of the
|
||||
<a class="reference internal" href="../Setup/Installation.html"><span class="doc std std-doc">Getting Started Instructions</span></a> for your OS. The difference is that you need to <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">clone</span> <span class="pre">https://github.com/TehomCD/evennia.git</span></code> instead of Evennia’s repo because Arx uses TehomCD’s older
|
||||
Evennia 0.8 <a class="reference external" href="https://github.com/TehomCD/evennia">fork</a>, notably still using Python2. This detail is
|
||||
important if referring to newer Evennia documentation.</p>
|
||||
<p>If you are new to Evennia it’s <em>highly</em> recommended that you run through the
|
||||
<a class="reference internal" href="../Setup/Installation-Git.html"><span class="doc std std-doc">Git-installation instructions</span></a> for your OS. The difference is that you
|
||||
need to <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">clone</span> <span class="pre">https://github.com/TehomCD/evennia.git</span></code> instead of Evennia’s repo because Arx
|
||||
uses TehomCD’s older Evennia 0.8 <a class="reference external" href="https://github.com/TehomCD/evennia">fork</a>, notably still using
|
||||
Python2. This detail is important if referring to newer Evennia documentation.</p>
|
||||
<p>If you are new to Evennia it’s <em>highly</em> recommended that you run through the normal install
|
||||
instructions in full - including initializing and starting a new empty game and connecting to it.
|
||||
That way you can be sure Evennia works correctly as a base line. If you have trouble, make sure to
|
||||
read the <span class="xref myst">Troubleshooting instructions</span> for your
|
||||
operating system. You can also drop into our
|
||||
<a class="reference external" href="https://groups.google.com/forum/#%21forum/evennia">forums</a>, join <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 chat from the linked <a class="reference external" href="https://discord.gg/NecFePw">Discord Server</a>.</p>
|
||||
That way you can be sure Evennia works correctly as a baseline.</p>
|
||||
<p>After installing you should have a <code class="docutils literal notranslate"><span class="pre">virtualenv</span></code> running and you should have the following file
|
||||
structure in your set-aside folder:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">vienv</span><span class="o">/</span>
|
||||
<span class="n">evennia</span><span class="o">/</span>
|
||||
<span class="n">mygame</span><span class="o">/</span>
|
||||
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">muddev</span><span class="o">/</span>
|
||||
<span class="n">vienv</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>Here <code class="docutils literal notranslate"><span class="pre">mygame</span></code> is the empty game you created during the Evennia install, with <code class="docutils literal notranslate"><span class="pre">evennia</span> <span class="pre">--init</span></code>. Go to
|
||||
|
|
@ -85,23 +82,20 @@ to compare to.</p>
|
|||
</section>
|
||||
<section id="installing-arxcode">
|
||||
<h2>Installing Arxcode<a class="headerlink" href="#installing-arxcode" title="Permalink to this headline">¶</a></h2>
|
||||
<section id="clone-the-arxcode-repo">
|
||||
<h3>Clone the arxcode repo<a class="headerlink" href="#clone-the-arxcode-repo" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Cd to the root of your directory and clone the released source code from github:</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">cd</span></code> to the root of your directory and clone the released source code from github:</p>
|
||||
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>git clone https://github.com/Arx-Game/arxcode.git myarx
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>A new folder <code class="docutils literal notranslate"><span class="pre">myarx</span></code> should appear next to the ones you already had. You could rename this to
|
||||
something else if you want.</p>
|
||||
<p>Cd into <code class="docutils literal notranslate"><span class="pre">myarx</span></code>. If you wonder about the structure of the game dir, you can
|
||||
<p><code class="docutils literal notranslate"><span class="pre">cd</span></code> into <code class="docutils literal notranslate"><span class="pre">myarx</span></code>. If you wonder about the structure of the game dir, you can
|
||||
<a class="reference internal" href="../Howto/Starting/Part1/Gamedir-Overview.html"><span class="doc std std-doc">read more about it here</span></a>.</p>
|
||||
</section>
|
||||
<section id="clean-up-settings">
|
||||
<h3>Clean up settings<a class="headerlink" href="#clean-up-settings" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Arx has split evennia’s normal settings into <code class="docutils literal notranslate"><span class="pre">base_settings.py</span></code> and <code class="docutils literal notranslate"><span class="pre">production_settings.py</span></code>. It
|
||||
also has its own solution for managing ‘secret’ parts of the settings file. We’ll keep most of Arx
|
||||
way but remove the secret-handling and replace it with the normal Evennia method.</p>
|
||||
<p>Cd into <code class="docutils literal notranslate"><span class="pre">myarx/server/conf/</span></code> and open the file <code class="docutils literal notranslate"><span class="pre">settings.py</span></code> in a text editor. The top part (within
|
||||
way but we’ll remove the secret-handling and replace it with the normal Evennia method.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">cd</span></code> into <code class="docutils literal notranslate"><span class="pre">myarx/server/conf/</span></code> and open the file <code class="docutils literal notranslate"><span class="pre">settings.py</span></code> in a text editor. The top part (within
|
||||
<code class="docutils literal notranslate"><span class="pre">"""..."""</span></code>) is just help text. Wipe everything underneath that and make it look like this instead
|
||||
(don’t forget to save):</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">base_settings</span> <span class="kn">import</span> <span class="o">*</span>
|
||||
|
|
@ -210,10 +204,10 @@ This creates a new in-game Character and places it in your current location.</p>
|
|||
</ol>
|
||||
<p>Now that you have a Character and an Account object, there’s a few additional things you may need to
|
||||
do in order for some commands to function properly. You can either execute these as in-game commands
|
||||
while <code class="docutils literal notranslate"><span class="pre">@ic</span></code> (controlling your character object).</p>
|
||||
while <code class="docutils literal notranslate"><span class="pre">ic</span></code> (controlling your character object).</p>
|
||||
<ol class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">@py</span> <span class="pre">from</span> <span class="pre">web.character.models</span> <span class="pre">import</span> <span class="pre">RosterEntry;RosterEntry.objects.create(player=self.player,</span> <span class="pre">character=self)</span></code></p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">@py</span> <span class="pre">from</span> <span class="pre">world.dominion.models</span> <span class="pre">import</span> <span class="pre">PlayerOrNpc,</span> <span class="pre">AssetOwner;dompc</span> <span class="pre">=</span> <span class="pre">PlayerOrNpc.objects.create(player</span> <span class="pre">=</span> <span class="pre">self.player);AssetOwner.objects.create(player=dompc)</span></code></p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">py</span> <span class="pre">from</span> <span class="pre">web.character.models</span> <span class="pre">import</span> <span class="pre">RosterEntry;RosterEntry.objects.create(player=self.player,</span> <span class="pre">character=self)</span></code></p></li>
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">py</span> <span class="pre">from</span> <span class="pre">world.dominion.models</span> <span class="pre">import</span> <span class="pre">PlayerOrNpc,</span> <span class="pre">AssetOwner;dompc</span> <span class="pre">=</span> <span class="pre">PlayerOrNpc.objects.create(player</span> <span class="pre">=</span> <span class="pre">self.player);AssetOwner.objects.create(player=dompc)</span></code></p></li>
|
||||
</ol>
|
||||
<p>Those steps will give you a ‘RosterEntry’, ‘PlayerOrNpc’, and ‘AssetOwner’ objects. RosterEntry
|
||||
explicitly connects a character and account object together, even while offline, and contains
|
||||
|
|
@ -224,10 +218,11 @@ offscreen members of a character’s family. It also allows for membership in Or
|
|||
AssetOwner holds information about a character or organization’s money and resources.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="alternate-guide-by-pax-for-installing-on-windows">
|
||||
<h2>Alternate guide by Pax for installing on Windows<a class="headerlink" href="#alternate-guide-by-pax-for-installing-on-windows" title="Permalink to this headline">¶</a></h2>
|
||||
<section id="alternate-windows-install-guide">
|
||||
<h2>Alternate Windows install guide<a class="headerlink" href="#alternate-windows-install-guide" title="Permalink to this headline">¶</a></h2>
|
||||
<p><em>Contributed by Pax</em></p>
|
||||
<p>If for some reason you cannot use the Windows Subsystem for Linux (which would use instructions
|
||||
identical to the ones above), it’s possible to get Evennia running under Anaconda for Windows. The
|
||||
identical to the ones above), it’s possible to get Evennia/Arx running under Anaconda for Windows. The
|
||||
process is a little bit trickier.</p>
|
||||
<p>Make sure you have:</p>
|
||||
<ul class="simple">
|
||||
|
|
@ -273,7 +268,6 @@ not need winpty.</p>
|
|||
<p>winpty …/evennia/bin/windows/evennia.bat start</p>
|
||||
<p>Once this is done, you should have your Evennia server running Arxcode up
|
||||
on localhost at port 4000, and the webserver at <a class="reference external" href="http://localhost:4001/">http://localhost:4001/</a></p>
|
||||
<p>And you are done! Huzzah!</p>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
|
@ -302,7 +296,6 @@ on localhost at port 4000, and the webserver at <a class="reference external" hr
|
|||
<li><a class="reference internal" href="#">Arxcode installing help</a><ul>
|
||||
<li><a class="reference internal" href="#installing-evennia">Installing Evennia</a></li>
|
||||
<li><a class="reference internal" href="#installing-arxcode">Installing Arxcode</a><ul>
|
||||
<li><a class="reference internal" href="#clone-the-arxcode-repo">Clone the arxcode repo</a></li>
|
||||
<li><a class="reference internal" href="#clean-up-settings">Clean up settings</a></li>
|
||||
<li><a class="reference internal" href="#install-arx-dependencies">Install Arx dependencies</a></li>
|
||||
<li><a class="reference internal" href="#adding-logs-folder">Adding logs/ folder</a></li>
|
||||
|
|
@ -310,7 +303,7 @@ on localhost at port 4000, and the webserver at <a class="reference external" hr
|
|||
<li><a class="reference internal" href="#additional-setup-steps">Additional Setup Steps</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#alternate-guide-by-pax-for-installing-on-windows">Alternate guide by Pax for installing on Windows</a></li>
|
||||
<li><a class="reference internal" href="#alternate-windows-install-guide">Alternate Windows install guide</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue