Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-16 21:06:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/6.x/Contribs/Contrib-Gendersub.html
Griatch 9e122e89ca Update with 6.x branch docs
2026-02-15 19:06:04 +01:00

243 lines
No EOL
12 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en" data-content_root="../">
<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" />
<title>Gendersub &#8212; Evennia latest documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d75fae25" />
<link rel="stylesheet" type="text/css" href="../_static/nature.css?v=279e0f84" />
<link rel="stylesheet" type="text/css" href="../_static/custom.css?v=e4a91a55" />
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="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="In-Game Mail system" href="Contrib-Mail.html" />
<link rel="prev" title="Crafting system" href="Contrib-Crafting.html" />
</head><body>
<div class="related" role="navigation" aria-label="Related">
<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="Contrib-Mail.html" title="In-Game Mail system"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="Contrib-Crafting.html" title="Crafting system"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="Contribs-Overview.html" accesskey="U">Contribs</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Gendersub</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section class="tex2jax_ignore mathjax_ignore" id="gendersub">
<h1>Gendersub<a class="headerlink" href="#gendersub" title="Link to this heading"></a></h1>
<p>Contribution by Griatch 2015</p>
<p>This is a simple gender-aware Character class for allowing users to
insert custom markers in their text to indicate gender-aware
messaging. It relies on a modified msg() and is meant as an
inspiration and starting point to how to do stuff like this.</p>
<p>An object can have the following genders:</p>
<ul class="simple">
<li><p>male (he/his)</p></li>
<li><p>female (her/hers)</p></li>
<li><p>neutral (it/its)</p></li>
<li><p>ambiguous (they/them/their/theirs)</p></li>
</ul>
<section id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Link to this heading"></a></h2>
<p>Import and add the <code class="docutils literal notranslate"><span class="pre">SetGender</span></code> command to your default cmdset in
<code class="docutils literal notranslate"><span class="pre">mygame/commands/default_cmdset.py</span></code>:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># mygame/commands/default_cmdsets.py</span>
<span class="c1"># ...</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">evennia.contrib.game_systems.gendersub</span><span class="w"> </span><span class="kn">import</span> <span class="n">SetGender</span> <span class="c1"># &lt;---</span>
<span class="c1"># ...</span>
<span class="k">class</span><span class="w"> </span><span class="nc">CharacterCmdSet</span><span class="p">(</span><span class="n">default_cmds</span><span class="o">.</span><span class="n">CharacterCmdSet</span><span class="p">):</span>
<span class="c1"># ...</span>
<span class="k">def</span><span class="w"> </span><span class="nf">at_cmdset_creation</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># ...</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">SetGender</span><span class="p">())</span> <span class="c1"># &lt;---</span>
</pre></div>
</div>
<p>Make your <code class="docutils literal notranslate"><span class="pre">Character</span></code> inherit from <code class="docutils literal notranslate"><span class="pre">GenderCharacter</span></code>.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># mygame/typeclasses/characters.py</span>
<span class="c1"># ...</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">evennia.contrib.game_systems.gendersub</span><span class="w"> </span><span class="kn">import</span> <span class="n">GenderCharacter</span> <span class="c1"># &lt;---</span>
<span class="k">class</span><span class="w"> </span><span class="nc">Character</span><span class="p">(</span><span class="n">GenderCharacter</span><span class="p">):</span> <span class="c1"># &lt;---</span>
<span class="c1"># ...</span>
</pre></div>
</div>
<p>Reload the server (<code class="docutils literal notranslate"><span class="pre">evennia</span> <span class="pre">reload</span></code> or <code class="docutils literal notranslate"><span class="pre">reload</span></code> from inside the game).</p>
</section>
<section id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Link to this heading"></a></h2>
<p>When in use, messages can contain special tags to indicate pronouns gendered
based on the one being addressed. Capitalization will be retained.</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">|s</span></code>, <code class="docutils literal notranslate"><span class="pre">|S</span></code>: Subjective form: he, she, it, He, She, It, They</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">|o</span></code>, <code class="docutils literal notranslate"><span class="pre">|O</span></code>: Objective form: him, her, it, Him, Her, It, Them</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">|p</span></code>, <code class="docutils literal notranslate"><span class="pre">|P</span></code>: Possessive form: his, her, its, His, Her, Its, Their</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">|a</span></code>, <code class="docutils literal notranslate"><span class="pre">|A</span></code>: Absolute Possessive form: his, hers, its, His, Hers, Its, Theirs</p></li>
</ul>
<p>For example,</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">char</span><span class="o">.</span><span class="n">msg</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2"> falls on |p face with a thud.&quot;</span> <span class="o">%</span> <span class="n">char</span><span class="o">.</span><span class="n">key</span><span class="p">)</span>
<span class="s2">&quot;Tom falls on his face with a thud&quot;</span>
</pre></div>
</div>
<p>The default gender is “ambiguous” (they/them/their/theirs).</p>
<p>To use, have DefaultCharacter inherit from this, or change
setting.DEFAULT_CHARACTER to point to this class.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">gender</span></code> command is used to set the gender. It needs to be added to the
default cmdset before it becomes available.</p>
<hr class="docutils" />
<p><small>This document page is generated from <code class="docutils literal notranslate"><span class="pre">evennia/contrib/game_systems/gendersub/README.md</span></code>. Changes to this
file will be overwritten, so edit that file rather than this one.</small></p>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/evennia_logo.png" alt="Logo of Evennia"/>
</a></p>
<search 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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Gendersub</a><ul>
<li><a class="reference internal" href="#installation">Installation</a></li>
<li><a class="reference internal" href="#usage">Usage</a></li>
</ul>
</li>
</ul>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="Contrib-Crafting.html"
title="previous chapter">Crafting system</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="Contrib-Mail.html"
title="next chapter">In-Game Mail system</a></p>
</div>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/Contribs/Contrib-Gendersub.md.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</div><h3>Links</h3>
<ul>
<li><a href="https://www.evennia.com/docs/latest/index.html">Documentation Top</a> </li>
<li><a href="https://www.evennia.com">Evennia Home</a> </li>
<li><a href="https://github.com/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/">Blog</a>
</li>
</ul>
<h3>Doc Versions</h3>
<ul>
<li>
<a href="https://www.evennia.com/docs/latest/index.html">latest (main branch)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/6.x/index.html">v6.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/5.x/index.html">v5.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/4.x/index.html">v4.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/3.x/index.html">v3.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/2.x/index.html">v2.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/1.x/index.html">v1.0.0 branch (outdated)</a>
</li>
<li>
<a href="https://www.evennia.com/docs/0.x/index.html">v0.9.5 branch (outdated)</a>
</li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="Related">
<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="Contrib-Mail.html" title="In-Game Mail system"
>next</a> |</li>
<li class="right" >
<a href="Contrib-Crafting.html" title="Crafting system"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="Contribs-Overview.html" >Contribs</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Gendersub</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2024, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink