Basics » History » Revision 5
Revision 4 (Vincent Le Goff, 10/15/2016 12:24 AM) → Revision 5/9 (Vincent Le Goff, 10/26/2016 02:57 AM)
h1. CocoMUD basics CocoMUD is a "MUD client":https://en.wikipedia.org/wiki/MUD_client specifically designed to enhance accessibility with screen readers. It supports a native TTS (Text-to-Speech) for most common screen readers on Windows, as well as Braille. This document aims at explaining the basic features of CocoMUD client in a practical way, to tell you what you can do with it and how to do it. More complex features will have a document of their own. {{toc}} h2. When opening CocoMUD When opening CocoMUD, it should display a list of configured servers (or worlds, in MUD client terminology). It's a list, you can select another world by pressing the arrow keys or move more quickly by typing the first letters of a server. It's possible that the server you would like to connect to doesn't appear in the list: you may need to [[#Adding-a-world|add it before going on]]. When you have selected the world to which to connect, press RETURN (or click on the *connect* button). h2. The client's main window CocoMUD client's main window is as simple as it divided into two: on top is an input field where you can be. enter commands. There's only one Below it, taking most of the screen, is the output field (where you see the results of your commands). It's a read-only text field, through which so you can navigate using browse through it with the arrow keys, PageUp and Down, select and copy text, move at go back to the beginning of or the end of the window, end, and so on. To navigate between these two areas, just press Tab. The cursor should move between the input field and the output field. If you start begin typing in this text the output field, the cursor is moved will go back to the last line. Consider this text field like a read-only area, except for the last line. You can type your command as usual and press RETURN to send it. You can then arrow up to see the result of your command (and up again to see previous messages). This should be quite straightforward after just a minute or so. input field. When you press RETURN on a world, CocoMUD tries to connect to the server. If everything goes well, the client connects and the welcome message of the server is displayed in the output field (you can read it with the arrow keys). press Tab to see it). The welcome message should also be sent to the screen reader (and, if you have a Braille display, you should see it there as well). Most MUD servers will ask for your username and password. If you're asked for your password, CocoMUD automatically hides what you're typing and it won't appear in the [[#The-command-history|command history]] either. h2. The command history This feature is not available for When you are in the time being. h2. Tab-completion CocoMUD client supports tab-completion. If input field (where you start typing a word, can type commands), you can press tab use the up and down arrow keys to move through the client command history. The command history is fed each time you type a command (except for passwords, that will try to finish it, based on what you have received during this session. not appear there). For instance, if If you type "st" in the client, then press tab, the client up arrow key, you will try to complete see the word with what command you have received. sent previously. Perhaps it Up again will suggest "street" or "status". Words that are more frequent will be suggested first. When show you press tab, the word will be written under the cursor. previous command, and so on. You can continue typing or press RETURN at any time to send the full command. command again. When you navigate into the command history, you might notice something a bit unsettling: when you go up and down, then press RETURN, the cursor is not moved back to the end of the history. The input field will be cleared (so you can type another command), but if you move up and down again, you will see the commands directly surrounding the previous command you just typed. Let's take an example, with a history that looks like this: <pre> inventory look into bag wield sword </pre> If you press tab again, twice on the client up arrow key, you will look for another possibility beginning be prompted with the same letters "look into bag" command. If you had initially entered. You can press tab as many times as you want, RETURN at this point, the client command will write suggestions from most frequent be sent to less frequent. the MUD again. If you then press the client can't find anything, it down arrow key, you will just enter your initial letters and you'll be prompted with the "wield sword" command. This mechanism is very useful when you have to type the rest of the word. retype several commands, but it might be disconcerting when unaware. h2. The menu bar Some options are accessible through the menu bar. In File -> Preferences, you will see some settings that you can modify to have your experience with CocoMUD more comfortable. h2. The preferences When you select File -> Preferences in the menu bar, or press _Alt + Enter_, you should see a dialog with several tabs. The first tab (selected by default) is *general*. It only contains the language selection for the time being. CocoMUD should be in the language of your system, if it is translated in this language. Otherwise, English should be selected. In the *display* tab, you can select a different encoding. By default, CocoMUD is set to use a Latin encoding, but you can change it. If you connect to only-English MUDs, you may not need this setting. In the *accessibility* tab are several options that affect accessibility. Here they are, in more details: * Go to the end of output when pressing Tab: by default, when you press Tab in the input field, CocoMUD will put the cursor at the end of the output field. This is not always comfortable and can be disabled here. * Add a new line at the end of the output: when a message is received from a server, a new line will be added at the end, which is often expected, but can be disabled if it slows you down. * Enable the smart cursor: the smart cursor is a special CocoMUD feature. When you are in the output field and press letters, you are automatically moved to the entry field. If the smart cursor is enabled, when you press RETURN after typing your command, you are moved back to the output field. You will find more details in [[#The-smart-cursor|the smart cursor section]]. * Enable TTS (Text-to-Speech): you can here disable the TTS (Text-to-Speech). The TTS is what sends the content of the output field to your screen reader. Sometimes, it's really not necessary, and you can turn it off. * Enable TTS on a different window: by default, CocoMUD client enables its TTS even if you're not currently in the CocoMUD application. It means that, you can be reading a web page, or a book, or sending an email, and suddenly your screen reader starts on the messages you have received on the MUD. As this can be useful, this can sometimes be annoying, so you can turn this option off to let TTS only speak when you are in the CocoMUD client. h2. The smart cursor The smart cursor is a feature designed to decrease the number of times you will have to press the tab key. When you have logged into a server, entered your username and password if required, you can tab as usual to move in the output field. From there, however, if you begin typing, the cursor will move back into the entry field. When you press RETURN to send the command, the cursor is moved back in the output field. When you have enabled the feature to automatically go at the end of the output when pressing tab, instead of coming back to the place where the cursor was when you started typing in the output field, the smart cursor moves to the end of the window. This occurs before the server replies, however, so you might see the result of the command you just typed very quickly, and won't be exactly on the last line of the output. h2. Adding a world If you want to add a new world, in the world selection (when the client opens), select the *add* button. You will be asked three information: * The world's name: what name should the world be given? Most likely, you will use the MUD's name, like Alter Aeon or T2T. * The server's hostname. * The server's port number. The name, hostname and port number can be changed if needed. Notice, however, that the name is used to determine the location. This will be a directory created for the world in which settings are stored. If you change the name, the location won't be changed. Once you have created a new world, it will appear in the world list and you will be able to connect to it.
.