[Home] [Downloads] [Search] [Help/forum]

Edit alias


What to match on. Can be a regular expression. If not a regular expression, use "*" to match on wildcards (variable text).

For example, "kick *" would match on "kick (someone)".

If you are using regular expressions wildcards are things in brackets.

For example: "^kick (.*)$" would be the same as the above, with the wildcard being the expression in round brackets.


Click on the button labelled "..." to open a larger box for editing the alias match text.


What to send if the alias matches. You can use %1 to match the first wildcard, %2 to match the second wildcard, and so on up to %9. For wildcards above 9 you can use %<n> (for example, %<50> for wildcard 50).

%0 represents the whole matching text.

Use %% to represent a single % symbol. You can also use %C to insert the contents of the Clipboard, and %N to insert the current alias's name (label).

If you are sending to script then any quotes or other special characters in the send text (inside the wildcard contents) are "escaped" appropriately for the script language you are using.

For example, if you were sending to Jscript, and %1 contained 'Nick said "hello" ', and the "send" text was:

world.Note "%1"

In this case it would parse the line:

world.Note "Nick said \"hello\" "


Click on the button labelled "..." to open a larger box for editing the alias send text.

Alternatively press Alt+Enter to open the editing dialog box.


If checked, the alias is enabled (active).

Omit From Log File

If checked, the alias is not logged.

Ignore Case

If checked, the alias is not case-sensitive. Otherwise "AB" is considered different from "ab".

Regular Expression

If checked, the alias is a regular expression. See the regular expression documentation for more details.

Expand Variables

If checked, variables in the alias "send" text are expanded. A variable starts with "@" and is followed by the variable name. To put "@" in the alias response, use "@@".

For example, if the variable "target" contained "kobold", then sending "punch @target" would send "punch kobold".

Omit From Output

If checked, the alias response is not echoed in the output window.


If checked, the alias is not saved in the world file.


If checked, once this alias fires, it is deleted.

Keep Evaluating

If checked, the further aliases are checked against the same thing you typed. This lets you set one alias to (say) omit things from the log file, and other aliases to do different things.

Echo Alias

If checked, the alias itself is echoed in the output window.

Omit From Command History

If checked, the alias itself is not stored in the command history.

Send To:

Where to send the alias response to. The default is to the MUD. However you can choose other places, such as the output window, a notepad window, or make the alias "send to script" in which case the alias "send" text can be script commands.

If you send to "execute" then the send text is re-evaluated through the command processor, so you can then have an alias inside an alias if you want.

The "send-to" box lets you choose to send the "send" text to one of:

  • world (the MUD)
  • command (the command window)
  • output (directly to the output window, as a note to yourself)
  • status (to the status line)
  • notepad - new (create a new notepad window)
  • notepad - append (append to a notepad window)
  • log file (directly to the log file)
  • notepad - replace (replace an existing notepad window)
  • world - speedwalk delay (queue for delayed send at the speedwalk rate)
  • variable (set a variable, whose name you provide in the variable box)
  • execute (execute through normal command parser, so aliases, speedwalks etc. will be executed)
  • speedwalk (send to world after converting speedwalk string)
  • script (execute as a script command in the current scripting language)
  • world - immediate (to the MUD immediately, even if you are speedwalking)


Aliases are evaluated in sequence number order, where the lower number is evaluated sooner. Change this number to alter the order of alias evaluation.

Reverse Speedwalk

If the alias is "send to speedwalk" this button will be active. Clicking it will reverse the speedwalk direction. (eg. 4n 5e would become 5w 4s).

Convert to Regular Expression

Click this button to convert a "normal" alias to a regular expression. This is a quick way of converting an alias into a regular expression ready for improving on it.


Aliases can have names - put the name in the "label" box.

Rules for names

Names of triggers, aliases, timers and variables must follow these rules:

  • Start with a letter (A-Z)
  • Be followed by letters (A-Z), numbers (0-9) or the underscore character (_)


If checked, the alias is added to the menu which appears when you Control-Left-Click in the output or command window. This lets you set up a menu of things you do frequently.

The menu text is the label, with underscore replaced by spaces.


If you have a script file, the alias will call a script in it if you place the script function name here. The script function must be declared with 3 arguments: name, line, wildcards. For example, in VBscript:

sub my_alias_function (name, line, wildcards)
  world.note "alias " & name & " called."
end sub

However in Lua all arguments are optional (as is usual with Lua function calls).


Aliases can be placed in groups. If you want to group your aliases place the group name in the group box. You can use groups to enable/disable or delete groups of aliases.


If you have set the alias to "send to variable", place the variable name here.

See Also ...


Default triggers/aliases/timers/macros/colours
Getting started
Keypad navigation
Macro keys
Regular Expressions
Speed walking


Alias configuration (list)


(AddAlias) Adds an alias
(DeleteAlias) Deletes an alias
(DeleteAliasGroup) Deletes a group of aliases
(DeleteTemporaryAliases) Deletes all temporary aliases
(EnableAlias) Enables or disables an alias
(EnableAliasGroup) Enables/disables a group of aliases
(GetAlias) Gets details about an alias
(GetAliasInfo) Gets details about an alias
(GetAliasList) Gets the list of aliases
(GetAliasOption) Gets the value of a named alias option
(GetAliasWildcard) Returns the contents of the specified wildcard for the named alias
(GetPluginAliasInfo) Gets details about a named alias for a specified plugin
(GetPluginAliasList) Gets the list of aliases in a specified plugin
(GetPluginAliasOption) Gets the value of a named alias option for a specified plugin
(IsAlias) Tests to see if an alias exists
(SetAliasOption) Sets the value of a named alias option

(Help topic: dialog=IDD_EDIT_ALIAS)

Documentation contents page

Search ...

Enter a search string to find matching documentation.

Search for:   

Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]