Table of Contents
This chapter describes the structure of GgrTF, what the different modules included in GgrTF are and what functionality they provide. There are basically three flavours of modules: generic modules that are either required or optional and provide functionality unrelated to specific guilds; then there are guild-related modules, containing guild-specialties.
Each module section has short introduction about what is provided and section with macro commands and variables available. Some modules also have additional information about usage and configuration with examples.
This is the main module and core of GgrTF. It contains helper macro functions used by all the other modules and is thus always required to be loaded. It also provides much of the basic functionality, such as:
Statusline. Provides nice, realtimeish view of your character's current condition, applied prots and other such information.
Prot management. Keeps note of what prots have been cast at you, and provides this information in various ways.
Curse/degen/etc tracking. Tracks what handicaps have been cast at enemies (non-partymembers). This information is most useful in eq-parties.
Battle round handling. Enables commands to be executed each battle round and autopss functionality.
Heartbeat and tick prediction. Display prediction of next "tick" via a heartbeat counter.
Functions for binding command strings to macros, or to cast spells and use skills, with or without reporting to party channel. See bindings section for more information.
Support for state-saving. Most GgrTF settings can be saved to files and reloaded later (for example at startup) with /gsave and /gload commands.
Automatic "ripaction", which is performed when your opponent (monster) dies. This way you can automate small inconveniencies like looting and digging of graves.
Keyboard movement handling and mapping. Bind your numpad keys to move around, either by walking, walking with peering in adjacent rooms (useful for merchants) or guiding your ship. Additional modes may be provided by other optional modules.
Enemy shape string highlighting and reformatting. You can make GgrTF mangle 'scan' command's output into more readable and convenient form.
Keep and display statistics about skills, spells and whatnots. ("/stats" command)
Consider-skill reporting: Takes output of 'consider' skill and compresses the information into one prettyprinted line, which is reported. Output is name of the target, estimated experience worth and final estimation of target's toughness.
Combat Damage Analysis reporting: Triggers for reporting results of CDA-skill to party report-channel.
Purse contents prettyprinting: Highlites and colorizes the output of 'look at purse', and calculates total sum of money (in gold) contained in the purse.
Camping status handling and reporting: Keeps note of whether you can use 'camping' skill. Reports the hp/sp/ep gained from resting.
Ceremony status: Tracks status of ceremony, and provides macro "/ceremony", which executes ceremony skill only if ceremony is not active currently.
Path compression for map.tf: TinyFugue distribution comes with map.tf, which enables easy creation of walkpaths (See "/help map" in TF). GgrTF adds an special purpose RLE compressor function, which reduces the length of the paths. Additional command to output the paths in format that is compatible with BatMUD's "command"-aliases is also provided.
Plus numerous miscellaneous reporting- and helper-triggers.
<> = required argument, [] = optional argument
Table 4.1. GgrTF core macro commands
| Command | Description |
|---|---|
| /autopss | Toggle autopss-functionality on/off. If enabled, /pss macro is executed on each battle round flag. By default, /pss is 'party short status', but some modules (like PSS-mangler) override this to provide additional functionality. |
| /balance | Perform Alexandra sleeves 'balance', but only if the current HP - SP difference is favorable. |
| /binds | List all currently defined GgrTF command bindings. Refer to bindings section for more information and example output. |
| /ceremony | Perform skill 'ceremony', but only if ceremony is not already "active". |
| /chkbalance | Check and report the status of Alexandra sleeve 'balance' without actually performing 'balance'. |
| /cprots | This command clears all prots on you. It is meant for those cases where GgrTF is either bugging and does not notice a prot dropping, or any other |
| /cruise | Toggle cruise mode if movement mode is ship (/move ship). |
| /gagsc | Toggle gagging of short score ('sc') messages. |
| /gload | Load GgrTF settings. Refer to state saving section for more information. |
| /gprompt [prompt string] | Set or change GgrTF's displayed prompt. The setting can contain any TinyFugue expressions, such as variable substitutions. Refer to prompt settings section for details. |
| /grepcmd [grep command] | Set what BatMUD command GgrTF uses for all 'grep' actions. Default value is 'grep'. The value is automatically prefixed with a '@@' escape sequence. |
| /greset | Reset all skill/spell counters and statistics. Notice that issuing this command also requires executing of "/gsave" if you want to save the zeroed statistics, otherwise the old saved statistics will be loaded on next /gload. |
| /gsave | Save all GgrTF settings. Refer to state saving section for more information. |
| /gver | Prints (or returns, if called as function) a short version string of GgrTF. |
| /gversion | Prints (or returns, if called as function) a long version string of GgrTF with copyright- and TinyFugue version information. |
| /lichaction <action> | Sets action taken after a Lich performs "soul sucking". |
| /move <type> | Change the meaning of keyboard movement hooks. |
| /opts | Lists all the run-time changeable settings of GgrTF, with short descriptions and current values. |
| /peer [regexp string] | View or set regular expression used with autopeering movement mode (/move peer). |
| /prots | Show any currently active prots on you. The output is only echoed locally, use BatMUD 'tweak me' emote to list prots to party report-channel. |
| /rcda | Toggle reporting of Combat Damage Analysis. If set 'off', CDA reports are only displayed locally to you, if set 'on', reporting is done to party report channel. |
| /ripaction <action> | Set the action performed at opponent RIP. Possible additional settings may be provided by other loaded modules. Functions provided by base GgrTF are: off (no special action performed), dig (dig grave for corpse), eat (get and eat corpse), get (get corpse) and cmd (execute mud command(s) specified with /ripcommand setting, see /ripcommand) |
| /ripcommand [commands] | Sets the MUD command(s) to be executed if /ripaction is set to "cmd". This string is sent "as is" to the MUD at opponent R.I.P, if /ripaction is "cmd". Sets action taken after a Lord of Chaos performs "blood corpse". This is useful for automating corpse handling, if you are a LoC yourself, or are partying with one. |
| /rmisc | Toggle miscellaneous reporting features. |
| /round [commands] | Sets the BatMUD command(s) to be executed on each battle round. The string of commands is sent to the MUD when battle round flag is received. |
| /roundmin <value> | Maximum amount of spell rounds left before reporting number of rounds. See /rrounds setting. |
| /rrounds | Report spell rounds to 'party report' channel. This functionality has some minor "intelligence" to report only relevant information, but it may be considered spammy and annoying by many people. |
| /shape | Reports the last catched shape of a opponent (monster) in battle. This does not work too well if you were fighting more than one opponents. |
| /shipmove <off|view|map> | Set what action is performed when ship movement is detected. |
| /skspam | Toggle skill/spell start/end liting spam. If disabled, normal BatMUD skill and spell start and finish lines are let through unmangled. |
| /stats | Display miscellaneous statistics about skills, spells, etc. |
| /verbose | Toggle in-MUD verbosity on and off. Off means that some things are echoed to client only, aka you. On means that those things are reported on party channel, etc. |
Table 4.2. GgrTF core 'general' type command bindings
| Command | Quiet | NoTarget | Description |
|---|---|---|---|
| cere | X | /ceremony | |
| prots | /prots | ||
| curses | /curses | ||
| cbalance | /chkbalance | ||
| balance | /balance |