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/source/Contribs/Contrib-Mux-Comms-Cmds.md
Griatch a452434ba8 Revert "Updated HTML docs." 
This reverts commit 06bc3c8bcd.
2022-11-15 20:46:50 +01:00

2.1 KiB
Raw Blame History

Legacy Comms-commands

Contribution by Griatch 2021

In Evennia 1.0+, the old Channel commands (originally inspired by MUX) were replaced by the single channel 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 channel command is still called under the hood.

Contrib syntax Default channel syntax
allcom channel/all and channel
addcom channel/alias, channel/sub and channel/unmute
delcom channel/unalias, alias/unsub and channel/mute
cboot channel/boot (channel/ban and /unban not supported)
cwho channel/who
ccreate channel/create
cdestroy channel/destroy
clock channel/lock
cdesc channel/desc

Installation

  • Import the CmdSetLegacyComms cmdset from this module into mygame/commands/default_cmdsets.py
  • Add it to the CharacterCmdSet's at_cmdset_creation method (see below).
  • Reload the server.
# in mygame/commands/default_cmdsets.py

# ..
from evennia.contrib.base_systems.mux_comms_cmds import CmdSetLegacyComms   # <----

class CharacterCmdSet(default_cmds.CharacterCmdSet):
    # ...
    def at_cmdset_creation(self):
        # ...
        self.add(CmdSetLegacyComms)   # <----

Note that you will still be able to use the channel command; this is actually still used under the hood by these commands.

This document page is generated from evennia/contrib/base_systems/mux_comms_cmds/README.md. Changes to this file will be overwritten, so edit that file rather than this one.