evennia/docs/1.0-dev/Contribs/Contrib-Overview.html
2021-08-06 00:47:51 +02:00

475 lines
No EOL
24 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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>Contrib modules &#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>
<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="Crafting system contrib" href="Crafting.html" />
<link rel="prev" title="Coding and development help" href="../Coding/Coding-Overview.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="Crafting.html" title="Crafting system contrib"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../Coding/Coding-Overview.html" title="Coding and development help"
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-this"><a href="">Contrib modules</a></li>
</ul>
<div class="develop">develop branch</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="contrib-modules">
<h1>Contrib modules<a class="headerlink" href="#contrib-modules" title="Permalink to this headline"></a></h1>
<p>Contribs are found in <a class="reference external" href="../api/evennia.contrib.html">evennia/contrib/</a> and are optional game-specific code-snippets
or even full systems you can use for your game. They are contributed by the Evennia community and
released under the same license as Evennia itself. Each contrib has its own installation instructions.
Bugs are reported to the Evennia <a class="reference external" href="https://github.com/evennia/evennia/issues/new/choose">issue tracker</a> as usual.</p>
<section id="character-related">
<h2>Character-related<a class="headerlink" href="#character-related" title="Permalink to this headline"></a></h2>
<p>Contribs related to characters and character displays.</p>
<section id="chargen">
<h3>CharGen<a class="headerlink" href="#chargen" title="Permalink to this headline"></a></h3>
<p><em>Griatch 2011</em></p>
<p>A simple Character creator for OOC mode. Meant as a starting point for a more fleshed-out system.</p>
</section>
<section id="clothing">
<h3>Clothing<a class="headerlink" href="#clothing" title="Permalink to this headline"></a></h3>
<p><em>FlutterSprite 2017</em></p>
<p>A layered clothing system with slots for different types of garments auto-showing in description.</p>
</section>
<section id="health-bar">
<h3>Health Bar<a class="headerlink" href="#health-bar" title="Permalink to this headline"></a></h3>
<p><em>Tim Ashley Jenkins 2017</em></p>
<p>Tool to create colorful bars/meters.</p>
</section>
<section id="multidescer">
<h3>Multidescer<a class="headerlink" href="#multidescer" title="Permalink to this headline"></a></h3>
<p><em>Griatch 2016</em></p>
<p>Advanced descriptions combined from many separate description components, inspired by MUSH.</p>
</section>
</section>
<hr class="docutils" />
<section id="rooms-movement-and-grid">
<h2>Rooms, movement and grid<a class="headerlink" href="#rooms-movement-and-grid" title="Permalink to this headline"></a></h2>
<p>Contribs modifying locations, movement or helping to creating rooms.</p>
<section id="xyzgrid">
<h3>XYZGrid<a class="headerlink" href="#xyzgrid" title="Permalink to this headline"></a></h3>
<p><em>Griatch 2021</em></p>
<p>Adds an XYZgrid to Evennia, with map-display and pathfinding. Created via map
strings and maintained outside of the game via Evennia launch commands.</p>
<ul class="simple">
<li><p><a class="reference internal" href="XYZGrid.html"><span class="doc">XYZGrid documentation</span></a></p></li>
</ul>
</section>
<section id="extended-room">
<h3>Extended Room<a class="headerlink" href="#extended-room" title="Permalink to this headline"></a></h3>
<p><em>Griatch 2012</em></p>
<p>An expanded Room typeclass with multiple descriptions for time and season as well as details.</p>
</section>
<section id="map-builder">
<h3>Map Builder<a class="headerlink" href="#map-builder" title="Permalink to this headline"></a></h3>
<p><em>CloudKeeper 2016</em></p>
<p>Build a game area based on a 2D “graphical” unicode map. Supports asymmetric exits.</p>
<ul class="simple">
<li><p><a class="reference internal" href="Static-In-Game-Map.html"><span class="doc">Static in-game map</span></a></p></li>
</ul>
</section>
<section id="simple-door">
<h3>Simple Door<a class="headerlink" href="#simple-door" title="Permalink to this headline"></a></h3>
<p><em>Griatch 2014</em></p>
<p>Example of an exit that can be opened and closed from both sides.</p>
</section>
<section id="slow-exit">
<h3>Slow exit<a class="headerlink" href="#slow-exit" title="Permalink to this headline"></a></h3>
<p><em>Griatch 2014</em></p>
<p>Custom Exit class that takes different time to pass depending on if you are walking/running etc.</p>
</section>
<section id="wilderness">
<h3>Wilderness<a class="headerlink" href="#wilderness" title="Permalink to this headline"></a></h3>
<p><em>titeuf87 2017</em></p>
<p>Make infinitely large wilderness areas with dynamically created locations.</p>
<ul class="simple">
<li><p><a class="reference internal" href="Dynamic-In-Game-Map.html"><span class="doc">Dynamic in-game map</span></a></p></li>
</ul>
</section>
</section>
<hr class="docutils" />
<section id="roleplaying-and-rules">
<h2>Roleplaying and rules<a class="headerlink" href="#roleplaying-and-rules" title="Permalink to this headline"></a></h2>
<p>Contribs supporting roleplay and in-game roleplaying actions.</p>
<section id="barter-system">
<h3>Barter system<a class="headerlink" href="#barter-system" title="Permalink to this headline"></a></h3>
<p><em>Griatch 2012</em></p>
<p>A safe and effective barter-system for any game. Allows safe trading of any goods (including coin).</p>
</section>
<section id="crafting">
<h3>Crafting<a class="headerlink" href="#crafting" title="Permalink to this headline"></a></h3>
<p><em>Griatch 2020</em></p>
<p>A full, extendable crafting system.</p>
<ul class="simple">
<li><p><a class="reference internal" href="Crafting.html"><span class="doc">Crafting overview</span></a></p></li>
<li><p><a class="reference external" href="../api/evennia.contrib.crafting.crafting.html">Crafting API documentation</a></p></li>
<li><p><a class="reference external" href="../api/evennia.contrib.crafting.example_recipes.html">Example of a sword crafting tree</a></p></li>
</ul>
</section>
<section id="dice">
<h3>Dice<a class="headerlink" href="#dice" title="Permalink to this headline"></a></h3>
<p><em>Griatch 2012</em></p>
<p>A fully featured dice rolling system.</p>
</section>
<section id="mail">
<h3>Mail<a class="headerlink" href="#mail" title="Permalink to this headline"></a></h3>
<p><em>grungies1138 2016</em></p>
<p>An in-game mail system for communication.</p>
</section>
<section id="puzzles">
<h3>Puzzles<a class="headerlink" href="#puzzles" title="Permalink to this headline"></a></h3>
<p><em>Hendher 2019</em></p>
<p>Combine objects to create new items, adventure-game style</p>
</section>
<section id="rp-system">
<h3>RP System<a class="headerlink" href="#rp-system" title="Permalink to this headline"></a></h3>
<p><em>Griatch 2015</em></p>
<p>Full director-style emoting system replacing names with sdescs/recogs. Supports wearing masks.</p>
</section>
<section id="rp-language">
<h3>RP Language<a class="headerlink" href="#rp-language" title="Permalink to this headline"></a></h3>
<p><em>Griatch 2015</em></p>
<p>Dynamic obfuscation of emotes when speaking unfamiliar languages. Also obfuscates whispers.</p>
</section>
<section id="turnbattle">
<h3>Turnbattle<a class="headerlink" href="#turnbattle" title="Permalink to this headline"></a></h3>
<p><em>FlutterSprite 2017</em></p>
<p>A turn-based combat engine meant as a start to build from. Has attack/disengage and turn timeouts,
and includes optional expansions for equipment and combat movement, magic and ranged combat.</p>
</section>
</section>
<hr class="docutils" />
<section id="building-and-server-systems">
<h2>Building and server systems<a class="headerlink" href="#building-and-server-systems" title="Permalink to this headline"></a></h2>
<section id="building-menu">
<h3>Building menu<a class="headerlink" href="#building-menu" title="Permalink to this headline"></a></h3>
<p><em>vincent-lg 2018</em></p>
<p>An <code class="docutils literal notranslate"><span class="pre">&#64;edit</span></code> command for modifying objects using a generated menu. Customizable for different games.</p>
</section>
<section id="field-fill">
<h3>Field Fill<a class="headerlink" href="#field-fill" title="Permalink to this headline"></a></h3>
<p><em>FlutterSprite 2018</em></p>
<p>A simple system for creating an EvMenu that presents a player with a highly customizable fillable form</p>
</section>
<section id="in-game-python">
<h3>In-Game-Python<a class="headerlink" href="#in-game-python" title="Permalink to this headline"></a></h3>
<p><em>Vincent Le Geoff 2017</em></p>
<p>Allow Builders to add Python-scripted events to their objects (OBS-not for untrusted users!)</p>
<ul class="simple">
<li><p><a class="reference internal" href="A-voice-operated-elevator-using-events.html"><span class="doc">A voice-operated elevator using events</span></a></p></li>
<li><p><a class="reference internal" href="Dialogues-in-events.html"><span class="doc">Dialogues using events</span></a></p></li>
</ul>
</section>
<section id="menu-builder">
<h3>Menu-builder<a class="headerlink" href="#menu-builder" title="Permalink to this headline"></a></h3>
<p>A tool for building using an in-game menu instead of the normal build commands. Meant to
be expanded for the needs of your game.</p>
<ul class="simple">
<li><p><a class="reference internal" href="Building-menus.html"><span class="doc">Building Menus</span></a></p></li>
</ul>
</section>
<section id="security-auditing">
<h3>Security/Auditing<a class="headerlink" href="#security-auditing" title="Permalink to this headline"></a></h3>
<p><em>Johhny 2018</em></p>
<p>Log server input/output for debug/security.</p>
</section>
<section id="tree-select">
<h3>Tree Select<a class="headerlink" href="#tree-select" title="Permalink to this headline"></a></h3>
<p><em>FlutterSprite 2017</em></p>
<p>A simple system for creating a branching EvMenu with selection options sourced from a single
multi-line string.</p>
</section>
</section>
<hr class="docutils" />
<section id="snippets-and-config">
<h2>Snippets and config<a class="headerlink" href="#snippets-and-config" title="Permalink to this headline"></a></h2>
<p>Contribs meant to be used as part of other code, or as replacements for default settings.</p>
<section id="color-markups">
<h3>Color-markups<a class="headerlink" href="#color-markups" title="Permalink to this headline"></a></h3>
<p><em>Griatch, 2017</em></p>
<p>Alternative in-game color markups.</p>
</section>
<section id="custom-gametime">
<h3>Custom gametime<a class="headerlink" href="#custom-gametime" title="Permalink to this headline"></a></h3>
<p><em>Griatch, vlgeoff 2017</em></p>
<p>Implements Evennias gametime module but for custom game world-specific calendars.</p>
</section>
<section id="logins">
<h3>Logins<a class="headerlink" href="#logins" title="Permalink to this headline"></a></h3>
<section id="email-login">
<h4>Email login<a class="headerlink" href="#email-login" title="Permalink to this headline"></a></h4>
<p><em>Griatch 2012</em></p>
<p>A variant of the standard login system that requires an email to login rather then just name+password.</p>
</section>
<section id="menu-login">
<h4>Menu login<a class="headerlink" href="#menu-login" title="Permalink to this headline"></a></h4>
<p><em>Griatch 2011, 2019, Vincent-lg 2016</em></p>
<p>A login system using menus asking for name/password rather than giving them as one command.</p>
</section>
</section>
<section id="random-string-generator">
<h3>Random String Generator<a class="headerlink" href="#random-string-generator" title="Permalink to this headline"></a></h3>
<p><em>Vincent Le Goff 2017</em></p>
<p>Simple pseudo-random generator of strings with rules, avoiding repetitions.</p>
</section>
<section id="unixcommand">
<h3>UnixCommand<a class="headerlink" href="#unixcommand" title="Permalink to this headline"></a></h3>
<p><em>Vincent Le Geoff 2017</em></p>
<p>Add commands with UNIX-style syntax.</p>
</section>
</section>
<hr class="docutils" />
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<p>Contribs not meant to be used as-is, but just as examples to learn from.</p>
<section id="gendersub">
<h3>GenderSub<a class="headerlink" href="#gendersub" title="Permalink to this headline"></a></h3>
<p><em>Griatch 2015</em></p>
<p>Simple example (only) of storing gender on a character and access it in an emote with a custom marker.</p>
</section>
<section id="talking-npc">
<h3>Talking NPC<a class="headerlink" href="#talking-npc" title="Permalink to this headline"></a></h3>
<p><em>Griatch 2011</em></p>
<p>A talking NPC object that offers a menu-driven conversation tree.</p>
</section>
<section id="tutorial-examples">
<h3>Tutorial examples<a class="headerlink" href="#tutorial-examples" title="Permalink to this headline"></a></h3>
<p><em>Griatch 2011, 2015</em></p>
<p>A folder of basic example objects, commands and scripts.</p>
</section>
<section id="the-tutorial-world">
<h3>The tutorial-world<a class="headerlink" href="#the-tutorial-world" title="Permalink to this headline"></a></h3>
<p><em>Griatch 2011, 2015</em></p>
<p>The Evennia single-player sole quest. Made to be analyzed to learn.</p>
<ul class="simple">
<li><p><a class="reference internal" href="../Howto/Starting/Part1/Tutorial-World-Introduction.html"><span class="doc">The tutorial world introduction</span></a></p></li>
</ul>
</section>
</section>
<hr class="docutils" />
<section id="full-game-systems">
<h2>Full game systems<a class="headerlink" href="#full-game-systems" title="Permalink to this headline"></a></h2>
<p>Full game-dir replacement systems.</p>
<section id="ainneve">
<h3>Ainneve<a class="headerlink" href="#ainneve" title="Permalink to this headline"></a></h3>
<p><em>Evennia community 2015-?</em></p>
<p>This is a community attempt to make an Evennia example game using good practices. It is also a good
place to jump in if you want to help in another project rather than run it alone. Development of this
has stalled a bit so we are looking for enthusiastic people to lead the charge.</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/evennia/ainneve">evennia/ainneve repository</a></p></li>
<li><p><a class="reference external" href="https://groups.google.com/g/evennia/c/48PMDirb7go/m/Z9EAuvXZn7UJ">Original discussion thread</a> (external link)</p></li>
</ul>
</section>
<section id="arxcode">
<h3>Arxcode<a class="headerlink" href="#arxcode" title="Permalink to this headline"></a></h3>
<p><em>Tehom 2019</em></p>
<p>Open source code release of the popular Evennia-based <a class="reference external" href="https://play.arxgame.org/">Arx, after the reckoning</a>.
This is a fantasy game with a focus on roleplay and code-supported political intrigue. This code-release
is maintained by Tehom in its own repository so bug reports should be directed there.</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/Arx-Game/arxcode">Arxcode repository on github</a></p></li>
<li><p><a class="reference external" href="https://github.com/Arx-Game/arxcode/issues">Arxcode issue tracker</a></p></li>
<li><p><a class="reference internal" href="Arxcode-installing-help.html"><span class="doc">Arxcode installation help</span></a> - this may not always be fully up-to-date with
latest Evennia. Report your findings!</p></li>
</ul>
</section>
<section id="evscaperoom">
<h3>Evscaperoom<a class="headerlink" href="#evscaperoom" title="Permalink to this headline"></a></h3>
<p><em>Griatch 2019</em></p>
<p>A full engine for making multiplayer escape-rooms completely in code.
This is based on the 2019 MUD Game jam winner <em>Evscaperoom</em>.</p>
<ul class="simple">
<li><p><a class="reference external" href="../api/evennia.contrib.evscaperoom.html">contrib/evscaperoom</a> - game engine to make your own escape rooms.</p></li>
<li><p><a class="reference external" href="https://demo.evennia.com">https://demo.evennia.com</a> - a full installation of the original game can
be played by entering the <em>evscaperoom</em> exit in the first Limbo room.</p></li>
<li><p>https://github.com/Griatch/evscaperoom - the original games source code (warning for spoilers if you
want to solve the puzzles and mystery yourself).</p></li>
</ul>
<div class="toctree-wrapper compound">
</div>
</section>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<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>
<p><h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Contrib modules</a><ul>
<li><a class="reference internal" href="#character-related">Character-related</a><ul>
<li><a class="reference internal" href="#chargen">CharGen</a></li>
<li><a class="reference internal" href="#clothing">Clothing</a></li>
<li><a class="reference internal" href="#health-bar">Health Bar</a></li>
<li><a class="reference internal" href="#multidescer">Multidescer</a></li>
</ul>
</li>
<li><a class="reference internal" href="#rooms-movement-and-grid">Rooms, movement and grid</a><ul>
<li><a class="reference internal" href="#xyzgrid">XYZGrid</a></li>
<li><a class="reference internal" href="#extended-room">Extended Room</a></li>
<li><a class="reference internal" href="#map-builder">Map Builder</a></li>
<li><a class="reference internal" href="#simple-door">Simple Door</a></li>
<li><a class="reference internal" href="#slow-exit">Slow exit</a></li>
<li><a class="reference internal" href="#wilderness">Wilderness</a></li>
</ul>
</li>
<li><a class="reference internal" href="#roleplaying-and-rules">Roleplaying and rules</a><ul>
<li><a class="reference internal" href="#barter-system">Barter system</a></li>
<li><a class="reference internal" href="#crafting">Crafting</a></li>
<li><a class="reference internal" href="#dice">Dice</a></li>
<li><a class="reference internal" href="#mail">Mail</a></li>
<li><a class="reference internal" href="#puzzles">Puzzles</a></li>
<li><a class="reference internal" href="#rp-system">RP System</a></li>
<li><a class="reference internal" href="#rp-language">RP Language</a></li>
<li><a class="reference internal" href="#turnbattle">Turnbattle</a></li>
</ul>
</li>
<li><a class="reference internal" href="#building-and-server-systems">Building and server systems</a><ul>
<li><a class="reference internal" href="#building-menu">Building menu</a></li>
<li><a class="reference internal" href="#field-fill">Field Fill</a></li>
<li><a class="reference internal" href="#in-game-python">In-Game-Python</a></li>
<li><a class="reference internal" href="#menu-builder">Menu-builder</a></li>
<li><a class="reference internal" href="#security-auditing">Security/Auditing</a></li>
<li><a class="reference internal" href="#tree-select">Tree Select</a></li>
</ul>
</li>
<li><a class="reference internal" href="#snippets-and-config">Snippets and config</a><ul>
<li><a class="reference internal" href="#color-markups">Color-markups</a></li>
<li><a class="reference internal" href="#custom-gametime">Custom gametime</a></li>
<li><a class="reference internal" href="#logins">Logins</a><ul>
<li><a class="reference internal" href="#email-login">Email login</a></li>
<li><a class="reference internal" href="#menu-login">Menu login</a></li>
</ul>
</li>
<li><a class="reference internal" href="#random-string-generator">Random String Generator</a></li>
<li><a class="reference internal" href="#unixcommand">UnixCommand</a></li>
</ul>
</li>
<li><a class="reference internal" href="#examples">Examples</a><ul>
<li><a class="reference internal" href="#gendersub">GenderSub</a></li>
<li><a class="reference internal" href="#talking-npc">Talking NPC</a></li>
<li><a class="reference internal" href="#tutorial-examples">Tutorial examples</a></li>
<li><a class="reference internal" href="#the-tutorial-world">The tutorial-world</a></li>
</ul>
</li>
<li><a class="reference internal" href="#full-game-systems">Full game systems</a><ul>
<li><a class="reference internal" href="#ainneve">Ainneve</a></li>
<li><a class="reference internal" href="#arxcode">Arxcode</a></li>
<li><a class="reference internal" href="#evscaperoom">Evscaperoom</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="../Coding/Coding-Overview.html"
title="previous chapter">Coding and development help</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="Crafting.html"
title="next chapter">Crafting system contrib</a></p>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/Contribs/Contrib-Overview.md.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</div><h3>Links</h3>
<ul>
<li><a href="https://www.evennia.com">Home page</a> </li>
<li><a href="https://github.com/evennia/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/">Dev blog</a>
</li>
</ul>
<h3>Versions</h3>
<ul>
<li><a href="Contrib-Overview.html">1.0-dev (develop branch)</a></li>
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
</ul>
</div>
</div>
<div class="clearer"></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="Crafting.html" title="Crafting system contrib"
>next</a> |</li>
<li class="right" >
<a href="../Coding/Coding-Overview.html" title="Coding and development help"
>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-this"><a href="">Contrib modules</a></li>
</ul>
<div class="develop">develop branch</div>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2020, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>