Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-29 03:57:17 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated HTML docs

Browse source
This commit is contained in:
Griatch 2020-06-16 22:49:43 +02:00
parent f505351730
commit a551188691
1002 changed files with 30387 additions and 9820 deletions
Download patch file Download diff file Expand all files Collapse all files

37
docs/1.0-dev/Arxcode-installing-help.html
View file

@ -7,11 +7,13 @@
<title>Arxcode installing help &#8212; 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" />
@ -25,7 +27,10 @@
<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> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">Arxcode installing help</a></li>
</ul>
</div>
@ -55,16 +60,20 @@ better match with the vanilla Evennia install.</p>
<div class="section" id="installing-evennia">
<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="http://www.evennia.com">Evennia</a> by following most of the <a class="reference internal" href="Getting-Started.html"><span class="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>You need to start by installing <a class="reference external" href="http://www.evennia.com">Evennia</a> by following most of the <a class="reference internal" href="Getting-Started.html"><span class="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
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 <a class="reference external" href="/Getting-Started.html#troubleshooting">Troubleshooting instructions</a> for your
read the <a class="reference external" href="Getting-Started.html#troubleshooting">Troubleshooting instructions</a> 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>
<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>
<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>
@ -85,7 +94,8 @@ to compare to.</p>
</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 <a class="reference internal" href="Directory-Overview.html"><span class="doc">read more about it here</span></a>.</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 <a class="reference internal" href="Directory-Overview.html"><span class="doc">read more about it
here</span></a>.</p>
</div>
<div class="section" id="clean-up-settings">
<h3>Clean up settings<a class="headerlink" href="#clean-up-settings" title="Permalink to this headline"></a></h3>
@ -109,7 +119,8 @@ way but remove the secret-handling and replace it with the normal Evennia method
</div>
<blockquote>
<div><p>Note: Indents and capitalization matter in Python. Make indents 4 spaces (not tabs) for your own
sanity. If you want a starter on Python in Evennia, <a class="reference internal" href="Python-basic-introduction.html"><span class="doc">you can look here</span></a>.</p>
sanity. If you want a starter on Python in Evennia, [you can look here](Python-basic-
introduction).</p>
</div></blockquote>
<p>This will import Arx’ base settings and override them with the Evennia-default telnet port and give
the game a name. The slogan changes the sub-text shown under the name of your game in the website
@ -190,7 +201,8 @@ up an Admin Group in Django).</p></li>
account. Move to where you want the new staffer character to appear.</p></li>
<li><p>In the game client, run <code class="docutils literal notranslate"><span class="pre">&#64;create/drop</span> <span class="pre">&lt;staffername&gt;:typeclasses.characters.Character</span></code>, where
<code class="docutils literal notranslate"><span class="pre">&lt;staffername&gt;</span></code> is usually the same name you used for the Staffer account you created in the
Admin earlier (if you are creating a Character for your superuser, use your superuser account name).
Admin earlier (if you are creating a Character for your superuser, use your superuser account
name).
This creates a new in-game Character and places it in your current location.</p></li>
<li><p>Have the new Admin player log into the game.</p></li>
<li><p>Have the new Admin puppet the character with <code class="docutils literal notranslate"><span class="pre">&#64;ic</span> <span class="pre">StafferName</span></code>.</p></li>
@ -214,7 +226,9 @@ AssetOwner holds information about a character or organization’s money and res
</div>
<div class="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>
<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 process is a little bit trickier.</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
process is a little bit trickier.</p>
<p>Make sure you have:</p>
<ul class="simple">
<li><p>Git for Windows https://git-scm.com/download/win</p></li>
@ -327,7 +341,10 @@ on localhost at port 4000, and the webserver at http://localhost:4001/</p>
<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> &#187;</li>
<li class="nav-item nav-item-0"><a href="index.html">Evennia 1.0-dev documentation</a> &#187;</li>
<li class="nav-item nav-item-last"><a href="#">Arxcode installing help</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">