Project

Profile

Help

Basics » History » Sprint/Milestone 1

Vincent Le Goff, 10/04/2016 01:57 AM

1 1 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 1 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 entering 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 1 Vincent Le Goff
CocoMUD client's main window is divided into two:  on top is an input field where you can enter commands.  At the bottom, taking most of the screen, is the output field (where you see the results of your commands).  It's a read-only text field, so you can browse through it with the arrows, PageUp and Down, select and copy text, go back to the beginning or the end, and so on.
18 1 Vincent Le Goff
19 1 Vincent Le Goff
To navigate between these two areas, just press Tab.  The cursor should move between the input field and the output field.  If you begin typing in the output field, the cursor will go back to the input field.
20 1 Vincent Le Goff
21 1 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 in the output field (you can 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.
22 1 Vincent Le Goff
23 1 Vincent Le Goff
h2. The command history
24 1 Vincent Le Goff
25 1 Vincent Le Goff
When you are in the input field (where you can type commands), you can use the up and down arrow keys to move through the command history.  The command history is fed each time you type a command (except for passwords, that will not appear there).  If you press the up arrow, you will see the command you have sent previously.  Up again will show you the previous command, and so on.  You can press RETURN at any time to send the command again.
26 1 Vincent Le Goff
27 1 Vincent Le Goff
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.
28 1 Vincent Le Goff
29 1 Vincent Le Goff
Let's take an example, with a history that looks like this:
30 1 Vincent Le Goff
31 1 Vincent Le Goff
<pre>
32 1 Vincent Le Goff
inventory
33 1 Vincent Le Goff
look into bag
34 1 Vincent Le Goff
wield sword
35 1 Vincent Le Goff
</pre>
36 1 Vincent Le Goff
37 1 Vincent Le Goff
If you press twice on the up arrow, you will be prompted with the "look into bag" command.  If you press RETURN at this point, the command will be sent to the MUD again.  If you then press the down arrow key, you will be prompted with the "wield" sword command.  This mechanism is very useful when you have to retype several commands, but it might be disconcerting when unaware.
38 1 Vincent Le Goff
39 1 Vincent Le Goff
h2. The menu bar
40 1 Vincent Le Goff
41 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.
42 1 Vincent Le Goff
43 1 Vincent Le Goff
h2. The preferences
44 1 Vincent Le Goff
45 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.
46 1 Vincent Le Goff
47 1 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.
48 1 Vincent Le Goff
49 1 Vincent Le Goff
In the "accessibility" tab are several options that affect accessibility.  Here they are, in more details:
50 1 Vincent Le Goff
51 1 Vincent Le Goff
* 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.
52 1 Vincent Le Goff
* 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.
53 1 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.
54 1 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.
55 1 Vincent Le Goff
56 1 Vincent Le Goff
h2. Adding a world
57 1 Vincent Le Goff
58 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:
59 1 Vincent Le Goff
60 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.
61 1 Vincent Le Goff
* The server's hostname.
62 1 Vincent Le Goff
* The server's port number.
63 1 Vincent Le Goff
64 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.
65 1 Vincent Le Goff
66 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.