The option names (attribute names) in the table below can be used when manually configuring your MUSHclient XML world files (see example below).
<world
auto_say_override_prefix="-"
auto_say_string="say "
input_font_name="FixedSys"
mapping_failure="Alas, you cannot go that way."
name="Dawn Of Time"
new_activity_sound="(No sound)"
output_font_name="FixedSys"
enable_triggers="y"
enable_trigger_sounds="y"
history_lines="1000"
hyperlink_adds_to_command_history="y"
hyperlink_colour="#0080FF"
indent_paras="y"
input_background_colour="white"
>
<connect_text trim="1">
who
</connect_text>
</world>
They can also be used for world.GetOption, world.GetAlphaOption, world.SetOption, and world.SetAlphaOption.
For example:
world.SetOption "enable_triggers", 1
world.SetAlphaOption "input_font_name", "Lucida Console"
world.Note world.GetOption ("indent_paras")
world.Note world.GetAlphaOption ("player")
The options listed as type "Alpha" are to be used with GetAlphaOption and SetAlphaOption, the others are to be used with GetOption and SetOption.
Alpha options listed as "Multi-line" should be entered in a world file as a child tag of the <world> tag. See example above for "connect_text";
| Name | Description | Type | Range | Notes |
|---|---|---|---|---|
| alternative_inverse | Alternative method of displaying inverse colours | Boolean | y/n | |
| alt_arrow_recalls_partial | Pressing text + Alt+Arrow recalls a line | Boolean | y/n | |
| arrows_change_history | Arrow keys cycle through command history | Boolean | y/n | |
| arrow_keys_wrap | Arrow keys wrap command window | Boolean | y/n | |
| arrow_recalls_partial | Pressing text + Arrow recalls a line | Boolean | y/n | |
| autosay_exclude_macros | Exclude macro commands when doing an auto-say | Boolean | y/n | |
| autosay_exclude_non_alpha | Exclude non-alphabetic commands when doing an auto-say | Boolean | y/n | |
| auto_log_file_name | Name of log file for automatic logging | Alpha | ||
| auto_pause | Auto-pause when you scroll back | Boolean | y/n | |
| auto_repeat | Automatically repeat last command entered | Boolean | y/n | |
| auto_say_override_prefix | Prefix string to override auto-say | Alpha | ||
| auto_say_string | String to be sent when doing an auto-say | Alpha | ||
| auto_wrap_window_width | Change wrap size when window is resized | Boolean | y/n | |
| beep_sound | Name of beep sound | Alpha | ||
| confirm_before_replacing_typing | Confirm before replacing your typing (eg. by using arrow keys) | Boolean | y/n | |
| confirm_on_paste | Confirm preamble etc. when doing paste to world | Boolean | y/n | |
| confirm_on_send | Confirm preamble etc. when doing file send to world | Boolean | y/n | |
| connect_method | Connection method (0=manual, 1=MUSH style, 2=Diku-style, 3=MXP) | Number | 0 to 3 | |
| connect_text | Text sent upon connecting | Alpha | Multi-line | |
| ctrl_n_goes_to_next_command | Ctrl+N goes to next command | Boolean | y/n | |
| ctrl_p_goes_to_previous_command | Ctrl+P goes to previous command | Boolean | y/n | |
| ctrl_z_goes_to_end_of_buffer | Ctrl+Z goes to end of output window | Boolean | y/n | |
| custom_16_is_default_colour | Custom colour 16 is default output window colour | Boolean | y/n | |
| detect_pueblo | Auto-detect Pueblo initialisation string | Boolean | y/n | |
| disable_compression | Disable MCCP compression | Boolean | y/n | |
| display_my_input | Echo commands in output window | Boolean | y/n | |
| double_click_inserts | Double-click word inserts it into command window | Boolean | y/n | |
| double_click_sends | Double-click word sends it to MUD | Boolean | y/n | |
| echo_colour | Colour for echoing commands (0 = no change) | Number | 0 to 16 | Custom colour |
| echo_hyperlink_in_output_window | Output from MXP hyperlink is shown in output window | Boolean | y/n | |
| edit_script_with_notepad | Edit script files with internal notepad | Boolean | y/n | |
| enable_aliases | Enable all aliases | Boolean | y/n | |
| enable_auto_say | Enable auto-say | Boolean | y/n | |
| enable_beeps | Enable beeps (from MUD) | Boolean | y/n | |
| enable_command_stack | Enable command stacking | Boolean | y/n | |
| enable_scripts | Enable scripting | Boolean | y/n | |
| enable_speed_walk | Enable speed walking | Boolean | y/n | |
| enable_timers | Enable all timers | Boolean | y/n | |
| enable_triggers | Enable all triggers | Boolean | y/n | |
| enable_trigger_sounds | Enable trigger sounds | Boolean | y/n | |
| escape_deletes_input | Pressing ESC deletes command in command window | Boolean | y/n | |
| flash_taskbar_icon | Flash taskbar icon on new activity | Boolean | y/n | |
| history_lines | Number of commands saved in command history | Number | 20 to 5000 | |
| hyperlink_adds_to_command_history | MXP hyperlinks are added to command history | Boolean | y/n | |
| hyperlink_colour | MXP hyperlink colour | Number | 0 to 16777215 | RGB colour |
| ignore_mxp_colour_changes | Ignore MXP colour changes | Boolean | y/n | |
| indent_paras | Indent subsequent lines of paragraphs by one space | Boolean | y/n | |
| input_background_colour | Command window background colour | Number | 0 to 16777215 | RGB colour |
| input_font_height | Command window font height in pixels | Number | 1 to 1000 | |
| input_font_italic | Command window font - italic? | Boolean | y/n | |
| input_font_name | Command window font name | Alpha | ||
| input_font_weight | Command window font weight (0=Don't care, 100=thin, 400=normal, 700=bold, 900=heavy) | Number | 0 to 1000 | |
| input_text_colour | Command window text colour | Number | 0 to 16777215 | RGB colour |
| keep_commands_on_same_line | Keep commands on same line as MUD output | Boolean | y/n | |
| keypad_enable | Enable numeric keypad | Boolean | y/n | |
| line_information | Show line information when cursor hovers over line | Boolean | y/n | |
| log_file_postamble | Log file file postamble | Alpha | Multi-line | |
| log_file_preamble | Log file file preamble | Alpha | Multi-line | |
| log_html | Log in HTML | Boolean | y/n | |
| log_input | Log commands | Boolean | y/n | |
| log_in_colour | Log in HTML with colour codes | Boolean | y/n | |
| log_line_postamble_input | Logging - line postamble (appended to each line) - input lines | Alpha | ||
| log_line_postamble_notes | Logging - line postamble (appended to each line) - notes | Alpha | ||
| log_line_postamble_output | Logging - line postamble (appended to each line) - MUD output | Alpha | ||
| log_line_preamble_input | Logging - line preamble (prepended to each line) - input lines | Alpha | ||
| log_line_preamble_notes | Logging - line preamble (prepended to each line) - notes | Alpha | ||
| log_line_preamble_output | Logging - line preamble (prepended to each line) - MUD output | Alpha | ||
| log_notes | Log notes (world.note output) | Boolean | y/n | |
| log_output | Log MUD output | Boolean | y/n | |
| log_raw | Raw logging (log everything from the MUD, exactly as it arrived) | Boolean | y/n | |
| lower_case_tab_completion | Tab completion completes in lower case | Boolean | y/n | |
| mapping_failure | Regular expression which indicates failure to go in a direction | Alpha | ||
| map_failure_regexp | Field 'mapping failure' is a regular expression | Boolean | y/n | |
| max_output_lines | Maximum lines in output window | Number | 200 to 500000 | |
| mud_can_change_link_colour | MUD can change MXP hyperlink colours | Boolean | y/n | |
| mud_can_remove_underline | MUD can remove underlines from MXP hyperlinks | Boolean | y/n | |
| mxp_debug_level | MXP debug level (0=none, 1=errors, 2=warnings, 3=info, 4=all) | Number | 0 to 4 | |
| name | Name of world | Alpha | ||
| naws | Negotiate About Window Size | Boolean | y/n | |
| new_activity_sound | Name of sound file to play on new activity | Alpha | ||
| notes | World general notes | Alpha | Multi-line | |
| note_text_colour | Colour of notes text | Number | 0 to 16777215 | RGB colour |
| no_echo_off | MUD cannot turn command echoing off | Boolean | y/n | |
| on_mxp_close_tag | Script routine to execute on MXP tag close | Alpha | ||
| on_mxp_error | Script routine to execute on MXP error | Alpha | ||
| on_mxp_open_tag | Script routine to execute on MXP open tag | Alpha | ||
| on_mxp_set_variable | Script routine to execute on MXP setting a variable | Alpha | ||
| on_mxp_start | Script routine to execute on MXP start up | Alpha | ||
| on_mxp_stop | Script routine to execute on MXP close down | Alpha | ||
| on_world_close | Script routine to execute on world close | Alpha | ||
| on_world_connect | Script routine to execute on world connect | Alpha | ||
| on_world_disconnect | Script routine to execute on world disconnect | Alpha | ||
| on_world_get_focus | Script routine to execute on world getting the focus | Alpha | ||
| on_world_lose_focus | Script routine to execute on world losing the focus | Alpha | ||
| on_world_open | Script routine to execute on world open | Alpha | ||
| output_font_height | Height of output window font in pixels | Number | 1 to 1000 | |
| output_font_name | Name of font in output window | Alpha | ||
| output_font_weight | Output window font weight (0=Don't care, 100=thin, 400=normal, 700=bold, 900=heavy) | Number | 0 to 1000 | |
| password | Password for player connect | Alpha | Password | |
| paste_commented_softcode | When pasting, treat clipboard as commented softcode | Boolean | y/n | |
| paste_delay | Delay when pasting to MUD (milliseconds) | Number | 0 to 100000 | |
| paste_delay_per_lines | Number of lines to send before doing paste delay | Number | 1 to 100000 | |
| paste_echo | Echo paste to MUD in output window | Boolean | y/n | |
| paste_line_postamble | Paste to MUD - line postamble (appended to each line) | Alpha | ||
| paste_line_preamble | Paste to MUD - line preamble (prepended to each line) | Alpha | ||
| paste_postamble | Paste to MUD - sent after everything | Alpha | Multi-line | |
| paste_preamble | Paste to MUD - sent before everything | Alpha | Multi-line | |
| pixel_offset | Offset of text from window edge in pixels (output window) | Number | 0 to 20 | |
| player | Player name | Alpha | ||
| port | MUD port number | Number | 1 to 65535 | |
| recall_line_preamble | Recall window - line preamble (prepended to each line) | Alpha | ||
| save_deleted_command | Keep deleted commands in command history | Boolean | y/n | |
| save_world_automatically | Automatically save world on close | Boolean | y/n | |
| script_editor | Name of editor to use when editing scripts | Alpha | ||
| script_filename | Script file name | Alpha | ||
| script_language | Script language (vbscript, jscript or perlscript) | Alpha | ||
| script_prefix | Scripting prefix (typed in command window to enter immediate script) | Alpha | ||
| script_reload_option | When to reload scripts (0=confirm, 1=always, 2=never) | Number | 0 to 2 | |
| send_echo | Echo 'send to MUD' to MUD in output window | Boolean | y/n | |
| send_file_commented_softcode | When sending file to MUD, treat file as commented softcode | Boolean | y/n | |
| send_file_delay | Delay when sending file to MUD (milliseconds) | Number | 0 to 100000 | |
| send_file_delay_per_lines | Number of lines to send before doing send file delay | Number | 1 to 100000 | |
| send_to_world_file_postamble | Send file to MUD - line postamble (appended to each line) | Alpha | Multi-line | |
| send_to_world_file_preamble | Send file to MUD - line preamble (prepended to each line) | Alpha | Multi-line | |
| send_to_world_line_postamble | Send file to MUD - sent after everything | Alpha | ||
| send_to_world_line_preamble | Send file to MUD - sent before everything | Alpha | ||
| show_bold | Show highlighted text in a bold font | Boolean | y/n | |
| show_connect_disconnect | Show connect/disconnect messages in output window | Boolean | y/n | |
| show_italic | Show italic text in an italic font | Boolean | y/n | |
| show_underline | Show underlined text in an underlined font | Boolean | y/n | |
| site | TCP/IP address of MUD (name of site) | Alpha | ||
| speed_walk_delay | Speed walking delay in milliseconds | Number | 0 to 30000 | |
| speed_walk_filler | Speed walking filler string (for "F" character) | Alpha | ||
| speed_walk_prefix | Speed walking prefix string | Alpha | ||
| spell_check_on_send | Spell check when sending command | Boolean | y/n | |
| start_paused | Start in paused mode | Boolean | y/n | |
| tab_completion_defaults | Defaults for tab-completion | Alpha | Multi-line | |
| terminal_identification | Terminal identification for telnet negotiation | Alpha | ||
| translate_backslash_sequences | Translate C-style backslash sequence in command window | Boolean | y/n | |
| translate_german | Translate German sequence when sending commands | Boolean | y/n | |
| underline_hyperlinks | Underline MXP hyperlinks | Boolean | y/n | |
| unpause_on_send | When sending, cancel pause mode | Boolean | y/n | |
| use_custom_link_colour | Use custom hyperlink colour | Boolean | y/n | |
| use_default_aliases | Use default aliases (from global settings) | Boolean | y/n | |
| use_default_colours | Use default colours (from global settings) | Boolean | y/n | |
| use_default_input_font | Use default command window font (from global settings) | Boolean | y/n | |
| use_default_macros | Use default macros (from global settings) | Boolean | y/n | |
| use_default_output_font | Use default output window font (from global settings) | Boolean | y/n | |
| use_default_timers | Use default timers (from global settings) | Boolean | y/n | |
| use_default_triggers | Use default triggers (from global settings) | Boolean | y/n | |
| use_mxp | MXP enable (0=Telnet negotiated, 1=When queried, 2=on, 3=off) | Number | 0 to 3 | |
| wrap | Wrap at window width (at nearest space) | Boolean | y/n | |
| wrap_column | Column to wrap at | Number | 20 to 500 | |
| write_world_name_to_log | Write world name when opening log file | Boolean | y/n |
Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.