Download 1.18 Mb.
zMUD allows you to connect to and play MUDs on the Internet, and provides you many useful tools, such as aliases, actions, macros, keys, buttons, scripts, maps, databases, etc, to make your MUD life easier and more profitable.
Suggestions for improving zMUD are always welcome. Support is available to both licensed and trial users on the Support Forums at http://www.zuggsoft.com/forum and via email at email@example.com. The latest version of zMUD can be found in the Download page at http://www.zuggsoft.com/zmud.
zMUD is designed for both the novice MUD player, as well as the advanced player. For novice players, the built-in list of all MUD games on the Internet makes it easy to get started. If you are a novice user, don't be intimidated by the large number of commands and features in zMUD. These features will not get in your way, but they will be waiting for you when you become more advanced.
For advanced users, zMUD can be completely customized and scripted. You can create "robot" programs that respond to conditions on the MUD and take action for you. zMUD scripting can even be used to interact with other programs on your computer. As a scriptable Telnet client, zMUD can be used to automatically monitor a network, control routers, and more. Given the flexibility and power of zMUD, there is little you cannot accomplish.
For developers, additional tools are available for creating zMUD plugins, allowing you to expand the functions of zMUD beyond what is described in this help file.
This help file is designed to be a reference for zMUD, rather than a tutorial. While several of the topics in the Getting Started section can be used as tutorials, official tutorials can be found on the Zuggsoft web site at http://www.zuggsoft.com/library. This help file is also available online at http://www.zuggsoft.com/zmud/help6/helpset.htm. The online version of the help file contains many screen shots that are not included with the Windows Help version due to space considerations.
Here is an overview of the major topics included in this help file:
List of zMUD features
Information for new users
Information on all preferences
Details about each type of setting and using the Settings Editor
Information for power users
Reference for all menu commands
Reference and syntax for commands
Reference and syntax for built-in functions
What is a MUD?
MUD stands for Multi-User Dungeon, Multi-User Domain, or Multi-User Dimension. Regardless of what it stands for, a MUD is an online environment where multiple users are logged on and interacting with one and other. On some MUDs you only interact with other players that are logged on, similar to an online chat system. On other MUDs you can also interact with a game world where you can explore, fight monsters, and collect treasure, either alone or in the company of other players that are logged on. On some MUDs, the environment itself can be changed and expanded by the players themselves. On others, you must play the game long enough to advance to a Wizard level at which time you can add new areas to the game. Allowing players to change and add to the MUD world itself is one of the unique features that make MUDs so unique and fun. Every MUD you visit will be different in subtle or dramatic ways.
MUDs have been around since the early beginnings of the Internet. The first MUD was written by Roy Trubshaw and Richard Bartle at Essex University in 1979 on a DECsystem-10. For more information about the history of MUDs, take a look at The MUDdex (http://www.apocalypse.org/pub/u/lpb/muddex/) created by Lauren P. Burka.
For more information about MUDs, visit the incredible MUD Connector (http://www.mudconnector.com). This site has a detailed list of most every MUD on the Internet, along with every else you ever wanted to know about MUDs.
zMUD uses the MUD listing from the MUD connector as the database for its internal MUD Connection Wizard. You can select MUDs and view their description. zMUD also allows you to search the MUD list for various keywords. The entire MUD list can be quickly updated with records added or changed since your last update.
zMUD has unique features for both beginning MUD players, as well as for power wizards builders and coders accustom to clients like TINTIN. Don't be fooled by imitations; zMUD is the most standards-based and feature-rich MUD client available, with over 25,000 registered users, worldwide. Here is a list of major features:
MUD Sound Protocol
Support for the MUD Sound Protocol (MSP) allows the MUD to trigger sound effects and background music. zMUD can play up to 16 sounds at the same time as the background music and can chain multiple sound effects together.
MUD Extension Protocol
Supports the MXP markup language, which, similar to HTML and XML, allows your to add rich content to your MUD screen.
MUD Client Compression Protocol
Supports the compression protocol, allowing you to play even faster than ever.
full ANSI color support, and cursor support. Colors are user-configurable.
full VT100 terminal emulation, including cursor movement and scrolling regions. Great for MUDs with status lines
Works in both line-based MUD mode as well as character-based Telnet mode. You can use zMUD to log into your Internet Provider’s UNIX shell account. Supports Terminal Type, NAWS, and many other telnet options.
Compatible with the SOCKS proxy standard. Can also be used with dedicated Telnet proxy servers.
90% compatibility with TINTIN and TINTIN+ text-based clients. Includes a TINTIN++ script importing and conversion facility.
developed and tested on Windows 2000. Also tested and supported on Windows 95, Windows 98, Windows ME, and Windows NT 4.0.
Create a graphical map as you walk around the MUD. zMUD was the first MUD client to include this feature, and is still the only client that supports mapping on any MUD. The map handles 8 standard directions plus custom teleport directions, doors, multiple levels, one-way links, room colors, multiple zones, custom labels, and much more. Double click on a room and it will automatically speedwalk you to the room from wherever you are using the shortest path!
User-defineable database for storing information on equipment, monsters, other players, etc. Can be queried and scripted from the command line, or you can use the powerful GUI interface.
User-definable button bar for executing commands, keeping track of character status, or controlling your character.
Special gauge buttons allow you to visually monitor any variable or condition.
Uses the master MUD list from the MUD Connector to make it easy to browse all the MUDs on the Internet. Over 1000 MUDs in the list! You can easily update this list, or add your own entries to it.
Keeps a database of all of your MUD characters, and detailed notes for each one. Uses an Explorer-like interface to make it easy to select the character you want to play.
Supports multiple characters in multiple windows and methods to send commands to different windows. Can also capture text and send it to a secondary window. Window captions can be placed on the left side to provide the maximum number of text lines. Multiple windows can be docked together for the most flexible arrangement. Once you get the windows the way you want them, a simple Save Layout remembers your arrangement for next time.
assign text or commands to any key combination on the keyboard
assign text or commands to shortcut names to save typing
execute commands based upon patterns received from MUD. Sophisticated pattern matching functions are provided.
both text and numeric variables saved with your session
Built-in as well as user defined functions. zMUD contains a powerful programming language.
let you record directions to MUD locations, and even play them back in reverse. Called speedwalking in some clients. Path commands can be customized.
prevents you from sending the same string to the MUD too many times and being flagged a spammer
Allows you to trigger sounds, MIDI, movies, etc.
store commands in a text file and read them in as a script
Syntax checking and Debugging
A power syntax checker points out mistakes in your scripts. Then use the debugger to single-step through your scripts, or set breakpoints and watch variables.
allows you to enter long strings of text by typing the first few characters and then pressing
command history of last commands with customizable storage limit
log your session to a file for review at a later time. Log file supports ANSI color
a built-in timer allows you to take control of ticks
customizable line shows the status of variables and triggers
colors, fonts, sounds, special characters can all be modified and saved.
saves all settings (aliases, macros, etc). You can have a single settings file for several characters.
extensive online help system provides both reference and examples. Context-sensitive command help is also a keystroke away.
command and function wizards show zMUD programming syntax and help you create commands and functions
zMUD is designed to work with international keyboards, and non-English language MUDs. zMUD itself has been translated into many different languages. Check the www.zuggsoft.com web site for special versions for other languages.
Benchmarked against other Windows MUD and Telnet clients as the fastest scrolling client available.
provides both a GUI interface as well as a traditional command line interface. Output can be scrolled and word-wrapped, and window can be frozen to prevent unwanted scrolling, and splitscreen shows scrollback at same time as live text. Scrollback buffer can be as large as your computer's memory can hold.
zMUD is available as a 30-day trial evaluation. To use zMUD after 30 days, you must purchase it. To purchase zMUD, click the Purchase button that appears on the Trial screen. If you want to purchase zMUD and do not have a credit card, go to the BUY page on www.zuggsoft.com for more ordering options.
If you are having problems with your license, you can find solutions in the eLicense FAQ.
zMUD Copy Protection
zMUD uses the eLicense technology from ViaTech for its copy protection. The eLicense technology controls the 30-day trial period for zMUD, as well as the purchased license.
eLicense uses sophisticated encryption and digital signature algorithms to protect the zMUD license. Attempts to modify the zMUD software, use an invalid registration code, or attempts to circumvent the copy protection can cause zMUD to stop functioning. In addition, such illegal activities may prevent the user from using zMUD or any future Zugg Software products in the future. Tampering with the eLicense software can cause any other software on your system that uses eLicense to stop functioning.
Unlike zMUD versions 5.x, zMUD does NOT contact any remote server or send any information to any remote server. The eLicense server is only contacted when you first use the Purchase button to buy zMUD, or when you Unlicense and Relicense an existing Order ID. Once you have purchased zMUD, it will not communicate with the eLicense server again, until you Unlicense or Return the product.
zMUD MAY contact a remote server to determine if a new version of zMUD is available. No information is sent to this remote server. The remote server returns the latest version information, and zMUD than asks you if you want to upgrade. This feature can be disabled in the zMUD Preferences.
zMUD is licensed to a single user. You may install zMUD on up to 3 different computer systems. To use zMUD on more than 3 computers, you must purchase additional licenses. Each additional license adds one more computer to your allowed number of copies.
You can move a license from one machine to another. To move a license, right-click on the ZMUD.EXE file and select Unlicense. Then use your Order ID to install a copy of zMUD on another computer.
Your zMUD licenses are tied to the specific computer zMUD was installed on. If you copy zMUD to a different computer, zMUD will revert to Trial mode. Before reinstalling Windows or reformatting your hard disk, you should Unlicense zMUD to prevent your license from being lost. Zugg Software cannot restore licenses that are lost as a result of this.
To Unlicense zMUD, right-click on the ZMUD.EXE icon and select Unlicense from the eLicense options, or open the eLicense Control Panel, select Zugg Software, then right-click on zMUD.
The very first time you start zMUD, you will need to read and accept the licensing terms. After accepting the licensing terms, you are presented with zMUD’s main welcome dialog. The first time you view this main window, a Getting Started message will be displayed.
Follow the instructions and click the New button to create a new character, or the OK button to go to the normal startup screen where you can manage your MUD characters.
The steps in getting started with zMUD are:
Create a new character
Introduction to Aliases
Introduction to Macros
Introduction to Variables
Introduction to Classes
Introduction to Triggers
Introduction to Buttons
Introduction to Multiplaying
Introduction to the Database
Introduction to Mapping
To use zMUD, you must have a connection to the Internet. Usually this connection is made through dialup software that uses SLIP or PPP protocols, but it might also be through a direct LAN connection. If you can run other network software such as Web Browsers or email programs, your computer is probably set up properly to run zMUD. If you have trouble connecting to MUDs using zMUD, consult some of the topics below for more help.
To use zMUD, your network software must support 32-bit programs. Earlier versions of AOL software did not support this. So, if you are having trouble using zMUD on AOL, make sure you are using AOL version 3.0 or higher. When using more recent versions of AOL, you might need to turn off some of their firewall or blocking features. These features can sometimes prevent connecting to your MUD server.
Proxies and Firewalls
Some people are connected to the Internet via a Proxy Server or Firewall. Support for SOCKS4 and SOCKS5 compatible Proxy Servers, regular Telnet Proxy servers, and WWW Proxy Hosts is built in. To configure zMUD for these types of connections, select the Preferences option in the Edit menu at the main Character screen, or select Preferences while inside zMUD. Go to the Proxy settings page. Select whether you are using a SOCKS4, SOCKS5, Telnet proxy, or WWW Proxy. SOCKS4 is the preferred option and is supported by most modern firewalls. Simply enter the hostname or IP address of the Proxy server, along with the port that its SOCKS4 service runs on, which is usually 1080. If your server requires a username to connect, enter the proper name into the username field.
For a Telnet Proxy, enter the hostname or IP address of the Telnet Proxy server, along with the port that it is running on, which is usually port 23. Then you need to specify the command needed by your Telnet Proxy to connect to an outside MUD. Usually this command is just the MUD host name and the MUD port number, separated by a space. Use the %host variable for the hostname and the %port variable for the port number. Any other variables or zMUD functions may be used in this command to form a proper command to send to the proxy server to connect you.
Note that for any of the Proxy server setup to function, you must have DNS installed and running properly on your computer. Check with your Network or System Administrator to ensure that this is set up properly.
Cannot Lookup IP Addresses
The Domain Name Service (DNS) provides a mechanism to convert hostnames into the numeric IP address needed for zMUD to connect to a MUD. You must have DNS set up properly to use zMUD, or else you will have to specify the IP address manually in the Hostname field for the MUD in the Character database. Most network providers set up the DNS server information automatically when you connect. If you experience problems with this, contact your Internet Provider or your Network Manager.
To get started quickly, click the New button in the main Character window. zMUD will read a list of MUDs contained in the MUDLIST.MDB file and display them on the left. Simply select your favorite MUD from this list, or enter the Hostname and Port of the MUD you want to connect to in the boxes. Then click the Connect button to save this character and connect to the MUD.
Connecting to a MUD
zMUD will attempt to connect to the MUD that you have selected. Once connected, the MUD will normally ask for your username, followed by your password. Once you have entered this information, zMUD will ask if you want to create an auto-login1 trigger for this MUD. If you select Yes, auto-login triggers will be created, and your character name and password will be saved to the character database. Be sure and save your settings file before you exit so that this login trigger will get saved.
That’s all there is to it! You are now connected and playing a MUD. You can continue through this help section for more information to help you get started with zMUD.
Troubleshooting: If you have trouble connecting to a MUD and get the error message "can’t lookup address", then you probably have an incorrect nameserver setup. Setting up a proper nameserver for your Internet connection is beyond the scope of this document, however, there is a work-around for this. When using the Connection Wizard, both the host name and the host address are displayed. If you are having trouble connecting to the name, simply click the USE button to use the address rather than the hostname. This will prevent zMUD from trying to look up the address from a nameserver. This will typically allow you to connect to the MUD. If the MUD administrators ever change the address of their machine, your connection will stop working until you enter the new address. Also make sure you are running network software that supports 32-bit programs. For example, if you are an AOL user, you must use AOL version 3.0 or higher with zMUD.
The full version of zMUD ships with several sample files designed to illustrate some of the things you can do with zMUD. Simply click the "Sample MUD" character icon in the main window, then click Offline. Do not click Connect...there is no actual MUD associated with the sample files.. A sample MUD window will open, along with a sample map and sample database file. You can explore the sample settings in this file to get ideas for triggers for your own MUD characters.
Once you are connected to the MUD, you will typically be prompted for your character name and password. zMUD tries to auto-detect this, and will pop-up a dialog with your character name and password and ask if you want zMUD to create an auto-login trigger for you. If you click OK, then the next time you log-in, zMUD will automatically enter your character name and password. If you click Cancel, this trigger will not be created for you. Of course, the next time you log in, zMUD will ask about creating the trigger again. If you want to stop zMUD from auto-detecting your login process, simply go into the character database and fill in a value for your character name.
Note that the text you type appears in the bottom Command Line entry field. When you press
When you enter your password, it will also be echoed to the screen. To prevent this, use the #PW command. Type #PW and press
The Command Line
Once you have entered your character name and password, answer any other questions displayed by the MUD. All of the text that you type will be shown in the command line. You can use the
You can enter multiple commands on the same line using the Separator character, which defaults to semi-colon (;). Thus, eat bread;drink water will send the two commands eat bread and drink water to the MUD in quick succession. Also, when commands are sent to the MUD from the command line, a newline (CR/LF) is always added to the end automatically.
The command line can contain more than one line at a time. As you type, the text will automatically word-wrap at the right-edge of the line and the command line will expand to show the entire text string. Note that even though the text is displayed on a second line, it is still considered one line by zMUD and will be sent to the MUD as a single line. To add an actual second line, press Ctrl-Enter to force a hard new-line in the command. This works just like the command separator character. To clear the line, press the ESC key. Note that you can turn off the word-wrap setting in the Preferences.
Commands that you send to the MUD are stored in your Command History, which, by default, contains th last 20 command lines you have sent to the MUD. With the cursor on the first line of the command line, press UP-Arrow to recall the last command you entered. Press UP-Arrow again to recall the next command, and so on. If the cursor is in the last line of the command line, pressing Down-arrow will move the opposite direction through the command history. Or, if you have started typing a command, pressing Down-arrow will store the command in the command history without sending it.
The Down-arrow "save" feature is very useful if you are in the middle of typing a long message and you need to do something on the MUD quickly. Just press Down-arrow to save your command in the command buffer without sending it, then type the command you need to send to the MUD quickly and press Enter. Now that the command has been send, press Up-arrow to retrieve your long command and continue working on it, and press Enter when you are ready to send it to the MUD.
The Output Window
You can scroll the main MUD window by clicking the scrollbars to the right and below the main window. You can also use the PgUp and PgDn keys on the keyboard (but again, not the number pad). When you scroll the window, the screen is split, with the scrollback shown above and the live text from the MUD shown at the bottom. The split bar can be dragged to any position to see as much or as little live text as desired. Once the screen is split, the Shift-Up and Shift-Down arrows can be used to move line by line, or the PgUp and PdDn keys can be used to scroll a page at a time. You can still type commands in the command line and send them to the MUD while the screen is split. To unsplit the window and automatically return to the bottom of the scroll buffer, click the Pause button in the lower right corner of the window, or press the Ctrl-Z key, or press the ScrollLock key, or type #FREEZE on the command line. You can also unsplit the window by dragging the scroll bar to the bottom.
You can search for text in the output window using the Find command in the Edit menu, or by pressing Ctrl-F. You can search backwards (default) and forwards through the buffer. Since this buffer can grow quite large, especially in the 32-bit version of zMUD, the Find command is very handy for rapidly locating past text. The screen is automatically split when the text is found so that you can view the scrollback buffer and the live text at the same time.
You can also copy text from the output window and paste it into other programs. When you highlight text with the mouse (click the left button at the starting location, drag the mouse with the left button still held, then release the mouse button at the end location) the screen is automatically frozen to prevent scrolling from disturbing your selection. When you release the mouse button, the text is automatically copied to the clipboard. You can select large portions of text (more that a screenful) by left clicking the start location, the left clicking while holding the Shift key at the end location. If you double-left-click, the word under the mouse is highlighted then copied to the clipboard. If you left-click in the narrow margin to the left of a line, the entire line will be selected.
Contents of the screen are stored to the clipboard in both plain ASCII text format and in color ANSI format. When you paste to an external program like Notepad, the plain text format is used. If you paste to the Command Editor the ANSI color format is used to preserve MUD colors. If you paste to the Command Line, plain text is used unless you have defined a color translation syntax in the color preferences in which case the ANSI color is converted to color commands for your MUD. If you paste more than one line of text into the command line, the line breaks are replaced with the command separator character (;).
User Interface Overview
zMUD provides many special features that enhance the user interface or that allow you to customize the user interface to your preference. In general, if you find something about the zMUD user interface annoying, there is usually a way to change it.
New Window Caption Buttons
On the caption bar of most zMUD windows are some new buttons. In addition to the standard Minimize, Maximize, and Close buttons, many windows also have Rollup/Rolldown and Stay-On-Top buttons. MUD Output windows and the main zMUD menu window also have a partial maximize button.
These buttons collapse the window so that just the window caption is shown (Rollup), or expands the window back to its normal size (Rolldown).
Stay On Top
When this button is clicked, the window is set to stay on top of other windows. This function is a toggle. When the Stay On Top function is active, the button appears depressed. Note that there are bugs in Windows when dealing with multiple StayOnTop windows.