Cyber Assault

From Valiant8086.com wiki
Jump to: navigation, search

Welcome to the MTScripts Cyber Assault Soundpack!

Contents

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

  1. 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.
  2. Bring up the open dialogue, either by clicking the file menu, then open or by pressing ctrl+o.
  3. 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.
  4. browse to the files directory
  5. 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:

  1. repeat the command, hit enter again to send the same text to the mud again
  2. 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.
  3. 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

  1. 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
  2. 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.

  1. voice: selects the next SAPi voice
  2. rate: increases the SAPi rate by 5 percent
  3. 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.

  1. voice: selects the previous SAPi voice
  2. rate: decreases the SAPi rate by 5 percent
  3. 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.

Report your experience shift+ctrl+e

Speaks the number of experience (exp) points you currently have.

Report experience till next level (tnl) shift+ctrl+n

Speaks the number of experience points you need to reach your next level.

Report experience received for last kill ctrl+w

Speaks the number of experience you got for the last kill.

Toggle brief mode on or off ctrl+r

Turns the game's brief mode (help brief) on or off.