Latest revision as of 13:40, 1 October 2017

Welcome to the MTScripts Cyber Assault Soundpack!

Introduction

This page documents the basic functionality of the Cyber Assault Soundpack that is part of the MTScripts installation, an add-on to the Monkey Term mud client.

What is Cyber Assault?

Cyber Assault is an online mud (multi user dungeon) style text based game. See their own wiki for more

What is a mud client?

To play mud games, you need a mud client, like Monkey Term, Vip Mud, Mush Client, ZMud and there are a large number of other options. While muds are generally text based, sometimes a player or group of players of a mud may want to improve the experience. One way to do that is by creating a soundpack. This allows the mud client to be able to play sounds when specific text from the mud appears, and optionally change or hide that text, perhaps to reduce spam (a term mud players use to indicate a large amount of text coming in quickly enough to make it difficult or impossible to keep up reading it all. Some players of Cyber Assault have generated a soundpack for the Monkey Term mud client. That soundpack is delivered as part of the MTScripts package, an add-on that gives several soundpacks to Monkey Term users. This page is the documentation for the Cyber Assault soundpack.

Loading and connecting to the mud

Open Monkey Term. If you are presented with the recent sessions list, close it first. If you want the keyboard shortcut for that, alt+f4 should do it.
Bring up the open dialogue, either by clicking the file menu, then open or by pressing ctrl+o.
browse to your Monkey Term installation directory, which if you follow the suggestions in the MTScripts download pages and installer prompts, is in your user's documents folder.
browse to the files directory
find Cyber Assault.xml and, with it selected hit open or press enter.

Configuration (config) options explained

Basic Options

speech: speak incoming text? Currently enabled

This item allows you to turn automatic speech output off. The default assumption here is that you want it. Typing cfg speech disables it. Note that if you don't use a screen reader, your computer's built in SAPI speech will read out the text, so you may desire to turn it off because most likely it'll just be a distraction.
Hotkey ctrl+shift+s does this.

kcmd, keep Text in the input box after you press enter so you can hit enter to send again? currently disabled

When you type a command for the mud and hit enter to send, by default the text vanishes from the input edit field. This option allows you to change that so it remains in place, but is highlighted (selected). This would enable you to:

repeat the command, hit enter again to send the same text to the mud again
replace the command, , just start typing another command with the edit field still highlighted. The text from the previous command vanishes and what you are typing shows up as expected.
edit the command, move your input carrot to somewhere in the text, which unselects it, and modify it to your liking and hit enter to send the edited version.

Hotkey f11 does this.

ali: set up automatic logging in currently not configured

This option allows the soundpack to quickly log your character in immediately upon loading of the session. To disable it, type
cfg ali
to enable it, type
cfg ali name password
where name is the character's name and password is your password. Note the password is stored in plain text in the xml, not encrypted in any way shape or form. If you have security concerns about this, don't use auto login.

history: Store channel sends in the history buffer? enabled

This option toggles whether things you and other players say on channels like gossip, say, tell are stored in the history buffer. To toggle it between on and off, type
cfg his

echo: turn on command echo so you can up arrow through previous commands? enabled

This option toggles whether your commands are echoed back to you. When on, commands you type are

stored in the input edit field, so you can up arrow to prior commands then edit them as needed and press enter to send again
the commands appear interspersed among the text being outputted from the mud

This may be undesirable. Especially for blind folks who find arrowing past all the input commands on the way up or down the screen in search of some output message. This is on by default, to toggle it, type
cfg echo

reset: reset the xml to distribution default settings

Resets every configuration (config)option and several extra options not here present, such as the sound volume levels, to the default they were on when you opened the session for the first time.

Text hiding, truncating and verbosity

Soundpack settings

automation

hotkeys

Generic hotkeys

Clear the input box and interrupt all incoming speech escape

Interrupts any supported screen reader or SAPI speech, and clears the input window. Handy if you make a mistake while typing something and just want to start over.

Toggle keep command text (kcmd) on or off f11)

See the section #kcmd, keep Text in the input box after you press enter so you can hit enter to send again? currently disabled of the config command for an explanation of what this is. f11 is a shortcut key to toggle the same thing.

sounds

increase volume (f3)

Makes the general sounds louder

decrease volume (f2)

makes the general sounds softer

increase engine volume (shift+f3)

makes the sounds of engines for vehicles louder

decrease engine volume (shift+f2)

makes the sounds of engines for vehicles softer

speech output

Toggle main speech output (shift+ctrl+s)

The main speech output is what is used by default to read aloud all text that comes back from the mud. If you're blind or low vision and you use a screen reader, this is quite handy. The session will try to make your screen reader do the talking. If no supported screen reader can be detected, the built in windows SAPI speech function will be used instead. The voice used by SAPI can be assigned as described below.

next SAPI adjustment option (ctrl+plus)

Cycles to the next adjustable SAPI option. If you reach the end with this, it starts over. The options are voice, rate, and volume. See the below sections on increasing and decreasing current SAPI options values for more.

previous SAPI adjustment option (ctrl+minus)

Cycles to the previous adjustable SAPI option. If you reach the end with this, it starts over. The options are volume, rate, and voice. See the below sections on increasing and decreasing current SAPI options values for more.

increase current SAPi option's value (shift+ctrl+plus)

Increases the value of the current SAPi adjustment option, see the two sections about that above.

voice: selects the next SAPi voice
rate: increases the SAPi rate by 5 percent
volume: increases the SAPI volume by 5 percent

decrease current SAPi option's value (shift+ctrl+minus)

Decreases the value of the current SAPi adjustment option, see the two sections about that above.

voice: selects the previous SAPi voice
rate: decreases the SAPi rate by 5 percent
volume: decreases the SAPI volume by 5 percent

History Buffer

The history buffer is a stored list of what probably will be channel sends for later reviewing using a provided set of key combinations. It is possible to add what ever you want to it, but the most common method for getting things stored there is the channel history function, which you can toggle with the config his command. When this is on, supported channels will be represented in the history buffer. This is handy for a quick way to review what has been said by other players when there might be too much incoming text to be able to properly keep up with all the socialization going on. Note too that if you don't use a screen reader or you have speech output toggled off for one reason or another, the below listed keystrokes for reviewing the history buffer do still speak. If you use them while you haven't a supported screen reader running, this'll still speak, using your computer's built in SAPi function.
Note that the first time you use any of the below keystrokes you'll hear an ascending tone. This indicates that the buffer wasn't remembering a prior position to start from, so will now start at the most recent buffer item. Afterward, it will remember the position for about 1 minute after the last buffer reviewing command, then you'll hear a descending tone indicating that it has reset, and next time you press a buffer reviewing key it will begin at the most recent item again.
Channel history is not enabled by default, config his will toggle it.

Previous buffer item ctrl+comma

Move to and read the previous message.

Next buffer item ctrl+slash

move to and read the next message

repeat current buffer item ctrl+period

announces the current buffer item again

first buffer item ctrl+shift+comma

move to and read the first, (oldest), item in the buffer

last buffer item ctrl+shift+slash

move to and read the last, (newest), item in the buffer.

Spell current buffer item ctrl+apostrophe

Spells the current item in the buffer character by character. Might be handy for learning the name of someone who is sending you tells or similar.

Queerying information

Report your health and that of your enemy (if any) ctrl+grave accent (`)

Speaks the condition of your opponent (if any), and then reports the number of health points and the percentage of your max health points you have.

Report your psi ctrl+shift+p

Speaks the number of psionic points you currently have.

Report your vitality ctrl+shift+v

Speaks the number of vitality points you currently have.

Report your resource units shift+ctrl+u

Speaks the number of resource units (ru) you currently have.

Report your quest points shift+ctrl+q

Speaks the number of quest points (qp) you currently have.

Report your ammunition shift+ctrl+m

Speaks the number of ammunition rounds you currently have, provided you're using a weapon that uses ammunition.

@@ Line 1: / Line 1: @@
-Cyber Assault.xml
+<strong>Welcome to the MTScripts Cyber Assault Soundpack!</strong>
-This help file currently applies to: MTScripts 3.7.9.7
+=Introduction=
+This page documents the basic functionality of the [http://cyberassault.org Cyber Assault] Soundpack that is part of the [http://valiant8086.com/games/muds/monkeyterm/mtscripts MTScripts] installation, an add-on to the [http://valiant8086.com/games/muds/monkeyterm Monkey Term] [http://www.mudconnect.com/mud_intro.html mud] client.
-=How to open Cyber Assault.xml?=
+=What is Cyber Assault?=
-Open Monkey Term and close the recent sessions list if it appears with alt+f4. press ctrl+o to get the open dialogue. Browse using common browse techniques to c:\program files\monkeyTerm\Cyber Assault.xml and open it.
+Cyber Assault is an online mud (multi user dungeon) style text based game. See [http://cyberassault.wikia.com/wiki/CyberASSAULT_Wiki their own wiki for more]
-=What are some initial setup configurations one should make to get this xml to work best?=
+=What is a mud client?=
-==Select desired speech output==
+To play mud games, you need a mud client, like Monkey Term, Vip Mud, Mush Client, ZMud and there are a large number of other options. While muds are generally text based, sometimes a player or group of players of a mud may want to improve the experience. One way to do that is by creating a soundpack. This allows the mud client to be able to play sounds when specific text from the mud appears, and optionally change or hide that text, perhaps to reduce spam (a term mud players use to indicate a large amount of text coming in quickly enough to make it difficult or impossible to keep up reading it all. Some players of Cyber Assault have generated a soundpack for the Monkey Term mud client. That soundpack is delivered as part of the [http://valiant8086.com/games/muds/monkeyterm/mtscripts MTScripts] package, an add-on that gives several soundpacks to Monkey Term users. This page is the documentation for the Cyber Assault soundpack.
-Press ctrl+f2 to cycle between the speech settings. By default speech is set to sapi5. If you are a JAWS or Window-eyes user press this until it says "JAWS or Window-Eyes". Speech can be turned completely off using this key as well. If you lose automatic speech at any point try hitting ctrl+f2 to see if it comes back on.
-==Change the configuration to suit==
+=Loading and connecting to the mud=
-The config, (cfg for short), command allows users to modify some of the functionality of the xml. This section should explain how to take advantage of the config command.
+#Open Monkey Term. If you are presented with the recent sessions list, close it first. If you want the keyboard shortcut for that, alt+f4 should do it.
-===The config list===
+#Bring up the open dialogue, either by clicking the file menu, then open or by pressing ctrl+o.
-Just typing config and pressing enter displays a lot of information. Displayed is all that can be adjusted by using arguments when a user enters the config command. Let's call this the config list. Remember that cfg works as well. We will put each option that is available there below and include a description.
+#browse to your Monkey Term installation directory, which if you follow the suggestions in the MTScripts download pages and installer prompts, is in your user's documents folder.
-====Basic options:====
+#browse to the files directory
-=====ali: set up automatic logging in currently not configured=====
+#find Cyber Assault.xml and, with it selected hit open or press enter.
-Use this option to configure automatic character name and password entry when a connection to Cyber Assault is initially established. It will type the user name, then the password and stop there. The user will still have to press return to continue and then press 1 to actually log in, unless they were llinkDead. If The user has security concerns I discourage the use of this feature since the password is stored in a very easy to access variable, which can be viewed either from the Client itself or by opening the xml file in another program such as internet explorer or notepad.
-Syntax: cfg ali user pass
+=Configuration (config) options explained=
+==Basic Options==
+===speech: speak incoming text? Currently enabled===
+This item allows you to turn automatic speech output off. The default assumption here is that you want it. Typing cfg speech disables it. Note that if you don't use a screen reader, your computer's built in SAPI speech will read out the text, so you may desire to turn it off because most likely it'll just be a distraction.
+<br/><strong>Hotkey ctrl+shift+s does this.</strong>
-syntax: config auto login mathayas mypassword
+===kcmd, keep Text in the input box after you press enter so you can hit enter to send again? currently disabled===
+When you type a command for the mud and hit enter to send, by default the text vanishes from the input edit field. This option allows you to change that so it remains in place, but is highlighted (selected). This would enable you to:
+#repeat the command, hit enter again to send the same text to the mud again
+#replace the command, , just start typing another command with the edit field still highlighted. The text from the previous command vanishes and what you are typing shows up as expected.
+#edit the command, move your input carrot to somewhere in the text, which unselects it, and modify it to your liking and hit enter to send the edited version.
+<br/><strong>Hotkey f11 does this.</strong>
-=====reset: reset the xml to distribution default settings=====
+===ali: set up automatic logging in currently not configured===
-This deletes the auto login information, resets speech and sounds along with some of the truncations back to default settings, and ensures the soundpack is turned on. I use this command when I am about to package a new version of the soundpack to make sure when users run the xml it behaves with it's default functionality, plus that it doesn't log them into my character.
+This option allows the soundpack to quickly log your character in immediately upon loading of the session. To disable it, type
+<br/>cfg ali
+<br/>to enable it, type
+<br/>cfg ali name password
+<br/>where name is the character's name and password is your password. Note the password is stored in plain text in the xml, not encrypted in any way shape or form. If you have security concerns about this, don't use auto login.
-syntax: cfg reset
+===history: Store channel sends in the history buffer? enabled===
+This option toggles whether things you and other players say on channels like gossip, say, tell are stored in the history buffer. To toggle it between on and off, type
+<br/>cfg his
-====Text hiding, truncating and verbocity:====
+===echo: turn on command echo so you can up arrow through previous commands? enabled===
-=====numbers: Truncate numbers? enabled=====
+This option toggles whether your commands are echoed back to you. When on, commands you type are
-This turns a substitute who's function is to truncate any number longer than 3 digits encountered on or off. If on, any number that is longer than 3digits will be truncated to a form like 3k, 55k, 181k, 9m, 98m, 981m, 8.4bil. k means thousand, m means million and bil of course means billion. It might be necessary to disable this if a user is trying to work with gold or get an email address with a 4 or more  digit sequence of numbers in it or something like that.
+#stored in the input edit field, so you can up arrow to prior commands then edit them as needed and press enter to send again
-tip: This can be more easily toggled with ctrl+f3.
+#the commands appear interspersed among the text being outputted from the mud
+This may be undesirable. Especially for blind folks who find arrowing past all the input commands on the way up or down the screen in search of some output message. This is on by default, to toggle it, type
+<br/>cfg echo
-syntax: cfg numbers
+===reset: reset the xml to distribution default settings===
+Resets every configuration (config)option and several extra options not here present, such as the sound volume levels, to the default they were on when you opened the session for the first time.
-=====exits: Truncate exits and put them before room description? enabled=====
-This toggles a substitute who's function it is to truncate exits on or off and cause exits to appear before room descriptions instead of after. When on, this substitute causes the exits to appear before the room name and description as a user walks about. It also will remove some of the characters and the word exits: from around the list of exits, making it easier to listen to with a screen reader..
-syntax: cfg exits
+==Text hiding, truncating and verbosity==
-====Soundpack settings:====
+==Soundpack settings==
-=====sounds: use the soundpack? enabled=====
-This will toggle the soundpack on and off. It will not toggle any important sounds. these are sounds that indicate channels mostly. Disabling these sounds would brake other functionality elsewhere in the xml or at least make it unreliable depending on whether the soundpack were on and off. When the soundpack is turned on, all of the sound support will be used. Many things will be truncated, especially handy for screen reader users who could always use less to have to listen to.
-syntax; cfg sounds
-====automation====
+==automation==
-=====auto reload: set up automatic reloading currently set to clip, located in duf=====
+=hotkeys=
-Set whether automatic reloading is done when a weapon runs out of amunition. To turn off just type cfg reload. to turn on, type something like cfg reload clip duf. This says the amunition is called clip, and the container is called duff, which in my case is short for a duffel. In the case of this example it would type get clip duf, followed by typing load of course.
+==Generic hotkeys==
+===Clear the input box and interrupt all incoming speech escape===
+Interrupts any supported screen reader or SAPI speech, and clears the input window. Handy if you make a mistake while typing something and just want to start over.
+===Toggle keep command text (kcmd) on or off f11)===
+See the section [[#kcmd, keep Text in the input box after you press enter so you can hit enter to send again? currently disabled]] of the config command for an explanation of what this is. f11 is a shortcut key to toggle the same thing.
+==sounds==
+===increase volume (f3)===
+Makes the general sounds louder
+===decrease volume (f2)===
+makes the general sounds softer
+===increase engine volume (shift+f3)===
+makes the sounds of engines for vehicles louder
+===decrease engine volume (shift+f2)===
+makes the sounds of engines for vehicles softer
+==speech output==
+===Toggle main speech output (shift+ctrl+s)===
+The main speech output is what is used by default to read aloud all text that comes back from the mud. If you're blind or low vision and you use a screen reader, this is quite handy. The session will try to make your screen reader do the talking. If no supported screen reader can be detected, the built in windows SAPI speech function will be used instead. The voice used by SAPI can be assigned as described below.
+===next SAPI adjustment option (ctrl+plus)===
+Cycles to the next adjustable SAPI option. If you reach the end with this, it starts over. The options are voice, rate, and volume. See the below sections on increasing and decreasing current SAPI options values for more.
+===previous SAPI adjustment option (ctrl+minus)===
+Cycles to the previous adjustable SAPI option. If you reach the end with this, it starts over. The options are volume, rate, and voice. See the below sections on increasing and decreasing current SAPI options values for more.
+===increase current SAPi option's value (shift+ctrl+plus)===
+Increases the value of the current SAPi adjustment option, see the two sections about that above.
+#voice: selects the next SAPi voice
+#rate: increases the SAPi rate by 5 percent
+#volume: increases the SAPI volume by 5 percent
-syntax: cfg reload
+===decrease current SAPi option's value (shift+ctrl+minus)===
+Decreases the value of the current SAPi adjustment option, see the two sections about that above.
+#voice: selects the previous SAPi voice
+#rate: decreases the SAPi rate by 5 percent
+#volume: decreases the SAPI volume by 5 percent
-syntax: cfg reload clip duf
+==History Buffer==
+The history buffer is a stored list of what probably will be channel sends for later reviewing using a provided set of key combinations. It is possible to add what ever you want to it, but the most common method for getting things stored there is the channel history function, which you can toggle with the config his command. When this is on, supported channels will be represented in the history buffer. This is handy for a quick way to review what has been said by other players when there might be too much incoming text to be able to properly keep up with all the socialization going on. Note too that if you don't use a screen reader or you have speech output toggled off for one reason or another, the below listed keystrokes for reviewing the history buffer do still speak. If you use them while you haven't a supported screen reader running, this'll still speak, using your computer's built in SAPi function.
+<br><strong>Note that the first time you use any of the below keystrokes you'll hear an ascending tone. This indicates that the buffer wasn't remembering a prior position to start from, so will now start at the most recent buffer item. Afterward, it will remember the position for about 1 minute after the last buffer reviewing command, then you'll hear a descending tone indicating that it has reset, and next time you press a buffer reviewing key it will begin at the most recent item again.</strong>
+<br/><strong>Channel history is not enabled by default, config his will toggle it.</strong>
-=hotkeys=
+===Previous buffer item ctrl+comma===
-This section details all of the hotkeys available in Mathayas Cyber Assault.xml.
+Move to and read the previous message.
-==ctrl+` grave accent. speak health and apponent condition==
-Speak the character's health and the condition of the aponent if in combat. Prompt status monitor must be enabled for this to work.
+===Next buffer item ctrl+slash===
+move to and read the next message
+===repeat current buffer item ctrl+period===
+announces the current buffer item again
+===first buffer item ctrl+shift+comma===
+move to and read the first, (oldest), item in the buffer
-==ctrl+shift+p. speak psi==
+===last buffer item ctrl+shift+slash===
-Speak the character's psionic points. Prompt status monitor must be enabled for this to work.
+move to and read the last, (newest), item in the buffer.
-==ctrl+shift+v. speak vitality==
+===Spell current buffer item ctrl+apostrophe===
-Speak the character's vitality. Prompt status monitor must be enabled for this to work.
+Spells the current item in the buffer character by character. Might be handy for learning the name of someone who is sending you tells or similar.
-==ctrl+shift+e. speak experience==
+==Queerying information==
-Speak the character's experience. Prompt status monitor must be enabled for this to work.
+===Report your health and that of your enemy (if any) ctrl+grave accent (`)===
+Speaks the condition of your opponent (if any), and then reports the number of health points and the percentage of your max health points you have.
-==ctrl+shift+n. speak experience tnl==
+===Report your psi ctrl+shift+p===
-Speak and display the character's experience needed for the next level. Prompt status monitor must be enabled for this to work.
+Speaks the number of psionic points you currently have.
-==ctrl+shift+u. speak resource units==
+===Report your vitality ctrl+shift+v===
-Speak the character's resource units currently being carried. Banked resource units are not counted. Prompt status monitor must be enabled for this to work.
+Speaks the number of vitality points you currently have.
-==ctrl+shift+q. speak quest points==
+===Report your resource units shift+ctrl+u===
-Speak the character's quest points. Prompt status monitor must be enabled for this to work.
+Speaks the number of resource units (ru) you currently have.
-==ctrl+shift+m. speak ammo==
+===Report your quest points shift+ctrl+q===
-Speak the character's current weapon's amunition. Prompt status monitor must be enabled for this to work.
+Speaks the number of quest points (qp) you currently have.
-==f6. Prompt Status Monitor: cycle values==
+===Report your ammunition shift+ctrl+m===
-cycle through the adjustments that can be made to the prompt status monitor.
+Speaks the number of ammunition rounds you currently have, provided you're using a weapon that uses ammunition.
-==f7. Prompt Status Monitor: decrease value==
+===Report your experience shift+ctrl+e===
-Decrease the value of the currently selected item to be adjusted that was selected with f6. for instance, if f6 was pressed until it was set to Report health, f7 would then decrease the percentage at which health would start being reported.
+Speaks the number of experience (exp) points you currently have.
-==f8. Prompt Status Monitor: Increase value==
+===Report experience till next level (tnl) shift+ctrl+n===
-Increase the value of the currently selected item to be adjusted that was selected with f6. for instance, if f6 was pressed until it was set to Report health, f8 would then decrease the percentage at which health would start being reported.
+Speaks the number of experience points you need to reach your next level.
-==ctrl+shift+f3. Toggle number truncation==
+===Report experience received for last kill ctrl+w===
-Toggles the truncation of numbers larger than 4 digits on and off. For instance, 1234 would appear as 1k, 12345 would appear as 12k, 123456 would appear as 123k, 1234567 would appear as 1m, etc. 788512699369 appears as 788.6bil. A config command, cfg numbers, exists to do this as well. A user may want this off if they are trying to get a web address or email address that might have numbers with 4 or more digits in them. Also for situations when one needs to know how much resources units etc.
+Speaks the number of experience you got for the last kill.
-=Conclusions=
+===Toggle brief mode on or off ctrl+r===
-this help file is still being written.
+Turns the game's brief mode (help brief) on or off.