WebMU

WebMU is a HTML5 based client for online roleplaying games such as TinyMUX, TinyMUSH, and PennMUSH.

Some features:

  • ANSI Color
  • 256 Xterm colors (known as COLOR256 on MUX)
  • Logging
  • Unicode characters
  • Window size reporting via NAWS
  • Text highlighting
  • Text splitting into a secondary window
  • Unlimited input tabs/windows.

What is a MUX/MUSH/MU*

A MUSH, or MUX, is a text-based online roleplaying game, which is focused on cooperative storytelling and narration. A MUD is a similar type of game, but is focused on combat and automated 'games'.

WebMU is primarily intended to be used with MUSHes or MUXes, but can be used to play either sort of game.

You can read a more in depth guide on MUSHes and how to play on them at mu-gateway.net

Getting more help

If you have questions, feature requests, or need to get in touch with me for some other reason, I can be reached through the support forum for WebMU, located at http://www.cheesesoftware.com/forum/

A note on privacy

WebMU optionally saves passwords and logged output in a database. It also acts as a 'proxy', sitting between your browser and the remote game server. This allows WebMU to traverse most firewalls and filtering proxy servers.
However, it also means that everything you type and everything you see passes through the WebMU proxy.
I pledge not to look at any of this data or 'snoop' on your gaming unless I have a credible report that the WebMU service is being used for hacking or harassment.
I take privacy very seriously, but if you do not trust me to keep my promise, you should not use WebMU.

WebMU's main window

Main Window

The menu and tab bars, on the top, are used to change settings, open new game connections, and change which connection is the active one - that is, which is on your screen.

The output window, on the left, displays the game server's output.
By default, the main window will pause at each screenfull of text. You can view the next screenfull by pushing the tab key on your keyboard.
You can disable this behavior in the 'View' -> 'Customize...' dialog.

The 'splitter window' on the right displays any text that matches your 'Output split patterns".

The input window, along the bottom, is where you type your commands.

WebMU's input window

Main Window

The input window is where you type your commands to the game server

You can create new tabs by clicking on the small '+' icon on the right side of the input tab list.
This is helpful when you are in the middle of typing up a long command, but need to quickly run a shorter command without losing your progress.

Each input tab saves a command history - you can recall previously entered commands by pushing the up and down arrows on your keyboard.

Making a new connection

New world screen

Access the new world dialog by clicking on 'World' and then 'New...' from the menu bar.

The Name is any descriptive name - it will be shown on the tab bar later.

The host and port are the connection details of the game you would like to connect to. They will be in the form of a hostname (www.example.com) and a port (1234)

The 'login command' is text that will be automatically sent to the game server when you connect. For the MUSH type, you can enter 'connect charname password'. You can also leave this blank.
A note on privacy: this information is saved on WebMU's servers in a database. Please do not save any data in WebMU that you need to keep secured. In particular, please do not use passwords that you have used anywhere else.

The output split patterns are a set of wildcard matched strings. Any line of game output that matches one of these patterns will not appear in the main window - it will appear in the output splitter window instead.
A '*' will match any sequence of characters. A '?' will match a single character.

Open tab a startup - if you check this, this connection will be automatically opened whenever you visit WebMU.

The Address Book

Access the new address book by clicking on 'World' and then 'Address Book...' from the menu bar.

The Address book allows you to reconnect to worlds you have saved on WebMU. You must have a WebMU account to use the address book.

The 'Del' button will permanently delete a world from the list.

The 'Edit' button will allow you to make changes to the world's entry in the address book.

To reconnect to a world, simply click on the name or the connection details on the right.

The Connection Menu

Access the new address book by clicking on 'Connection' on the menu bar.

'Reconnect' will attempt to reestablish the connection to the game server.

'Disconnect' will disconnect the connection to the game server without closing the world's tab.
On MUSHes or MUXes, you can also disconnect by typing 'QUIT' in all capitals.

Logging

Access the Logging functions by clicking on 'Logging' on the menu bar.

'Start Log...' will begin logging (that is, recording) game output. Enter a descriptive log title.
This output will be saved on WebMU's server, due to limitations on how web applications may access your hard drive.

'Retrieve Logs...' will open a dialog from which you may delete, download, or view your saved logs.

'Stop Log' will cease logging.

Please note that you must be logged into a WebMU account to make use of the logging functions.

Customizing the display

Main Window

Access the Customization dialog by clicking on 'View' and then 'Customize...' from the menu bar.

From this window you can select your preferred text font and size, as well as text colors and background colors.

'Highlight patterns' will cause any matched text to have the background and foreground colors specified.
It's helpful for making game output you don't want to miss more obvious.
A '*' will match any sequence of characters. A '?' will match a single character.

'Scroll output one page at a time' controls the main window's scrolling behavior. When checked, text will pause whenever a screenfull is displayed without any input from you. When unchecked, output will scroll freely.

If you have a WebMU account, these settings will be saved for the next time you visit WebMU.

A note for MU* admins

On your game's web site, or when placing advertisments on other games or forums, consider including a customized link to WebMU.

A link like this:
http://www.cheesesoftware.com/MUCon?Host=example.com:2009

will connect anyone who clicks on it directly to your game, from the web browser.

a link like this:
http://localhost:8000/MUCon?Host=example.com:2009&Connectstring=connect%20guest%20guest

will connect and also log in to a guest account.