evennia/docs/1.0-dev/Howto/Howto-Overview.html
Evennia docbuilder action 7b2738e062 Updated HTML docs
2022-01-25 22:41:51 +00:00

280 lines
No EOL
18 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<title>Tutorials and Howtos &#8212; 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>
<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" />
<link rel="next" title="Core Components" href="../Components/Components-Overview.html" />
<link rel="prev" title="Server Setup and Life" href="../Setup/Setup-Overview.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="../Components/Components-Overview.html" title="Core Components"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../Setup/Setup-Overview.html" title="Server Setup and Life"
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 Howtos</a></li>
</ul>
<div class="develop">develop branch</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section class="tex2jax_ignore mathjax_ignore" id="tutorials-and-howtos">
<h1>Tutorials and Howtos<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 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>
<p>Recommended starting point! This will take you from absolute beginner to making
a small, but full, game with Evennia. Even if you have a very different game style
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 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 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 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 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 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 std std-doc">Coding FAQ</span></a></p></li>
</ul>
</section>
<section id="howtos">
<h2>Howtos<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 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">Dont 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 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 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 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 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 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>
<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="#">Tutorials and Howtos</a><ul>
<li><a class="reference internal" href="#the-starting-tutorial">The Starting Tutorial</a><ul>
<li><a class="reference internal" href="#part-1-what-we-have">Part 1: What we have</a></li>
<li><a class="reference internal" href="#part-2-what-we-want">Part 2: What we want</a></li>
<li><a class="reference internal" href="#part3-how-we-get-there">Part3: How we get there</a></li>
<li><a class="reference internal" href="#part-4-using-what-we-created">Part 4: Using what we created</a></li>
<li><a class="reference internal" href="#part-5-showing-the-world">Part 5: Showing the world</a></li>
</ul>
</li>
<li><a class="reference internal" href="#faqs">FAQs</a></li>
<li><a class="reference internal" href="#howtos">Howtos</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>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="../Setup/Setup-Overview.html"
title="previous chapter">Server Setup and Life</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="../Components/Components-Overview.html"
title="next chapter">Core Components</a></p>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/Howto/Howto-Overview.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="Howto-Overview.html">1.0-dev (develop branch)</a></li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="../Components/Components-Overview.html" title="Core Components"
>next</a> |</li>
<li class="right" >
<a href="../Setup/Setup-Overview.html" title="Server Setup and Life"
>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 Howtos</a></li>
</ul>
<div class="develop">develop branch</div>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2020, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>