Updated HTML docs.

This commit is contained in:
Evennia docbuilder action 2024-06-14 07:30:48 +00:00
parent 90438635b0
commit fba04e8a5e
38 changed files with 830 additions and 143 deletions

View file

@ -85,6 +85,7 @@
</ul>
</li>
<li><a class="reference internal" href="#game-systems">game_systems</a><ul>
<li><a class="reference internal" href="#achievements"><code class="docutils literal notranslate"><span class="pre">achievements</span></code></a></li>
<li><a class="reference internal" href="#barter"><code class="docutils literal notranslate"><span class="pre">barter</span></code></a></li>
<li><a class="reference internal" href="#clothing"><code class="docutils literal notranslate"><span class="pre">clothing</span></code></a></li>
<li><a class="reference internal" href="#containers"><code class="docutils literal notranslate"><span class="pre">containers</span></code></a></li>
@ -200,7 +201,7 @@ in the <a class="reference external" href="https://github.com/evennia/evennia/di
<p><em>Contribs</em> are optional code snippets and systems contributed by
the Evennia community. They vary in size and complexity and
may be more specific about game types and styles than core Evennia.
This page is auto-generated and summarizes all <strong>49</strong> contribs currently included
This page is auto-generated and summarizes all <strong>50</strong> contribs currently included
with the Evennia distribution.</p>
<p>All contrib categories are imported from <code class="docutils literal notranslate"><span class="pre">evennia.contrib</span></code>, such as</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>from evennia.contrib.base_systems import building_menu
@ -244,65 +245,65 @@ copy its entire folder to your game directory and modify/use it from there.</p>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><a class="reference internal" href="#auditing"><span class="std std-doc">auditing</span></a></p></td>
<tr class="row-even"><td><p><a class="reference internal" href="#achievements"><span class="std std-doc">achievements</span></a></p></td>
<td><p><a class="reference internal" href="#auditing"><span class="std std-doc">auditing</span></a></p></td>
<td><p><a class="reference internal" href="#awsstorage"><span class="std std-doc">awsstorage</span></a></p></td>
<td><p><a class="reference internal" href="#barter"><span class="std std-doc">barter</span></a></p></td>
<td><p><a class="reference internal" href="#batchprocessor"><span class="std std-doc">batchprocessor</span></a></p></td>
<td><p><a class="reference internal" href="#bodyfunctions"><span class="std std-doc">bodyfunctions</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#buffs"><span class="std std-doc">buffs</span></a></p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#bodyfunctions"><span class="std std-doc">bodyfunctions</span></a></p></td>
<td><p><a class="reference internal" href="#buffs"><span class="std std-doc">buffs</span></a></p></td>
<td><p><a class="reference internal" href="#building-menu"><span class="std std-doc">building_menu</span></a></p></td>
<td><p><a class="reference internal" href="#character-creator"><span class="std std-doc">character_creator</span></a></p></td>
<td><p><a class="reference internal" href="#clothing"><span class="std std-doc">clothing</span></a></p></td>
<td><p><a class="reference internal" href="#color-markups"><span class="std std-doc">color_markups</span></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#components"><span class="std std-doc">components</span></a></p></td>
<tr class="row-even"><td><p><a class="reference internal" href="#color-markups"><span class="std std-doc">color_markups</span></a></p></td>
<td><p><a class="reference internal" href="#components"><span class="std std-doc">components</span></a></p></td>
<td><p><a class="reference internal" href="#containers"><span class="std std-doc">containers</span></a></p></td>
<td><p><a class="reference internal" href="#cooldowns"><span class="std std-doc">cooldowns</span></a></p></td>
<td><p><a class="reference internal" href="#crafting"><span class="std std-doc">crafting</span></a></p></td>
<td><p><a class="reference internal" href="#custom-gametime"><span class="std std-doc">custom_gametime</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#dice"><span class="std std-doc">dice</span></a></p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#custom-gametime"><span class="std std-doc">custom_gametime</span></a></p></td>
<td><p><a class="reference internal" href="#dice"><span class="std std-doc">dice</span></a></p></td>
<td><p><a class="reference internal" href="#email-login"><span class="std std-doc">email_login</span></a></p></td>
<td><p><a class="reference internal" href="#evadventure"><span class="std std-doc">evadventure</span></a></p></td>
<td><p><a class="reference internal" href="#evscaperoom"><span class="std std-doc">evscaperoom</span></a></p></td>
<td><p><a class="reference internal" href="#extended-room"><span class="std std-doc">extended_room</span></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#fieldfill"><span class="std std-doc">fieldfill</span></a></p></td>
<tr class="row-even"><td><p><a class="reference internal" href="#extended-room"><span class="std std-doc">extended_room</span></a></p></td>
<td><p><a class="reference internal" href="#fieldfill"><span class="std std-doc">fieldfill</span></a></p></td>
<td><p><a class="reference internal" href="#gendersub"><span class="std std-doc">gendersub</span></a></p></td>
<td><p><a class="reference internal" href="#git-integration"><span class="std std-doc">git_integration</span></a></p></td>
<td><p><a class="reference internal" href="#godotwebsocket"><span class="std std-doc">godotwebsocket</span></a></p></td>
<td><p><a class="reference internal" href="#health-bar"><span class="std std-doc">health_bar</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#ingame-map-display"><span class="std std-doc">ingame_map_display</span></a></p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#health-bar"><span class="std std-doc">health_bar</span></a></p></td>
<td><p><a class="reference internal" href="#ingame-map-display"><span class="std std-doc">ingame_map_display</span></a></p></td>
<td><p><a class="reference internal" href="#ingame-python"><span class="std std-doc">ingame_python</span></a></p></td>
<td><p><a class="reference internal" href="#llm"><span class="std std-doc">llm</span></a></p></td>
<td><p><a class="reference internal" href="#mail"><span class="std std-doc">mail</span></a></p></td>
<td><p><a class="reference internal" href="#mapbuilder"><span class="std std-doc">mapbuilder</span></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#menu-login"><span class="std std-doc">menu_login</span></a></p></td>
<tr class="row-even"><td><p><a class="reference internal" href="#mapbuilder"><span class="std std-doc">mapbuilder</span></a></p></td>
<td><p><a class="reference internal" href="#menu-login"><span class="std std-doc">menu_login</span></a></p></td>
<td><p><a class="reference internal" href="#mirror"><span class="std std-doc">mirror</span></a></p></td>
<td><p><a class="reference internal" href="#multidescer"><span class="std std-doc">multidescer</span></a></p></td>
<td><p><a class="reference internal" href="#mux-comms-cmds"><span class="std std-doc">mux_comms_cmds</span></a></p></td>
<td><p><a class="reference internal" href="#name-generator"><span class="std std-doc">name_generator</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#puzzles"><span class="std std-doc">puzzles</span></a></p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#name-generator"><span class="std std-doc">name_generator</span></a></p></td>
<td><p><a class="reference internal" href="#puzzles"><span class="std std-doc">puzzles</span></a></p></td>
<td><p><a class="reference internal" href="#random-string-generator"><span class="std std-doc">random_string_generator</span></a></p></td>
<td><p><a class="reference internal" href="#red-button"><span class="std std-doc">red_button</span></a></p></td>
<td><p><a class="reference internal" href="#rpsystem"><span class="std std-doc">rpsystem</span></a></p></td>
<td><p><a class="reference internal" href="#simpledoor"><span class="std std-doc">simpledoor</span></a></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#slow-exit"><span class="std std-doc">slow_exit</span></a></p></td>
<tr class="row-even"><td><p><a class="reference internal" href="#simpledoor"><span class="std std-doc">simpledoor</span></a></p></td>
<td><p><a class="reference internal" href="#slow-exit"><span class="std std-doc">slow_exit</span></a></p></td>
<td><p><a class="reference internal" href="#talking-npc"><span class="std std-doc">talking_npc</span></a></p></td>
<td><p><a class="reference internal" href="#traits"><span class="std std-doc">traits</span></a></p></td>
<td><p><a class="reference internal" href="#tree-select"><span class="std std-doc">tree_select</span></a></p></td>
<td><p><a class="reference internal" href="#turnbattle"><span class="std std-doc">turnbattle</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#tutorial-world"><span class="std std-doc">tutorial_world</span></a></p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="#turnbattle"><span class="std std-doc">turnbattle</span></a></p></td>
<td><p><a class="reference internal" href="#tutorial-world"><span class="std std-doc">tutorial_world</span></a></p></td>
<td><p><a class="reference internal" href="#unixcommand"><span class="std std-doc">unixcommand</span></a></p></td>
<td><p><a class="reference internal" href="#wilderness"><span class="std std-doc">wilderness</span></a></p></td>
<td><p><a class="reference internal" href="#xyzgrid"><span class="std std-doc">xyzgrid</span></a></p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
@ -462,6 +463,7 @@ the <code class="docutils literal notranslate"><span class="pre">rpg</span></cod
</div>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="Contrib-Achievements.html">Achievements</a></li>
<li class="toctree-l1"><a class="reference internal" href="Contrib-Barter.html">Barter system</a></li>
<li class="toctree-l1"><a class="reference internal" href="Contrib-Clothing.html">Clothing</a></li>
<li class="toctree-l1"><a class="reference internal" href="Contrib-Containers.html">Containers</a></li>
@ -474,6 +476,12 @@ the <code class="docutils literal notranslate"><span class="pre">rpg</span></cod
<li class="toctree-l1"><a class="reference internal" href="Contrib-Turnbattle.html">Turn based battle system framework</a></li>
</ul>
</div>
<section id="achievements">
<h3><code class="docutils literal notranslate"><span class="pre">achievements</span></code><a class="headerlink" href="#achievements" title="Permalink to this headline"></a></h3>
<p><em>A simple, but reasonably comprehensive, system for tracking achievements. Achievements are defined using ordinary Python dicts, reminiscent of the core prototypes system, and while its expected youll use it only on Characters or Accounts, they can be tracked for any typeclassed object.</em></p>
<p>The contrib provides several functions for tracking and accessing achievements, as well as a basic in-game command for viewing achievement status.</p>
<p><a class="reference internal" href="Contrib-Achievements.html"><span class="doc std std-doc">Read the documentation</span></a> - <span class="xref myst">Browse the Code</span></p>
</section>
<section id="barter">
<h3><code class="docutils literal notranslate"><span class="pre">barter</span></code><a class="headerlink" href="#barter" title="Permalink to this headline"></a></h3>
<p><em>Contribution by Griatch, 2012</em></p>