FAQ, bugs, suggestions
Examples and reviews
Scripting, triggers and plugins
MUSHclient ... FreeWare MUD client
Fast and compact
Written in C++ for speed and compact size! Play your favourite MUD (Multi-User Dungeon) game with ease. Installed, it only requires around 11 Mb of disk space, plus any extra needed for storing MUD game configurations, and any plugins you download.
Want to know more about MUDs?
See MUD - from Wikipedia. Basically MUDs are text-based multi-player role-playing games. Most are free to play. MUSHclient itself is free and asks for no personal details before downloading it. A list of MUDs you can play is at The MUD Connector (there are over 1,000 of them!).
MUSHclient is easy to use
MUSHclient uses the "standard" Windows look-and-feel. Connecting to a MUD is really simple. Just select "Quick Connect" on the Connection menu, fill in the MUD's IP address and port number, and click OK!
MUSHclient is extensible
Add plugins to your world to extend MUSHclient's functionality! Over a dozen plugins are supplied with MUSHclient, plus you can download more from the plugins web page, and from other plugin authors.
Plugins are related groups of triggers, timers, aliases, scripts and variables. They are easily installed and removed.
Enhance your MUD experience with:
XML file format
MUSHclient files (world files, plugins, triggers, aliases, timers, variables) are saved in industry-standard XML format.
You can copy and paste triggers, aliases, etc. from one world to another.
The MUSHclient forum is a place for getting help, tips, asking questions, and generally getting support for MUSHclient.
You can use scripting to enhance the way that triggers, timers, aliases react to events, and also do additional things as required, like automatically reconnect, send "socials" randomly, and so on.
You can script in any of the following languages:
There are over 410 script functions and properties that can be called by scripting routines (plus some 300+ more that are specific to Lua only).
Recent versions support in-line scripting, so that triggers, aliases and timers can "make decisions" inline without having to use a separate script file.
There is a built-in editor to allow you to write scripts from within the program, which offers quick access to the help file entries for all script functions.
MXP and MCCP support
Proxy server support
MUSHclient supports connecting via Socks 4 and 5 proxy servers.
MUSHclient has a built-in chat system that is compatible with both MudMaster and zChat protocols. You can use it to both make and receive chat calls to other compatible clients (including MUSHclient of course!). This includes the capability to send files, snoop their output, send commands, and more. The chat system is fully scriptable.
You can have dozens of worlds open at once. Each one can have up to 500,000 lines of recent output saved in memory. Each one can remember the last 5,000 commands you typed. There is a search facility for quickly finding individual items.
Multiple worlds support
You can even enter a single command and have it sent simultaneously to all, or selected, worlds.
You can play up to 10 sound files simultaneously using DirectSound technology which is part of DirectX. These can be used for background music, ambient sounds, warnings, battle sounds and so on. Sounds can be played at different volume levels and panned between the left and right speakers.
Supported Operating Systems
Runs under Windows 95/98/ME/NT/2000/XP/Vista/7.
For hints about installing under Windows 7, see How to install MUSHclient on Windows 7.
Click on example screens for examples of MUSHclient in operation, and examples of configuration screens.
The features described pertain to the latest version of MUSHclient, which is currently 4.94.
Recent versions support "miniwindows" which are scriptable GUI elements. These can be used to show things like status bars, maps, experience bars, inventory, and so on, in floating windows which appear above, below, or to the side of the MUD text. Some examples are:
Health bar :
Experience bar :
Action buttons with cooldowns :
Inventory item information :
Quest information :
Miniwindows are created through scripting, however most of the above examples are available already as plugins from the Plugins part of the MUSHclient forum. The plugins described there will probably need a bit of tweaking to make them match the output from your particular MUD (eg. the health bar plugin has a trigger that matches how your current health is displayed).
You can use miniwindows to draw graphical elements (like rectangles and ellipses), text in any installed font and any colour, PNG and BMP pictures, lines, curves etc. They can also respond to mouse-over, mouse-down and mouse-up events. For more details see Miniwindows Introduction.
MUSHclient is now FreeWare, please read MUSHclient now FreeWare forum posting.
Donations are welcome. They help support future improvements.
This document was checked and found to be valid HTML 4.01 Transitional.
Comments to Gammon Software support
Page updated on Thursday, 11th June 2009