MUSHclient documentation: Macrokeys

Macro keys
You can use the macros configuration to define "macros" - these are really user-defined keystrokes. Macros are sent through the normal command interpreter, so they can consist of aliases, script commands, speedwalks and so forth. As an extension, from version 3.53 onwards you can also define your own "accelerator" keys, which is another fancy word for "extended macros". See the "Accelerator" function for more information. Unlike ordinary macros, which are fixed to certain predefined keystroke combinations, the Accelerator function lets you define any combination of keys (within reason), including redefining the behaviour of existing keystrokes (eg. Ctrl+N for New Document could become something else). Any accelerators which have been defined with the Accelerator function will hide a corresponding macro from being shown in the GUI macro configuration screen, so as to avoid confusion about what the keystroke actually does. Hint To do more elaborate things (like expanding variables, running scripts) enter a nonsense word as what to send, and then make an alias to "catch" that word, and do the extra processing in the alias. One way of doing this is to use the Edit -> Generate Unique ID menu item to generate a unique word, like this: 381e051a828fb201b6914699 This is unlikely to be something you would normally want to type into the MUD. Then make an alias to match on "381e051a828fb201b6914699" (or whatever word you choose) and make the alias do things like expand variables, call scripts, etc. See Also ... Topics Aliases Keypad navigation Commands AltA (Executes a user-defined macro.) AltB (Executes a user-defined macro.) AltJ (Executes a user-defined macro.) AltK (Executes a user-defined macro.) AltL (Executes a user-defined macro.) AltM (Executes a user-defined macro.) AltN (Executes a user-defined macro.) AltO (Executes a user-defined macro.) AltP (Executes a user-defined macro.) AltQ (Executes a user-defined macro.) AltR (Executes a user-defined macro.) AltS (Executes a user-defined macro.) AltT (Executes a user-defined macro.) AltU (Executes a user-defined macro.) AltV (Executes a user-defined macro.) AltX (Executes a user-defined macro.) AltY (Executes a user-defined macro.) AltZ (Executes a user-defined macro.) ConfigureMacros (Sets macro options) East (Executes a user-defined macro.) Look (Executes a user-defined macro.) MacroCtrlF10 (Executes a user-defined macro.) MacroCtrlF11 (Executes a user-defined macro.) MacroCtrlF12 (Executes a user-defined macro.) MacroCtrlF2 (Executes a user-defined macro.) MacroCtrlF3 (Executes a user-defined macro.) MacroCtrlF5 (Executes a user-defined macro.) MacroCtrlF7 (Executes a user-defined macro.) MacroCtrlF8 (Executes a user-defined macro.) MacroCtrlF9 (Executes a user-defined macro.) MacroF10 (Executes a user-defined macro.) MacroF11 (Executes a user-defined macro.) MacroF12 (Executes a user-defined macro.) MacroF2 (Executes a user-defined macro.) MacroF3 (Executes a user-defined macro.) MacroF4 (Executes a user-defined macro.) MacroF5 (Executes a user-defined macro.) MacroF7 (Executes a user-defined macro.) MacroF8 (Executes a user-defined macro.) MacroF9 (Executes a user-defined macro.) MacroShiftF10 (Executes a user-defined macro.) MacroShiftF11 (Executes a user-defined macro.) MacroShiftF12 (Executes a user-defined macro.) MacroShiftF2 (Executes a user-defined macro.) MacroShiftF3 (Executes a user-defined macro.) MacroShiftF4 (Executes a user-defined macro.) MacroShiftF5 (Executes a user-defined macro.) MacroShiftF6 (Executes a user-defined macro.) MacroShiftF7 (Executes a user-defined macro.) MacroShiftF8 (Executes a user-defined macro.) MacroShiftF9 (Executes a user-defined macro.) North (Executes a user-defined macro.) Quit (Quits from the current world) South (Executes a user-defined macro.) Take (Executes a user-defined macro.) Up (Executes a user-defined macro.) West (Executes a user-defined macro.) Whisper (Executes a user-defined macro.) Dialogs Edit macro Macros Functions Accelerator (Add or modify an accelerator key (keystroke to command mapping)) AcceleratorList (List defined accelerators) (Help topic: general=macros) Documentation contents page

Macro keys

You can use the macros configuration to define "macros" - these are really user-defined keystrokes.

Macros are sent through the normal command interpreter, so they can consist of aliases, script commands, speedwalks and so forth.

As an extension, from version 3.53 onwards you can also define your own "accelerator" keys, which is another fancy word for "extended macros".

See the "Accelerator" function for more information.

Unlike ordinary macros, which are fixed to certain predefined keystroke combinations, the Accelerator function lets you define any combination of keys (within reason), including redefining the behaviour of existing keystrokes (eg. Ctrl+N for New Document could become something else).

Any accelerators which have been defined with the Accelerator function will hide a corresponding macro from being shown in the GUI macro configuration screen, so as to avoid confusion about what the keystroke actually does.

Hint

To do more elaborate things (like expanding variables, running scripts) enter a nonsense word as what to send, and then make an alias to "catch" that word, and do the extra processing in the alias. One way of doing this is to use the Edit -> Generate Unique ID menu item to generate a unique word, like this:

381e051a828fb201b6914699

This is unlikely to be something you would normally want to type into the MUD. Then make an alias to match on "381e051a828fb201b6914699" (or whatever word you choose) and make the alias do things like expand variables, call scripts, etc.