MUSHclient documentation: Macros

Macros
Customise output from function keys and 'Game' menu. Use this dialog to configure what is sent if you press one of the function keys (macros), for example, F2. The string you enter is sent through command processing so you can put aliases here. Also, some items (like "quit") control what is sent if you select Quit from the Input menu. Override with default macros If checked, next time the world is loaded your macros are replaced with the default ones. See the help topic on "defaults" for more details. Edit... Click to edit a macro. Find... Click to find a macro based on its contents. Find Next Click to repeat the next find (find another one that matches). Load... Click to load macros from disk. Save... Click to save selected macros to disk. 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. Warning Any accelerators which have been defined with the Accelerator function will hide a corresponding macro from being shown in the macro configuration screen, so as to avoid confusion about what the keystroke actually does. See Also ... Topics Aliases Keypad navigation Macro keys 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.) Dialog Edit macro Functions Accelerator (Add or modify an accelerator key (keystroke to command mapping)) AcceleratorList (List defined accelerators) (Help topic: dialog=IDD_PREFS_P6) Documentation contents page

Macros

Customise output from function keys and 'Game' menu.

Use this dialog to configure what is sent if you press one of the function keys (macros), for example, F2. The string you enter is sent through command processing so you can put aliases here.

Also, some items (like "quit") control what is sent if you select Quit from the Input menu.

Override with default macros

If checked, next time the world is loaded your macros are replaced with the default ones. See the help topic on "defaults" for more details.

Edit...

Click to edit a macro.

Find...

Click to find a macro based on its contents.

Find Next

Click to repeat the next find (find another one that matches).

Load...

Click to load macros from disk.

Save...

Click to save selected macros to disk.

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.

Warning

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