2023-06-10 08:55:41 +02:00
<!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/" / >
2023-10-19 20:22:27 +00:00
< title > Tutorials and How-To’ s — Evennia 2.x documentation< / title >
2023-06-10 08:55:41 +02:00
< 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 >
2023-10-19 20:22:27 +00:00
2023-06-10 08:55:41 +02:00
< 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 >
2023-10-19 20:22:27 +00:00
< 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 How-To’ s< / a > < / li >
2023-06-10 08:55:41 +02:00
< / 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 >
2023-10-19 20:22:27 +00:00
< li > < a class = "reference internal" href = "#" > Tutorials and How-To’ s< / a > < ul >
< li > < a class = "reference internal" href = "#beginner-tutorial" > Beginner Tutorial< / a > < ul >
< / ul >
< / li >
< li > < a class = "reference internal" href = "#how-tos" > How-To’ s< / a > < / li >
2023-06-10 08:55:41 +02:00
< li > < a class = "reference internal" href = "#systems" > Systems< / a > < / li >
2023-10-19 20:22:27 +00:00
< li > < a class = "reference internal" href = "#website-tutorials" > Website 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 >
2023-06-10 08:55:41 +02:00
< / 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 >
2023-10-19 20:22:27 +00:00
< 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 >
2023-06-10 08:55:41 +02:00
< 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 >
2023-10-19 20:22:27 +00:00
< h3 > Doc Versions< / h3 >
2023-10-19 19:49:53 +00:00
< ul >
2023-10-19 20:22:27 +00:00
< li > < a href = "Howtos-Overview.html" > 2.x (main branch)< / a > < / li >
2023-10-19 19:49:53 +00:00
< ul >
2023-10-19 20:22:27 +00:00
< li > < a href = "../1.3.0/index.html" > 1.3.0 (v1.3.0 branch)< / a > < / li >
< li > < a href = "../0.9.5/index.html" > 0.9.5 (v0.9.5 branch)< / a > < / li >
2023-10-19 19:49:53 +00:00
< / ul >
2023-06-10 08:55:41 +02:00
< / div >
< / div >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
2023-10-19 20:22:27 +00:00
< section class = "tex2jax_ignore mathjax_ignore" id = "tutorials-and-how-tos" >
< h1 > Tutorials and How-To’ s< a class = "headerlink" href = "#tutorials-and-how-tos" title = "Permalink to this headline" > ¶< / a > < / h1 >
< p > Below you will find a variety of tutorials and how-to’ s for Evennia. The Beginner Tutorial is the recommended starting point.< / p >
< div class = "admonition note" >
< p class = "admonition-title" > Note< / p >
< p > Want more details about something? See the documentation for Evennia’ s 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 >
< / div >
2023-06-10 08:55:41 +02:00
< 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
2023-10-19 20:22:27 +00:00
a small – but full – game with Evennia. Other tutorials and how-to’ s tend to assume you are already familiar with the concepts explained in the Beginner Tutorial.< / p >
2023-06-10 08:55:41 +02:00
< 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 >
2023-10-19 20:22:27 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "Beginner-Tutorial/Beginner-Tutorial-Overview.html" > Beginner Tutorial< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Beginner-Tutorial/Part1/Beginner-Tutorial-Part1-Overview.html" > Part 1: What We Have< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Beginner-Tutorial/Part2/Beginner-Tutorial-Part2-Overview.html" > Part 2: What We Want< / a > < / 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 > < / 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 > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Beginner-Tutorial/Part5/Beginner-Tutorial-Part5-Overview.html" > Part 5: Showing the World< / a > < / li >
2023-06-10 08:55:41 +02:00
< / ul >
< / div >
2023-10-19 20:22:27 +00:00
< div class = "toctree-wrapper compound" >
< / div >
2023-06-10 08:55:41 +02:00
< / section >
2023-10-19 20:22:27 +00:00
< section id = "how-tos" >
< h2 > How-To’ s< a class = "headerlink" href = "#how-tos" title = "Permalink to this headline" > ¶< / a > < / h2 >
2023-06-10 08:55:41 +02:00
< 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 >
2023-10-19 20:22:27 +00:00
< section id = "website-tutorials" >
< h2 > Website Tutorials< a class = "headerlink" href = "#website-tutorials" title = "Permalink to this headline" > ¶< / a > < / h2 >
2023-06-10 08:55:41 +02:00
< 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 >
2023-10-19 20:22:27 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "Web-Help-System-Tutorial.html" > Web Help System Tutorial< / a > < / li >
2023-06-10 08:55:41 +02:00
< 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" >
2023-10-19 20:22:27 +00:00
< h2 > Deep Dives< a class = "headerlink" href = "#deep-dives" title = "Permalink to this headline" > ¶< / a > < / h2 >
2023-06-10 08:55:41 +02:00
< 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" >
2023-10-19 20:22:27 +00:00
< h2 > Old Tutorials< a class = "headerlink" href = "#old-tutorials" title = "Permalink to this headline" > ¶< / a > < / h2 >
2023-06-10 08:55:41 +02:00
< 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 >
2023-10-19 20:22:27 +00:00
< 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 How-To’ s< / a > < / li >
2023-06-10 08:55:41 +02:00
< / ul >
< / div >
2023-10-19 20:22:27 +00:00
2023-06-10 08:55:41 +02:00
< div class = "footer" role = "contentinfo" >
2023-10-19 20:22:27 +00:00
© Copyright 2023, The Evennia developer community.
2023-06-10 08:55:41 +02:00
Created using < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > 3.2.1.
< / div >
< / body >
< / html >