Valiant8086.com wiki - User contributions [en]

Mathayas alter aeon

2013-12-04T14:42:53Z

Mathayas:

Mathayas Alter Aeon.xml

This help file currently directly applies to: MTScripts 5.3.3.0

=What is Mathayas Alter Aeon.xml?=
Mathayas Alter Aeon.xml is a Monkey Term soundpack for the mud Alter Aeon. It has sounds for most spells and a few other things as well. It uses the prompt from the mud and does a number of interesting things with it. It is part of MTScripts and includes a neat little XP and gold counter which lets you keep track of how much experience and gold you've gained or lost. Most of my time working with MTScripts went straight into Mathayas Alter Aeon.xml, which is an exact copy of the xml I use to play the character Mathayas on alter Aeon. It has a lot of functionality, and this help page will try to touch on everything so new or upgrading users can take advantage of all the features.

=How to open Mathayas Alter Aeon.xml?=
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 your installed monkeyTerm directory (documents if you installed it where I now recommend people install), open the files directory in there and pick Mathayas Alter Aeon.xml and open it.

=What are some initial setup configurations one should make to get this xml to work best?=
Note that the config or cfg command has been introduced to make initial setup easier. If you prefer, you can just type cfg and press enter to be presented with a list of options that you can configure.
==Modify your eq change aliases to set the eq variable (optional).==
The eq variable is an Alter Aeon based variable that Monkey Term monitors, changing it's own variable's value to match that of the Alter Aeon variable. The purpose of this is to help Monkey term figure out what equipment set you are wearing and behave differently depending. For instance, if it thinks you are in hit and you have the trigger system turned on (not supported), it will make you automatically assist, etc. To learn about Alter Aeon's variable functionality, log into it and type help variable. Note that using triggers in groups is against the rules on Alter Aeon. The trigger system exists for you to use at your own risk. To set this up, at the end of each alias you have made for changing equipment you need a command that looks like this.
var eq eqhit
The above command has the word hit in it, telling Monkey term to behave like you are in a hit set. right now there are three different values that make a difference, eqhit, eqtank and eqheal. If you set it to eqblah for example, it will behave as though the variable were not set at all.
Tip: You can just type this yourself into alter Aeon instead of putting it in your equipment change aliases. Useful if you don't have eq change aliases or otherwise haven't added them to your aliases. Note that until this variable is set you will receive a slightly annoying error when you log in that says variable not set or something along those lines. To stop this error message, just type var eq eqblah. Also note that if you use Alter Aeon's eqset commands instead of aliases to change gear, you can achieve automatic setting of this variable by setting up aliases that include the eqset wear command along with the eqset variable adjustment command. for instance your alias could go
eqset wear tank
var eq eqtank

=How do I upgrade to a different version of Mathayas Alter Aeon.xml and maintain my own custom aliases and such?=
==create a template containing all of your personal items==
1. Open your existing xml file in MonkeyTerm.
2. Save this xml file as a different file by going to file menu with alt+f and choosing save as.
3. Open the FMT by pressing f5 and delete everything that you didn't create yourself. Delete all actions, aliases, substitutes, events, variables, etc. Delete every single thing that you can find that you don't think you created on your own. Things that were included when you first got the file but that you have modified you should probably delete to, or keep them if you think you know how you can manually merge them together. It can cause problems sometimes if you overwrite something already existing in the newest file when you merge in your old code. So if you have manually changed code in something that is included, maybe the best thing to do is copy the code for that particular item into a document in notepad or something like that and save it separately to paste back in after you finish merging the template and after you check if you shouldn't break anything by overwriting the new file's code with your own.
4. Once you are pretty certain you have deleted everything except things you have created, note that includes any default things like speech even. Don't be afraid to delete. Anything you don't delete may possibly have been something that was updated in the newest version and merging your own legacy code over top of the new may very well break it, save the template. For instance if your xml is called Mathayas Alter Aeon.xml, I suggest saving the template as Mathayas Template Alter Aeon.xml.
5. After updating to the latest MTScripts, you can open Mathayas Alter Aeon.xml, note that this will be a new file copied in by the installer for the new scripts. Anyway, open it in MonkeyTerm and make sure you like it if you want. When you are ready, leave Mathayas Alter Aeon.xml open and go to file with alt+f and choose import/merge xml. Answer any prompts during this process as you think best. It may want to know if you want to overwrite things. If these come up I would recommend choosing no. After the import is complete you can leave the new file open and check the template for things that it had asked you if you wanted to overwrite to compare differences and see if you need to copy in your own stuff and if you can do so without breaking things.
6. There isn't really a 6th step. You should be done. Well you should save the result of your merge if you are satisfied with the results as what ever name you desire. I'd recommend not overwriting Mathayas Alter Aeon.xml though so you shouldn't just press ctrl+s. You should go to file and choose save as and give it a name that will match your character or otherwise be significant to you. You don't want to overwrite Mathayas Alter Aeon.xml because if you happened to break anything you don't have the original default code to start fresh from any more until you reinstall MTScripts or grab a fresh copy of Mathayas Alter Aeon.xml from somewhere else.

=Hotkeys=
There are many hotkeys that can be used to do a wide variety of different things. Here we'll take an in depth look at the keybindings. Keybindings, by the way, is Monkey Term's name for hotkeys.

==Speech related=====ctrl+shift+f2: toggle the history buffer===

==Prompt related==
===f6: Cycle through the different values that can be adjusted===

===f7: decrease the currently selected value===

===f8: Increase the currently selected value===

===ctrl+grave accent: speak the current health of the character and that of the target if any===

==Spell reporter keybindings==
===ctrl+shift+q: cycle through the different spell reporter options that can be adjusted===

===ctrl+shift+w: toggle the value of the currently selected option that was chosen with ctrl+shift+q===

==Melee hotkeys==
===ctrl+f: foes===

===ctrl+b: bash===

===ctrl+l: leap===

===ctrl+k: kick===

===ctrl+i: trip===

===ctrl+shift+l: cleave===

===ctrl+shift+b: berserk===

===ctrl+t: throw and then retrieve the item selected with the config throw command at the current target===

===ctrl+g: retrieve the throw item selected from up to 5 different corpses and from the ground===

==Others==
===ctrl+shift+h: enters the home command===

===ctrl+r: replay the last two channels ends that contain the word tell===

===ctrl+shift+f3: toggle the number truncator===

===f2: decrease the sound volume===

===f3: increase the sound volume===

===shift+f2: decrease the terrain sound volume===

===shift+f3: increase the terrain sound volume===

===Grave Accent: Check the health condition of group members===

==History buffer commands==
===ctrl+shift+f2: Toggle the history buffer on and off===

===ctrl+shift+comma: beginning of buffer===

===ctrl+shift+slash: end of buffer===

===ctrl+comma: previous buffer entry===

===ctrl+slash: next buffer entry===

===ctrl+period: read current buffer entry===

===ctrl+shift+period: Read from current history buffer entry to end===

===ctrl+apostrophe: spell current buffer entry===

=The Config command (cfg)=
The config command, cfg for short, allows the user to make changes to the way Monkey Term behaves when using Mathayas Alter Aeon.xml. To use the config command, type cfg and press enter. A list of options will be given. If the meaning of one of the choices is unclear, see this section of the documentation for enlightenment. In most cases, the options can be toggled. If the option says it is enabled or disabled it can be toggled. Otherwise, something else must be typed after it to enable it, or nothing at all to disable it. See below to find out more about this.

==Basic options:==
===speech: speak incoming text? Currently enabled===
Syntax to toggle this on and off: cfg speech
Toggles speech output. This simply controls whether text is sent to screen readers or SAPI so blind people can play more easily. You can also press ctrl+shift+s to do the same thing.

===ali: set up automatic logging in (not configured)===
Syntax to auto log into Mathayas example: cfg ali mathayas password
Syntax to disable auto log in: cfg ali
This command enables the user to configure MTScripts to automatically log a character in when the file is open. To set this up, type cfg, a space, the name of the character, another space, then the password and press enter. To disable this functionality, just type cfg, a space, then ali (cfg ali).
NOTE: This functionality stores your password in a variable with no encryption, so it is not secure. If one looks at the variable, the password will be written there, clear as day. If you've security concerns please do not use ali.

===history: Store channel sends in the history buffer? enabled===
Syntax to toggle this on and off: cfg history
This functionality will track most channel sends and store them in the history buffer so they can be read with the history buffer commands. To learn how to read the history buffer please see the section dedicated to history buffer commands in this same document. When this functionality has been enabled, the standard history buffer will be disabled, so the only thing stored in the history buffer will be channel sends. This will be useful for those who have JAWS or Window-Eyes, but need a way to keep up with what people are saying during spammy situations.
NOTE: When this functionality is toggled on while the standard history buffer functionality is already on, the standard history buffer functionality will be automatically disabled. To switch back to the standard history buffer functionality, please use the standard history buffer toggle hotkey ctrl+shift+f2. Doing this will automatically disable the channel history buffer if not already.

===reconnect: attempt to reconnect when connection is lost? enabled===
Syntax to toggle this on and off: cfg reconnect
This sets whether you would like to try to reconnect to Alter Aeon if a connection is lost unexpectedly (not when you log out or get booted or banned or anything like that). if you have this enabled it will try reconnecting about 10 seconds after a connection loss is noticed.

===reset: reset the xml to distribution default settings===
Syntax to reset the file to distribution defaults: cfg reset
This command resets the xml file to it's default distribution settings. It will disable auto login and remove the user and password information from that, as well as turn off the order functionality, etc. I, that is the developer of MTScripts, use this command to make sure I have removed my own password and my own preferred configuration before I package up a new version of MTScripts for distribution. If you mess something up, cfg reset may fix it, depending on what the problem is.

==Triggers and automation==
===triggers: Use the trigger system? disabled===
syntax to toggle: cfg trigs
These are actions that will make the character automatically do certain things when in groups. Use the eq variable mentioned early on in this documentation to control what the triggers do. See the section mentioning that eq variable for more information.
NOTE: Group bots are now against the rules on Alter Aeon. So use this functionality at your own risk. It is disabled by default.

===order: use the order functionality currently disabled===
Syntax to enable this: cfg order followed by a list of comma separated names, such as cfg order lexie, mathayas or if just one cfg order mathayas
Syntax to turn this off: cfg order
Order is a trigger that allows anyone listed in it to have complete control over the character. It behaves just like the ordering of minions. Just type order name command and what ever you ordered will perform that action if it were charmed by you or happened to be your minion who also happened to have enough intelligence to follow commands.
WARNING: Order allows complete power over the character. Someone can order the character to quit, drop equipment, donate, sacrifice, send tells, sleep, leap, bash, trip, shout something, spamm people, beep someone, kill themselves, etc. User should not use order unless they know what they are doing. Order is disabled by default. Type cfg order until it says it is disabled.

===autogroup: automatically group those who follow you? disabled===
syntax to toggle: cfg autogroup
Autogroup will group anyone who follows the character automatically. This is disabled by default.

===recast: reattempt spells when they fail to cast? enabled===
Syntax to toggle this: cfg recast
Recast makes you automatically retry to cast spells when you fail them. To do this, it creates an alias on Alter Aeon that all cast commands that you send from Monkey Term will pass through. this allows Monkey term to figure out what you're trying to cast because it makes Alter Aeon set a variable called cast to what ever it is you typed. Since Monkey Term will learn from this variable being set what you tried to cast, it will know exactly what to type when you fail to cast something. You might want to disable this if you are creating an alias on Alter Aeon itself that handles the casting of a spell. for instance if you want to create an alias that you just type fb and it types c fireball, well if you type c fireball with recast in Monkey Term enabled you will actually type something like
var cast castfireball
cast fireball
into your Alter Aeon alias unless you disable the recast functionality with the cfg recast command. an alternative way to get around this is to type something stupid like, blah, into your alias, and then change that line using the editor to say cast fireball. For instance if it's a 1 line alias that's easy, command would be /change 1 cast fireball. if it's got more than one line in it, you might need to type /show to find out which line it's on then type /change linenumber cast fireball. Notice the forward slash that is in front of change, and show, in my examples here. I do recommend that people always make their cast commands type out cast completely instead of just c. this way if you have cfg recast turned on, your alter aeon aliases that type things like cast fireball will actually fire the also alter aeon side cast command, effectively making it set the variable from within your custom aliases as it goes, but it is not part of said aliases that you create. this has the advantage that if you need to go without MTScripts for a while for one reason or another, you can just unalias the cast command in Alter Aeon by typing unalias cast, and you'll stop getting spammed with those cast variable messages, which certainly will be a problem if you try to cast things while using a different client since it won't be automatically hiding that variable from the screen because it hasn't been coded to support that. You'll probably just type c fireball most of the time though so it won't always set the variable if you do keep the cast alias because the cast alias is cast all spelled out not just c, but if you put cast in your custom Alter Aeon side aliases to make sure they will fire the Alter Aeon side cast alias if it is enabled, custom aliases used while playing without MTScripts will cause those variables to show up. When you come back to monkey Term you may have the recaster enabled, but the variable might not be getting set if you unaliased cast, you mould end up trying to cast fireball but when fireball fails it just makes a stab and does something stupid like trying to cast sanc instead of fireball again. To fix, do cfg recast twice to turn it off, and back on making it recreate your alter aeon side cast alias. By the way, Monkey Term always types cast when the recaster is on, even if you just type c, ca, or cas. that's why it works in those cases. Note that you can have aliases that you create yourself inside monkey Term which handle casting of spells just type c given what I just said. Whew! what a whopper.

===gold: automatic gold looting? enabled===
===throw: set the keyword(s) to use with ctrl+t (currently tomahawk)===
===report: set where the improvement reports go (currently yt)===
===pickpocket: Automatically continue pickpocketing? Enabled===
===picklocks: Automatically continue picking doorlocks? Enabled===
===rs: Report time needed to regen (not set).===

==Text hiding, truncating and verbocity:==
===sitstand: hide texts of others sitting and standing? disabled===
===numbers: Truncate numbers? enabled===
===exits: Truncate exits and put them before room description? enabled===
===osm: Monitor the spells of group members? enabled===

==Soundpack settings:==
===sounds: use the soundpack? enabled===
syntax to toggle this: cfg sounds
The soundpack will play different auditory noises for various things that you do on Alter aeon to help make it feel a little more involved and also to help keep up to speed on what exactly is going on (especially useful if you're using a screen reader). If you turn this off, note that not all sounds will disappear. the MSP system mentioned below may still be on for one thing, as well as the channel sounds mentioned below that, plus I have some of what I consider important sounds that can't be turned off from any config command, sounds for things like group tell and clan tell and tells and replies etc.

===msp: use the msp soundpack? enabled===
Syntax to toggle this: cfg msp
MSP (mud sounds protocol) is a protocol that gives the mud the ability to issue instructions to the client about sounds to play, where the sounds should be and exactly when to play them. Alter Aeon does support MSP, type help msp on there for details, and so does MTScripts. When this is on (is by default), you'll get a lot more sound affects. If you turn this off, the main soundpack mentioned above will not also be turned off, so if it is still turned on you'll get the sounds that is handled by that, same happens in reverse. You can certainly turn the main soundpack off, and use msp only, or msp off and use the main soundpack only, just however you prefer. They are both on by default. Just if you turn them both off you will still get channel sounds if enabled (see below), and there are some soundes that I consider to be important that can't be disabled from the config system. If you really need silence, turn the volume all the way down with f2 and don't forget about the terrain sound too, turn that all the way down with shift+f2.

===channels: Set up beep sound for most channels===
Syntax to toggle this: cfg channels
When on (is by default), MTScripts will use the cprefix functionality (type help cprefix into Alter Aeon for more information about this) to be able to play a chirp sound when anyone sends anything out on a typical channel. What is a typical channel? Any channel that you can turn off by typing it's name. Gossip, Newbie, Shout, Yt, and many more.

=Conclusions=
this help file is still being written.

Mathayas alter aeon

2013-12-04T14:07:40Z

Mathayas:

Mathayas Alter Aeon.xml

This help file currently directly applies to: MTScripts 5.3.3.0

=What is Mathayas Alter Aeon.xml?=
Mathayas Alter Aeon.xml is a Monkey Term soundpack for the mud Alter Aeon. It has sounds for most spells and a few other things as well. It uses the prompt from the mud and does a number of interesting things with it. It is part of MTScripts and includes a neat little XP and gold counter which lets you keep track of how much experience and gold you've gained or lost. Most of my time working with MTScripts went straight into Mathayas Alter Aeon.xml, which is an exact copy of the xml I use to play the character Mathayas on alter Aeon. It has a lot of functionality, and this help page will try to touch on everything so new or upgrading users can take advantage of all the features.

=How to open Mathayas Alter Aeon.xml?=
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 your installed monkeyTerm directory (documents if you installed it where I now recommend people install), open the files directory in there and pick Mathayas Alter Aeon.xml and open it.

=What are some initial setup configurations one should make to get this xml to work best?=
Note that the config or cfg command has been introduced to make initial setup easier. If you prefer, you can just type cfg and press enter to be presented with a list of options that you can configure.
==Modify your eq change aliases to set the eq variable (optional).==
The eq variable is an Alter Aeon based variable that Monkey Term monitors, changing it's own variable's value to match that of the Alter Aeon variable. The purpose of this is to help Monkey term figure out what equipment set you are wearing and behave differently depending. For instance, if it thinks you are in hit and you have the trigger system turned on (not supported), it will make you automatically assist, etc. To learn about Alter Aeon's variable functionality, log into it and type help variable. Note that using triggers in groups is against the rules on Alter Aeon. The trigger system exists for you to use at your own risk. To set this up, at the end of each alias you have made for changing equipment you need a command that looks like this.
var eq eqhit
The above command has the word hit in it, telling Monkey term to behave like you are in a hit set. right now there are three different values that make a difference, eqhit, eqtank and eqheal. If you set it to eqblah for example, it will behave as though the variable were not set at all.
Tip: You can just type this yourself into alter Aeon instead of putting it in your equipment change aliases. Useful if you don't have eq change aliases or otherwise haven't added them to your aliases. Note that until this variable is set you will receive a slightly annoying error when you log in that says variable not set or something along those lines. To stop this error message, just type var eq eqblah. Also note that if you use Alter Aeon's eqset commands instead of aliases to change gear, you can achieve automatic setting of this variable by setting up aliases that include the eqset wear command along with the eqset variable adjustment command. for instance your alias could go
eqset wear tank
var eq eqtank

=How do I upgrade to a different version of Mathayas Alter Aeon.xml and maintain my own custom aliases and such?=
==create a template containing all of your personal items==
1. Open your existing xml file in MonkeyTerm.
2. Save this xml file as a different file by going to file menu with alt+f and choosing save as.
3. Open the FMT by pressing f5 and delete everything that you didn't create yourself. Delete all actions, aliases, substitutes, events, variables, etc. Delete every single thing that you can find that you don't think you created on your own. Things that were included when you first got the file but that you have modified you should probably delete to, or keep them if you think you know how you can manually merge them together. It can cause problems sometimes if you overwrite something already existing in the newest file when you merge in your old code. So if you have manually changed code in something that is included, maybe the best thing to do is copy the code for that particular item into a document in notepad or something like that and save it separately to paste back in after you finish merging the template and after you check if you shouldn't break anything by overwriting the new file's code with your own.
4. Once you are pretty certain you have deleted everything except things you have created, note that includes any default things like speech even. Don't be afraid to delete. Anything you don't delete may possibly have been something that was updated in the newest version and merging your own legacy code over top of the new may very well break it, save the template. For instance if your xml is called Mathayas Alter Aeon.xml, I suggest saving the template as Mathayas Template Alter Aeon.xml.
5. After updating to the latest MTScripts, you can open Mathayas Alter Aeon.xml, note that this will be a new file copied in by the installer for the new scripts. Anyway, open it in MonkeyTerm and make sure you like it if you want. When you are ready, leave Mathayas Alter Aeon.xml open and go to file with alt+f and choose import/merge xml. Answer any prompts during this process as you think best. It may want to know if you want to overwrite things. If these come up I would recommend choosing no. After the import is complete you can leave the new file open and check the template for things that it had asked you if you wanted to overwrite to compare differences and see if you need to copy in your own stuff and if you can do so without breaking things.
6. There isn't really a 6th step. You should be done. Well you should save the result of your merge if you are satisfied with the results as what ever name you desire. I'd recommend not overwriting Mathayas Alter Aeon.xml though so you shouldn't just press ctrl+s. You should go to file and choose save as and give it a name that will match your character or otherwise be significant to you. You don't want to overwrite Mathayas Alter Aeon.xml because if you happened to break anything you don't have the original default code to start fresh from any more until you reinstall MTScripts or grab a fresh copy of Mathayas Alter Aeon.xml from somewhere else.

=Hotkeys=
There are many hotkeys that can be used to do a wide variety of different things. Here we'll take an in depth look at the keybindings. Keybindings, by the way, is Monkey Term's name for hotkeys.

==Speech related=====ctrl+shift+f2: toggle the history buffer===

==Prompt related==
===f6: Cycle through the different values that can be adjusted===

===f7: decrease the currently selected value===

===f8: Increase the currently selected value===

===ctrl+grave accent: speak the current health of the character and that of the target if any===

==Spell reporter keybindings==
===ctrl+shift+q: cycle through the different spell reporter options that can be adjusted===

===ctrl+shift+w: toggle the value of the currently selected option that was chosen with ctrl+shift+q===

==Melee hotkeys==
===ctrl+f: foes===

===ctrl+b: bash===

===ctrl+l: leap===

===ctrl+k: kick===

===ctrl+i: trip===

===ctrl+shift+l: cleave===

===ctrl+shift+b: berserk===

===ctrl+t: throw and then retrieve the item selected with the config throw command at the current target===

===ctrl+g: retrieve the throw item selected from up to 5 different corpses and from the ground===

==Others==
===ctrl+shift+h: enters the home command===

===ctrl+r: replay the last two channels ends that contain the word tell===

===ctrl+shift+f3: toggle the number truncator===

===f2: decrease the sound volume===

===f3: increase the sound volume===

===shift+f2: decrease the terrain sound volume===

===shift+f3: increase the terrain sound volume===

===Grave Accent: Check the health condition of group members===

==History buffer commands==
===ctrl+shift+f2: Toggle the history buffer on and off===

===ctrl+shift+comma: beginning of buffer===

===ctrl+shift+slash: end of buffer===

===ctrl+comma: previous buffer entry===

===ctrl+slash: next buffer entry===

===ctrl+period: read current buffer entry===

===ctrl+shift+period: Read from current history buffer entry to end===

===ctrl+apostrophe: spell current buffer entry===

=The Config command (cfg)=
The config command, cfg for short, allows the user to make changes to the way Monkey Term behaves when using Mathayas Alter Aeon.xml. To use the config command, type cfg and press enter. A list of options will be given. If the meaning of one of the choices is unclear, see this section of the documentation for enlightenment. In most cases, the options can be toggled. If the option says it is enabled or disabled it can be toggled. Otherwise, something else must be typed after it to enable it, or nothing at all to disable it. See below to find out more about this.

==Basic options:==
===speech: speak incoming text? Currently enabled===
Syntax to toggle this on and off: cfg speech
Toggles speech output. This simply controls whether text is sent to screen readers or SAPI so blind people can play more easily. You can also press ctrl+shift+s to do the same thing.

===ali: set up automatic logging in (not configured)===
Syntax to auto log into Mathayas example: cfg ali mathayas password
Syntax to disable auto log in: cfg ali
This command enables the user to configure MTScripts to automatically log a character in when the file is open. To set this up, type cfg, a space, the name of the character, another space, then the password and press enter. To disable this functionality, just type cfg, a space, then ali (cfg ali).
NOTE: This functionality stores your password in a variable with no encryption, so it is not secure. If one looks at the variable, the password will be written there, clear as day. If you've security concerns please do not use ali.

===history: Store channel sends in the history buffer? enabled===
Syntax to toggle this on and off: cfg history
This functionality will track most channel sends and store them in the history buffer so they can be read with the history buffer commands. To learn how to read the history buffer please see the section dedicated to history buffer commands in this same document. When this functionality has been enabled, the standard history buffer will be disabled, so the only thing stored in the history buffer will be channel sends. This will be useful for those who have JAWS or Window-Eyes, but need a way to keep up with what people are saying during spammy situations.
NOTE: When this functionality is toggled on while the standard history buffer functionality is already on, the standard history buffer functionality will be automatically disabled. To switch back to the standard history buffer functionality, please use the standard history buffer toggle hotkey ctrl+shift+f2. Doing this will automatically disable the channel history buffer if not already.

===reconnect: attempt to reconnect when connection is lost? enabled===
Syntax to toggle this on and off: cfg reconnect
This sets whether you would like to try to reconnect to Alter Aeon if a connection is lost unexpectedly (not when you log out or get booted or banned or anything like that). if you have this enabled it will try reconnecting about 10 seconds after a connection loss is noticed.

===reset: reset the xml to distribution default settings===
Syntax to reset the file to distribution defaults: cfg reset
This command resets the xml file to it's default distribution settings. It will disable auto login and remove the user and password information from that, as well as turn off the order functionality, etc. I, that is the developer of MTScripts, use this command to make sure I have removed my own password and my own preferred configuration before I package up a new version of MTScripts for distribution. If you mess something up, cfg reset may fix it, depending on what the problem is.

==Triggers and automation==
===triggers: Use the trigger system? disabled===
syntax to toggle: cfg trigs
These are actions that will make the character automatically do certain things when in groups. Use the eq variable mentioned early on in this documentation to control what the triggers do. See the section mentioning that eq variable for more information.
NOTE: Group bots are now against the rules on Alter Aeon. So use this functionality at your own risk. It is disabled by default.

===order: use the order functionality currently disabled===
Syntax to enable this: cfg order followed by a list of comma separated names, such as cfg order lexie, mathayas or if just one cfg order mathayas
Syntax to turn this off: cfg order
Order is a trigger that allows anyone listed in it to have complete control over the character. It behaves just like the ordering of minions. Just type order name command and what ever you ordered will perform that action if it were charmed by you or happened to be your minion who also happened to have enough intelligence to follow commands.
WARNING: Order allows complete power over the character. Someone can order the character to quit, drop equipment, donate, sacrifice, send tells, sleep, leap, bash, trip, shout something, spamm people, beep someone, kill themselves, etc. User should not use order unless they know what they are doing. Order is disabled by default. Type cfg order until it says it is disabled.

===autogroup: automatically group those who follow you? disabled===
syntax to toggle: cfg autogroup
Autogroup will group anyone who follows the character automatically. This is disabled by default.

===recast: reattempt spells when they fail to cast? enabled===
Syntax to toggle this: cfg recast
Recast makes you automatically retry to cast spells when you fail them. To do this, it creates an alias on Alter Aeon that all cast commands that you send from Monkey Term will pass through. this allows Monkey term to figure out what you're trying to cast because it makes Alter Aeon set a variable called cast to what ever it is you typed. Since Monkey Term will learn from this variable being set what you tried to cast, it will know exactly what to type when you fail to cast something. You might want to disable this if you are creating an alias on Alter Aeon itself that handles the casting of a spell. for instance if you want to create an alias that you just type fb and it types c fireball, well if you type c fireball with recast in Monkey Term enabled you will actually type something like
var cast castfireball
cast fireball
into your Alter Aeon alias unless you disable the recast functionality with the cfg recast command. an alternative way to get around this is to type something stupid like, blah, into your alias, and then change that line using the editor to say cast fireball. For instance if it's a 1 line alias that's easy, command would be /change 1 cast fireball. if it's got more than one line in it, you might need to type /show to find out which line it's on then type /change linenumber cast fireball. Notice the forward slash that is in front of change, and show, in my examples here. I do recommend that people always make their cast commands type out cast completely instead of just c. this way if you have cfg recast turned on, your alter aeon aliases that type things like cast fireball will actually fire the also alter aeon side cast command, effectively making it set the variable from within your custom aliases as it goes, but it is not part of said aliases that you create. this has the advantage that if you need to go without MTScripts for a while for one reason or another, you can just unalias the cast command in Alter Aeon by typing unalias cast, and you'll stop getting spammed with those cast variable messages, which certainly will be a problem if you try to cast things while using a different client since it won't be automatically hiding that variable from the screen because it hasn't been coded to support that. You'll probably just type c fireball most of the time though so it won't always set the variable if you do keep the cast alias because the cast alias is cast all spelled out not just c, but if you put cast in your custom Alter Aeon side aliases to make sure they will fire the Alter Aeon side cast alias if it is enabled, custom aliases used while playing without MTScripts will cause those variables to show up. When you come back to monkey Term you may have the recaster enabled, but the variable might not be getting set if you unaliased cast, you mould end up trying to cast fireball but when fireball fails it just makes a stab and does something stupid like trying to cast sanc instead of fireball again. To fix, do cfg recast twice to turn it off, and back on making it recreate your alter aeon side cast alias. By the way, Monkey Term always types cast when the recaster is on, even if you just type c, ca, or cas. that's why it works in those cases. Note that you can have aliases that you create yourself inside monkey Term which handle casting of spells just type c given what I just said. Whew! what a whopper.

===gold: automatic gold looting? enabled===
===throw: set the keyword(s) to use with ctrl+t (currently tomahawk)===
===report: set where the improvement reports go (currently yt)===
===pickpocket: Automatically continue pickpocketing? Enabled===
===picklocks: Automatically continue picking doorlocks? Enabled===
===rs: Report time needed to regen (not set).===

==Text hiding, truncating and verbocity:==
===sitstand: hide texts of others sitting and standing? disabled===
===numbers: Truncate numbers? enabled===
===exits: Truncate exits and put them before room description? enabled===
===osm: Monitor the spells of group members? enabled===

==Soundpack settings:==
===sounds: use the soundpack? enabled===
===channels: Set up beep sound for most channels===

=Conclusions=
this help file is still being written.

MTScripts

2012-01-24T20:51:42Z

Mathayas: one more try at getting the cyber assault link to work

'''Welcome to MTScripts documentation!'''

these links lead to all of the documentation currently publically available for MTScripts.

[[mathayas_alter_aeon]]
help for Mathayas Alter Aeon.xml

[[Cyber Assault]]
help for cyber Assault.xml

[[default_xml]]
help for default.xml

MTScripts

2012-01-24T20:45:21Z

Mathayas: changed cyber assault link to point to it correctly

'''Welcome to MTScripts documentation!'''

these links lead to all of the documentation currently publically available for MTScripts.

[[mathayas_alter_aeon]]
help for Mathayas Alter Aeon.xml

[[cyber assault]]
help for cyber Assault.xml

[[default_xml]]
help for default.xml

MTScripts

2012-01-24T20:41:57Z

Mathayas:

'''Welcome to MTScripts documentation!'''

these links lead to all of the documentation currently publically available for MTScripts.

[[mathayas_alter_aeon]]
help for Mathayas Alter Aeon.xml

[[cyber_assault]]
help for cyber Assault.xml

[[default_xml]]
help for default.xml

Mathayas cyber assault

2010-10-05T04:13:27Z

Mathayas: moved Mathayas cyber assault to Cyber Assault: The xml's Virjal Cyber Assault and Mathayas Cyber Assault are being merged into one, so the documentation for them will become one.

#REDIRECT [[Cyber Assault]]

Cyber Assault

2010-10-05T04:13:27Z

Mathayas: moved Mathayas cyber assault to Cyber Assault: The xml's Virjal Cyber Assault and Mathayas Cyber Assault are being merged into one, so the documentation for them will become one.

Cyber Assault.xml

This help file currently applies to: MTScripts 3.7.9.7

=How to open Cyber Assault.xml?=
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.

=What are some initial setup configurations one should make to get this xml to work best?=
==Select desired speech output==
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==
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.
===The config list===
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.
====Basic options:====
=====ali: set up automatic logging in currently not configured=====
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

syntax: config auto login mathayas mypassword

=====reset: reset the xml to distribution default settings=====
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.

syntax: cfg reset

====Text hiding, truncating and verbocity:====
=====numbers: Truncate numbers? enabled=====
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.
tip: This can be more easily toggled with ctrl+f3.

syntax: cfg numbers

=====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

====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====
=====auto reload: set up automatic reloading currently set to clip, located in duf=====
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.

syntax: cfg reload

syntax: cfg reload clip duf

=hotkeys=
This section details all of the hotkeys available in Mathayas Cyber Assault.xml.
==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.

==ctrl+shift+p. speak psi==
Speak the character's psionic points. Prompt status monitor must be enabled for this to work.

==ctrl+shift+v. speak vitality==
Speak the character's vitality. Prompt status monitor must be enabled for this to work.

==ctrl+shift+e. speak experience==
Speak the character's experience. Prompt status monitor must be enabled for this to work.

==ctrl+shift+n. speak experience tnl==
Speak and display the character's experience needed for the next level. Prompt status monitor must be enabled for this to work.

==ctrl+shift+u. speak resource units==
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.

==ctrl+shift+q. speak quest points==
Speak the character's quest points. Prompt status monitor must be enabled for this to work.

==ctrl+shift+m. speak ammo==
Speak the character's current weapon's amunition. Prompt status monitor must be enabled for this to work.

==f6. Prompt Status Monitor: cycle values==
cycle through the adjustments that can be made to the prompt status monitor.

==f7. Prompt Status Monitor: decrease value==
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.

==f8. Prompt Status Monitor: Increase value==
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.

==ctrl+shift+f3. Toggle number truncation==
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.

=Conclusions=
this help file is still being written.

Cyber Assault

2010-10-05T04:07:19Z

Mathayas: Updated support version number to 3.7.9.7. Fixed some spelling errors.

Mathayas alter aeon

2010-10-05T01:01:43Z

Mathayas: This changed the "applies to" version number to 3.7.9.7 and integrated a tutorial for maintaining personal aliases and such across an upgrade.

Mathayas Alter Aeon.xml

This help file currently directly applies to: MTScripts 3.7.9.7

=What is Mathayas Alter Aeon.xml?=
Mathayas Alter Aeon.xml is a soundpack for the mud Alter Aeon. It has sounds for most spells and a few other things as well. It uses the prompt from the mud and does a number of interesting things with it. It is part of MTScripts and includes a neat little XP and gold counter which lets you keep track of how much experience and gold you've gained or lost. Most of my time working with MTScripts went straight into Mathayas Alter Aeon.xml, which is an exact copy of the xml I use to play the character Mathayas on alter Aeon. It has a lot of functionality, and this help page will try to touch on everything so new or upgrading users can take advantage of all the features.

=How to open Mathayas Alter Aeon.xml?=
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\Mathayas Alter Aeon.xml and open it. These instructions are correct even for those of you running 64 bit versions of windows.

=What are some initial setup configurations one should make to get this xml to work best?=
Note that the config or cfg command has been introduced to make initial setup easier. If you prefer, you can just type cfg and press enter to be presented with a list of options that you can configure.
==Select desired speech output==
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.

==Modify your eq change aliases to set the eq variable (optional).==
The eq variable is an Alter Aeon based variable that Monkey Term monitors, changing it's own variable's value to match that of the Alter Aeon variable. The purpose of this is to help Monkey term figure out what equipment set you are wearing and behave differently depending. For instance, if it thinks you are in hit and you have the trigger system turned on, it will make you automatically assist, etc. To learn about Alter Aeon's variable functionality, log into it and type help variable. Note that using triggers in groups is against the rules on Alter Aeon. The trigger system exists for you to use at your own risk. To set this up, at the end of each alias you have made for changing equipment you need a command that looks like this.
var eq eqhit
The above command has the word hit in it, telling Monkey term to behave like you are in a hit set. right now there are three different values that make a difference, eqhit, eqtank and eqheal. If you set it to eqblah for example, it will behave as though the variable were not set at all.
Tip: You can just type this yourself into alter Aeon instead of putting it in your equipment change aliases. Useful if you don't have eq change aliases or otherwise haven't added them to your aliases. Note that until this variable is set you will receive a slightly annoying error when you log in that says variable not set or something along those lines. To stop this error message, just type var eq eqblah.

=How do I upgrade to a different version of Mathayas Alter Aeon.xml and maintain my own custom aliases and such?=
==create a template containing all of your personal items==
1. Open your existing xml file in MonkeyTerm.
2. Save this xml file as a different file by going to file menu with alt+f and choosing save as.
3. Open the FMT by pressing f5 and delete everything that you didn't create yourself. Delete all actions, aliases, substitutes, events, variables, etc. Delete every single thing that you can find that you don't think you created on your own. Things that were included when you first got the file but that you have modified you should probably delete to, or keep them if you think you know how you can manually merge them together. It can cause problems sometimes if you overwrite something already existing in the newest file when you merge in your old code. So if you have manually changed code in something that is included, maybe the best thing to do is copy the code for that particular item into a document in notepad or something like that and save it separately to paste back in after you finish merging the template and after you check if you shouldn't break anything by overwriting the new file's code with your own.
4. Once you are pretty certain you have deleted everything except things you have created, note that includes any default things like speech even. Don't be afraid to delete. Anything you don't delete may possibly have been something that was updated in the newest version and merging your own legacy code over top of the new may very well break it, save the template. For instance if your xml is called Mathayas Alter Aeon.xml, I suggest saving the template as Mathayas Template Alter Aeon.xml.
5. After updating to the latest MTScripts, you can open Mathayas Alter Aeon.xml, note that this will be a new file copied in by the installer for the new scripts. Anyway, open it in MonkeyTerm and make sure you like it if you want. When you are ready, leave Mathayas Alter Aeon.xml open and go to file with alt+f and choose import/merge xml. Answer any prompts during this process as you think best. It may want to know if you want to overwrite things. If these come up I would recommend choosing no. After the import is complete you can leave the new file open and check the template for things that it had asked you if you wanted to overwrite to compare differences and see if you need to copy in your own stuff and if you can do so without breaking things.
6. There isn't really a 6th step. You should be done. Well you should save the result of your merge if you are satisfied with the results as what ever name you desire. I'd recommend not overwriting Mathayas Alter Aeon.xml though so you shouldn't just press ctrl+s. You should go to file and choose save as and give it a name that will match your character or otherwise be significant to you. You don't want to overwrite Mathayas Alter Aeon.xml because if you happened to break anything you don't have the original default code to start fresh from any more until you reinstall MTScripts or grab a fresh copy of Mathayas Alter Aeon.xml from somewhere else.

=Hotkeys=
There are many hotkeys that can be used to do a wide variety of different things. Here we'll take an in depth look at the keybindings. Keybindings, by the way, is Monkey Term's name for hotkeys.

==Speech related==
===ctrl+f2: toggle the selected speech output===

===ctrl+shift+f2: toggle the history buffer===

==Prompt related==
===f6: Cycle through the different values that can be adjusted===

===f7: decrease the currently selected value===

===f8: Increase the currently selected value===

===ctrl+grave accent: speak the current health of the character and that of the target if any===

==Spell reporter keybindings==
===ctrl+shift+q: cycle through the different spell reporter options that can be adjusted===

===ctrl+shift+w: toggle the value of the currently selected option that was chosen with ctrl+shift+q===

==Melee hotkeys==
===ctrl+b: bash===

===ctrl+l: leap===

===ctrl+k: kick===

===ctrl+i: trip===

===ctrl+t: throw and then retrieve the item selected with the config throw command at the current target===

===ctrl+g: retrieve the throw item selected from up to 5 different corpses and from the ground===

==Others==
===ctrl+shift+h: enters the home command===

===ctrl+r: replay the last two channels ends that contain the word tell===

===ctrl+shift+f3: toggle the number truncator===

===f2: decrease the sound volume===

===f3: increase the sound volume===

===shift+f2: decrease the terrain sound volume===

===shift+f3: increase the terrain sound volume===

===Grave Accent: Check the health condition of group members===

==History buffer commands==
===ctrl+shift+f2: Toggle the history buffer on and off===

===ctrl+shift+comma: beginning of buffer===

===ctrl+shift+slash: end of buffer===

===ctrl+comma: previous buffer entry===

===ctrl+slash: next buffer entry===

===ctrl+period: read current buffer entry===

===ctrl+shift+period: Read from current history buffer entry to end===

===ctrl+apostrophe: spell current buffer entry===

=The Config command (cfg)=
The config command, cfg for short, allows the user to make changes to the way Monkey Term behaves when using Mathayas Alter Aeon.xml. To use the config command, type cfg and press enter. A list of options will be given. If the meaning of one of the choices is unclear, see this section of the documentation for enlightenment. In most cases, the options can be toggled. If the option says it is enabled or disabled it can be toggled. Otherwise, something else must be typed after it to enable it, or nothing at all to disable it. See below to find out more about this.

==Basic options:==
===ali: set up automatic logging in (currently mathayas)===
Syntax to auto log into Mathayas example: cfg ali mathayas password
Syntax to disable auto log in: cfg ali
This command enables the user to configure MTScripts to automatically log a character in when the file is open. To set this up, type cfg, a space, the name of the character, another space, then the password and press enter. To disable this functionality, just type cfg, a space, then ali (cfg ali).
NOTE: This functionality stores your password in a variable with no encryption, so it is not secure. If one looks at the variable, the password will be written there, clear as day. If you've security concerns please do not use ali.

===history: Store channel sends in the history buffer? enabled===
Syntax to toggle this on and off: cfg history
This functionality will track most channel sends and store them in the history buffer so they can be read with the history buffer commands. To learn how to read the history buffer please see the section dedicated to history buffer commands in this same document. When this functionality has been enabled, the standard history buffer will be disabled, so the only thing stored in the history buffer will be channel sends. This will be useful for those who have JAWS or Window-Eyes, but need a way to keep up with people are saying during spammy situations.
NOTE: When this functionality is toggled on while the standard history buffer functionality is already on, the standard history buffer functionality will be automatically disabled. To switch back to the standard history buffer functionality, please use the standard history buffer toggle hotkey ctrl+shift+f2. Doing this will automatically disable the channel history buffer.

===reset: reset the xml to distribution default settings===
Syntax to reset the file to distribution defaults: cfg reset
This command resets the xml file to it's default distribution settings. It will disable auto login and remove the user and password information from that, as well as turn off the order functionality, etc. I, that is the developer of MTScripts, use this command to make sure I have removed my own password and my own preferred configuration before I package up a new version of MTScripts for distribution. If you mess something up, cfg reset may fix it, depending on what the problem is.

==Triggers and automation==
===triggers: Use the trigger system? disabled===
syntax to toggle: cfg trigs
These are actions that will make the character automatically do certain things when in groups. Use the eq variable mentioned early on in this documentation to control what the triggers do. See the section mentioning that eq variable for more information.
NOTE: Group bots are now against the rules on Alter Aeon. So use this functionality at your own risk. It is disabled by default.

===order: use the order functionality? enabled===
Syntax to toggle: cfg order
Order is a trigger that allows anyone listed in it to have complete control over the character. It behaves just like the ordering of minions. Just type order name command and what ever you ordered will perform that action if it were charmed by you or happened to be your minion who also happened to have enough intelligence to follow commands. To adjust who can order the character when it is enabled, find the action misc/order. Understand the code in the if statement before adding or removing names.
NOTE: Order is set to allow people whom Mathayas has allowed to order him by default. A new user of MTScripts should not use order, as they don't know who can order them until they look at the code in action/misc/order. Order allows complete power over the character. Someone can order the character to quit, drop equipment, donate, sacrifice, send tells, sleep, leap, bash, trip, shout something, spamm people, beep someone, kill themselves, etc. User should not use order unless they know what they are doing. Order is disabled by default. Type cfg order until it says it is disabled.

===autogroup: automatically group those who follow you? disabled===
syntax to toggle: cfg autogroup
Autogroup will group anyone who follows the character automatically. This is disabled by default.

===recast: reattempt spells when they fail to cast? enabled===
===gold: automatic gold looting? enabled===
===throw: set the keyword(s) to use with ctrl+t (currently tomahawk)===
===report: set where the improvement reports go (currently yt)===
===pickpocket: Automatically continue pickpocketing? Enabled===
===picklocks: Automatically continue picking doorlocks? Enabled===
===rs: Report time needed to regen (not set).===

==Text hiding, truncating and verbocity:==
===sitstand: hide texts of others sitting and standing? disabled===
===numbers: Truncate numbers? enabled===
===exits: Truncate exits and put them before room description? enabled===
===osm: Monitor the spells of group members? enabled===

==Soundpack settings:==
===sounds: use the soundpack? enabled===
===channels: Set up beep sound for most channels===

=Conclusions=
this help file is still being written.

Default xml

2010-10-05T00:40:29Z

Mathayas: More changes to get ready for version 3.7.9.7. This change implements a tutorial on how to save a new xml file.

default.xml

This information currently applies to: MTScripts 3.7.9.7

=Initial notes=
Default.xml's contents is copied into new xmls when they are created. It should never be opened unless one intends to modify the behavior of brand new xml files. That said, newly created xml files, as they use the same information found in default.xml, are still covered by this help file. this help file is actually intended to help people creating new xml files from the ground up and who are using MTScripts to know what they can do to configure their new xml file. so it's kind of an xml file developer's reference. it explains everything found in the fmt and what all of that stuff does. it tries to explain what stuff can and cannot be modified without breaking the functionality of what. If you pressed ctrl+f1 while in something other than default.xml and ended up with this page, it's because the path to the help page for that xml file was not modified and consequently it may mean that xml hasn't itself been modified enough to warrant a specific help file for it.
Notice that when I reference keybindings way down at the end of this help file, or close to the end anyway, on keybindings that have punctuation keys like period, slash, comma, apostrophe involved in them etc, I pointed out the ASCII value of each punctuation key involved. this is because that's what the fmt does to reference the keys, and I did that so readers would be able to figure out which keybinding in the fmt it was exactly that I was talking about. I did point out also which keys actually need to be pressed to activate that keybinding in parentheses after the name the fmt references it by so that should be the best of both worlds hopefully.

=What is default.xml?=
Default.xml is a file that sits in the monkeyTerm directory (c:\program files\monkeyTerm). When a new xml file is created, either by going to file and clicking on new, by pressing ctrl+n, by clicking new session from the recent sessions list etc, the contents of default.xml is loaded. This means by editing default.xml I was able to make brand new xml files already have some customization when created. Default.xml that is installed by MTScripts has been configured to use the script file that installs with MTScripts. it also has a few extra features besides, including the action that allows MonkeyTerm to make JAWS or Window-Eyes read incoming text from the mud. In short, after installing MTScripts, not only do users get the specific support for muds like Alter Aeon and Miriani by using the xml files that are installed in the files directory under monkeyTerm, but they can make new xml files of their own that already talk, just hit ctrl+n and the whole process is already done.

All of that said, you may have pressed ctrl+f1 to get here, but you may not actually have been using default.xml when you did so. In fact it's likely you weren't. It's likely you created a new xml file and saved it somewhere and pressed ctrl+f1 and wound up with this page. Unless you or someone has made lots of changes to their new xml without remembering to change the link to go to a page that details the xml with it's many customizations, this page will probably still apply and be valid. Mathayas Alter Aeon for example has a different page, so the ctrl+f1 keybinding in that particular xml is modified to lead to that page instead of this one. Hopefully that made some sense.

=how do I open this default.xml?=
You don't, well, you can, but you're not expected to. When you open default.xml a counter goes off and changes the runcount from 0 to 1. This could cause new xml files that are created later to start out with a runcount of 1, which may cause problems. If default.xml must be opened, please change the value of the variable "default/runcounter" to 0 before saving and closing the xml. Default.xml is located in c:\program files\monkeyTerm\default.xml. To open it if that is necessary, open monkeyTerm and close the recent sessions list with alt+f4 if it appears. Press ctrl+o to get the open dialogue. Press shift+tab and use common browse techniques to browse to the path indicated previously for default.xml and press enter on the file. It will be opened and you're ready to go.

It's probably a great idea to read the information on the stuff available in default.xml so that if you create a new xml on your own at some point for a different mud that MTScripts doesn't have direct support for already you can make any adjustments to the xml you need to and know what you are doing.

=What to do if I made a new xml with ctrl+n and wish to save it for a new mud I'm creating an xml for?=
==step 1: give the xml a session name, set the host name, and set the port==
When creating the xml, you were probably prompted for a session name. You should name the session when that appears. If it didn't appear, or you didn't know what to do with it and just accepted it or closed it, you can bring it back up again by pressing f4. This same dialogue is what you need to use for setting the host name and port also.
The first field you get after pressing f4 is the session name. It probably says "default". Delete that out and put what you want. If you are making an xml for Cyber Assault you could put "Cyber Assault". What ever you want. It is for user reference. The second field you have is te host name. It probably has an IP address typed in there like 66.100.167.156 which is the IP address for Alter Aeon. If the mud you are making this xml for isn't Alter Aeon, you should delete this out and type in the IP address or Host Name of the mud you want. Usually, you will have the host name like alterAeon.com or toastsoft.net that you can type in here. The last field is the port number. It will have 3010 written in there already. This is the port blind players use on Alter Aeon. You should change this port to be what you need on the mud you are trying to connect to. You can just press enter after you enter all of this information to accept and return back to the input window of MonkeyTerm.
==save the file==
Now that you've set the session info up, it will be time to save the xml file. To save it, press ctrl+s. A save as dialogue will appear to let you browse to where you want to save your file. I recommend "c:\program Files\monkeyTerm\files". note that even on 64bit systems this still applies. In the file name field type the name you want for your file. I typicall give my file the same name as the session name. Press save to save the file.

That's it, you're done saving the newly created file. After doing this, the file should appear in the recent sessions list that appears when you first open MonkeyTerm.

=A quick tutorial on the available commands, actions, etc, in default.xml=
==Actions==
===default:===
====speech:====
=====output=====
the output action is the action that fetches all text that is sent to the client from the mud and, depending on your settings, may or may not instruct your desired speech system to speak that text. Deleting this action will completely break speech support from the mud, although it will not affect speech that the client does from it's own code.
=====history buffer=====
The history buffer action fetches all text from the screen and stores it in an aray variable which can later be read from using the appropriate keystrokes. The history buffer is an off screen version of all of the text that appears on screen. It allows to read the screen without having to chase text around on screen with the screen reader's flat review mode, and it also allows SAPI5 users to be able to read text they missed a second time. Helpful information is shown on screen about the history buffer when it is turned on. to turn it on, press ctrl+shift+f2. This is a toggle so if it turns off, press it again, or if it turns on and you want it turned off, press it again, etc. Generally this is disabled by default because it can slow down the client.
==Aliases==
===default===
====speedwalk====
This alias allows you to speedwalk by typing in simple one line commands. You can type something like nwswwws and then press enter to go north, west, south, west, west, west, and south all at once. One could also type something like 2s4w1s6w15n1w1n1w1n2w1n45e2s, and it will go that direction the same number of times as the number in front of each letter. The speedwalk is disabled by default because it prevents people from typing in news, as it converts that to north, east, west, south. I could fix that easily, but the other issue is that it doesn't support sub cardinal directions northeast, southeast, southwest, and northwest. It does support up and down. Just check the active checkbox to try it out. Maybe at some point I'll be able to improve this alias.
====connection handling====
=====connect=====
This is an alias that initiates a connection to the mud when invoked. Just type "scon" or "sconnect" into the edit field in Monkey term to connect.
=====disconnect=====
This is an alias that terminates a connection to the mud when invoked. Just type "sdcon" or "sdconnect" or "sdisconnect" into the edit field in Monkey Term to disconnect.
===Autosay===
====launcher====
This alias initiates the autosay alias. it is disabled at the moment do to some major problems with the main autosay alias itself. When this alias is enabled, type asay and a bunch of instructions will appear on screen explaining how to use autosay.
====main====
This alias is the main part of the autosay functionality. The launcher alias turns this on and this alias begins to interpret everything that is typed and prefix it with what ever the launcher instructs it to prefix. This alias is always disabled if autosay functionality is turned off. turning this alias on will prevent all commands from working properly. to try out autosay, please check the active checkbox for the launcher alias and then type asay into the edit field in monkey Term.
==Events==
===default===
====sounds====
There are a few sound events that play sounds for opening the xml file, saving it, initiating a connection, disconnecting, etc. All of the events under default/sounds can be deleted without breaking anything other than the functionality of sounds that alert to when an xml is being saved etc.
====autosay====
=====run=====
this event is the timer that allows one to paste in text for the autosay system to send with the desired prefix, and the text not be sent all at once but rather one line at a time with a pause between each send. To change the pause interval between each send, select this event and change the interval to some other value.
===firstrun===
This event runs every time the xml file is open. it does a lot of different things such as loading up the desired sound volume setting from a stored variable in the xml, adding one to the runcounter, opening free slots for looping sounds, etc. It is this event that shows the text like "this is run number 85" when the xml is first open, but it of course does a whole lot of other stuff as well. This event should not be deleted nor disabled, as some of the things it does are necessary for certain functionalities, such as sound playback, to work properly if at all.
===hll timer===
This event is used for the history buffer. Deleting this event will completely break the history buffer. The code involved with the history buffer is found in a bunch of different keybindings, this event, and the action default/speech/history buffer.
==Keybindings==
===ctrl+[188] (ctrl+,)===
Moves to and reads the previous line in the history buffer.
===f3===
Turns the volume up for the sounds, except for the free slots
===f2===
Turns the volume down for the sounds, except for the free slots
===ctrl+f2===
cycles between the three different speech choices "Jaws or Window-Eyes", "SAPI5", or "no speech". Just press repeatedly until you get the one you want.
===ctrl+[191] (ctrl+/)===
Moves to and reads the next line in the history buffer.
===ctrl+[190] (ctrl+.)===
Reads the current line of the history buffer
===Escape===
Haults any speech currently going on. Most useful for SAPI5, since screen readers you can just press ctrl.
===ctrl+shift+f2===
Toggles the default/speech/history buffer action between enabled and disabled. When disabled, text will not be captured to the history buffer, but all keybindings related to the history buffer will still function. It is possible to turn the history buffer on, mud for a while, then disable it and still read what was stored there when the history buffer was enabled.
===ctrl+shift+[188] (ctrl+shift+,)===
Move to and read the first line in the history buffer
===ctrl+shift+[191] (ctrl+shift+/)===
Moves to and reads the last line in the history buffer.
===ctrl+shift+[190} (ctrl+shift+.)===
Read the history buffer from current location to end, sort of like say all
===ctrl+[222] (ctrl+')===
Spell the current line in the history buffer
===ctrl+f1===
Opens this help file
===ctrl+shift+f3===
Toggles the default/number truncator substitutes. In short it turns the truncation of numbers like 332710 into 332k on and off.
===ctrl+[189] (ctrl+-)===
Switch to the previous adjustable control of SAPI voice.
===ctrl+[187] (ctrl+=)===
Switch to the next adjustable control of SAPI voice.
===Shift+ctrl+[189] (shift+ctrl+-)===
Decrease the value of the current control of SAPI voice.
===shift+ctrl+[187] (shift+ctrl+=)===
Increase the value of the current control of SAPI voice.
==Substitutes==
===default===
====bell====
plays a loud sound when the mud instructs the client to play the bell sound. This keybinding can be deleted and the client will revert to playing the default windows beep sound. I like the sound it plays though, until someone beeps me, cause it usually scares me out of my skin.
====number truncator====
Truncates numbers like 78888151012 into 78.8bil. It's turned off by default. It generally gets in the way when you're trying to figure out how much currency you need for something, so at least it's easy to turn on and off, ctrl+shift+f3.
==Variables==
===sound volume===
Stores how loud you want your sounds to play. This variable's value is saved and restored when the client is opened by the default/firstrun event. If this variable is missing, no error will be printed but the sound's volume will default to 0.5 when the xml is opened. Editing this variable rather than using f2 and f3 will not work to adjust the volume of the sounds for the xml while it is open as that is stored in a visual basic variable for faster access. If the xml is saved and closed and reopened after thee value of this variable is changed the sound will be at the volume indicated in the variable, somewhere between 0.0 and 1.0 are valid values, other values will just go as far as it can go in that direction and then call it quits. I recommend that this and all other default variables be ignored, since the client has code to handle them by itself and editing these variables in correctly can break things.
===runcounter===
Stores how many times the xml has been loaded. the default/firstrun event adds one to this variable and then saves the xml every time the xml is opened.
===primary speech===
Stores which speech system you want to use. If this variable gets deleted or it's value is edited incorrectly it will completely break the speech system.

=summery:=
==Sound related stuff==
To decrease the volume, press f2. To increase it, press f3.
speech
To cycle between the different speech options, press ctrl+f2
History buffer
Press ctrl+shift+f2 to toggle the history buffer on and off.
Press ctrl+shift+, to go to the first line in the history buffer.
Press ctrl+shift+/ to go to the last line in the history buffer.
Press ctrl+, to go to the previous line in the history buffer.
Press ctrl+/ to go to the next line in the history buffer.
Press ctrl+. to read the current line in the history buffer.
Press ctrl+' to spell the current line in the history buffer.
Number Truncator
Press ctrl+shift+f3 to toggle the number truncator on and off.

=Conclusions=
This documentation is basically complete

Default xml

2010-10-05T00:27:56Z

Mathayas:

default.xml

This information currently applies to: MTScripts 3.7.9.7

=Initial notes=
Default.xml's contents is copied into new xmls when they are created. It should never be opened unless one intends to modify the behavior of brand new xml files. That said, newly created xml files, as they use the same information found in default.xml, are still covered by this help file. this help file is actually intended to help people creating new xml files from the ground up and who are using MTScripts to know what they can do to configure their new xml file. so it's kind of an xml file developer's reference. it explains everything found in the fmt and what all of that stuff does. it tries to explain what stuff can and cannot be modified without breaking the functionality of what. If you pressed ctrl+f1 while in something other than default.xml and ended up with this page, it's because the path to the help page for that xml file was not modified and consequently it may mean that xml hasn't itself been modified enough to warrant a specific help file for it.
Notice that when I reference keybindings way down at the end of this help file, or close to the end anyway, on keybindings that have punctuation keys like period, slash, comma, apostrophe involved in them etc, I pointed out the ASCII value of each punctuation key involved. this is because that's what the fmt does to reference the keys, and I did that so readers would be able to figure out which keybinding in the fmt it was exactly that I was talking about. I did point out also which keys actually need to be pressed to activate that keybinding in parentheses after the name the fmt references it by so that should be the best of both worlds hopefully.

=What is default.xml?=
Default.xml is a file that sits in the monkeyTerm directory (c:\program files\monkeyTerm). When a new xml file is created, either by going to file and clicking on new, by pressing ctrl+n, by clicking new session from the recent sessions list etc, the contents of default.xml is loaded. This means by editing default.xml I was able to make brand new xml files already have some customization when created. Default.xml that is installed by MTScripts has been configured to use the script file that installs with MTScripts. it also has a few extra features besides, including the action that allows MonkeyTerm to make JAWS or Window-Eyes read incoming text from the mud. In short, after installing MTScripts, not only do users get the specific support for muds like Alter Aeon and Miriani by using the xml files that are installed in the files directory under monkeyTerm, but they can make new xml files of their own that already talk, just hit ctrl+n and the whole process is already done.

All of that said, you may have pressed ctrl+f1 to get here, but you may not actually have been using default.xml when you did so. In fact it's likely you weren't. It's likely you created a new xml file and saved it somewhere and pressed ctrl+f1 and wound up with this page. Unless you or someone has made lots of changes to their new xml without remembering to change the link to go to a page that details the xml with it's many customizations, this page will probably still apply and be valid. Mathayas Alter Aeon for example has a different page, so the ctrl+f1 keybinding in that particular xml is modified to lead to that page instead of this one. Hopefully that made some sense.

=how do I open this default.xml?=
You don't, well, you can, but you're not expected to. When you open default.xml a counter goes off and changes the runcount from 0 to 1. This could cause new xml files that are created later to start out with a runcount of 1, which may cause problems. If default.xml must be opened, please change the value of the variable "default/runcounter" to 0 before saving and closing the xml. Default.xml is located in c:\program files\monkeyTerm\default.xml. To open it if that is necessary, open monkeyTerm and close the recent sessions list with alt+f4 if it appears. Press ctrl+o to get the open dialogue. Press shift+tab and use common browse techniques to browse to the path indicated previously for default.xml and press enter on the file. It will be opened and you're ready to go.

It's probably a great idea to read the information on the stuff available in default.xml so that if you create a new xml on your own at some point for a different mud that MTScripts doesn't have direct support for already you can make any adjustments to the xml you need to and know what you are doing.

=A quick tutorial on the available commands, actions, etc, in default.xml=
==Actions==
===default:===
====speech:====
=====output=====
the output action is the action that fetches all text that is sent to the client from the mud and, depending on your settings, may or may not instruct your desired speech system to speak that text. Deleting this action will completely break speech support from the mud, although it will not affect speech that the client does from it's own code.
=====history buffer=====
The history buffer action fetches all text from the screen and stores it in an aray variable which can later be read from using the appropriate keystrokes. The history buffer is an off screen version of all of the text that appears on screen. It allows to read the screen without having to chase text around on screen with the screen reader's flat review mode, and it also allows SAPI5 users to be able to read text they missed a second time. Helpful information is shown on screen about the history buffer when it is turned on. to turn it on, press ctrl+shift+f2. This is a toggle so if it turns off, press it again, or if it turns on and you want it turned off, press it again, etc. Generally this is disabled by default because it can slow down the client.
==Aliases==
===default===
====speedwalk====
This alias allows you to speedwalk by typing in simple one line commands. You can type something like nwswwws and then press enter to go north, west, south, west, west, west, and south all at once. One could also type something like 2s4w1s6w15n1w1n1w1n2w1n45e2s, and it will go that direction the same number of times as the number in front of each letter. The speedwalk is disabled by default because it prevents people from typing in news, as it converts that to north, east, west, south. I could fix that easily, but the other issue is that it doesn't support sub cardinal directions northeast, southeast, southwest, and northwest. It does support up and down. Just check the active checkbox to try it out. Maybe at some point I'll be able to improve this alias.
====connection handling====
=====connect=====
This is an alias that initiates a connection to the mud when invoked. Just type "scon" or "sconnect" into the edit field in Monkey term to connect.
=====disconnect=====
This is an alias that terminates a connection to the mud when invoked. Just type "sdcon" or "sdconnect" or "sdisconnect" into the edit field in Monkey Term to disconnect.
===Autosay===
====launcher====
This alias initiates the autosay alias. it is disabled at the moment do to some major problems with the main autosay alias itself. When this alias is enabled, type asay and a bunch of instructions will appear on screen explaining how to use autosay.
====main====
This alias is the main part of the autosay functionality. The launcher alias turns this on and this alias begins to interpret everything that is typed and prefix it with what ever the launcher instructs it to prefix. This alias is always disabled if autosay functionality is turned off. turning this alias on will prevent all commands from working properly. to try out autosay, please check the active checkbox for the launcher alias and then type asay into the edit field in monkey Term.
==Events==
===default===
====sounds====
There are a few sound events that play sounds for opening the xml file, saving it, initiating a connection, disconnecting, etc. All of the events under default/sounds can be deleted without breaking anything other than the functionality of sounds that alert to when an xml is being saved etc.
====autosay====
=====run=====
this event is the timer that allows one to paste in text for the autosay system to send with the desired prefix, and the text not be sent all at once but rather one line at a time with a pause between each send. To change the pause interval between each send, select this event and change the interval to some other value.
===firstrun===
This event runs every time the xml file is open. it does a lot of different things such as loading up the desired sound volume setting from a stored variable in the xml, adding one to the runcounter, opening free slots for looping sounds, etc. It is this event that shows the text like "this is run number 85" when the xml is first open, but it of course does a whole lot of other stuff as well. This event should not be deleted nor disabled, as some of the things it does are necessary for certain functionalities, such as sound playback, to work properly if at all.
===hll timer===
This event is used for the history buffer. Deleting this event will completely break the history buffer. The code involved with the history buffer is found in a bunch of different keybindings, this event, and the action default/speech/history buffer.
==Keybindings==
===ctrl+[188] (ctrl+,)===
Moves to and reads the previous line in the history buffer.
===f3===
Turns the volume up for the sounds, except for the free slots
===f2===
Turns the volume down for the sounds, except for the free slots
===ctrl+f2===
cycles between the three different speech choices "Jaws or Window-Eyes", "SAPI5", or "no speech". Just press repeatedly until you get the one you want.
===ctrl+[191] (ctrl+/)===
Moves to and reads the next line in the history buffer.
===ctrl+[190] (ctrl+.)===
Reads the current line of the history buffer
===Escape===
Haults any speech currently going on. Most useful for SAPI5, since screen readers you can just press ctrl.
===ctrl+shift+f2===
Toggles the default/speech/history buffer action between enabled and disabled. When disabled, text will not be captured to the history buffer, but all keybindings related to the history buffer will still function. It is possible to turn the history buffer on, mud for a while, then disable it and still read what was stored there when the history buffer was enabled.
===ctrl+shift+[188] (ctrl+shift+,)===
Move to and read the first line in the history buffer
===ctrl+shift+[191] (ctrl+shift+/)===
Moves to and reads the last line in the history buffer.
===ctrl+shift+[190} (ctrl+shift+.)===
Read the history buffer from current location to end, sort of like say all
===ctrl+[222] (ctrl+')===
Spell the current line in the history buffer
===ctrl+f1===
Opens this help file
===ctrl+shift+f3===
Toggles the default/number truncator substitutes. In short it turns the truncation of numbers like 332710 into 332k on and off.
===ctrl+[189] (ctrl+-)===
Switch to the previous adjustable control of SAPI voice.
===ctrl+[187] (ctrl+=)===
Switch to the next adjustable control of SAPI voice.
===Shift+ctrl+[189] (shift+ctrl+-)===
Decrease the value of the current control of SAPI voice.
===shift+ctrl+[187] (shift+ctrl+=)===
Increase the value of the current control of SAPI voice.
==Substitutes==
===default===
====bell====
plays a loud sound when the mud instructs the client to play the bell sound. This keybinding can be deleted and the client will revert to playing the default windows beep sound. I like the sound it plays though, until someone beeps me, cause it usually scares me out of my skin.
====number truncator====
Truncates numbers like 78888151012 into 78.8bil. It's turned off by default. It generally gets in the way when you're trying to figure out how much currency you need for something, so at least it's easy to turn on and off, ctrl+shift+f3.
==Variables==
===sound volume===
Stores how loud you want your sounds to play. This variable's value is saved and restored when the client is opened by the default/firstrun event. If this variable is missing, no error will be printed but the sound's volume will default to 0.5 when the xml is opened. Editing this variable rather than using f2 and f3 will not work to adjust the volume of the sounds for the xml while it is open as that is stored in a visual basic variable for faster access. If the xml is saved and closed and reopened after thee value of this variable is changed the sound will be at the volume indicated in the variable, somewhere between 0.0 and 1.0 are valid values, other values will just go as far as it can go in that direction and then call it quits. I recommend that this and all other default variables be ignored, since the client has code to handle them by itself and editing these variables in correctly can break things.
===runcounter===
Stores how many times the xml has been loaded. the default/firstrun event adds one to this variable and then saves the xml every time the xml is opened.
===primary speech===
Stores which speech system you want to use. If this variable gets deleted or it's value is edited incorrectly it will completely break the speech system.

=summery:=
==Sound related stuff==
To decrease the volume, press f2. To increase it, press f3.
speech
To cycle between the different speech options, press ctrl+f2
History buffer
Press ctrl+shift+f2 to toggle the history buffer on and off.
Press ctrl+shift+, to go to the first line in the history buffer.
Press ctrl+shift+/ to go to the last line in the history buffer.
Press ctrl+, to go to the previous line in the history buffer.
Press ctrl+/ to go to the next line in the history buffer.
Press ctrl+. to read the current line in the history buffer.
Press ctrl+' to spell the current line in the history buffer.
Number Truncator
Press ctrl+shift+f3 to toggle the number truncator on and off.

=Conclusions=
This documentation is basically complete

Mathayas alter aeon

2010-10-04T11:39:53Z

Mathayas: Adding descriptions for triggers and order in the cfg command.

Mathayas Alter Aeon.xml

This help file currently directly applies to: MTScripts 3.4.4.1

=What is Mathayas Alter Aeon.xml?=
Mathayas Alter Aeon.xml is a soundpack for the mud Alter Aeon. It has sounds for most spells and a few other things as well. It uses the prompt from the mud and does a number of interesting things with it. It is part of MTScripts and includes a neat little XP and gold counter which lets you keep track of how much experience and gold you've gained or lost. Most of my time working with MTScripts went straight into Mathayas Alter Aeon.xml, which is an exact copy of the xml I use to play the character Mathayas on alter Aeon. It has a lot of functionality, and this help page will try to touch on everything so new or upgrading users can take advantage of all the features.

=How to open Mathayas Alter Aeon.xml?=
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\Mathayas Alter Aeon.xml and open it. These instructions are correct even for those of you running 64 bit versions of windows.

=What are some initial setup configurations one should make to get this xml to work best?=
Note that the config or cfg command has been introduced to make initial setup easier. If you prefer, you can just type cfg and press enter to be presented with a list of options that you can configure.
==Select desired speech output==
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.

==Modify your eq change aliases to set the eq variable (optional).==
The eq variable is an Alter Aeon based variable that Monkey Term monitors, changing it's own variable's value to match that of the Alter Aeon variable. The purpose of this is to help Monkey term figure out what equipment set you are wearing and behave differently depending. For instance, if it thinks you are in hit and you have the trigger system turned on, it will make you automatically assist, etc. To learn about Alter Aeon's variable functionality, log into it and type help variable. Note that using triggers in groups is against the rules on Alter Aeon. The trigger system exists for you to use at your own risk. To set this up, at the end of each alias you have made for changing equipment you need a command that looks like this.
var eq eqhit
The above command has the word hit in it, telling Monkey term to behave like you are in a hit set. right now there are three different values that make a difference, eqhit, eqtank and eqheal. If you set it to eqblah for example, it will behave as though the variable were not set at all.
Tip: You can just type this yourself into alter Aeon instead of putting it in your equipment change aliases. Useful if you don't have eq change aliases or otherwise haven't added them to your aliases. Note that until this variable is set you will receive a slightly annoying error when you log in that says variable not set or something along those lines. To stop this error message, just type var eq eqblah.

=Hotkeys=
There are many hotkeys that can be used to do a wide variety of different things. Here we'll take an in depth look at the keybindings. Keybindings, by the way, is Monkey Term's name for hotkeys.

==Speech related==
===ctrl+f2: toggle the selected speech output===

===ctrl+shift+f2: toggle the history buffer===

==Prompt related==
===f6: Cycle through the different values that can be adjusted===

===f7: decrease the currently selected value===

===f8: Increase the currently selected value===

===ctrl+grave accent: speak the current health of the character and that of the target if any===

==Spell reporter keybindings==
===ctrl+shift+q: cycle through the different spell reporter options that can be adjusted===

===ctrl+shift+w: toggle the value of the currently selected option that was chosen with ctrl+shift+q===

==Melee hotkeys==
===ctrl+b: bash===

===ctrl+l: leap===

===ctrl+k: kick===

===ctrl+i: trip===

===ctrl+t: throw and then retrieve the item selected with the config throw command at the current target===

===ctrl+g: retrieve the throw item selected from up to 5 different corpses and from the ground===

==Others==
===ctrl+shift+h: enters the home command===

===ctrl+r: replay the last two channels ends that contain the word tell===

===ctrl+shift+f3: toggle the number truncator===

===f2: decrease the sound volume===

===f3: increase the sound volume===

===shift+f2: decrease the terrain sound volume===

===shift+f3: increase the terrain sound volume===

===Grave Accent: Check the health condition of group members===

==History buffer commands==
===ctrl+shift+f2: Toggle the history buffer on and off===

===ctrl+shift+comma: beginning of buffer===

===ctrl+shift+slash: end of buffer===

===ctrl+comma: previous buffer entry===

===ctrl+slash: next buffer entry===

===ctrl+period: read current buffer entry===

===ctrl+shift+period: Read from current history buffer entry to end===

===ctrl+apostrophe: spell current buffer entry===

=The Config command (cfg)=
The config command, cfg for short, allows the user to make changes to the way Monkey Term behaves when using Mathayas Alter Aeon.xml. To use the config command, type cfg and press enter. A list of options will be given. If the meaning of one of the choices is unclear, see this section of the documentation for enlightenment. In most cases, the options can be toggled. If the option says it is enabled or disabled it can be toggled. Otherwise, something else must be typed after it to enable it, or nothing at all to disable it. See below to find out more about this.

==Basic options:==
===ali: set up automatic logging in (currently mathayas)===
Syntax to auto log into Mathayas example: cfg ali mathayas password
Syntax to disable auto log in: cfg ali
This command enables the user to configure MTScripts to automatically log a character in when the file is open. To set this up, type cfg, a space, the name of the character, another space, then the password and press enter. To disable this functionality, just type cfg, a space, then ali (cfg ali).
NOTE: This functionality stores your password in a variable with no encryption, so it is not secure. If one looks at the variable, the password will be written there, clear as day. If you've security concerns please do not use ali.

===history: Store channel sends in the history buffer? enabled===
Syntax to toggle this on and off: cfg history
This functionality will track most channel sends and store them in the history buffer so they can be read with the history buffer commands. To learn how to read the history buffer please see the section dedicated to history buffer commands in this same document. When this functionality has been enabled, the standard history buffer will be disabled, so the only thing stored in the history buffer will be channel sends. This will be useful for those who have JAWS or Window-Eyes, but need a way to keep up with people are saying during spammy situations.
NOTE: When this functionality is toggled on while the standard history buffer functionality is already on, the standard history buffer functionality will be automatically disabled. To switch back to the standard history buffer functionality, please use the standard history buffer toggle hotkey ctrl+shift+f2. Doing this will automatically disable the channel history buffer.

===reset: reset the xml to distribution default settings===
Syntax to reset the file to distribution defaults: cfg reset
This command resets the xml file to it's default distribution settings. It will disable auto login and remove the user and password information from that, as well as turn off the order functionality, etc. I, that is the developer of MTScripts, use this command to make sure I have removed my own password and my own preferred configuration before I package up a new version of MTScripts for distribution. If you mess something up, cfg reset may fix it, depending on what the problem is.

==Triggers and automation==
===triggers: Use the trigger system? disabled===
syntax to toggle: cfg trigs
These are actions that will make the character automatically do certain things when in groups. Use the eq variable mentioned early on in this documentation to control what the triggers do. See the section mentioning that eq variable for more information.
NOTE: Group bots are now against the rules on Alter Aeon. So use this functionality at your own risk. It is disabled by default.

===order: use the order functionality? enabled===
Syntax to toggle: cfg order
Order is a trigger that allows anyone listed in it to have complete control over the character. It behaves just like the ordering of minions. Just type order name command and what ever you ordered will perform that action if it were charmed by you or happened to be your minion who also happened to have enough intelligence to follow commands. To adjust who can order the character when it is enabled, find the action misc/order. Understand the code in the if statement before adding or removing names.
NOTE: Order is set to allow people whom Mathayas has allowed to order him by default. A new user of MTScripts should not use order, as they don't know who can order them until they look at the code in action/misc/order. Order allows complete power over the character. Someone can order the character to quit, drop equipment, donate, sacrifice, send tells, sleep, leap, bash, trip, shout something, spamm people, beep someone, kill themselves, etc. User should not use order unless they know what they are doing. Order is disabled by default. Type cfg order until it says it is disabled.

===autogroup: automatically group those who follow you? disabled===
syntax to toggle: cfg autogroup
Autogroup will group anyone who follows the character automatically. This is disabled by default.

===recast: reattempt spells when they fail to cast? enabled===
===gold: automatic gold looting? enabled===
===throw: set the keyword(s) to use with ctrl+t (currently tomahawk)===
===report: set where the improvement reports go (currently yt)===
===pickpocket: Automatically continue pickpocketing? Enabled===
===picklocks: Automatically continue picking doorlocks? Enabled===
===rs: Report time needed to regen (not set).===

==Text hiding, truncating and verbocity:==
===sitstand: hide texts of others sitting and standing? disabled===
===numbers: Truncate numbers? enabled===
===exits: Truncate exits and put them before room description? enabled===
===osm: Monitor the spells of group members? enabled===

==Soundpack settings:==
===sounds: use the soundpack? enabled===
===channels: Set up beep sound for most channels===

=Conclusions=
this help file is still being written.

Mathayas alter aeon

2010-10-03T01:22:51Z

Mathayas: Working toward getting this helpfile to be more compatible with newest MTScripts, the one that comes after 3.4.4.1. This edit adds in help for the basic portion of the cfg command.

Mathayas Alter Aeon.xml

This help file currently directly applies to: MTScripts 3.4.4.1

=What is Mathayas Alter Aeon.xml?=
Mathayas Alter Aeon.xml is a soundpack for the mud Alter Aeon. It has sounds for most spells and a few other things as well. It uses the prompt from the mud and does a number of interesting things with it. It is part of MTScripts and includes a neat little XP and gold counter which lets you keep track of how much experience and gold you've gained or lost. Most of my time working with MTScripts went straight into Mathayas Alter Aeon.xml, which is an exact copy of the xml I use to play the character Mathayas on alter Aeon. It has a lot of functionality, and this help page will try to touch on everything so new or upgrading users can take advantage of all the features.

=How to open Mathayas Alter Aeon.xml?=
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\Mathayas Alter Aeon.xml and open it. These instructions are correct even for those of you running 64 bit versions of windows.

=What are some initial setup configurations one should make to get this xml to work best?=
Note that the config or cfg command has been introduced to make initial setup easier. If you prefer, you can just type cfg and press enter to be presented with a list of options that you can configure.
==Select desired speech output==
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.

==Modify your eq change aliases to set the eq variable (optional).==
The eq variable is an Alter Aeon based variable that Monkey Term monitors, changing it's own variable's value to match that of the Alter Aeon variable. The purpose of this is to help Monkey term figure out what equipment set you are wearing and behave differently depending. For instance, if it thinks you are in hit and you have the trigger system turned on, it will make you automatically assist, etc. To learn about Alter Aeon's variable functionality, log into it and type help variable. Note that using triggers in groups is against the rules on Alter Aeon. The trigger system exists for you to use at your own risk. To set this up, at the end of each alias you have made for changing equipment you need a command that looks like this.
var eq eqhit
The above command has the word hit in it, telling Monkey term to behave like you are in a hit set. right now there are three different values that make a difference, eqhit, eqtank and eqheal. If you set it to eqblah for example, it will behave as though the variable were not set at all.
Tip: You can just type this yourself into alter Aeon instead of putting it in your equipment change aliases. Useful if you don't have eq change aliases or otherwise haven't added them to your aliases. Note that until this variable is set you will receive a slightly annoying error when you log in that says variable not set or something along those lines. To stop this error message, just type var eq eqblah.

=Hotkeys=
There are many hotkeys that can be used to do a wide variety of different things. Here we'll take an in depth look at the keybindings. Keybindings, by the way, is Monkey Term's name for hotkeys.

==Speech related==
===ctrl+f2: toggle the selected speech output===

===ctrl+shift+f2: toggle the history buffer===

==Prompt related==
===f6: Cycle through the different values that can be adjusted===

===f7: decrease the currently selected value===

===f8: Increase the currently selected value===

===ctrl+grave accent: speak the current health of the character and that of the target if any===

==Spell reporter keybindings==
===ctrl+shift+q: cycle through the different spell reporter options that can be adjusted===

===ctrl+shift+w: toggle the value of the currently selected option that was chosen with ctrl+shift+q===

==Melee hotkeys==
===ctrl+b: bash===

===ctrl+l: leap===

===ctrl+k: kick===

===ctrl+i: trip===

===ctrl+t: throw and then retrieve the item selected with the config throw command at the current target===

===ctrl+g: retrieve the throw item selected from up to 5 different corpses and from the ground===

==Others==
===ctrl+shift+h: enters the home command===

===ctrl+r: replay the last two channels ends that contain the word tell===

===ctrl+shift+f3: toggle the number truncator===

===f2: decrease the sound volume===

===f3: increase the sound volume===

===shift+f2: decrease the terrain sound volume===

===shift+f3: increase the terrain sound volume===

===Grave Accent: Check the health condition of group members===

==History buffer commands==
===ctrl+shift+f2: Toggle the history buffer on and off===

===ctrl+shift+comma: beginning of buffer===

===ctrl+shift+slash: end of buffer===

===ctrl+comma: previous buffer entry===

===ctrl+slash: next buffer entry===

===ctrl+period: read current buffer entry===

===ctrl+shift+period: Read from current history buffer entry to end===

===ctrl+apostrophe: spell current buffer entry===

=The Config command (cfg)=
==Basic options:==
===ali: set up automatic logging in (currently mathayas)===
Syntax to auto log into Mathayas example: cfg ali mathayas password
Syntax to disable auto log in: cfg ali
This command enables the user to configure MTScripts to automatically log a character in when the file is open. To set this up, type cfg, a space, the name of the character, another space, then the password and press enter. To disable this functionality, just type cfg, a space, then ali (cfg ali).
NOTE: This functionality stores your password in a variable with no encryption, so it is not secure. If one looks at the variable, the password will be written there, clear as day. If you've security concerns please do not use ali.

===history: Store channel sends in the history buffer? enabled===
Syntax to toggle this on and off: cfg history
This functionality will track most channel sends and store them in the history buffer so they can be read with the history buffer commands. To learn how to read the history buffer please see the section dedicated to history buffer commands in this same document. When this functionality has been enabled, the standard history buffer will be disabled, so the only thing stored in the history buffer will be channel sends. This will be useful for those who have JAWS or Window-Eyes, but need a way to keep up with people are saying during spammy situations.
NOTE: When this functionality is toggled on while the standard history buffer functionality is already on, the standard history buffer functionality will be automatically disabled. To switch back to the standard history buffer functionality, please use the standard history buffer toggle hotkey ctrl+shift+f2. Doing this will automatically disable the channel history buffer.

===reset: reset the xml to distribution default settings===
Syntax to reset the file to distribution defaults: cfg reset
This command resets the xml file to it's default distribution settings. It will disable auto login and remove the user and password information from that, as well as turn off the order functionality, etc. I, that is the developer of MTScripts, use this command to make sure I have removed my own password and my own preferred configuration before I package up a new version of MTScripts for distribution. If you mess something up, cfg reset may fix it, depending on what the problem is.

==Triggers and automation==
===triggers: Use the trigger system? disabled===
===order: use the order functionality? enabled===
===autogroup: automatically group those who follow you? disabled===
===recast: reattempt spells when they fail to cast? enabled===
===gold: automatic gold looting? enabled===
===throw: set the keyword(s) to use with ctrl+t (currently tomahawk)===
===report: set where the improvement reports go (currently yt)===
===pickpocket: Automatically continue pickpocketing? Enabled===
===picklocks: Automatically continue picking doorlocks? Enabled===
===rs: Report time needed to regen (not set).===

==Text hiding, truncating and verbocity:==
===sitstand: hide texts of others sitting and standing? disabled===
===numbers: Truncate numbers? enabled===
===exits: Truncate exits and put them before room description? enabled===
===osm: Monitor the spells of group members? enabled===

==Soundpack settings:==
===sounds: use the soundpack? enabled===
===channels: Set up beep sound for most channels===

=Conclusions=
this help file is still being written.