Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-19 14:26:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/1.0-dev/Howtos/Howtos-Overview.html
Evennia docbuilder action 1ae614d35e Updated HTML docs.
2022-11-22 10:37:02 +00:00

335 lines
No EOL
21 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 Howto’s &#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>
<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="Apache Config" href="../Setup/Apache-Config.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="Beginner-Tutorial/Beginner-Tutorial-Intro.html" title="Beginner Tutorial"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../Setup/Apache-Config.html" title="Apache Config"
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>
</ul>
<div class="develop">develop branch</div>
</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="#">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>
<li><a class="reference internal" href="#old-tutorials">Old tutorials</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="../Setup/Apache-Config.html"
title="previous chapter">Apache Config</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="Beginner-Tutorial/Beginner-Tutorial-Intro.html"
title="next chapter">Beginner Tutorial</a></p>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/Howtos/Howtos-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="Howtos-Overview.html">1.0-dev (develop branch)</a></li>
<ul>
<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">
<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>
<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
a small but full game with Evennia. Other tutorials and howto’s tend to assume you are already familiar with the concepts explained in the Beginning tutorial.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Part 3 and onwards are still under development.</p>
</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>
</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-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>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part1/Beginner-Tutorial-Gamedir-Overview.html">4. Overview of your new Game Dir</a></li>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part1/Beginner-Tutorial-Python-classes-and-objects.html">5. Introduction to Python classes and objects</a></li>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part1/Beginner-Tutorial-Evennia-Library-Overview.html">6. Overview of the Evennia library</a></li>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part1/Beginner-Tutorial-Learning-Typeclasses.html">7. Making objects persistent</a></li>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part1/Beginner-Tutorial-Adding-Commands.html">8. Adding custom commands</a></li>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part1/Beginner-Tutorial-More-on-Commands.html">9. Parsing Command input</a></li>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part1/Beginner-Tutorial-Creating-Things.html">10. Creating things</a></li>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part1/Beginner-Tutorial-Searching-Things.html">11. Searching for things</a></li>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part1/Beginner-Tutorial-Django-queries.html">12. Advanced searching - Django Database queries</a></li>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part1/Beginner-Tutorial-Making-A-Sittable-Object.html">13. Building a chair you can sit on</a></li>
</ul>
</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-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>
</ul>
</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-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>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part3/Beginner-Tutorial-Objects.html">4. In-game Objects and items</a></li>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part3/Beginner-Tutorial-Equipment.html">5. Handling Equipment</a></li>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part3/Beginner-Tutorial-Chargen.html">6. Character Generation</a></li>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part3/Beginner-Tutorial-Rooms.html">7. In-game Rooms</a></li>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part3/Beginner-Tutorial-NPCs.html">8. Non-Player-Characters (NPCs)</a></li>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part3/Beginner-Tutorial-Quests.html">9. Game Quests</a></li>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part3/Beginner-Tutorial-Shops.html">10. In-game Shops</a></li>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part3/Beginner-Tutorial-Dungeon.html">11. Dynamically generated Dungeon</a></li>
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part3/Beginner-Tutorial-Commands.html">12. In-game Commands</a></li>
</ul>
</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-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-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>
</li>
</ul>
</div>
</section>
<section id="howtos">
<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="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>
</ul>
</div>
</section>
<section id="systems">
<h2>Systems<a class="headerlink" href="#systems" title="Permalink to this headline"></a></h2>
<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>
</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>
<div class="toctree-wrapper compound">
<ul>
<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>
</ul>
</div>
</section>
<section id="deep-dives">
<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-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>
</ul>
</div>
</section>
<section id="old-tutorials">
<h2>Old tutorials<a class="headerlink" href="#old-tutorials" title="Permalink to this headline"></a></h2>
<p>These will be replaced by the Beginner Tutorial, but remain here until that is complete.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="Implementing-a-game-rule-system.html">Implementing a game rule system</a></li>
<li class="toctree-l1"><a class="reference internal" href="Turn-based-Combat-System.html">Turn based Combat System</a></li>
<li class="toctree-l1"><a class="reference internal" href="Tutorial-for-basic-MUSH-like-game.html">Tutorial for basic MUSH like game</a></li>
</ul>
</div>
</section>
</section>
</div>
</div>
</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="Beginner-Tutorial/Beginner-Tutorial-Intro.html" title="Beginner Tutorial"
>next</a> |</li>
<li class="right" >
<a href="../Setup/Apache-Config.html" title="Apache Config"
>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>
</ul>
<div class="develop">develop branch</div>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2022, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink