<h1>Evennia for MUSH Users<aclass="headerlink"href="#evennia-for-mush-users"title="Permalink to this headline">¶</a></h1>
<p><em>This page is adopted from an article originally posted for the MUSH community <aclass="reference external"href="https://musoapbox.net/topic/1150/evennia-for-mushers">here on
musoapbox.net</a>.</em></p>
<p><aclass="reference external"href="https://en.wikipedia.org/wiki/MUSH">MUSH</a>es are text multiplayer games traditionally used for
heavily roleplay-focused game styles. They are often (but not always) utilizing game masters and
human oversight over code automation. MUSHes are traditionally built on the TinyMUSH-family of game
servers, like PennMUSH, TinyMUSH, TinyMUX and RhostMUSH. Also their siblings
<aclass="reference external"href="https://en.wikipedia.org/wiki/TinyMUCK">MUCK</a> and <aclass="reference external"href="https://en.wikipedia.org/wiki/MOO">MOO</a> are
often mentioned together with MUSH since they all inherit from the same
<aclass="reference external"href="https://en.wikipedia.org/wiki/MUD_trees#TinyMUD_family_tree">TinyMUD</a> base. A major feature is the
ability to modify and program the game world from inside the game by using a custom scripting
language. We will refer to this online scripting as <em>softcode</em> here.</p>
<p>Evennia works quite differently from a MUSH both in its overall design and under the hood. The same
things are achievable, just in a different way. Here are some fundamental differences to keep in
mind if you are coming from the MUSH world.</p>
<sectionid="developers-vs-players">
<h2>Developers vs Players<aclass="headerlink"href="#developers-vs-players"title="Permalink to this headline">¶</a></h2>
<p>In MUSH, users tend to code and expand all aspects of the game from inside it using softcode. A MUSH
can thus be said to be managed solely by <em>Players</em> with different levels of access. Evennia on the
other hand, differentiates between the role of the <em>Player</em> and the <em>Developer</em>.</p>
<ulclass="simple">
<li><p>An Evennia <em>Developer</em> works in Python from <em>outside</em> the game, in what MUSH would consider
“hardcode”. Developers implement larger-scale code changes and can fundamentally change how the game
works. They then load their changes into the running Evennia server. Such changes will usually not
drop any connected players.</p></li>
<li><p>An Evennia <em>Player</em> operates from <em>inside</em> the game. Some staff-level players are likely to double
as developers. Depending on access level, players can modify and expand the game’s world by digging
new rooms, creating new objects, alias commands, customize their experience and so on. Trusted staff
may get access to Python via the <codeclass="docutils literal notranslate"><spanclass="pre">@py</span></code> command, but this would be a security risk for normal Players
to use. So the <em>Player</em> usually operates by making use of the tools prepared for them by the
<em>Developer</em> - tools that can be as rigid or flexible as the developer desires.</p></li>
<h2>Collaborating on a game - Python vs Softcode<aclass="headerlink"href="#collaborating-on-a-game-python-vs-softcode"title="Permalink to this headline">¶</a></h2>
<p>For a <em>Player</em>, collaborating on a game need not be too different between MUSH and Evennia. The
building and description of the game world can still happen mostly in-game using build commands,
using text tags and <aclass="reference internal"href="../Components/FuncParser.html"><spanclass="doc std std-doc">inline functions</span></a> to prettify and customize the
experience. Evennia offers external ways to build a world but those are optional. There is also
nothing <em>in principle</em> stopping a Developer from offering a softcode-like language to Players if
that is deemed necessary.</p>
<p>For <em>Developers</em> of the game, the difference is larger: Code is mainly written outside the game in
Python modules rather than in-game on the command line. Python is a very popular and well-supported
language with tons of documentation and help to be found. The Python standard library is also a
great help for not having to reinvent the wheel. But that said, while Python is considered one of
the easier languages to learn and use it is undoubtedly very different from MUSH softcode.</p>
<p>While softcode allows collaboration in-game, Evennia’s external coding instead opens up the
possibility for collaboration using professional version control tools and bug tracking using
websites like github (or bitbucket for a free private repo). Source code can be written in proper
text editors and IDEs with refactoring, syntax highlighting and all other conveniences. In short,
collaborative development of an Evennia game is done in the same way most professional collaborative
development is done in the world, meaning all the best tools can be used.</p>
</section>
<sectionid="parent-vs-typeclass-and-spawn">
<h2><codeclass="docutils literal notranslate"><spanclass="pre">@parent</span></code> vs <codeclass="docutils literal notranslate"><spanclass="pre">@typeclass</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">@spawn</span></code><aclass="headerlink"href="#parent-vs-typeclass-and-spawn"title="Permalink to this headline">¶</a></h2>
<p>Inheritance works differently in Python than in softcode. Evennia has no concept of a “master
object” that other objects inherit from. There is in fact no reason at all to introduce “virtual
objects” in the game world - code and data are kept separate from one another.</p>
<p>In Python (which is an <aclass="reference external"href="https://en.wikipedia.org/wiki/Object-oriented_programming">object oriented</a>
language) one instead creates <em>classes</em> - these are like blueprints from which you spawn any number
of <em>object instances</em>. Evennia also adds the extra feature that every instance is persistent in the
database (this means no SQL is ever needed). To take one example, a unique character in Evennia is
an instances of the class <codeclass="docutils literal notranslate"><spanclass="pre">Character</span></code>.</p>
<p>One parallel to MUSH’s <codeclass="docutils literal notranslate"><spanclass="pre">@parent</span></code> command may be Evennia’s <codeclass="docutils literal notranslate"><spanclass="pre">@typeclass</span></code> command, which changes which
class an already existing object is an instance of. This way you can literally turn a <codeclass="docutils literal notranslate"><spanclass="pre">Character</span></code>
into a <codeclass="docutils literal notranslate"><spanclass="pre">Flowerpot</span></code> on the spot.</p>
<p>if you are new to object oriented design it’s important to note that all object instances of a class
does <em>not</em> have to be identical. If they did, all Characters would be named the same. Evennia allows
to customize individual objects in many different ways. One way is through <em>Attributes</em>, which are
database-bound properties that can be linked to any object. For example, you could have an <codeclass="docutils literal notranslate"><spanclass="pre">Orc</span></code>
class that defines all the stuff an Orc should be able to do (probably in turn inheriting from some
<codeclass="docutils literal notranslate"><spanclass="pre">Monster</span></code> class shared by all monsters). Setting different Attributes on different instances
(different strength, equipment, looks etc) would make each Orc unique despite all sharing the same
class.</p>
<p>The <codeclass="docutils literal notranslate"><spanclass="pre">@spawn</span></code> command allows one to conveniently choose between different “sets” of Attributes to
put on each new Orc (like the “warrior” set or “shaman” set) . Such sets can even inherit one
another which is again somewhat remniscent at least of the <em>effect</em> of <codeclass="docutils literal notranslate"><spanclass="pre">@parent</span></code> and the object-
based inheritance of MUSH.</p>
<p>There are other differences for sure, but that should give some feel for things. Enough with the
theory. Let’s get down to more practical matters next. To install, see the
<aclass="reference internal"href="../Setup/Installation.html"><spanclass="doc std std-doc">Getting Started instructions</span></a>.</p>
<h2>A first step making things more familiar<aclass="headerlink"href="#a-first-step-making-things-more-familiar"title="Permalink to this headline">¶</a></h2>
<p>We will here give two examples of customizing Evennia to be more familiar to a MUSH <em>Player</em>.</p>
<sectionid="activating-a-multi-descer">
<h3>Activating a multi-descer<aclass="headerlink"href="#activating-a-multi-descer"title="Permalink to this headline">¶</a></h3>
<p>By default Evennia’s <codeclass="docutils literal notranslate"><spanclass="pre">desc</span></code> command updates your description and that’s it. There is a more feature-
rich optional “multi-descer” in <codeclass="docutils literal notranslate"><spanclass="pre">evennia/contrib/multidesc.py</span></code> though. This alternative allows for
managing and combining a multitude of keyed descriptions.</p>
<p>To activate the multi-descer, <codeclass="docutils literal notranslate"><spanclass="pre">cd</span></code> to your game folder and into the <codeclass="docutils literal notranslate"><spanclass="pre">commands</span></code> sub-folder. There
you’ll find the file <codeclass="docutils literal notranslate"><spanclass="pre">default_cmdsets.py</span></code>. In Python lingo all <codeclass="docutils literal notranslate"><spanclass="pre">*.py</span></code> files are called <em>modules</em>.
Open the module in a text editor. We won’t go into Evennia in-game <em>Commands</em> and <em>Command sets</em>
further here, but suffice to say Evennia allows you to change which commands (or versions of
commands) are available to the player from moment to moment depending on circumstance.</p>
<p>Add two new lines to the module as seen below:</p>
<divclass="highlight-python notranslate"><divclass="highlight"><pre><span></span><spanclass="c1"># the file mygame/commands/default_cmdsets.py</span>
<spanclass="c1"># any commands you add below will overload the default ones.</span>
<spanclass="c1">#</span>
<spanclass="bp">self</span><spanclass="o">.</span><spanclass="n">add</span><spanclass="p">(</span><spanclass="n">multidescer</span><spanclass="o">.</span><spanclass="n">CmdMultiDesc</span><spanclass="p">())</span><spanclass="c1"># <- added now </span>
<spanclass="c1"># [...]</span>
</pre></div>
</div>
<p>Note that Python cares about indentation, so make sure to indent with the same number of spaces as
shown above!</p>
<p>So what happens above? We <aclass="reference external"href="https://www.linuxtopia.org/online_books/programming_books/python_programming/python_ch28s03.html">import the
module</a>
<codeclass="docutils literal notranslate"><spanclass="pre">evennia/contrib/multidescer.py</span></code> at the top. Once imported we can access stuff inside that module
using full stop (<codeclass="docutils literal notranslate"><spanclass="pre">.</span></code>). The multidescer is defined as a class <codeclass="docutils literal notranslate"><spanclass="pre">CmdMultiDesc</span></code> (we could find this out
by opening said module in a text editor). At the bottom we create a new instance of this class and
add it to the <codeclass="docutils literal notranslate"><spanclass="pre">CharacterCmdSet</span></code> class. For the sake of this tutorial we only need to know that
<codeclass="docutils literal notranslate"><spanclass="pre">CharacterCmdSet</span></code> contains all commands that should be be available to the <codeclass="docutils literal notranslate"><spanclass="pre">Character</span></code> by default.</p>
<p>This whole thing will be triggered when the command set is first created, which happens on server
start. So we need to reload Evennia with <codeclass="docutils literal notranslate"><spanclass="pre">@reload</span></code> - no one will be disconnected by doing this. If
all went well you should now be able to use <codeclass="docutils literal notranslate"><spanclass="pre">desc</span></code> (or <codeclass="docutils literal notranslate"><spanclass="pre">+desc</span></code>) and find that you have more
possibilities:</p>
<divclass="highlight-text notranslate"><divclass="highlight"><pre><span></span>> help +desc # get help on the command
> +desc eyes = His eyes are blue.
> +desc basic = A big guy.
> +desc/set basic + + eyes # we add an extra space between
> look me
A big guy. His eyes are blue.
</pre></div>
</div>
<p>If there are errors, a <em>traceback</em> will show in the server log - several lines of text showing
where the error occurred. Find where the error is by locating the line number related to the
<codeclass="docutils literal notranslate"><spanclass="pre">default_cmdsets.py</span></code> file (it’s the only one you’ve changed so far). Most likely you mis-spelled
something or missed the indentation. Fix it and either <codeclass="docutils literal notranslate"><spanclass="pre">@reload</span></code> again or run <codeclass="docutils literal notranslate"><spanclass="pre">evennia</span><spanclass="pre">start</span></code> as
needed.</p>
</section>
<sectionid="customizing-the-multidescer-syntax">
<h3>Customizing the multidescer syntax<aclass="headerlink"href="#customizing-the-multidescer-syntax"title="Permalink to this headline">¶</a></h3>
<p>As seen above the multidescer uses syntax like this (where <codeclass="docutils literal notranslate"><spanclass="pre">|/</span></code> are Evennia’s tags for line breaks)
<p>This use of <codeclass="docutils literal notranslate"><spanclass="pre">+</span></code> was prescribed by the <em>Developer</em> that coded this <codeclass="docutils literal notranslate"><spanclass="pre">+desc</span></code> command. What if the
<em>Player</em> doesn’t like this syntax though? Do players need to pester the dev to change it? Not
necessarily. While Evennia does not allow the player to build their own multi-descer on the command
line, it does allow for <em>re-mapping</em> the command syntax to one they prefer. This is done using the
<p>The string on the left will be matched against your input and if matching, it will be replaced with
the string on the right. The <codeclass="docutils literal notranslate"><spanclass="pre">$</span></code>-type tags will store space-separated arguments and put them into
the replacement. The nick allows <aclass="reference external"href="http://www.linfo.org/wildcard.html">shell-like wildcards</a>, so you
can use <codeclass="docutils literal notranslate"><spanclass="pre">*</span></code>, <codeclass="docutils literal notranslate"><spanclass="pre">?</span></code>, <codeclass="docutils literal notranslate"><spanclass="pre">[...]</span></code>, <codeclass="docutils literal notranslate"><spanclass="pre">[!...]</span></code> etc to match parts of the input.</p>
<p>The same description as before can now be set as</p>
<p>With the <codeclass="docutils literal notranslate"><spanclass="pre">nick</span></code> functionality players can mitigate a lot of syntax dislikes even without the
developer changing the underlying Python code.</p>
</section>
</section>
<sectionid="next-steps">
<h2>Next steps<aclass="headerlink"href="#next-steps"title="Permalink to this headline">¶</a></h2>
<p>If you are a <em>Developer</em> and are interested in making a more MUSH-like Evennia game, a good start is
to look into the Evennia <aclass="reference internal"href="Tutorial-for-basic-MUSH-like-game.html"><spanclass="doc std std-doc">Tutorial for a first MUSH-like game</span></a>.
That steps through building a simple little game from scratch and helps to acquaint you with the
various corners of Evennia. There is also the [Tutorial for running roleplaying sessions](Evennia-
for-roleplaying-sessions) that can be of interest.</p>
<p>An important aspect of making things more familiar for <em>Players</em> is adding new and tweaking existing
commands. How this is done is covered by the [Tutorial on adding new commands](Adding-Command-
Tutorial). You may also find it useful to shop through the <codeclass="docutils literal notranslate"><spanclass="pre">evennia/contrib/</span></code> folder. The
<aclass="reference internal"href="Beginner-Tutorial/Part1/Beginner-Tutorial-Tutorial-World.html"><spanclass="doc std std-doc">Tutorial world</span></a> is a small single-player quest you can try (it’s not very MUSH-
like but it does show many Evennia concepts in action). Beyond that there are <aclass="reference internal"href="Howtos-Overview.html"><spanclass="doc std std-doc">many more tutorials</span></a>
to try out. If you feel you want a more visual overview you can also look at
<aclass="reference external"href="https://evennia.blogspot.se/2016/05/evennia-in-pictures.html">Evennia in pictures</a>.</p>
<p>… And of course, if you need further help you can always drop into the <aclass="reference external"href="https://webchat.freenode.net/?channels=evennia&uio=MT1mYWxzZSY5PXRydWUmMTE9MTk1JjEyPXRydWUbb">Evennia
chatroom</a>
or post a question in our <aclass="reference external"href="https://groups.google.com/forum/#%21forum/evennia">forum/mailing list</a>!</p>
