Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-05 23:47:16 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated HTML docs

Browse source
This commit is contained in:
Evennia docbuilder action 2022-10-23 09:04:07 +00:00
parent 478c0b6473
commit 0e0cd24694
958 changed files with 41858 additions and 39649 deletions
Download patch file Download diff file Expand all files Collapse all files

189
docs/1.0-dev/Contribs/Contrib-XYZGrid.html
View file

@ -43,7 +43,96 @@
</div>
<div class="document">
<div class="documentwrapper">
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
</a></p>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">XYZgrid</a><ul>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#installation">Installation</a></li>
<li><a class="reference internal" href="#overview">Overview</a></li>
<li><a class="reference internal" href="#first-example-usage">First example usage</a></li>
<li><a class="reference internal" href="#defining-an-xymap">Defining an XYMap</a><ul>
<li><a class="reference internal" href="#the-zcoord">The Zcoord</a></li>
<li><a class="reference internal" href="#map-string">Map String</a></li>
<li><a class="reference internal" href="#map-legend">Map legend</a><ul>
<li><a class="reference internal" href="#important-node-link-properties">Important node/link properties</a></li>
<li><a class="reference internal" href="#default-legend">Default Legend</a></li>
<li><a class="reference internal" href="#map-nodes">Map Nodes</a></li>
<li><a class="reference internal" href="#one-way-links">One-way links</a></li>
<li><a class="reference internal" href="#up-and-down-links">Up- and Down-links</a></li>
<li><a class="reference internal" href="#interrupt-nodes">Interrupt-nodes</a></li>
<li><a class="reference internal" href="#interrupt-links">Interrupt-links</a></li>
<li><a class="reference internal" href="#blocked-links">Blocked links</a></li>
<li><a class="reference internal" href="#router-links">Router-links</a></li>
<li><a class="reference internal" href="#teleporter-links">Teleporter Links</a></li>
<li><a class="reference internal" href="#map-transition-nodes">Map-Transition Nodes</a></li>
</ul>
</li>
<li><a class="reference internal" href="#prototypes">Prototypes</a><ul>
<li><a class="reference internal" href="#extending-the-base-prototypes">Extending the base prototypes</a></li>
</ul>
</li>
<li><a class="reference internal" href="#options">Options</a></li>
<li><a class="reference internal" href="#about-the-pathfinder">About the Pathfinder</a></li>
</ul>
</li>
<li><a class="reference internal" href="#id1">XYZGrid</a></li>
<li><a class="reference internal" href="#xyzroom-and-xyzexit">XYZRoom and XYZExit</a></li>
<li><a class="reference internal" href="#working-with-the-grid">Working with the grid</a></li>
<li><a class="reference internal" href="#details">Details</a></li>
<li><a class="reference internal" href="#id2">Installation</a></li>
<li><a class="reference internal" href="#example-usage">Example usage</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="Contrib-Wilderness.html"
title="previous chapter">Wilderness system</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="Contrib-Buffs.html"
title="next chapter">Buffs</a></p>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/Contribs/Contrib-XYZGrid.md.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</div><h3>Links</h3>
<ul>
<li><a href="https://www.evennia.com">Home page</a> </li>
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Blog</a>
</li>
</ul>
<h3>Versions</h3>
<ul>
<li><a href="Contrib-XYZGrid.html">1.0-dev (develop branch)</a></li>
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
</ul>
</div>
</div>
<div class="bodywrapper">
<div class="body" role="main">
@ -99,16 +188,15 @@ doing</p>
</div>
<p>This will install all optional requirements of Evennia.</p>
</li>
<li><p>Import and add the <code class="docutils literal notranslate"><span class="pre">evennia.contrib.commands.XYZGridCmdSet</span></code> to the
<li><p>Import and <a class="reference internal" href="../Components/Command-Sets.html"><span class="doc std std-doc">add</span></a> the <code class="docutils literal notranslate"><span class="pre">evennia.contrib.grid.xyzgrid.commands.XYZGridCmdSet</span></code> to the
<code class="docutils literal notranslate"><span class="pre">CharacterCmdset</span></code> cmdset in <code class="docutils literal notranslate"><span class="pre">mygame/commands.default_cmds.py</span></code>. Reload
the server. This makes the <code class="docutils literal notranslate"><span class="pre">map</span></code>, <code class="docutils literal notranslate"><span class="pre">goto/path</span></code> and the modified <code class="docutils literal notranslate"><span class="pre">teleport</span></code> and
<code class="docutils literal notranslate"><span class="pre">open</span></code> commands available in-game.</p></li>
</ol>
<ol>
<li><p>Edit <code class="docutils literal notranslate"><span class="pre">mygame/server/conf/settings.py</span></code> and add</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>EXTRA_LAUNCHER_COMMANDS[&#39;xyzgrid&#39;] = &#39;evennia.contrib.launchcmd.xyzcommand&#39;
</pre></div>
</div>
<p>and</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>PROTOTYPE_MODULES += [’evennia.contrib.grid.xyzgrid.prototypes’]
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>EXTRA_LAUNCHER_COMMANDS[&#39;xyzgrid&#39;] = &#39;evennia.contrib.grid.xyzgrid.launchcmd.xyzcommand&#39;
PROTOTYPE_MODULES += [&#39;evennia.contrib.grid.xyzgrid.prototypes&#39;]
</pre></div>
</div>
<p>This will add the new ability to enter <code class="docutils literal notranslate"><span class="pre">evennia</span> <span class="pre">xyzgrid</span> <span class="pre">&lt;option&gt;</span></code> on the
@ -1482,99 +1570,10 @@ file will be overwritten, so edit that file rather than this one.</small></p>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
</a></p>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
<p><h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">XYZgrid</a><ul>
<li><a class="reference internal" href="#examples">Examples</a></li>
<li><a class="reference internal" href="#installation">Installation</a></li>
<li><a class="reference internal" href="#overview">Overview</a></li>
<li><a class="reference internal" href="#first-example-usage">First example usage</a></li>
<li><a class="reference internal" href="#defining-an-xymap">Defining an XYMap</a><ul>
<li><a class="reference internal" href="#the-zcoord">The Zcoord</a></li>
<li><a class="reference internal" href="#map-string">Map String</a></li>
<li><a class="reference internal" href="#map-legend">Map legend</a><ul>
<li><a class="reference internal" href="#important-node-link-properties">Important node/link properties</a></li>
<li><a class="reference internal" href="#default-legend">Default Legend</a></li>
<li><a class="reference internal" href="#map-nodes">Map Nodes</a></li>
<li><a class="reference internal" href="#one-way-links">One-way links</a></li>
<li><a class="reference internal" href="#up-and-down-links">Up- and Down-links</a></li>
<li><a class="reference internal" href="#interrupt-nodes">Interrupt-nodes</a></li>
<li><a class="reference internal" href="#interrupt-links">Interrupt-links</a></li>
<li><a class="reference internal" href="#blocked-links">Blocked links</a></li>
<li><a class="reference internal" href="#router-links">Router-links</a></li>
<li><a class="reference internal" href="#teleporter-links">Teleporter Links</a></li>
<li><a class="reference internal" href="#map-transition-nodes">Map-Transition Nodes</a></li>
</ul>
</li>
<li><a class="reference internal" href="#prototypes">Prototypes</a><ul>
<li><a class="reference internal" href="#extending-the-base-prototypes">Extending the base prototypes</a></li>
</ul>
</li>
<li><a class="reference internal" href="#options">Options</a></li>
<li><a class="reference internal" href="#about-the-pathfinder">About the Pathfinder</a></li>
</ul>
</li>
<li><a class="reference internal" href="#id1">XYZGrid</a></li>
<li><a class="reference internal" href="#xyzroom-and-xyzexit">XYZRoom and XYZExit</a></li>
<li><a class="reference internal" href="#working-with-the-grid">Working with the grid</a></li>
<li><a class="reference internal" href="#details">Details</a></li>
<li><a class="reference internal" href="#id2">Installation</a></li>
<li><a class="reference internal" href="#example-usage">Example usage</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="Contrib-Wilderness.html"
title="previous chapter">Wilderness system</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="Contrib-Buffs.html"
title="next chapter">Buffs</a></p>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/Contribs/Contrib-XYZGrid.md.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</div><h3>Links</h3>
<ul>
<li><a href="https://www.evennia.com">Home page</a> </li>
<li><a href="https://github.com/evennia/evennia">Evennia Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Blog</a>
</li>
</ul>
<h3>Versions</h3>
<ul>
<li><a href="Contrib-XYZGrid.html">1.0-dev (develop branch)</a></li>
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>