Jump to content

Mathayas alter aeon: Difference between revisions

From Valiant8086.com wiki
No edit summary
No edit summary
 
Line 167: Line 167:
==Soundpack settings:==
==Soundpack settings:==
===sounds: use the soundpack? enabled===
===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===
===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=
=Conclusions=
this help file is still being written.
this help file is still being written.

Latest revision as of 10:42, 4 December 2013

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.