Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-30 12:37: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-11-23 20:20:36 +00:00
parent a6076aff42
commit 64849b32e2
146 changed files with 1903 additions and 2426 deletions
Download patch file Download diff file Expand all files Collapse all files

124
docs/1.0-dev/Howtos/Howtos-Overview.html
View file

@ -17,8 +17,8 @@
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Beginner Tutorial" href="Beginner-Tutorial/Beginner-Tutorial-Intro.html" />
<link rel="prev" title="Configuring HAProxy" href="../Setup/Config-HAProxy.html" />
<link rel="next" title="Beginner Tutorial" href="Beginner-Tutorial/Beginner-Tutorial-Overview.html" />
<link rel="prev" title="Configuring an Apache Proxy" href="../Setup/Config-Apache-Proxy.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
@ -30,10 +30,10 @@
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="Beginner-Tutorial/Beginner-Tutorial-Intro.html" title="Beginner Tutorial"
<a href="Beginner-Tutorial/Beginner-Tutorial-Overview.html" title="Beginner Tutorial"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../Setup/Config-HAProxy.html" title="Configuring HAProxy"
<a href="../Setup/Config-Apache-Proxy.html" title="Configuring an Apache Proxy"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Tutorials and Howto’s</a></li>
@ -64,8 +64,6 @@
<li><a class="reference internal" href="#">Tutorials and Howto’s</a><ul>
<li><a class="reference internal" href="#beginner-tutorial">Beginner Tutorial</a></li>
<li><a class="reference internal" href="#howtos">Howto’s</a></li>
<li><a class="reference internal" href="#mobs-and-npcs">Mobs and NPCs</a></li>
<li><a class="reference internal" href="#vehicles">Vehicles</a></li>
<li><a class="reference internal" href="#systems">Systems</a></li>
<li><a class="reference internal" href="#web-related-tutorials">Web-related tutorials</a></li>
<li><a class="reference internal" href="#deep-dives">Deep-dives</a></li>
@ -75,10 +73,10 @@
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="../Setup/Config-HAProxy.html"
title="previous chapter">Configuring HAProxy</a></p>
<p class="topless"><a href="../Setup/Config-Apache-Proxy.html"
title="previous chapter">Configuring an Apache Proxy</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="Beginner-Tutorial/Beginner-Tutorial-Intro.html"
<p class="topless"><a href="Beginner-Tutorial/Beginner-Tutorial-Overview.html"
title="next chapter">Beginner Tutorial</a></p>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
@ -112,7 +110,10 @@
<section class="tex2jax_ignore mathjax_ignore" id="tutorials-and-howtos">
<h1>Tutorials and Howto’s<a class="headerlink" href="#tutorials-and-howtos" title="Permalink to this headline"></a></h1>
<p>All Evennia tutorials. They will often refer to the <a class="reference internal" href="../Components/Components-Overview.html"><span class="doc std std-doc">components</span></a> or <a class="reference internal" href="../Concepts/Concepts-Overview.html"><span class="doc std std-doc">concepts</span></a> if you want to dive deeper.</p>
<aside class="sidebar">
<p class="sidebar-title">Want more details about something?</p>
<p>See the documentation about the Evennia core <a class="reference internal" href="../Components/Components-Overview.html"><span class="doc std std-doc">Components</span></a> and important <a class="reference internal" href="../Concepts/Concepts-Overview.html"><span class="doc std std-doc">Concepts</span></a>.</p>
</aside>
<section id="beginner-tutorial">
<h2>Beginner Tutorial<a class="headerlink" href="#beginner-tutorial" title="Permalink to this headline"></a></h2>
<p>Recommended starting point! This will take you from absolute beginner to making
@ -123,18 +124,18 @@ a small but full game with Evennia. Other tutorials and howto’s tend to assume
</div>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="Beginner-Tutorial/Beginner-Tutorial-Intro.html">Beginner Tutorial</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Beginner-Tutorial/Beginner-Tutorial-Intro.html#things-you-need">Things you need</a><ul>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Beginner-Tutorial-Intro.html#a-command-line">A Command line</a></li>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Beginner-Tutorial-Intro.html#a-mud-client">A MUD client</a></li>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Beginner-Tutorial-Intro.html#an-editor">An Editor</a></li>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Beginner-Tutorial-Intro.html#set-up-a-game-dir-for-the-tutorial">Set up a game dir for the tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="Beginner-Tutorial/Beginner-Tutorial-Overview.html">Beginner Tutorial</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Beginner-Tutorial/Beginner-Tutorial-Overview.html#things-you-need">Things you need</a><ul>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Beginner-Tutorial-Overview.html#a-command-line">A Command line</a></li>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Beginner-Tutorial-Overview.html#a-mud-client">A MUD client</a></li>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Beginner-Tutorial-Overview.html#a-text-editor-or-ide">A text Editor or IDE</a></li>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Beginner-Tutorial-Overview.html#a-fresh-game-dir">A fresh game dir?</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Beginner-Tutorial/Part1/Beginner-Tutorial-Part1-Intro.html">Part 1: What we have</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Beginner-Tutorial/Part1/Beginner-Tutorial-Part1-Intro.html#lessons">Lessons</a><ul>
<li class="toctree-l1"><a class="reference internal" href="Beginner-Tutorial/Part1/Beginner-Tutorial-Part1-Overview.html">Part 1: What we have</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Beginner-Tutorial/Part1/Beginner-Tutorial-Part1-Overview.html#lessons">Lessons</a><ul>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part1/Beginner-Tutorial-Building-Quickstart.html">1. Using commands and building stuff</a></li>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part1/Beginner-Tutorial-Tutorial-World.html">2. The Tutorial World</a></li>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part1/Beginner-Tutorial-Python-basic-introduction.html">3. Intro to using Python with Evennia</a></li>
@ -152,8 +153,8 @@ a small but full game with Evennia. Other tutorials and howto’s tend to assume
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Beginner-Tutorial/Part2/Beginner-Tutorial-Part2-Intro.html">Part 2: What we want</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Beginner-Tutorial/Part2/Beginner-Tutorial-Part2-Intro.html#lessons">Lessons</a><ul>
<li class="toctree-l1"><a class="reference internal" href="Beginner-Tutorial/Part2/Beginner-Tutorial-Part2-Overview.html">Part 2: What we want</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Beginner-Tutorial/Part2/Beginner-Tutorial-Part2-Overview.html#lessons">Lessons</a><ul>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part2/Beginner-Tutorial-Planning-Where-Do-I-Begin.html">1. Where do I begin?</a></li>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part2/Beginner-Tutorial-Game-Planning.html">2. On Planning a Game</a></li>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part2/Beginner-Tutorial-Planning-The-Tutorial-Game.html">3. Planning our tutorial game</a></li>
@ -161,8 +162,8 @@ a small but full game with Evennia. Other tutorials and howto’s tend to assume
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Beginner-Tutorial/Part3/Beginner-Tutorial-Part3-Intro.html">Part 3: How we get there (example game)</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Beginner-Tutorial/Part3/Beginner-Tutorial-Part3-Intro.html#lessons">Lessons</a><ul>
<li class="toctree-l1"><a class="reference internal" href="Beginner-Tutorial/Part3/Beginner-Tutorial-Part3-Overview.html">Part 3: How we get there (example game)</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Beginner-Tutorial/Part3/Beginner-Tutorial-Part3-Overview.html#lessons">Lessons</a><ul>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part3/Beginner-Tutorial-Utilities.html">1. Code structure and Utilities</a></li>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part3/Beginner-Tutorial-Rules.html">2. Rules and dice rolling</a></li>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part3/Beginner-Tutorial-Characters.html">3. Player Characters</a></li>
@ -179,17 +180,16 @@ a small but full game with Evennia. Other tutorials and howto’s tend to assume
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Beginner-Tutorial/Part4/Beginner-Tutorial-Part4-Intro.html">Part 4: Using what we created</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Beginner-Tutorial/Part4/Beginner-Tutorial-Part4-Intro.html#lessons">Lessons</a><ul>
<li class="toctree-l1"><a class="reference internal" href="Beginner-Tutorial/Part4/Beginner-Tutorial-Part4-Overview.html">Part 4: Using what we created</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Beginner-Tutorial/Part4/Beginner-Tutorial-Part4-Overview.html#lessons">Lessons</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../Unimplemented.html">1. Unimplemented</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Beginner-Tutorial/Part5/Beginner-Tutorial-Part5-Intro.html">Part 5: Showing the world</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Beginner-Tutorial/Part5/Beginner-Tutorial-Part5-Intro.html#lessons">Lessons</a><ul>
<li class="toctree-l1"><a class="reference internal" href="Beginner-Tutorial/Part5/Beginner-Tutorial-Part5-Overview.html">Part 5: Showing the world</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Beginner-Tutorial/Part5/Beginner-Tutorial-Part5-Overview.html#lessons">Lessons</a><ul>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part5/Add-a-simple-new-web-page.html">1. Add a simple new web page</a></li>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part5/Web-Tutorial.html">2. Web Tutorial</a></li>
</ul>
</li>
</ul>
@ -201,50 +201,16 @@ a small but full game with Evennia. Other tutorials and howto’s tend to assume
<h2>Howto’s<a class="headerlink" href="#howtos" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="Howto-Command-Prompt.html">Adding a Command Prompt</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Howto-Command-Prompt.html#a-fixed-location-prompt">A fixed-location prompt</a></li>
<li class="toctree-l2"><a class="reference internal" href="Howto-Command-Prompt.html#a-prompt-with-every-command">A prompt with every command</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Howto-Command-Cooldown.html">Adding Command Cooldowns</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Howto-Command-Cooldown.html#an-efficient-cooldown">An efficient cooldown</a></li>
<li class="toctree-l2"><a class="reference internal" href="Howto-Command-Cooldown.html#make-a-cooldown-aware-command-parent">Make a cooldown-aware command parent</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Howto-Command-Duration.html">Commands that take time to finish</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Howto-Command-Duration.html#pause-commands-with-yield">Pause commands with <code class="docutils literal notranslate"><span class="pre">yield</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="Howto-Command-Duration.html#pause-commands-with-utils-delay">Pause commands with <code class="docutils literal notranslate"><span class="pre">utils.delay</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="Howto-Command-Duration.html#making-a-blocking-command">Making a blocking command</a></li>
<li class="toctree-l2"><a class="reference internal" href="Howto-Command-Duration.html#make-a-command-possible-to-abort">Make a Command possible to Abort</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Howto-Default-Exit-Errors.html">Return custom errors on missing Exits</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Howto-Default-Exit-Errors.html#why-not-a-single-command">Why not a single command?</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Howto-Add-Object-Weight.html">Give objects weight</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Howto-Add-Object-Weight.html#limit-inventory-by-weight-carried">Limit inventory by weight carried</a></li>
</ul>
</li>
</ul>
</div>
</section>
<section id="mobs-and-npcs">
<h2>Mobs and NPCs<a class="headerlink" href="#mobs-and-npcs" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="Howto-Command-Prompt.html">Adding a Command Prompt</a></li>
<li class="toctree-l1"><a class="reference internal" href="Howto-Command-Cooldown.html">Adding Command Cooldowns</a></li>
<li class="toctree-l1"><a class="reference internal" href="Howto-Command-Duration.html">Commands that take time to finish</a></li>
<li class="toctree-l1"><a class="reference internal" href="Howto-Default-Exit-Errors.html">Return custom errors on missing Exits</a></li>
<li class="toctree-l1"><a class="reference internal" href="Howto-Add-Object-Weight.html">Give objects weight</a></li>
<li class="toctree-l1"><a class="reference internal" href="Tutorial-NPC-Listening.html">NPCs that listen to what is said</a></li>
<li class="toctree-l1"><a class="reference internal" href="Tutorial-NPC-Reacting.html">NPCs reacting to your presence</a></li>
<li class="toctree-l1"><a class="reference internal" href="Tutorial-NPC-Merchants.html">NPC merchants</a></li>
</ul>
</div>
</section>
<section id="vehicles">
<h2>Vehicles<a class="headerlink" href="#vehicles" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="Building-a-mech-tutorial.html">Building a mech tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="Tutorial-Vehicles.html">Tutorial Vehicles</a></li>
<li class="toctree-l1"><a class="reference internal" href="Tutorial-Building-a-Mech.html">Building a giant mech</a></li>
<li class="toctree-l1"><a class="reference internal" href="Tutorial-Building-a-Train.html">Building a train that moves</a></li>
</ul>
</div>
</section>
@ -253,25 +219,25 @@ a small but full game with Evennia. Other tutorials and howto’s tend to assume
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="Tutorial-Persistent-Handler.html">Making a Persistent object Handler</a></li>
<li class="toctree-l1"><a class="reference internal" href="Gametime-Tutorial.html">Gametime Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="Weather-Tutorial.html">Weather Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="Tutorial-Coordinates.html">Coordinates</a></li>
<li class="toctree-l1"><a class="reference internal" href="Tutorial-Coordinates.html#adding-room-coordinates-in-your-game">Adding room coordinates in your game</a></li>
<li class="toctree-l1"><a class="reference internal" href="Dynamic-In-Game-Map.html">Dynamic In Game Map</a></li>
<li class="toctree-l1"><a class="reference internal" href="Static-In-Game-Map.html">Static In Game Map</a></li>
<li class="toctree-l1"><a class="reference internal" href="Tutorial-Tweeting-Game-Stats.html">Tutorial Tweeting Game Stats</a></li>
<li class="toctree-l1"><a class="reference internal" href="Howto-Game-Time.html">Changing game calendar and time speed</a></li>
<li class="toctree-l1"><a class="reference internal" href="Tutorial-Weather-Effects.html">Adding Weather messages to a Room</a></li>
<li class="toctree-l1"><a class="reference internal" href="Tutorial-Coordinates.html">Adding room coordinates to your game</a></li>
<li class="toctree-l1"><a class="reference internal" href="Tutorial-Displaying-Room-Map.html">Show a dynamic map of rooms</a></li>
</ul>
</div>
</section>
<section id="web-related-tutorials">
<h2>Web-related tutorials<a class="headerlink" href="#web-related-tutorials" title="Permalink to this headline"></a></h2>
<p><em>Some of these will likely move into the Beginner tutorial later</em>.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="Web-Changing-Webpage.html">Changing the Game Website</a></li>
<li class="toctree-l1"><a class="reference internal" href="Web-Add-a-wiki.html">Add a wiki on your website</a></li>
<li class="toctree-l1"><a class="reference internal" href="Web-Character-Generation.html">Web Character Generation</a></li>
<li class="toctree-l1"><a class="reference internal" href="Web-Character-View-Tutorial.html">Web Character View Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="Web-Help-System-Tutorial.html">Help System Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="Web-Extending-the-REST-API.html">Extending the REST API</a></li>
<li class="toctree-l1"><a class="reference internal" href="Web-Tweeting-Game-Stats.html">Automatically Tweet game stats</a></li>
</ul>
</div>
</section>
@ -279,12 +245,12 @@ a small but full game with Evennia. Other tutorials and howto’s tend to assume
<h2>Deep-dives<a class="headerlink" href="#deep-dives" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="Parsing-commands-tutorial.html">Parsing command arguments, theory and best practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="Tutorial-Parsing-Commands.html">Parsing command arguments, theory and best practices</a></li>
<li class="toctree-l1"><a class="reference internal" href="Tutorial-Understanding-Color-Tags.html">Understanding Color Tags</a></li>
<li class="toctree-l1"><a class="reference internal" href="Evennia-for-roleplaying-sessions.html">Evennia for roleplaying sessions</a></li>
<li class="toctree-l1"><a class="reference internal" href="Evennia-for-Diku-Users.html">Evennia for Diku Users</a></li>
<li class="toctree-l1"><a class="reference internal" href="Evennia-for-MUSH-Users.html">Evennia for MUSH Users</a></li>
<li class="toctree-l1"><a class="reference internal" href="Arxcode-Installation.html">Arxcode installing help</a></li>
<li class="toctree-l1"><a class="reference internal" href="Tutorial-Using-Arxcode.html">Using the Arxcode game dir</a></li>
</ul>
</div>
</section>
@ -317,10 +283,10 @@ a small but full game with Evennia. Other tutorials and howto’s tend to assume
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="Beginner-Tutorial/Beginner-Tutorial-Intro.html" title="Beginner Tutorial"
<a href="Beginner-Tutorial/Beginner-Tutorial-Overview.html" title="Beginner Tutorial"
>next</a> |</li>
<li class="right" >
<a href="../Setup/Config-HAProxy.html" title="Configuring HAProxy"
<a href="../Setup/Config-Apache-Proxy.html" title="Configuring an Apache Proxy"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Tutorials and Howto’s</a></li>