Mav MUSH Client Help Page

Mav MUSH Client Help

System Requirements
Configuration
FAQ

System Requirements

Tcl/Tk 8.3 or better
~1 Megabyte free disk space for Mav. (an overestimate)

To run the client, go into the directory you unpacked it in, and run the mav script (usually, './mav'). It should load up fine from there.

Configuration

I've tried to make the configure windows as clear as possible, but some extra words to help you navigate can't hurt.

Window Configuration

Font: Controls the text window's font.
Scrollback: Controls how many lines of scrollback the window retains. Note that a long, wrapping line is still considered only one line of MU* text.
Word wrap: Turns word-wrap on and off. Effects both the output and input areas.
Echo input: Turns on or off a local client echo of the input you typed.
Enable ANSI Colors: If enabled, ANSI Color sequences sent by the MUSH will be followed.
Enable ANSI Flashing: If enabled, the ANSI Flash code will be followed.
Flash Rate: Milliseconds between flashing text switching states (visible, invisible).
Paste newline as %r: Will have any newlines in the input you're pasting converted to %r's. Useful if you're pasting word-wrapped text from an editor into the MU*.
Web browser: A command line to call up a web browser to a website; "%s" will be replaced with the URL to go to.

Worlds Configuration

The worlds configuration dialog should look farmiliar to anyone who's defined a world before in either another graphical client, or even in tinyfugue. Set the name (spaces allowed), host, port, etc and hit "update" to push it into the list of worlds. The delete button will clear a world's definition from the list, and the clear button will clear all the fields.

Your password will be displayed as '*'s so you can enter it safely with anyone looking over your shoulder.

The only two odd options are the "Connect Dark" and "Connect Hidden" options, which will replace the usual "connect <name> <pass>" with a "cd <name> <pass>" or "ch <name> <pass>" to allow you to connect-DARK or connect-HIDDEN by default. If you aren't able to use one of the special connects, these options won't have any effect.

Triggers Configuration

Configuring triggers is where Mav starts being complex. To understand the configuration panel, you need to have an understanding of regular expressions.

Every trigger must have a name, so it can be listed by the name. That's obvious. Every trigger also must have a regexp pattern that it will be matching against. These fields are not optional.

The "Substitution" field is there for doing regular expression substitutions. For instance, something like a channel highlight is implemented in this way. You'd insert text such as:

	^[[1m\\1^[[0m

To turn everything in the first set of matched parentheses in the regular expression bold (think perl-regexps). The "escape character" there (^[) is not typed as a usual escape character, but rather as a literal carat followed by open-bracket. Mav will translate the "^[" sequence into an escape. See this example of how to define a channel highlight.

The other field which should be farmiliar is the code to execute. The major difference here is that the code is entierly Tcl. You have access to many, many undocumented functions in the window in here. See the window.tcl file to see what functions you can call. Useful ones are shown in the picture to the right, implementing a tinyfugue edit. Notice how it sets the text variable to null -- this is what prevents the FugueEdit line from showing up in the output window. If you'd prefer to see it there, just delete that line.

Frequently Asked Questions

None yet!