Mushclient Accessibility

From Epitaph Player Wiki
Jump to: navigation, search

Introduction

This page aims to be a brief guide to getting mushclient configured for best accessibility while playing Epitaph. We'll start out by showing you how to configure Mmushclient to have text automatically read out by your screen reader, if you haven't already done this. We'll then recommend some other mushclient plugins that will improve your accessibility experience, and show you how to install and configure them. Lastly, we'll show you some sample triggers that you may find useful.

Getting Mushclient

If you don't already have it, you will need to download and install the Mushclient software on to your computer. You can get the latest version of Mushclient at: http://mushclient.com/downloads/dlmushclient.htm

The installer-free version is strongly recommended. Just unzip it into a folder on your hard drive, and run mushclient.exe whenever you want to start the program. This way, it will be easy to add new plugins, and you will have a fully portable version of Mushclient that you can easily move from one computer to another.

Configuring Mushclient For Your Screen Reader

The first step is to get Mushclient to send all text from the mud to your screen reader, to be read outloud. Currently Jaws, NVDA, Window-Eyes, and System Access are supported.

First, download the mushreader plugin from: http://www.allinaccess.com/mc/mushReader.zip

Unzip this file, and place the XML file in your mushclient directory, under plugins, under worlds. Then, place the included DLL file in the top-level of your mushclient directory (along with mushclient.exe and the other files and folders there).

Second, run mushclient.exe. Once you're in the main window, go to the menu bar, open the file menu, and select global options. Press control+tab until you get to the "plugins" screen. Press add, navigate to the mushreader.xml file that you placed in your mushclient directory, under worlds, under plugins, and select it. Then press OK to close the global options dialogue.

Capturing Text for Review

While Mushclient is now ready to send mud output directly to your screen reader, it is still difficult to review text that the mud sent previously. Fortunately, a plugin called Output Functions exists to fix this problem. You can download it from: https://dl.dropboxusercontent.com/u/18413495/output_functions.xml

Once again, save this XML file under mushclient, worlds, plugins.

As previously, run mushclient, select global options under the file menu, control+tab to the plugins page, and press add. Select the output_functions.xml file, and then press OK to close the global options dialogue.

This plugin makes several new functions available to you:

  • press control 1 through control 0 to review the last 10 lines of output.
  • press control shift u to hear the previous line of output, control shift i to hear the current line of output, and control shift o to hear the next line of output.
  • Press control shift y to move to the first line of output, and control shift n to move to the last line of output.
  • Press any of the above keys twice quickly to copy the text to the clipboard, instead of speaking it.
  • press control alt o to begin saving all mud output to a new window. You can then press control tab to cycle between the main epitaph window, and the log window to review mud output.
  • press control shift s to save a snapshot of all current mud output to a new window.

Creating The Epitaph World

Now that basic accessibility for Mushclient has been configured, it's time to configure mushclient to connect to Epitaph. First, press control n to create a new world. When mushclient asks you if you would like to load world defaults from an existing world, say no. You will now be placed into a large settings dialogue, with many sections. You can change sections by using the tree view, and tab through each section to enter values.

The following settings are strongly recommended:

In the IP address section:

  • Enter Epitaph under world name
  • Enter epitaphonline.co.uk under TCP/IP address
  • Enter 6789 under port number
  • Check the box that says "save world automatically on close"

In the connecting section:

  • Enter your Epitaph name under name
  • Enter your Epitaph password under password
  • Set the connect combobox to the option DIKU-Style ( name, password )

In the output section, under appearance:

  • Uncheck the "show line information checkbox
  • Check the box that says "convert IAC EOR/GA to new line"

In the MXP/Pueblo section, under appearance:

  • Set the "use MXP/Pueblo" combobox to "No - Never"

Once the configuration dialogue has been filled out, press the OK button to close it. Then, press control s to save the world you just created. I recommend placing it in your mushclient directory, under worlds.

Next time you want to connect to epitaph, open mushclient, press control o, and find the world file you saved.

Creating Seperat Review Buffers for the Radio

The following steps are optional. They are intended to demonstrate adding new plugins to your Epitaph world, creating triggers, and playing sounds on events.

If you want to review just messages sent over the radio, instead of all mud output, this is how to do it. We'll be using a handy plugin called channel history. Download it from: https://dl.dropboxusercontent.com/u/18413495/channel_history.xml

As usual, save that XML file to mushclient, world, plugins.

First, we need to add this plugin to Epitaph. When you're connected to epitaph, press control shift p. Press the add button, and select the channel_history.xml file you just saved. Then, press the close button to exit the plugins dialogue.

This plugin has created a new alias for us, called history_add, that can be called with the syntax:

history_add category=message

When the alias has been called several times, you can use alt left arrow and alt right arrow to move left and right between categories, and alt 1 through alt 0 to read the last ten messages placed into each category.

Our job is going to be to create triggers that will sort mud output into categories for us. An example of doing this for the radio follows.

First, press control shift 8 to open the triggers dialogue, and tab to the add button. Once the edit trigger dialogue is open:

  • In the edit trigger dialogue, under trigger, enter the following: (* MHz) *: *
  • under send, enter this: history_add %1=%2: %3
  • Change the send to combo box to execute.
  • If you want to hear a sound every time someone says something on the radio, tab to the browse button under sound, and select one. If you want the sound I use, you can get it at: https://dl.dropboxusercontent.com/u/18413495/short.wav
  • Press OK to close the edit trigger dialogue, then press close to close the triggers dialogue.
  • When connected to Epitaph, type: cols 999
  • Press alt enter to open the options dialogue, and select output.
  • Uncheck the "wrap lines at" checkbox
  • Uncheck the "negotiate about window size" checkbox

If you want to test the trigger you created, you can use the frimble command, like so:

frimble (1240 MHz) Evariste: OK, thanks.

Conclusion

Between the channel history plugin, triggers, and sounds, you now have all of the tools you need to customize your Epitaph play experience however you want! Have fun! If you create any other useful triggers, feel free to add them to the Epitaph Wiki for the education of other players.