mirror of
https://github.com/evennia/evennia.git
synced 2026-03-23 16:26:30 +01:00
Updated HTML docs
This commit is contained in:
Griatch
parent
f505351730
commit
a551188691
1002 changed files with 30387 additions and 9820 deletions
|
|
@ -7,11 +7,13 @@
|
|||
<title>Tutorial World Introduction — 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> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Evennia 1.0-dev documentation</a> »</li>
|
||||
<li class="nav-item nav-item-last"><a href="#">Tutorial World Introduction</a></li>
|
||||
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
|
@ -36,8 +41,11 @@
|
|||
|
||||
<div class="section" id="tutorial-world-introduction">
|
||||
<h1>Tutorial World Introduction<a class="headerlink" href="#tutorial-world-introduction" title="Permalink to this headline">¶</a></h1>
|
||||
<p>The <em>Tutorial World</em> is a small and functioning MUD-style game world. It is intended to be deconstructed and used as a way to learn Evennia. The game consists of a single-player quest and has some 20 rooms that you can explore as you seek to discover the whereabouts of a mythical weapon.</p>
|
||||
<p>The source code is fully documented. You can find the whole thing in <code class="docutils literal notranslate"><span class="pre">evennia/contrib/tutorial_world/</span></code>.</p>
|
||||
<p>The <em>Tutorial World</em> is a small and functioning MUD-style game world. It is intended to be
|
||||
deconstructed and used as a way to learn Evennia. The game consists of a single-player quest and
|
||||
has some 20 rooms that you can explore as you seek to discover the whereabouts of a mythical weapon.</p>
|
||||
<p>The source code is fully documented. You can find the whole thing in
|
||||
<code class="docutils literal notranslate"><span class="pre">evennia/contrib/tutorial_world/</span></code>.</p>
|
||||
<p>Some features exemplified by the tutorial world:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Tutorial command, giving “behind-the-scenes” help for every room and some of the special objects</p></li>
|
||||
|
|
@ -57,27 +65,44 @@
|
|||
</ul>
|
||||
<div class="section" id="install">
|
||||
<h2>Install<a class="headerlink" href="#install" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The tutorial world consists of a few modules in <code class="docutils literal notranslate"><span class="pre">evennia/contrib/tutorial_world/</span></code> containing custom <a class="reference internal" href="Typeclasses.html"><span class="doc">Typeclasses</span></a> for <a class="reference internal" href="Objects.html"><span class="doc">rooms and objects</span></a> and associated <a class="reference internal" href="Commands.html"><span class="doc">Commands</span></a>.</p>
|
||||
<p>These reusable bits and pieces are then put together into a functioning game area (“world” is maybe too big a word for such a small zone) using a <a class="reference internal" href="Batch-Processors.html"><span class="doc">batch script</span></a> called <code class="docutils literal notranslate"><span class="pre">build.ev</span></code>. To install, log into the server as the superuser (user #1) and run:</p>
|
||||
<p>The tutorial world consists of a few modules in <code class="docutils literal notranslate"><span class="pre">evennia/contrib/tutorial_world/</span></code> containing custom
|
||||
<a class="reference internal" href="Typeclasses.html"><span class="doc">Typeclasses</span></a> for <a class="reference internal" href="Objects.html"><span class="doc">rooms and objects</span></a> and associated <a class="reference internal" href="Commands.html"><span class="doc">Commands</span></a>.</p>
|
||||
<p>These reusable bits and pieces are then put together into a functioning game area (“world” is maybe
|
||||
too big a word for such a small zone) using a <a class="reference internal" href="Batch-Processors.html"><span class="doc">batch script</span></a> called <code class="docutils literal notranslate"><span class="pre">build.ev</span></code>. To
|
||||
install, log into the server as the superuser (user #1) 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>The world will be built (this might take a while, so don’t rerun the command even if it seems the system has frozen). After finishing you will end up back in Limbo with a new exit called <code class="docutils literal notranslate"><span class="pre">tutorial</span></code>.</p>
|
||||
<p>The world will be built (this might take a while, so don’t rerun the command even if it seems the
|
||||
system has frozen). After finishing you will end up back in Limbo with a new exit called <code class="docutils literal notranslate"><span class="pre">tutorial</span></code>.</p>
|
||||
<p>An alternative is</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nd">@batchcommand</span><span class="o">/</span><span class="n">interactive</span> <span class="n">tutorial_world</span><span class="o">.</span><span class="n">build</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>with the /interactive switch you are able to step through the building process at your own pace to see what happens in detail.</p>
|
||||
<p>To play the tutorial “correctly”, you should <em>not</em> do so as superuser. The reason for this is that many game systems ignore the presence of a superuser and will thus not work as normal. Use the <code class="docutils literal notranslate"><span class="pre">@quell</span></code> command to limit your powers or log out and reconnect as a different user. As superuser you can of course examine things “under the hood” later if you want.</p>
|
||||
<p>with the /interactive switch you are able to step through the building process at your own pace to
|
||||
see what happens in detail.</p>
|
||||
<p>To play the tutorial “correctly”, you should <em>not</em> do so as superuser. The reason for this is that
|
||||
many game systems ignore the presence of a superuser and will thus not work as normal. Use the
|
||||
<code class="docutils literal notranslate"><span class="pre">@quell</span></code> command to limit your powers or log out and reconnect as a different user. As superuser you
|
||||
can of course examine things “under the hood” later if you want.</p>
|
||||
</div>
|
||||
<div class="section" id="gameplay">
|
||||
<h2>Gameplay<a class="headerlink" href="#gameplay" title="Permalink to this headline">¶</a></h2>
|
||||
<p><img alt="the castle off the moor" src="https://images-wixmp-ed30a86b8c4ca887773594c2.wixmp.com/f/22916c25-6299-453d-a221-446ec839f567/da2pmzu-46d63c6d-9cdc-41dd-87d6-1106db5a5e1a.jpg/v1/fill/w_600,h_849,q_75,strp/the_castle_off_the_moor_by_griatch_art_da2pmzu-fullview.jpg?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ1cm46YXBwOiIsImlzcyI6InVybjphcHA6Iiwib2JqIjpbW3siaGVpZ2h0IjoiPD04NDkiLCJwYXRoIjoiXC9mXC8yMjkxNmMyNS02Mjk5LTQ1M2QtYTIyMS00NDZlYzgzOWY1NjdcL2RhMnBtenUtNDZkNjNjNmQtOWNkYy00MWRkLTg3ZDYtMTEwNmRiNWE1ZTFhLmpwZyIsIndpZHRoIjoiPD02MDAifV1dLCJhdWQiOlsidXJuOnNlcnZpY2U6aW1hZ2Uub3BlcmF0aW9ucyJdfQ.omuS3D1RmFiZCy9OSXiIita-HxVGrBok3_7asq0rflw" /></p>
|
||||
<p><em>To get into the mood of this miniature quest, imagine you are an adventurer out to find fame and fortune. You have heard rumours of an old castle ruin by the coast. In its depth a warrior princess was buried together with her powerful magical weapon - a valuable prize, if it’s true. Of course this is a chance to adventure that you cannot turn down!</em></p>
|
||||
<p><em>You reach the ocean in the midst of a raging thunderstorm. With wind and rain screaming in your face you stand where the moor meets the sea along a high, rocky coast …</em></p>
|
||||
<p></p>
|
||||
<p><em>To get into the mood of this miniature quest, imagine you are an adventurer out to find fame and
|
||||
fortune. You have heard rumours of an old castle ruin by the coast. In its depth a warrior princess
|
||||
was buried together with her powerful magical weapon - a valuable prize, if it’s true. Of course
|
||||
this is a chance to adventure that you cannot turn down!</em></p>
|
||||
<p><em>You reach the ocean in the midst of a raging thunderstorm. With wind and rain screaming in your
|
||||
face you stand where the moor meets the sea along a high, rocky coast …</em></p>
|
||||
<ul class="simple">
|
||||
<li><p>Look at everything.</p></li>
|
||||
<li><p>Some objects are interactive in more than one way. Use the normal <code class="docutils literal notranslate"><span class="pre">help</span></code> command to get a feel for which commands are available at any given time. (use the command <code class="docutils literal notranslate"><span class="pre">tutorial</span></code> to get insight behind the scenes of the tutorial).</p></li>
|
||||
<li><p>Some objects are interactive in more than one way. Use the normal <code class="docutils literal notranslate"><span class="pre">help</span></code> command to get a feel for
|
||||
which commands are available at any given time. (use the command <code class="docutils literal notranslate"><span class="pre">tutorial</span></code> to get insight behind
|
||||
the scenes of the tutorial).</p></li>
|
||||
<li><p>In order to fight, you need to first find some type of weapon.</p></li>
|
||||
<li><p><em>slash</em> is a normal attack</p></li>
|
||||
<li><p><em>stab</em> launches an attack that makes more damage but has a lower chance to hit.</p></li>
|
||||
|
|
@ -88,20 +113,27 @@
|
|||
</div>
|
||||
<div class="section" id="uninstall">
|
||||
<h2>Uninstall<a class="headerlink" href="#uninstall" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Uninstalling the tutorial world basically means deleting all the rooms and objects it consists of. First, move out of the tutorial area.</p>
|
||||
<p>Uninstalling the tutorial world basically means deleting all the rooms and objects it consists of.
|
||||
First, move out of the tutorial area.</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="nd">@find</span> <span class="n">tut</span><span class="c1">#01</span>
|
||||
<span class="nd">@find</span> <span class="n">tut</span><span class="c1">#16</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>This should locate the first and last rooms created by <code class="docutils literal notranslate"><span class="pre">build.ev</span></code> - <em>Intro</em> and <em>Outro</em>. If you installed normally, everything created between these two numbers should be part of the tutorial. Note their dbref numbers, for example 5 and 80. Next we just delete all objects in that range:</p>
|
||||
<p>This should locate the first and last rooms created by <code class="docutils literal notranslate"><span class="pre">build.ev</span></code> - <em>Intro</em> and <em>Outro</em>. If you
|
||||
installed normally, everything created between these two numbers should be part of the tutorial.
|
||||
Note their dbref numbers, for example 5 and 80. Next we just delete all objects in that range:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="nd">@del</span> <span class="mi">5</span><span class="o">-</span><span class="mi">80</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>You will see some errors since some objects are auto-deleted and so cannot be found when the delete mechanism gets to them. That’s fine. You should have removed the tutorial completely once the command finishes.</p>
|
||||
<p>You will see some errors since some objects are auto-deleted and so cannot be found when the delete
|
||||
mechanism gets to them. That’s fine. You should have removed the tutorial completely once the
|
||||
command finishes.</p>
|
||||
</div>
|
||||
<div class="section" id="notes">
|
||||
<h2>Notes<a class="headerlink" href="#notes" title="Permalink to this headline">¶</a></h2>
|
||||
<p>When reading and learning from the code, keep in mind that <em>Tutorial World</em> was created with a very specific goal: to install easily and to not permanently modify the rest of the server. It therefore goes to some length to use only temporary solutions and to clean up after
|
||||
<p>When reading and learning from the code, keep in mind that <em>Tutorial World</em> was created with a very
|
||||
specific goal: to install easily and to not permanently modify the rest of the server. It therefore
|
||||
goes to some length to use only temporary solutions and to clean up after
|
||||
itself.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -162,7 +194,10 @@ itself.</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> »</li>
|
||||
<li class="nav-item nav-item-0"><a href="index.html">Evennia 1.0-dev documentation</a> »</li>
|
||||
<li class="nav-item nav-item-last"><a href="#">Tutorial World Introduction</a></li>
|
||||
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue