<h1>Tutorials<aclass="headerlink"href="#tutorials"title="Permalink to this headline">¶</a></h1>
<p>Before continuing to read these tutorials (and especially before you start to code or build your game in earnest) it’s strongly recommended that you read the <aclass="reference internal"href="Coding-Introduction.html"><spanclass="doc">Evennia coding introduction</span></a> as well as the <aclass="reference internal"href="Game-Planning.html"><spanclass="doc">Planning your own game</span></a> pages first.</p>
<p>Please note that it’s not within the scope of our tutorials to teach you basic Python. If you are new to the language, expect to have to look up concepts you are unfamiliar with. Usually a quick internet search will give you all info you need. Furthermore, our tutorials tend to focus on implementation and concepts. As such they give only brief explanations to use Evennia features while providing ample links to the relevant detailed documentation.</p>
<p>The main information resource for builders is the <aclass="reference internal"href="Builder-Docs.html"><spanclass="doc">Builder Documentation</span></a>. Coders should refer to the <aclass="reference internal"href="Developer-Central.html"><spanclass="doc">Developer Central</span></a> for further information.</p>
<divclass="section"id="building">
<h2>Building<aclass="headerlink"href="#building"title="Permalink to this headline">¶</a></h2>
<p><em>Help with populating your game world.</em></p>
<ulclass="simple">
<li><p><aclass="reference internal"href="Building-Quickstart.html"><spanclass="doc">Tutorial: Building Quick-start</span></a> - helps you build your first rocks and crates using Evennia’s defaults.</p></li>
<li><p><aclass="reference internal"href="Understanding-Color-Tags.html"><spanclass="doc">Tutorial: Understanding Color Tags</span></a>- explains how you color your game’s text.</p></li>
<li><p><aclass="reference internal"href="Tutorial-World-Introduction.html"><spanclass="doc">Introduction: The Tutorial World</span></a> - this introduces the full (if small) solo-adventure game that comes with the Evennia distribution. It is useful both as an example of building and of coding.</p></li>
<li><p><aclass="reference internal"href="Building-a-mech-tutorial.html"><spanclass="doc">Tutorial: Building a Giant Mech</span></a> - this starts as a building tutorial and transitions into writing code.</p></li>
<h2>General Development tutorials<aclass="headerlink"href="#general-development-tutorials"title="Permalink to this headline">¶</a></h2>
<p><em>General code practices for newbie game developers.</em></p>
<p>To use Evennia, you will need basic understanding of Python <aclass="reference external"href="http://docs.python.org/3.7/tutorial/modules.html">modules</a>, <aclass="reference external"href="http://www.tutorialspoint.com/python/python_variable_types.htm">variables</a>, <aclass="reference external"href="http://docs.python.org/tutorial/controlflow.html#if-statements">conditional statements</a>, <aclass="reference external"href="http://docs.python.org/tutorial/controlflow.html#for-statements">loops</a>, <aclass="reference external"href="http://docs.python.org/tutorial/controlflow.html#defining-functions">functions</a>, <aclass="reference external"href="http://docs.python.org/tutorial/datastructures.html">lists, dictionaries, list comprehensions</a> and <aclass="reference external"href="http://docs.python.org/tutorial/introduction.html#strings">string formatting</a>. You should also have a basic understanding of <aclass="reference external"href="http://www.tutorialspoint.com/python/python_classes_objects.htm">object-oriented programming</a> and what Python <aclass="reference external"href="http://docs.python.org/tutorial/classes.html">Classes</a> are.</p>
<ulclass="simple">
<li><p><aclass="reference external"href="https://wiki.python.org/moin/BeginnersGuide/NonProgrammers">Python tutorials for beginners</a> - external link with tutorials for those not familiar with coding in general or Python in particular.</p></li>
<li><p><aclass="reference internal"href="Version-Control.html"><spanclass="doc">Tutorial: Version Control</span></a> - use GIT to organize your code both for your own game project and for contributing to Evennia.</p></li>
<li><p>MIT offers free courses in many subjects. Their <aclass="reference external"href="https://ocw.mit.edu/courses/electrical-engineering-and-computer-science/6-00sc-introduction-to-computer-science-and-programming-spring-2011/">Introduction to Computer Science and Programming</a> uses Python as its language of choice. Longer path, but more in-depth. Definitely worth a look.</p></li>
<li><p><aclass="reference internal"href="Python-basic-tutorial-part-two.html"><spanclass="doc">Python basic introduction</span></a> (part 2) - More on objects, classes and finding where things are.</p></li>
<li><p><aclass="reference internal"href="First-Steps-Coding.html"><spanclass="doc">Tutorial: First Steps Coding</span></a> - learn each basic feature on their own through step-by-step instruction.</p></li>
<li><p><aclass="reference internal"href="Tutorial-for-basic-MUSH-like-game.html"><spanclass="doc">Tutorial: A small first game</span></a> - learn basic features as part of building a small but working game from scratch.</p></li>
<li><p><aclass="reference internal"href="Adding-Command-Tutorial.html"><spanclass="doc">Tutorial: Adding new commands</span></a> - focuses specifically on how to add new commands.</p></li>
<li><p><aclass="reference internal"href="Adding-Object-Typeclass-Tutorial.html"><spanclass="doc">Tutorial: Adding new objects</span></a> - focuses specifically on how to add new objects.</p></li>
<li><p><aclass="reference internal"href="Tutorial-Searching-For-Objects.html"><spanclass="doc">Tutorial: Searching objects in the database</span></a> - how to find existing objects so you can operate on them.</p></li>
<li><p><aclass="reference internal"href="Tutorial-Vehicles.html"><spanclass="doc">Tutorial: Creating a vehicle</span></a></p></li>
<li><p><aclass="reference internal"href="NPC-shop-Tutorial.html"><spanclass="doc">Tutorial: Making an NPC shop</span></a> (also advanced <aclass="reference internal"href="EvMenu.html"><spanclass="doc">EvMenu</span></a> usage)</p></li>
<li><p><aclass="reference internal"href="Static-In-Game-Map.html"><spanclass="doc">Tutorial: Implementing a Static In Game Map</span></a> (also <aclass="reference internal"href="Batch-Code-Processor.html"><spanclass="doc">Batch Code</span></a> usage)</p></li>
<li><p><aclass="reference internal"href="Dynamic-In-Game-Map.html"><spanclass="doc">Tutorial: Implementing a Dynamic In Game Map</span></a></p></li>
<li><p><aclass="reference external"href="/Unit-Testing.html#testing-for-game-development-mini-tutorial">Tutorial: Writing your own unit tests</a></p></li>
</ul>
</div>
<divclass="section"id="game-mechanics-tutorials">
<h2>Game mechanics tutorials<aclass="headerlink"href="#game-mechanics-tutorials"title="Permalink to this headline">¶</a></h2>
<p><em>Creating the underlying game mechanics of game play.</em></p>
<ulclass="simple">
<li><p><aclass="reference internal"href="Implementing-a-game-rule-system.html"><spanclass="doc">Hints: Implementing a game rule system</span></a></p></li>
<li><p><aclass="reference internal"href="Turn-based-Combat-System.html"><spanclass="doc">Tutorial: Implementing a Combat system</span></a></p></li>
<li><p><aclass="reference internal"href="Evennia-for-roleplaying-sessions.html"><spanclass="doc">Tutorial: Evennia for running tabletop rpgs</span></a></p></li>
<h2>Miscellaneous system tutorials<aclass="headerlink"href="#miscellaneous-system-tutorials"title="Permalink to this headline">¶</a></h2>
<p><em>Design various game systems and achieve particular effects.</em></p>
<ulclass="simple">
<li><p><aclass="reference internal"href="Coding-FAQ.html"><spanclass="doc">FAQ</span></a>: A place for users to enter their own hints on achieving various goals in Evennia.</p></li>
<li><p><aclass="reference internal"href="Command-Prompt.html"><spanclass="doc">Tutorial: Adding a Command prompt</span></a></p></li>
<li><p><aclass="reference internal"href="Zones.html"><spanclass="doc">Tutorial: Creating a Zoning system</span></a></p></li>
<li><p><aclass="reference internal"href="Manually-Configuring-Color.html"><spanclass="doc">Tutorial: Letting players manually configure color settings</span></a></p></li>
<li><p><aclass="reference external"href="/EvMenu.html#ask-for-simple-input">Hints: Asking the user a question and dealing with the result</a></p></li>
<li><p><aclass="reference internal"href="Command-Duration.html"><spanclass="doc">Hints: Designing commands that take time to finish</span></a></p></li>
<li><p><aclass="reference internal"href="Command-Cooldown.html"><spanclass="doc">Hints: Adding cooldowns to commands</span></a></p></li>
<li><p><aclass="reference internal"href="Mass-and-weight-for-objects.html"><spanclass="doc">Tutorial: Mass and weight for objects</span></a></p></li>
<li><p><aclass="reference internal"href="Default-Exit-Errors.html"><spanclass="doc">Hints: Show a different message when trying a non-existent exit</span></a></p></li>
<li><p><aclass="reference internal"href="Tutorial-Tweeting-Game-Stats.html"><spanclass="doc">Tutorial: Make automatic tweets of game statistics</span></a></p></li>
<li><p><aclass="reference internal"href="Gametime-Tutorial.html"><spanclass="doc">Tutorial: Handling virtual time in your game</span></a></p></li>
<li><p><aclass="reference internal"href="Coordinates.html"><spanclass="doc">Tutorial: Setting up a coordinate system for rooms</span></a></p></li>
<li><p><aclass="reference internal"href="Customize-channels.html"><spanclass="doc">Tutorial: customize the way channels and channel commands work in your game</span></a></p></li>
<li><p><aclass="reference external"href="/Unit-Testing.html#testing-for-game-development-mini-tutorial">Tutorial: Adding unit tests to your game project</a></p></li>
</ul>
</div>
<divclass="section"id="contrib">
<h2>Contrib<aclass="headerlink"href="#contrib"title="Permalink to this headline">¶</a></h2>
<p><em>This section contains tutorials linked with contribs. These contribs can be used in your game, but you’ll need to install them explicitly. They add common features that can earn you time in implementation.</em></p>
<ulclass="simple">
<li><p><aclass="reference external"href="https://github.com/evennia/evennia/blob/master/evennia/contrib/README.md">list of contribs</a></p></li>
<li><p><aclass="reference internal"href="Dialogues-in-events.html"><spanclass="doc">In-game Python: dialogues with characters</span></a>.</p></li>
<li><p><aclass="reference internal"href="A-voice-operated-elevator-using-events.html"><spanclass="doc">In-game Python: a voice-operated elevator</span></a>.</p></li>
</ul>
</div>
<divclass="section"id="web-tutorials">
<h2>Web tutorials<aclass="headerlink"href="#web-tutorials"title="Permalink to this headline">¶</a></h2>
<p><em>Expanding Evennia’s web presence.</em></p>
<ulclass="simple">
<li><p><aclass="reference internal"href="Add-a-simple-new-web-page.html"><spanclass="doc">Tutorial: Add a new web page</span></a> - simple example to see how Django pages hang together.</p></li>
<li><p><aclass="reference internal"href="Web-Tutorial.html"><spanclass="doc">Tutorial: Website customization</span></a> - learn how to start customizing your game’s web presence.</p></li>
<li><p><aclass="reference internal"href="Bootstrap-&-Evennia.html"><spanclass="doc">Tutorial: Bootstrap & Evennia</span></a> - Learn more about Bootstrap, the current CSS framework Evennia is using</p></li>
<li><p><aclass="reference internal"href="Web-Character-View-Tutorial.html"><spanclass="doc">Tutorial: Build a web page displaying a game character</span></a> - make a way to view your character on the web page.</p></li>
<li><p><aclass="reference internal"href="Help-System-Tutorial.html"><spanclass="doc">Tutorial: access your help system from your website</span></a></p></li>
<li><p><aclass="reference internal"href="Add-a-wiki-on-your-website.html"><spanclass="doc">Tutorial: add a wiki on your website</span></a></p></li>
<li><p><aclass="reference internal"href="Web-Character-Generation.html"><spanclass="doc">Tutorial: Web Character Generation</span></a> - make a web-based character application form.</p></li>
<li><p><aclass="reference internal"href="Bootstrap-Components-and-Utilities.html"><spanclass="doc">Tutorial: Bootstrap Components and Utilities</span></a> - Describes some common Bootstrap Components and Utilities that might help in designing for Evennia</p></li>
</ul>
</div>
<divclass="section"id="evennia-for-engine-users">
<h2>Evennia for [Engine]-Users<aclass="headerlink"href="#evennia-for-engine-users"title="Permalink to this headline">¶</a></h2>
<p><em>Hints for new users more familiar with other game engines.</em></p>
<ulclass="simple">
<li><p><aclass="reference internal"href="Evennia-for-Diku-Users.html"><spanclass="doc">Evennia for Diku Users</span></a> - read up on the differences between Diku style muds and Evennia.</p></li>
<li><p><aclass="reference internal"href="Evennia-for-MUSH-Users.html"><spanclass="doc">Evennia for MUSH Users</span></a> - an introduction to Evennia for those accustomed to MUSH-style servers.</p></li>
