Updated HTML docs.

This commit is contained in:
Evennia docbuilder action 2022-11-20 23:39:28 +00:00
parent 57f411a6fa
commit 3fbd6c8647
154 changed files with 5284 additions and 4653 deletions

View file

@ -6,7 +6,7 @@
<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>On Planning a Game &#8212; Evennia 1.0-dev documentation</title>
<title>2. On Planning a Game &#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>
@ -17,8 +17,8 @@
<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="Planning our tutorial game" href="Beginner-Tutorial-Planning-The-Tutorial-Game.html" />
<link rel="prev" title="Where do I begin?" href="Beginner-Tutorial-Planning-Where-Do-I-Begin.html" />
<link rel="next" title="3. Planning our tutorial game" href="Beginner-Tutorial-Planning-The-Tutorial-Game.html" />
<link rel="prev" title="1. Where do I begin?" href="Beginner-Tutorial-Planning-Where-Do-I-Begin.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
@ -30,16 +30,16 @@
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="Beginner-Tutorial-Planning-The-Tutorial-Game.html" title="Planning our tutorial game"
<a href="Beginner-Tutorial-Planning-The-Tutorial-Game.html" title="3. Planning our tutorial game"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="Beginner-Tutorial-Planning-Where-Do-I-Begin.html" title="Where do I begin?"
<a href="Beginner-Tutorial-Planning-Where-Do-I-Begin.html" title="1. Where do I begin?"
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-1"><a href="../../Howtos-Overview.html" >Tutorials and Howtos</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="../Beginner-Tutorial-Intro.html" >Beginner Tutorial</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="Beginner-Tutorial-Part2-Intro.html" accesskey="U">Part 2: What we want</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">On Planning a Game</a></li>
<li class="nav-item nav-item-this"><a href=""><span class="section-number">2. </span>On Planning a Game</a></li>
</ul>
<div class="develop">develop branch</div>
</div>
@ -64,33 +64,33 @@
<script>$('#searchbox').show(0);</script>
<h3><a href="../../../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">On Planning a Game</a><ul>
<li><a class="reference internal" href="#the-steps">The steps</a></li>
<li><a class="reference internal" href="#planning">Planning</a><ul>
<li><a class="reference internal" href="#administration">Administration</a></li>
<li><a class="reference internal" href="#building">Building</a></li>
<li><a class="reference internal" href="#systems">Systems</a></li>
<li><a class="reference internal" href="#rooms">Rooms</a></li>
<li><a class="reference internal" href="#objects-items">Objects / items</a></li>
<li><a class="reference internal" href="#characters">Characters</a></li>
<li><a class="reference internal" href="#">2. On Planning a Game</a><ul>
<li><a class="reference internal" href="#the-steps">2.1. The steps</a></li>
<li><a class="reference internal" href="#planning">2.2. Planning</a><ul>
<li><a class="reference internal" href="#administration">2.2.1. Administration</a></li>
<li><a class="reference internal" href="#building">2.2.2. Building</a></li>
<li><a class="reference internal" href="#systems">2.2.3. Systems</a></li>
<li><a class="reference internal" href="#rooms">2.2.4. Rooms</a></li>
<li><a class="reference internal" href="#objects-items">2.2.5. Objects / items</a></li>
<li><a class="reference internal" href="#characters">2.2.6. Characters</a></li>
</ul>
</li>
<li><a class="reference internal" href="#coding-and-tech-demo">Coding and Tech demo</a></li>
<li><a class="reference internal" href="#world-building">World Building</a></li>
<li><a class="reference internal" href="#alpha-release">Alpha Release</a></li>
<li><a class="reference internal" href="#beta-release-perpetual-beta">Beta Release/Perpetual Beta</a></li>
<li><a class="reference internal" href="#congratulate-yourself">Congratulate yourself!</a></li>
<li><a class="reference internal" href="#planning-our-tutorial-game">Planning our tutorial game</a></li>
<li><a class="reference internal" href="#coding-and-tech-demo">2.3. Coding and Tech demo</a></li>
<li><a class="reference internal" href="#world-building">2.4. World Building</a></li>
<li><a class="reference internal" href="#alpha-release">2.5. Alpha Release</a></li>
<li><a class="reference internal" href="#beta-release-perpetual-beta">2.6. Beta Release/Perpetual Beta</a></li>
<li><a class="reference internal" href="#congratulate-yourself">2.7. Congratulate yourself!</a></li>
<li><a class="reference internal" href="#planning-our-tutorial-game">2.8. Planning our tutorial game</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="Beginner-Tutorial-Planning-Where-Do-I-Begin.html"
title="previous chapter">Where do I begin?</a></p>
title="previous chapter"><span class="section-number">1. </span>Where do I begin?</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="Beginner-Tutorial-Planning-The-Tutorial-Game.html"
title="next chapter">Planning our tutorial game</a></p>
title="next chapter"><span class="section-number">3. </span>Planning our tutorial game</a></p>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
@ -122,7 +122,7 @@
<div class="body" role="main">
<section class="tex2jax_ignore mathjax_ignore" id="on-planning-a-game">
<h1>On Planning a Game<a class="headerlink" href="#on-planning-a-game" title="Permalink to this headline"></a></h1>
<h1><span class="section-number">2. </span>On Planning a Game<a class="headerlink" href="#on-planning-a-game" title="Permalink to this headline"></a></h1>
<p>Last lesson we asked ourselves some questions about our motivation. In this one well present
some more technical questions to consider. In the next lesson well answer them for the sake of
our tutorial game.</p>
@ -143,7 +143,7 @@ later than to code in isolation until you burn out, lose interest or your hard d
<li><p>Keep having <em>fun</em>. You must keep your motivation up, whichever way works for <em>you</em>.</p></li>
</ul>
<section id="the-steps">
<h2>The steps<a class="headerlink" href="#the-steps" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">2.1. </span>The steps<a class="headerlink" href="#the-steps" title="Permalink to this headline"></a></h2>
<p>Here are the rough steps towards your goal.</p>
<ol class="simple">
<li><p>Planning</p></li>
@ -154,7 +154,7 @@ later than to code in isolation until you burn out, lose interest or your hard d
</ol>
</section>
<section id="planning">
<h2>Planning<a class="headerlink" href="#planning" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">2.2. </span>Planning<a class="headerlink" href="#planning" title="Permalink to this headline"></a></h2>
<p>You need to have at least a rough idea about what you want to create. Some like a lot of planning, others
do it more seat-of-the-pants style. Regardless, while <em>some</em> planning is always good to do, its common
to have your plans change on you as you create your code prototypes. So dont get <em>too</em> bogged down in
@ -166,7 +166,7 @@ Evennia.</p>
<p>Below are some questions to get you going. In the next lesson we will try to answer them for our particular
tutorial game. There are of course many more questions you could be asking yourself.</p>
<section id="administration">
<h3>Administration<a class="headerlink" href="#administration" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">2.2.1. </span>Administration<a class="headerlink" href="#administration" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Should your game rules be enforced by coded systems or by human game masters?</p></li>
<li><p>What is the staff hierarchy in your game? Is vanilla Evennia roles enough or do you need something else?</p></li>
@ -174,7 +174,7 @@ tutorial game. There are of course many more questions you could be asking yours
</ul>
</section>
<section id="building">
<h3>Building<a class="headerlink" href="#building" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">2.2.2. </span>Building<a class="headerlink" href="#building" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>How will the world be built? Traditionally (from in-game with build-commands) or externally (by batchcmds/code
or directly with custom code)?</p></li>
@ -182,7 +182,7 @@ or directly with custom code)?</p></li>
</ul>
</section>
<section id="systems">
<h3>Systems<a class="headerlink" href="#systems" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">2.2.3. </span>Systems<a class="headerlink" href="#systems" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Do you base your game off an existing RPG system or make up your own?</p></li>
<li><p>What are the game mechanics? How do you decide if an action succeeds or fails?</p></li>
@ -194,7 +194,7 @@ or directly with custom code)?</p></li>
</ul>
</section>
<section id="rooms">
<h3>Rooms<a class="headerlink" href="#rooms" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">2.2.4. </span>Rooms<a class="headerlink" href="#rooms" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Is a simple room description enough or should the description be able to change (such as with time, by
light conditions, weather or season)?</p></li>
@ -205,7 +205,7 @@ these things something admins/game masters should handle manually?</p></li>
</ul>
</section>
<section id="objects-items">
<h3>Objects / items<a class="headerlink" href="#objects-items" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">2.2.5. </span>Objects / items<a class="headerlink" href="#objects-items" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>How numerous are your objects? Do you want large loot-lists or are objects just role playing props
created on demand?</p></li>
@ -221,7 +221,7 @@ created on demand?</p></li>
</ul>
</section>
<section id="characters">
<h3>Characters<a class="headerlink" href="#characters" title="Permalink to this headline"></a></h3>
<h3><span class="section-number">2.2.6. </span>Characters<a class="headerlink" href="#characters" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Can players have more than one Character active at a time or are they allowed to multi-play?</p></li>
<li><p>How does the character-generation work? Walk from room-to-room? A menu?</p></li>
@ -240,7 +240,7 @@ release. Make a list. Keep future expansions in mind but limit yourself.</p>
</section>
</section>
<section id="coding-and-tech-demo">
<h2>Coding and Tech demo<a class="headerlink" href="#coding-and-tech-demo" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">2.3. </span>Coding and Tech demo<a class="headerlink" href="#coding-and-tech-demo" title="Permalink to this headline"></a></h2>
<p>This is the actual work of creating the “game” part of your game. As you code and test systems you should
build a little “tech demo” along the way.</p>
<aside class="sidebar">
@ -268,7 +268,7 @@ your work is backed up at all times. The page on <a class="reference internal" h
will help you to setting up a sane developer environment with proper version control.</p>
</section>
<section id="world-building">
<h2>World Building<a class="headerlink" href="#world-building" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">2.4. </span>World Building<a class="headerlink" href="#world-building" title="Permalink to this headline"></a></h2>
<p>Up until this point weve only had a few tech-demo objects in the database. This step is the act of
populating the database with a larger, thematic world. Too many would-be developers jump to this
stage too soon (skipping the <strong>Coding</strong> or even <strong>Planning</strong> stages). What if the rooms you build
@ -289,7 +289,7 @@ get a chance to hear if some things are hard to understand or non-intuitive. Ma
to this feedback.</p>
</section>
<section id="alpha-release">
<h2>Alpha Release<a class="headerlink" href="#alpha-release" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">2.5. </span>Alpha Release<a class="headerlink" href="#alpha-release" title="Permalink to this headline"></a></h2>
<p>As mentioned, dont hold onto your world more than necessary. <em>Get it out there</em> with a huge <em>Alpha</em>
flag and let people try it!</p>
<p>Call upon your alpha-players to try everything - they <em>will</em> find ways to break your game in ways that
@ -303,7 +303,7 @@ game visible online.</p>
pre-alpha games are allowed in the index so dont be shy)!</p>
</section>
<section id="beta-release-perpetual-beta">
<h2>Beta Release/Perpetual Beta<a class="headerlink" href="#beta-release-perpetual-beta" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">2.6. </span>Beta Release/Perpetual Beta<a class="headerlink" href="#beta-release-perpetual-beta" title="Permalink to this headline"></a></h2>
<p>Once things stabilize in Alpha you can move to <em>Beta</em> and let more people in. Many MUDs are in
<a class="reference external" href="https://en.wikipedia.org/wiki/Perpetual_beta">perpetual beta</a>, meaning they are never considered
“finished”, but just repeat the cycle of Planning, Coding, Testing and Building over and over as new
@ -311,12 +311,12 @@ features get implemented or Players come with suggestions. As the game designer
to gradually perfect your vision.</p>
</section>
<section id="congratulate-yourself">
<h2>Congratulate yourself!<a class="headerlink" href="#congratulate-yourself" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">2.7. </span>Congratulate yourself!<a class="headerlink" href="#congratulate-yourself" title="Permalink to this headline"></a></h2>
<p>You are worthy of a celebration since at this point you have joined the small, exclusive crowd who
have made their dream game a reality!</p>
</section>
<section id="planning-our-tutorial-game">
<h2>Planning our tutorial game<a class="headerlink" href="#planning-our-tutorial-game" title="Permalink to this headline"></a></h2>
<h2><span class="section-number">2.8. </span>Planning our tutorial game<a class="headerlink" href="#planning-our-tutorial-game" title="Permalink to this headline"></a></h2>
<p>In the next lesson well make use of these general points and try to plan out our tutorial game.</p>
</section>
</section>
@ -337,16 +337,16 @@ have made their dream game a reality!</p>
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="Beginner-Tutorial-Planning-The-Tutorial-Game.html" title="Planning our tutorial game"
<a href="Beginner-Tutorial-Planning-The-Tutorial-Game.html" title="3. Planning our tutorial game"
>next</a> |</li>
<li class="right" >
<a href="Beginner-Tutorial-Planning-Where-Do-I-Begin.html" title="Where do I begin?"
<a href="Beginner-Tutorial-Planning-Where-Do-I-Begin.html" title="1. Where do I begin?"
>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-1"><a href="../../Howtos-Overview.html" >Tutorials and Howtos</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="../Beginner-Tutorial-Intro.html" >Beginner Tutorial</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="Beginner-Tutorial-Part2-Intro.html" >Part 2: What we want</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">On Planning a Game</a></li>
<li class="nav-item nav-item-this"><a href=""><span class="section-number">2. </span>On Planning a Game</a></li>
</ul>
<div class="develop">develop branch</div>
</div>