mirror of
https://github.com/evennia/evennia.git
synced 2026-03-30 20:47:17 +02:00
Updated HTML docs
This commit is contained in:
Griatch
parent
58f5ece91b
commit
1bbc93507a
1000 changed files with 39106 additions and 33861 deletions
|
|
@ -4,7 +4,8 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<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 — 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" />
|
||||
|
|
@ -45,82 +46,82 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="contrib-modules">
|
||||
<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>
|
||||
<div class="section" id="character-related">
|
||||
<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>
|
||||
<div class="section" id="chargen">
|
||||
<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>
|
||||
</div>
|
||||
<div class="section" id="clothing">
|
||||
</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>
|
||||
</div>
|
||||
<div class="section" id="health-bar">
|
||||
</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>
|
||||
</div>
|
||||
<div class="section" id="multidescer">
|
||||
</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>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="rooms-movement-and-grid">
|
||||
<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>
|
||||
<div class="section" id="extended-room">
|
||||
<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>
|
||||
</div>
|
||||
<div class="section" id="map-builder">
|
||||
</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>
|
||||
</div>
|
||||
<div class="section" id="simple-door">
|
||||
</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>
|
||||
</div>
|
||||
<div class="section" id="slow-exit">
|
||||
</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>
|
||||
</div>
|
||||
<div class="section" id="wilderness">
|
||||
</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>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="roleplaying-and-rules">
|
||||
<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>
|
||||
<div class="section" id="barter-system">
|
||||
<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>
|
||||
</div>
|
||||
<div class="section" id="crafting">
|
||||
</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>
|
||||
|
|
@ -129,53 +130,53 @@ Bugs are reported to the Evennia <a class="reference external" href="https://git
|
|||
<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>
|
||||
</div>
|
||||
<div class="section" id="dice">
|
||||
</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>
|
||||
</div>
|
||||
<div class="section" id="mail">
|
||||
</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>
|
||||
</div>
|
||||
<div class="section" id="puzzles">
|
||||
</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>
|
||||
</div>
|
||||
<div class="section" id="rp-system">
|
||||
</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>
|
||||
</div>
|
||||
<div class="section" id="rp-language">
|
||||
</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>
|
||||
</div>
|
||||
<div class="section" id="turnbattle">
|
||||
</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>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="building-and-server-systems">
|
||||
<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>
|
||||
<div class="section" id="building-menu">
|
||||
<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">@edit</span></code> command for modifying objects using a generated menu. Customizable for different games.</p>
|
||||
</div>
|
||||
<div class="section" id="field-fill">
|
||||
</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>
|
||||
</div>
|
||||
<div class="section" id="in-game-python">
|
||||
</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>
|
||||
|
|
@ -183,98 +184,98 @@ and includes optional expansions for equipment and combat movement, magic and ra
|
|||
<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>
|
||||
</div>
|
||||
<div class="section" id="menu-builder">
|
||||
</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>
|
||||
</div>
|
||||
<div class="section" id="security-auditing">
|
||||
</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>
|
||||
</div>
|
||||
<div class="section" id="tree-select">
|
||||
</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>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="snippets-and-config">
|
||||
<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>
|
||||
<div class="section" id="color-markups">
|
||||
<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>
|
||||
</div>
|
||||
<div class="section" id="custom-gametime">
|
||||
</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 Evennia’s gametime module but for custom game world-specific calendars.</p>
|
||||
</div>
|
||||
<div class="section" id="logins">
|
||||
</section>
|
||||
<section id="logins">
|
||||
<h3>Logins<a class="headerlink" href="#logins" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="section" id="email-login">
|
||||
<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>
|
||||
</div>
|
||||
<div class="section" id="menu-login">
|
||||
</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>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="random-string-generator">
|
||||
</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>
|
||||
</div>
|
||||
<div class="section" id="unixcommand">
|
||||
</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>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="examples">
|
||||
<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>
|
||||
<div class="section" id="gendersub">
|
||||
<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>
|
||||
</div>
|
||||
<div class="section" id="talking-npc">
|
||||
</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>
|
||||
</div>
|
||||
<div class="section" id="tutorial-examples">
|
||||
</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>
|
||||
</div>
|
||||
<div class="section" id="the-tutorial-world">
|
||||
</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>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<hr class="docutils" />
|
||||
<div class="section" id="full-game-systems">
|
||||
<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>
|
||||
<div class="section" id="ainneve">
|
||||
<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
|
||||
|
|
@ -284,8 +285,8 @@ has stalled a bit so we are looking for enthusiastic people to lead the charge.<
|
|||
<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>
|
||||
</div>
|
||||
<div class="section" id="arxcode">
|
||||
</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>.
|
||||
|
|
@ -297,8 +298,8 @@ is maintained by Tehom in its own repository so bug reports should be directed t
|
|||
<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>
|
||||
</div>
|
||||
<div class="section" id="evscaperoom">
|
||||
</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.
|
||||
|
|
@ -312,9 +313,9 @@ want to solve the puzzles and mystery yourself).</p></li>
|
|||
</ul>
|
||||
<div class="toctree-wrapper compound">
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue