Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-23 00:06:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated HTML docs

Browse source
This commit is contained in:
Griatch 2021-10-26 21:41:11 +02:00
parent 66d0ad0bc9
commit 7900aad365
2073 changed files with 32986 additions and 41197 deletions
Download patch file Download diff file Expand all files Collapse all files

126
docs/1.0-dev/Howto/Howto-Overview.html
View file

@ -14,6 +14,8 @@
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"processClass": "tex2jax_process|mathjax_process|math|output_area"}})</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" />
@ -46,12 +48,12 @@
<div class="bodywrapper">
<div class="body" role="main">
<section id="tutorials-and-howto-s">
<h1>Tutorials and Howto’s<a class="headerlink" href="#tutorials-and-howto-s" title="Permalink to this headline"></a></h1>
<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>The documents in this section aims to teach how to use Evennia in a tutorial or
a step-by-step way. They often give hints on about solving a problem or implementing
a particular feature or concept. They will often refer to the
<a class="reference internal" href="../Components/Components-Overview.html"><span class="doc">components</span></a> or <a class="reference internal" href="../Concepts/Concepts-Overview.html"><span class="doc">concepts</span></a>
<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>
docs for those that want to dive deeper.</p>
<section id="the-starting-tutorial">
<h2>The Starting Tutorial<a class="headerlink" href="#the-starting-tutorial" title="Permalink to this headline"></a></h2>
@ -61,117 +63,117 @@ in mind for your own game, this will give you a good start.</p>
<section id="part-1-what-we-have">
<h3>Part 1: What we have<a class="headerlink" href="#part-1-what-we-have" title="Permalink to this headline"></a></h3>
<ol class="simple">
<li><p><a class="reference internal" href="Starting/Part1/Starting-Part1.html"><span class="doc">Introduction &amp; Overview</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part1/Building-Quickstart.html"><span class="doc">Building stuff</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part1/Tutorial-World-Introduction.html"><span class="doc">The Tutorial World</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part1/Python-basic-introduction.html"><span class="doc">Python basics</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part1/Gamedir-Overview.html"><span class="doc">Game dir overview</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part1/Python-classes-and-objects.html"><span class="doc">Python classes and objects</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part1/Evennia-Library-Overview.html"><span class="doc">Accessing the Evennia library</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part1/Learning-Typeclasses.html"><span class="doc">Typeclasses - Persistent objects</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part1/Adding-Commands.html"><span class="doc">Making our first own commands</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part1/More-on-Commands.html"><span class="doc">Parsing and replacing default Commands</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part1/Creating-Things.html"><span class="doc">Creating things</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part1/Searching-Things.html"><span class="doc">Searching for things</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part1/Django-queries.html"><span class="doc">Advanced searching with Django queries</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part1/Starting-Part1.html"><span class="doc std std-doc">Introduction &amp; Overview</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part1/Building-Quickstart.html"><span class="doc std std-doc">Building stuff</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part1/Tutorial-World-Introduction.html"><span class="doc std std-doc">The Tutorial World</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part1/Python-basic-introduction.html"><span class="doc std std-doc">Python basics</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part1/Gamedir-Overview.html"><span class="doc std std-doc">Game dir overview</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part1/Python-classes-and-objects.html"><span class="doc std std-doc">Python classes and objects</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part1/Evennia-Library-Overview.html"><span class="doc std std-doc">Accessing the Evennia library</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part1/Learning-Typeclasses.html"><span class="doc std std-doc">Typeclasses - Persistent objects</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part1/Adding-Commands.html"><span class="doc std std-doc">Making our first own commands</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part1/More-on-Commands.html"><span class="doc std std-doc">Parsing and replacing default Commands</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part1/Creating-Things.html"><span class="doc std std-doc">Creating things</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part1/Searching-Things.html"><span class="doc std std-doc">Searching for things</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part1/Django-queries.html"><span class="doc std std-doc">Advanced searching with Django queries</span></a></p></li>
</ol>
</section>
<section id="part-2-what-we-want">
<h3>Part 2: What we want<a class="headerlink" href="#part-2-what-we-want" title="Permalink to this headline"></a></h3>
<ol class="simple">
<li><p><a class="reference internal" href="Starting/Part2/Starting-Part2.html"><span class="doc">Introduction &amp; Overview</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part2/Game-Planning.html"><span class="doc">On planning a game</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part2/Planning-Some-Useful-Contribs.html"><span class="doc">Planning to use some useful Contribs</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part2/Starting-Part2.html"><span class="doc std std-doc">Introduction &amp; Overview</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part2/Game-Planning.html"><span class="doc std std-doc">On planning a game</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part2/Planning-Some-Useful-Contribs.html"><span class="doc std std-doc">Planning to use some useful Contribs</span></a></p></li>
</ol>
</section>
<section id="part3-how-we-get-there">
<h3>Part3: How we get there<a class="headerlink" href="#part3-how-we-get-there" title="Permalink to this headline"></a></h3>
<ol class="simple">
<li><p><a class="reference internal" href="Starting/Part3/Starting-Part3.html"><span class="doc">Introduction &amp; Overview</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part3/Implementing-a-game-rule-system.html"><span class="doc">Making a custom Character</span></a></p></li>
<li><p><a class="reference internal" href="../Unimplemented.html"><span class="doc">Character generation</span></a></p></li>
<li><p><a class="reference internal" href="../Unimplemented.html"><span class="doc">Resolving skills and challenges</span></a></p></li>
<li><p><a class="reference internal" href="Coordinates.html"><span class="doc">NPCs and mobiles</span></a></p></li>
<li><p><a class="reference internal" href="../Unimplemented.html"><span class="doc">Quests and Zones</span></a></p></li>
<li><p><a class="reference internal" href="../Unimplemented.html"><span class="doc">A Combat system</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part3/Starting-Part3.html"><span class="doc std std-doc">Introduction &amp; Overview</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part3/Implementing-a-game-rule-system.html"><span class="doc std std-doc">Making a custom Character</span></a></p></li>
<li><p><a class="reference internal" href="../Unimplemented.html"><span class="doc std std-doc">Character generation</span></a></p></li>
<li><p><a class="reference internal" href="../Unimplemented.html"><span class="doc std std-doc">Resolving skills and challenges</span></a></p></li>
<li><p><a class="reference internal" href="Coordinates.html"><span class="doc std std-doc">NPCs and mobiles</span></a></p></li>
<li><p><a class="reference internal" href="../Unimplemented.html"><span class="doc std std-doc">Quests and Zones</span></a></p></li>
<li><p><a class="reference internal" href="../Unimplemented.html"><span class="doc std std-doc">A Combat system</span></a></p></li>
</ol>
</section>
<section id="part-4-using-what-we-created">
<h3>Part 4: Using what we created<a class="headerlink" href="#part-4-using-what-we-created" title="Permalink to this headline"></a></h3>
<ol class="simple">
<li><p><a class="reference internal" href="Starting/Part4/Starting-Part4.html"><span class="doc">Introduction &amp; Overview</span></a></p></li>
<li><p><a class="reference internal" href="../Unimplemented.html"><span class="doc">Building the tech demo</span></a></p></li>
<li><p><a class="reference internal" href="../Unimplemented.html"><span class="doc">Creating a game world</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part4/Starting-Part4.html"><span class="doc std std-doc">Introduction &amp; Overview</span></a></p></li>
<li><p><a class="reference internal" href="../Unimplemented.html"><span class="doc std std-doc">Building the tech demo</span></a></p></li>
<li><p><a class="reference internal" href="../Unimplemented.html"><span class="doc std std-doc">Creating a game world</span></a></p></li>
</ol>
</section>
<section id="part-5-showing-the-world">
<h3>Part 5: Showing the world<a class="headerlink" href="#part-5-showing-the-world" title="Permalink to this headline"></a></h3>
<ol class="simple">
<li><p><a class="reference internal" href="Starting/Part5/Starting-Part5.html"><span class="doc">Introduction &amp; Overview</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part5/Add-a-simple-new-web-page.html"><span class="doc">Add a web page</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part5/Web-Tutorial.html"><span class="doc">More on adding web features</span></a></p></li>
<li><p><a class="reference internal" href="../Unimplemented.html"><span class="doc">Taking your game online</span></a></p></li>
<li><p><a class="reference internal" href="../Unimplemented.html"><span class="doc">Next steps</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part5/Starting-Part5.html"><span class="doc std std-doc">Introduction &amp; Overview</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part5/Add-a-simple-new-web-page.html"><span class="doc std std-doc">Add a web page</span></a></p></li>
<li><p><a class="reference internal" href="Starting/Part5/Web-Tutorial.html"><span class="doc std std-doc">More on adding web features</span></a></p></li>
<li><p><a class="reference internal" href="../Unimplemented.html"><span class="doc std std-doc">Taking your game online</span></a></p></li>
<li><p><a class="reference internal" href="../Unimplemented.html"><span class="doc std std-doc">Next steps</span></a></p></li>
</ol>
</section>
</section>
<section id="faqs">
<h2>FAQs<a class="headerlink" href="#faqs" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="Coding-FAQ.html"><span class="doc">Coding FAQ</span></a></p></li>
<li><p><a class="reference internal" href="Coding-FAQ.html"><span class="doc std std-doc">Coding FAQ</span></a></p></li>
</ul>
</section>
<section id="howto-s">
<h2>Howto’s<a class="headerlink" href="#howto-s" title="Permalink to this headline"></a></h2>
<section id="howtos">
<h2>Howto’s<a class="headerlink" href="#howtos" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="Default-Exit-Errors.html"><span class="doc">Giving Exits a default error</span></a></p></li>
<li><p><a class="reference internal" href="Command-Prompt.html"><span class="doc">Add a command prompt</span></a></p></li>
<li><p><a class="reference internal" href="Command-Cooldown.html"><span class="doc">Don’t allow spamming commands</span></a></p></li>
<li><p><a class="reference internal" href="Command-Duration.html"><span class="doc">Commands that take time</span></a></p></li>
<li><p><a class="reference internal" href="Manually-Configuring-Color.html"><span class="doc">Configuring color</span></a></p></li>
<li><p><a class="reference internal" href="Tutorial-Tweeting-Game-Stats.html"><span class="doc">Tweet game stats</span></a></p></li>
<li><p><a class="reference internal" href="Default-Exit-Errors.html"><span class="doc std std-doc">Giving Exits a default error</span></a></p></li>
<li><p><a class="reference internal" href="Command-Prompt.html"><span class="doc std std-doc">Add a command prompt</span></a></p></li>
<li><p><a class="reference internal" href="Command-Cooldown.html"><span class="doc std std-doc">Don’t allow spamming commands</span></a></p></li>
<li><p><a class="reference internal" href="Command-Duration.html"><span class="doc std std-doc">Commands that take time</span></a></p></li>
<li><p><a class="reference internal" href="Manually-Configuring-Color.html"><span class="doc std std-doc">Configuring color</span></a></p></li>
<li><p><a class="reference internal" href="Tutorial-Tweeting-Game-Stats.html"><span class="doc std std-doc">Tweet game stats</span></a></p></li>
</ul>
</section>
<section id="mobs-and-npcs">
<h2>Mobs and NPCs<a class="headerlink" href="#mobs-and-npcs" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="Tutorial-NPCs-listening.html"><span class="doc">NPCs that listen to you</span></a></p></li>
<li><p><a class="reference internal" href="Tutorial-Aggressive-NPCs.html"><span class="doc">Mobs that attack you</span></a></p></li>
<li><p><a class="reference internal" href="NPC-shop-Tutorial.html"><span class="doc">Shopkeepers</span></a></p></li>
<li><p><a class="reference internal" href="Tutorial-NPCs-listening.html"><span class="doc std std-doc">NPCs that listen to you</span></a></p></li>
<li><p><a class="reference internal" href="Tutorial-Aggressive-NPCs.html"><span class="doc std std-doc">Mobs that attack you</span></a></p></li>
<li><p><a class="reference internal" href="NPC-shop-Tutorial.html"><span class="doc std std-doc">Shopkeepers</span></a></p></li>
</ul>
</section>
<section id="vehicles">
<h2>Vehicles<a class="headerlink" href="#vehicles" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="Building-a-mech-tutorial.html"><span class="doc">Building a mech</span></a></p></li>
<li><p><a class="reference internal" href="Tutorial-Vehicles.html"><span class="doc">Building a train</span></a></p></li>
<li><p><a class="reference internal" href="Building-a-mech-tutorial.html"><span class="doc std std-doc">Building a mech</span></a></p></li>
<li><p><a class="reference internal" href="Tutorial-Vehicles.html"><span class="doc std std-doc">Building a train</span></a></p></li>
</ul>
</section>
<section id="systems">
<h2>Systems<a class="headerlink" href="#systems" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="Gametime-Tutorial.html"><span class="doc">Understanding In-game time</span></a></p></li>
<li><p><a class="reference internal" href="Help-System-Tutorial.html"><span class="doc">Understanding the Help system</span></a></p></li>
<li><p><a class="reference internal" href="Mass-and-weight-for-objects.html"><span class="doc">Adding mass to objects</span></a></p></li>
<li><p><a class="reference internal" href="Weather-Tutorial.html"><span class="doc">Add weather</span></a></p></li>
<li><p><a class="reference internal" href="Gametime-Tutorial.html"><span class="doc std std-doc">Understanding In-game time</span></a></p></li>
<li><p><a class="reference internal" href="Help-System-Tutorial.html"><span class="doc std std-doc">Understanding the Help system</span></a></p></li>
<li><p><a class="reference internal" href="Mass-and-weight-for-objects.html"><span class="doc std std-doc">Adding mass to objects</span></a></p></li>
<li><p><a class="reference internal" href="Weather-Tutorial.html"><span class="doc std std-doc">Add weather</span></a></p></li>
</ul>
</section>
<section id="web-related-tutorials">
<h2>Web-related tutorials<a class="headerlink" href="#web-related-tutorials" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="Add-a-wiki-on-your-website.html"><span class="doc">Add a wiki</span></a></p></li>
<li><p><a class="reference internal" href="Web-Character-Generation.html"><span class="doc">A web-based character generation</span></a></p></li>
<li><p><a class="reference internal" href="Web-Character-View-Tutorial.html"><span class="doc">View Character on website</span></a></p></li>
<li><p><a class="reference internal" href="Add-a-wiki-on-your-website.html"><span class="doc std std-doc">Add a wiki</span></a></p></li>
<li><p><a class="reference internal" href="Web-Character-Generation.html"><span class="doc std std-doc">A web-based character generation</span></a></p></li>
<li><p><a class="reference internal" href="Web-Character-View-Tutorial.html"><span class="doc std std-doc">View Character on website</span></a></p></li>
</ul>
</section>
<section id="deep-dives">
<h2>Deep-dives<a class="headerlink" href="#deep-dives" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="Parsing-commands-tutorial.html"><span class="doc">Parsing command inputs</span></a></p></li>
<li><p><a class="reference internal" href="Understanding-Color-Tags.html"><span class="doc">Understanding color-tags</span></a></p></li>
<li><p><a class="reference internal" href="Evennia-for-roleplaying-sessions.html"><span class="doc">Play paper&amp;pen RPGs online with Evennia</span></a></p></li>
<li><p><a class="reference internal" href="Evennia-for-Diku-Users.html"><span class="doc">Evennia for Diku Users</span></a></p></li>
<li><p><a class="reference internal" href="Evennia-for-MUSH-Users.html"><span class="doc">Evennia for MUSH-Users</span></a></p></li>
<li><p><a class="reference internal" href="Parsing-commands-tutorial.html"><span class="doc std std-doc">Parsing command inputs</span></a></p></li>
<li><p><a class="reference internal" href="Understanding-Color-Tags.html"><span class="doc std std-doc">Understanding color-tags</span></a></p></li>
<li><p><a class="reference internal" href="Evennia-for-roleplaying-sessions.html"><span class="doc std std-doc">Play paper&amp;pen RPGs online with Evennia</span></a></p></li>
<li><p><a class="reference internal" href="Evennia-for-Diku-Users.html"><span class="doc std std-doc">Evennia for Diku Users</span></a></p></li>
<li><p><a class="reference internal" href="Evennia-for-MUSH-Users.html"><span class="doc std std-doc">Evennia for MUSH-Users</span></a></p></li>
</ul>
</section>
</section>
@ -208,7 +210,7 @@ in mind for your own game, this will give you a good start.</p>
</ul>
</li>
<li><a class="reference internal" href="#faqs">FAQs</a></li>
<li><a class="reference internal" href="#howto-s">Howto’s</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>
@ -244,7 +246,7 @@ in mind for your own game, this will give you a good start.</p>
<h3>Versions</h3>
<ul>
<li><a href="Howto-Overview.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>
<li><a href="../../0.95/index.html">0.95 (v0.9.5 branch)</a></li>
</ul>
</div>