2022-11-14 22:43:45 +01:00
<!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/" / >
2023-10-19 20:22:27 +00:00
< title > Legacy Comms-commands — Evennia 2.x documentation< / title >
2022-11-14 22:43:45 +01:00
< 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 = "Unix-like Command style" href = "Contrib-Unixcommand.html" / >
< link rel = "prev" title = "Menu-based login system" href = "Contrib-Menu-Login.html" / >
< / head > < body >
2023-10-19 20:22:27 +00:00
2022-11-14 22:43:45 +01:00
< 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 = "Contrib-Unixcommand.html" title = "Unix-like Command style"
accesskey="N">next< / a > |< / li >
< li class = "right" >
< a href = "Contrib-Menu-Login.html" title = "Menu-based login system"
accesskey="P">previous< / a > |< / li >
2023-10-19 20:22:27 +00:00
< li class = "nav-item nav-item-0" > < a href = "../index.html" > Evennia 2.x< / a > » < / li >
2022-11-14 22:43:45 +01:00
< li class = "nav-item nav-item-1" > < a href = "Contribs-Overview.html" accesskey = "U" > Contribs< / a > » < / li >
< li class = "nav-item nav-item-this" > < a href = "" > Legacy Comms-commands< / a > < / li >
< / ul >
2023-06-10 08:53:19 +00:00
< / div >
2022-11-14 22:43:45 +01:00
< div class = "document" >
< div class = "documentwrapper" >
< 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 >
< h3 > < a href = "../index.html" > Table of Contents< / a > < / h3 >
< ul >
< li > < a class = "reference internal" href = "#" > Legacy Comms-commands< / a > < ul >
< li > < a class = "reference internal" href = "#installation" > Installation< / a > < / li >
< / ul >
< / li >
< / ul >
< h4 > Previous topic< / h4 >
< p class = "topless" > < a href = "Contrib-Menu-Login.html"
title="previous chapter">Menu-based login system< / a > < / p >
< h4 > Next topic< / h4 >
< p class = "topless" > < a href = "Contrib-Unixcommand.html"
title="next chapter">Unix-like Command style< / a > < / p >
< div role = "note" aria-label = "source link" >
<!-- h3>This Page</h3 -->
< ul class = "this-page-menu" >
< li > < a href = "../_sources/Contribs/Contrib-Mux-Comms-Cmds.md.txt"
rel="nofollow">Show Page Source< / a > < / li >
< / ul >
< / div > < h3 > Links< / h3 >
< ul >
2023-10-19 20:22:27 +00:00
< 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 >
2022-11-14 22:43:45 +01:00
< 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 >
2023-10-19 20:22:27 +00:00
< h3 > Doc Versions< / h3 >
2022-11-14 22:43:45 +01:00
< ul >
2023-10-19 20:22:27 +00:00
< li > < a href = "Contrib-Mux-Comms-Cmds.html" > 2.x (main branch)< / a > < / li >
2022-11-15 20:29:38 +00:00
< ul >
2023-10-19 20:22:27 +00:00
< li > < a href = "../1.3.0/index.html" > 1.3.0 (v1.3.0 branch)< / a > < / li >
< li > < a href = "../0.9.5/index.html" > 0.9.5 (v0.9.5 branch)< / a > < / li >
2022-11-15 20:29:38 +00:00
2022-11-14 22:43:45 +01:00
< / ul >
< / div >
< / div >
< div class = "bodywrapper" >
< div class = "body" role = "main" >
< section class = "tex2jax_ignore mathjax_ignore" id = "legacy-comms-commands" >
< h1 > Legacy Comms-commands< a class = "headerlink" href = "#legacy-comms-commands" title = "Permalink to this headline" > ¶< / a > < / h1 >
< p > Contribution by Griatch 2021< / p >
< p > In Evennia 1.0+, the old Channel commands (originally inspired by MUX) were
replaced by the single < code class = "docutils literal notranslate" > < span class = "pre" > channel< / span > < / code > command that performs all these functions.
This contrib (extracted from Evennia 0.9.5) breaks out the functionality into
separate Commands more familiar to MU* users. This is just for show though, the
main < code class = "docutils literal notranslate" > < span class = "pre" > channel< / span > < / code > command is still called under the hood.< / p >
< table class = "colwidths-auto docutils align-default" >
< thead >
< tr class = "row-odd" > < th class = "head" > < p > Contrib syntax< / p > < / th >
< th class = "head" > < p > Default < code class = "docutils literal notranslate" > < span class = "pre" > channel< / span > < / code > syntax< / p > < / th >
< / tr >
< / thead >
< tbody >
< tr class = "row-even" > < td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > allcom< / span > < / code > < / p > < / td >
< td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > channel/all< / span > < / code > and < code class = "docutils literal notranslate" > < span class = "pre" > channel< / span > < / code > < / p > < / td >
< / tr >
< tr class = "row-odd" > < td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > addcom< / span > < / code > < / p > < / td >
< td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > channel/alias< / span > < / code > , < code class = "docutils literal notranslate" > < span class = "pre" > channel/sub< / span > < / code > and < code class = "docutils literal notranslate" > < span class = "pre" > channel/unmute< / span > < / code > < / p > < / td >
< / tr >
< tr class = "row-even" > < td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > delcom< / span > < / code > < / p > < / td >
< td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > channel/unalias< / span > < / code > , < code class = "docutils literal notranslate" > < span class = "pre" > alias/unsub< / span > < / code > and < code class = "docutils literal notranslate" > < span class = "pre" > channel/mute< / span > < / code > < / p > < / td >
< / tr >
< tr class = "row-odd" > < td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > cboot< / span > < / code > < / p > < / td >
< td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > channel/boot< / span > < / code > (< code class = "docutils literal notranslate" > < span class = "pre" > channel/ban< / span > < / code > and < code class = "docutils literal notranslate" > < span class = "pre" > /unban< / span > < / code > not supported)< / p > < / td >
< / tr >
< tr class = "row-even" > < td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > cwho< / span > < / code > < / p > < / td >
< td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > channel/who< / span > < / code > < / p > < / td >
< / tr >
< tr class = "row-odd" > < td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > ccreate< / span > < / code > < / p > < / td >
< td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > channel/create< / span > < / code > < / p > < / td >
< / tr >
< tr class = "row-even" > < td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > cdestroy< / span > < / code > < / p > < / td >
< td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > channel/destroy< / span > < / code > < / p > < / td >
< / tr >
< tr class = "row-odd" > < td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > clock< / span > < / code > < / p > < / td >
< td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > channel/lock< / span > < / code > < / p > < / td >
< / tr >
< tr class = "row-even" > < td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > cdesc< / span > < / code > < / p > < / td >
< td > < p > < code class = "docutils literal notranslate" > < span class = "pre" > channel/desc< / span > < / code > < / p > < / td >
< / tr >
< / tbody >
< / table >
< section id = "installation" >
< h2 > Installation< a class = "headerlink" href = "#installation" title = "Permalink to this headline" > ¶< / a > < / h2 >
< ul class = "simple" >
< li > < p > Import the < code class = "docutils literal notranslate" > < span class = "pre" > CmdSetLegacyComms< / span > < / code > cmdset from this module into < code class = "docutils literal notranslate" > < span class = "pre" > mygame/commands/default_cmdsets.py< / span > < / code > < / p > < / li >
< li > < p > Add it to the CharacterCmdSet’ < code class = "docutils literal notranslate" > < span class = "pre" > at_cmdset_creation< / span > < / code > method (see below).< / p > < / li >
< li > < p > Reload the server.< / p > < / li >
< / ul >
< div class = "highlight-python notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "c1" > # in mygame/commands/default_cmdsets.py< / span >
< span class = "c1" > # ..< / span >
< span class = "kn" > from< / span > < span class = "nn" > evennia.contrib.base_systems.mux_comms_cmds< / span > < span class = "kn" > import< / span > < span class = "n" > CmdSetLegacyComms< / span > < span class = "c1" > # < ----< / span >
< span class = "k" > class< / 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 = "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" > CmdSetLegacyComms< / span > < span class = "p" > )< / span > < span class = "c1" > # < ----< / span >
< / pre > < / div >
< / div >
< p > Note that you will still be able to use the < code class = "docutils literal notranslate" > < span class = "pre" > channel< / span > < / code > command; this is actually
still used under the hood by these commands.< / p >
< hr class = "docutils" / >
< p > < small > This document page is generated from < code class = "docutils literal notranslate" > < span class = "pre" > evennia/contrib/base_systems/mux_comms_cmds/README.md< / span > < / code > . Changes to this
file will be overwritten, so edit that file rather than this one.< / small > < / p >
< / section >
< / section >
< / div >
< / div >
< / 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 = "Contrib-Unixcommand.html" title = "Unix-like Command style"
>next< / a > |< / li >
< li class = "right" >
< a href = "Contrib-Menu-Login.html" title = "Menu-based login system"
>previous< / a > |< / li >
2023-10-19 20:22:27 +00:00
< li class = "nav-item nav-item-0" > < a href = "../index.html" > Evennia 2.x< / a > » < / li >
2022-11-14 22:43:45 +01:00
< li class = "nav-item nav-item-1" > < a href = "Contribs-Overview.html" > Contribs< / a > » < / li >
< li class = "nav-item nav-item-this" > < a href = "" > Legacy Comms-commands< / a > < / li >
< / ul >
< / div >
2023-10-19 20:22:27 +00:00
2022-11-14 22:43:45 +01:00
< div class = "footer" role = "contentinfo" >
2023-10-19 20:22:27 +00:00
© Copyright 2023, The Evennia developer community.
2022-11-14 22:43:45 +01:00
Created using < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > 3.2.1.
< / div >
< / body >
< / html >
