Command Line Aliases and Triggers - fiendish/aardwolfclientpackage GitHub Wiki

MUSHclient does not by default have a mechanism for creating aliases and triggers from the command line. This is likely because of a combination of the possible complexity of setting up any given alias or trigger and the fact that more and more people are moving towards using plugins for everything.

But the fact remains that sometimes a player wants to be able to set up simple aliases and triggers quickly and easily without dealing with the rather complicated interface and without having to write a full plugin.

It is possible to add this functionality to MUSHclient by adding two aliases (described down below) for adding new simple aliases and triggers.

If you are using the world file included in recent versions of the Aardwolf MUSHclient Package, then you may already have these aliases.

You can check by going to the Aliases configuration screen by pressing Shift+Ctrl+9 or by going to Game→Configure→Aliases... as shown here:

The process for adding these is as follows:

1. Select all of the text in the box below and copy it. Typically this is done either with Ctrl+C or by right-clicking on the selected text and choosing "Copy".

<aliases>
<alias
  match="^#alias +{(.*?)} +{(.*?)}( +{(.*?)})?$"
  enabled="y"
  group="special_convenience_aliases"
  regexp="y"
  send_to="12"
  ignore_case="y"
  sequence="100"
>
<send>require "addxml"

addxml.alias {
  name = "command_line_alias_"..string.gsub(Base64Encode("%1"), "=", ""),
  match = "%1",
  send = "%2",
  sequence = 100,
  enabled = true,
  send_to = 10,
  group = "%4"
}

ColourNote("white", "green", "Added alias "..(("%4" ~= "") and "to group '%4' " or "").."to match on '%1' and send '%2'")
</send>
</alias>

<alias
  match="^#trigger +{(.*?)} +{(.*?)}( +{(.*?)})?$"
  enabled="y"
  group="special_convenience_aliases"
  regexp="y"
  send_to="12"
  ignore_case="y"
  sequence="100"
>
<send>require "addxml"

addxml.trigger {
  name = "command_line_trigger_"..string.gsub(Base64Encode("%1"), "=", ""),
  match = "%1", 
  send = "%2",
  sequence = 100,
  enabled = true,
  send_to = 10,
  group = "%4"
}

ColourNote("white", "green", "Added trigger "..(("%4" ~= "") and "to group '%4' " or "").."to match on '%1' and send '%2'")
</send>
</alias>
</aliases>

2. Go back to MUSHclient and bring up the Aliases configuration screen by pressing Shift+Ctrl+9 or by going to Game→Configure→Aliases... as shown above.

3. On the Aliases configuration screen, find the Paste button and click it:

You should now have both aliases in place. Click OK to go back to the game.

Say you want to make an alias where the pattern is:

h *

and you want the result to be (where %1 is the target you want to heal):

cast 'heal' %1

You would now be able to type:

#alias {h *} {cast 'heal' %1}

And then you could, for example, do:

h self

which would result in sending:

cast 'heal' self

If you want to perform multiple commands, you need to use two semicolons (;;) to separate the commands as in:

#alias {h *} {cast 'heal' %1;;say I just healed %1!}

For the reason why, read about semicolons in MUSHclient here.

In brand new installs (but not updates) after snapshot r2282, both #trigger and #alias have optional third arguments for group names as in:

#alias {h *} {cast 'heal' %1} {spells}

Assigning them to groups allows you to enable/disable many at once by category. If you don't have the updated aliases, replace your aliases with the versions above.