mirror of
https://github.com/evennia/evennia.git
synced 2026-03-18 13:56:30 +01:00
302 lines
No EOL
20 KiB
HTML
302 lines
No EOL
20 KiB
HTML
|
||
<!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 — Evennia 2.x 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-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>
|
||
<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-Overview.html" title="Beginner Tutorial"
|
||
accesskey="N">next</a> |</li>
|
||
<li class="right" >
|
||
<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 2.x</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">Tutorials and Howto’s</a></li>
|
||
</ul>
|
||
</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="#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/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-Overview.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/docs/latest/index.html">Documentation Top</a> </li>
|
||
<li><a href="https://www.evennia.com">Evennia Home</a> </li>
|
||
<li><a href="https://github.com/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>
|
||
</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>
|
||
<section id="beginner-tutorial">
|
||
<h2>Beginner Tutorial<a class="headerlink" href="#beginner-tutorial" title="Permalink to this headline">¶</a></h2>
|
||
<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>
|
||
<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-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-fresh-game-dir">A fresh game dir?</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>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<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>
|
||
<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-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>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<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>
|
||
<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</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part3/Beginner-Tutorial-Combat-Base.html">9. Combat base framework</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part3/Beginner-Tutorial-Combat-Twitch.html">10. Twitch Combat</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part3/Beginner-Tutorial-Combat-Turnbased.html">11. Turnbased Combat</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part3/Beginner-Tutorial-AI.html">12. NPC and monster AI</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part3/Beginner-Tutorial-Dungeon.html">13. Dynamically generated Dungeon</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part3/Beginner-Tutorial-Quests.html">14. Game Quests</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part3/Beginner-Tutorial-Shops.html">15. In-game Shops</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="Beginner-Tutorial/Part3/Beginner-Tutorial-Commands.html">16. In-game Commands</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<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-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>
|
||
</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></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>
|
||
<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>
|
||
<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="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>
|
||
<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="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="Tutorial-Using-Arxcode.html">Using the Arxcode game dir</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-Overview.html" title="Beginner Tutorial"
|
||
>next</a> |</li>
|
||
<li class="right" >
|
||
<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 2.x</a> »</li>
|
||
<li class="nav-item nav-item-this"><a href="">Tutorials and Howto’s</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="footer" role="contentinfo">
|
||
© Copyright 2023, The Evennia developer community.
|
||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
|
||
</div>
|
||
</body>
|
||
</html> |