Project

Profile

Help

Basics » History » Sprint/Milestone 6

Vincent Le Goff, 10/27/2016 02:29 AM

1 2 Vincent Le Goff
h1. CocoMUD basics
2 1 Vincent Le Goff
3 1 Vincent Le Goff
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.
4 1 Vincent Le Goff
5 1 Vincent Le Goff
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.
6 1 Vincent Le Goff
7 1 Vincent Le Goff
{{toc}}
8 1 Vincent Le Goff
9 1 Vincent Le Goff
h2. When opening CocoMUD
10 1 Vincent Le Goff
11 2 Vincent Le Goff
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]].
12 1 Vincent Le Goff
13 1 Vincent Le Goff
When you have selected the world to which to connect, press RETURN (or click on the *connect* button).
14 1 Vincent Le Goff
15 1 Vincent Le Goff
h2. The client's main window
16 1 Vincent Le Goff
17 5 Vincent Le Goff
CocoMUD client's main window is as simple as it can be.  There's only one text field, through which you can navigate using the arrow keys, select and copy text, move at the beginning of the end of the window, and so on.
18 1 Vincent Le Goff
19 5 Vincent Le Goff
If you start typing in this text field, the cursor is moved 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.
20 1 Vincent Le Goff
21 5 Vincent Le Goff
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 (you can read it with the arrow keys).  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.
22 1 Vincent Le Goff
23 1 Vincent Le Goff
h2. The command history
24 1 Vincent Le Goff
25 6 Vincent Le Goff
Whenever you press RETURN to send a command, it is added into the command history.  You can browse through the command history to see what has been send, send a command again or even modify a command you have entered.  There are two ways to use the command history:
26 6 Vincent Le Goff
27 6 Vincent Le Goff
* Using the CTRL + Up and Down arrow keys, you can browse through the command history.  If you press CTRL + up arrow key, you will be prompted with the command you entered previously.  You can press RETURN or modify this command at will.  Press CTRL + down arrow key to go down into your command history.
28 6 Vincent Le Goff
* Using the lock mode.  To enter into lock mode, press Escape.  You can now navigate through the history using the arrow keys.  You have to leave the lock mode to see the result of your commands, by pressing Escape again.
29 1 Vincent Le Goff
30 5 Vincent Le Goff
h2. Tab-completion
31 1 Vincent Le Goff
32 5 Vincent Le Goff
CocoMUD client supports tab-completion.  If you start typing a word, you can press tab and the client will try to finish it, based on what you have received during this session.  For instance, if you type "st" in the client, then press tab, the client will try to complete the word with what you have received.  Perhaps it will suggest "street" or "status".  Words that are more frequent will be suggested first.
33 1 Vincent Le Goff
34 5 Vincent Le Goff
When you press tab, the word will be written under the cursor.  You can continue typing or press RETURN to send the full command.  If you press tab again, the client will look for another possibility beginning with the same letters you had initially entered.  You can press tab as many times as you want, the client will write suggestions from most frequent to less frequent.  If the client can't find anything, it will just enter your initial letters and you'll have to type the rest of the word.
35 1 Vincent Le Goff
36 1 Vincent Le Goff
h2. The menu bar
37 1 Vincent Le Goff
38 1 Vincent Le Goff
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.
39 1 Vincent Le Goff
40 1 Vincent Le Goff
h2. The preferences
41 2 Vincent Le Goff
42 1 Vincent Le Goff
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.
43 1 Vincent Le Goff
44 4 Vincent Le Goff
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.
45 4 Vincent Le Goff
46 4 Vincent Le Goff
In the *accessibility* tab are several options that affect accessibility.  Here they are, in more details:
47 4 Vincent Le Goff
48 4 Vincent Le Goff
* 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.
49 4 Vincent Le Goff
* 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.
50 1 Vincent Le Goff
51 1 Vincent Le Goff
h2. Adding a world
52 1 Vincent Le Goff
53 1 Vincent Le Goff
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:
54 1 Vincent Le Goff
55 1 Vincent Le Goff
* 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.
56 1 Vincent Le Goff
* The server's hostname.
57 1 Vincent Le Goff
* The server's port number.
58 1 Vincent Le Goff
59 1 Vincent Le Goff
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.
60 1 Vincent Le Goff
61 1 Vincent Le Goff
Once you have created a new world, it will appear in the world list and you will be able to connect to it.