<p>The auto-help system uses the <codeclass="docutils literal notranslate"><spanclass="pre">__doc__</span></code> strings of your command classes and formats this to a nice-
looking help entry. This makes for a very easy way to keep the help updated - just document your
commands well and updating the help file is just a <codeclass="docutils literal notranslate"><spanclass="pre">@reload</span></code> away. There is no need to manually
create and maintain help database entries for commands; as long as you keep the docstrings updated
your help will be dynamically updated for you as well.</p>
<p>The text at the very top of the command class definition is the class’<codeclass="docutils literal notranslate"><spanclass="pre">__doc__</span></code>-string and will be
shown to users looking for help. Try to use a consistent format - all default commands are using the
structure shown above.</p>
<p>You should also supply the <codeclass="docutils literal notranslate"><spanclass="pre">help_category</span></code> class property if you can; this helps to group help
entries together for people to more easily find them. See the <codeclass="docutils literal notranslate"><spanclass="pre">help</span></code> command in-game to see the
default categories. If you don’t specify the category, “General” is assumed.</p>
<p>If you don’t want your command to be picked up by the auto-help system at all (like if you want to
write its docs manually using the info in the next section or you use a <aclass="reference internal"href="Command-Sets.html"><spanclass="doc">cmdset</span></a> that
has its own help functionality) you can explicitly set <codeclass="docutils literal notranslate"><spanclass="pre">auto_help</span></code> class property to <codeclass="docutils literal notranslate"><spanclass="pre">False</span></code> in your
command definition.</p>
<p>Alternatively, you can keep the advantages of <em>auto-help</em> in commands, but control the display of
command helps. You can do so by overriding the command’s <codeclass="docutils literal notranslate"><spanclass="pre">get_help()</span></code> method. By default, this
method will return the class docstring. You could modify it to add custom behavior: the text
returned by this method will be displayed to the character asking for help in this command.</p>
<p>These are all help entries not involving commands (this is handled automatically by the <aclass="reference external"href="Help-System.html#command-auto-help-system">Command
Auto-help system</a>). Non-automatic help entries describe how
your particular game is played - its rules, world descriptions and so on.</p>
<li><p>locks - a <aclass="reference internal"href="Locks.html"><spanclass="doc">lock definition</span></a>. This can be used to limit access to this help entry, maybe
because it’s staff-only or otherwise meant to be restricted. Help commands check for <codeclass="docutils literal notranslate"><spanclass="pre">access_type</span></code>s
<codeclass="docutils literal notranslate"><spanclass="pre">view</span></code> and <codeclass="docutils literal notranslate"><spanclass="pre">edit</span></code>. An example of a lock string would be <codeclass="docutils literal notranslate"><spanclass="pre">view:perm(Builders)</span></code>.</p></li>
<p>You can create new help entries in code by using <codeclass="docutils literal notranslate"><spanclass="pre">evennia.create_help_entry()</span></code>.</p>
<p>From inside the game those with the right permissions can use the <codeclass="docutils literal notranslate"><spanclass="pre">@sethelp</span></code> command to add and
<p>Using <codeclass="docutils literal notranslate"><spanclass="pre">@sethelp</span></code> you can add, delete and append text to existing entries. By default new entries
will go in the <em>General</em> help category. You can change this using a different form of the <codeclass="docutils literal notranslate"><spanclass="pre">@sethelp</span></code>
<p>If the category <em>Roleplaying</em> did not already exist, it is created and will appear in the help
index.</p>
<p>You can, finally, define a lock for the help entry by following the category with a <aclass="reference internal"href="Locks.html"><spanclass="doc">lock
