Chapter 3. Usage

Table of Contents

GgrTF core (ggrtf.tf)
Macro commands
Statusline
State-saving
What is saved?
Special, non-saved variables
How to setup TF for state-saving
How to make state-saving automatic
Macro commands
Command bindings
Defining bindings
Enabling bindings
Keyboard numpad movement hooks
Macro commands
Prot management
Macro commands
Skill and spell handling
Miscellaneous stuff (ggrtf-misc.tf)
Macro commands
Magical guilds support (ggrtf-magical.tf)
PSS-mangler (ggrtf-pssmangle.tf)
HP/SP/EP colours
Player name colours
Macro commands
Party Placer (ggrtf-pplacer.tf)
Macro commands
Party Prots Tracker (ggrtf-ptracker.tf)
Macro commands
Spellwords translator (ggrtf-spellnames.tf)
Macro commands
HCBat support (ggrtf-hc.tf)
TinyFugue 5 support (ggrtf-tf5.tf)
Raise/Resurrect/New Body/etc. (ggrtf-rais.tf)
Macro commands
Hit Statistics (ggrtf-hstats.tf)
Macro commands
Guild: Channellers (ggrtf-chann.tf)
Guild: Merchants (ggrtf-merchant.tf)
Macro commands
Settings and user-replaceable macros
Guild: Barbarian (ggrtf-barb.tf)
Macro commands
Guild: Spiders (ggrtf-spiders.tf)
Macro commands
Guild: Tarmalens (ggrtf-tarma.tf)
Guild: Druids (ggrtf-druid.tf)
Guild: Nuns (ggrtf-nun.tf)
Guild: Lords of Chaos (ggrtf-loc.tf)
Macro commands

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.

Following block-diagram represents the structure of GgrTF and how different components approximately relate to each other:

GgrTF's internal structure

Internal structure and relations of GgrTF components represented as block-diagram.

GgrTF core (ggrtf.tf)

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.

  • Battle round handling. Enables commands to be executed each battle round and autopss functionality.

  • 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.

  • Prompt gagging. Optional skill/spell viewing in prompt, which shows the currently ongoing skill or spell in your prompt.

  • Spell round reporting. Enables you to optionally spam your fellow players with information how many rounds are left until your spell goes off.

  • 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)

Macro commands

<> = required argument, [] = optional argument

Each of these commands will print current setting/value and usage information if executed without arguments (or in some cases, with incorrect arguments).

Table 3.1. Macro commands

Command Description
/opts Lists all the run-time changeable settings of GgrTF, with short descriptions and current values.
/stats Display miscellaneous statistics about skills, spells, etc.
/move <type> Change the meaning of keyboard movement hooks.
/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 to the MUD at opponent R.I.P, if /ripaction is "cmd".
/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.
/locaction <action> 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.
/lichaction <action> Sets action taken after a Lich performs "soul sucking".
/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.
/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 reason when you need to remove all prots at your discretion.
/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.
/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.
/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.
/binds List all currently defined GgrTF command bindings. Refer to bindings section for more information and example output.
/gsave Save all GgrTF settings. Refer to state saving section for more information.
/gload Load GgrTF settings. Refer to state saving section for more information.
/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.