The GgrTF v0.7.4.2 User's Guide

Matti Hämäläinen

Jarkko Vääräniemi

This document is distributed under Creative Commons Attribution-Share Alike 3.0 license, of which full version can be found from Creative Commons website.

THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.

BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. TO THE EXTENT THIS LICENSE MAY BE CONSIDERED TO BE A CONTRACT, THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.

2021


Table of Contents

1. Preface
What is GgrTF?
Is GgrTF for Me?
History of GgrTF
GgrTF License
2. Installation
Releases
Development version
Checking out
Keeping up to date
3. Configuration
TF configuration file
Character set encoding and locales
Terminal/keyboard issues
BatMUD settings
4. Usage
GgrTF core (ggrtf.tf)
Macro commands
Statusline
Prompt configuration
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
Bindings listing
Keyboard numpad hooks
Macro commands
Prot management
Macro commands
Curse management
Macro commands
Heartbeat and tick prediction
Technical details
Skill handling
Magical guilds support (gm-magical.tf)
PSS-mangler (gm-pssmangle.tf)
HP/SP/EP colours
Player name colours
Macro commands
Party Placer (gm-pplacer.tf)
Macro commands
Party Prots Tracker (gm-ptracker.tf)
Spellwords translator (gm-spellnames.tf)
Numpad targetted casting (gm-tgtcast.tf)
HCBat support (gm-hcbat.tf)
TinyFugue 5 support (gm-tf5.tf)
Raise/Resurrect/New Body/etc. (gm-rais.tf)
Hit Statistics (gm-hitstats.tf)
Identify output beautifier (gm-identify.tf)
Reagent Pouch handler (gm-rpouch.tf)
Guild: Channellers (gm-chann.tf)
Guild: Mages (gm-mage.tf)
Guild: Merchants (gm-merchant.tf)
Settings and user-replaceable macros
Guild: Alchemists (gm-alchemist.tf)
Guild: Barbarian (gm-barb.tf)
Macro commands
Guild: Spiders (gm-spider.tf)
Guild: Tigers (gm-tiger.tf)
Guild: Tarmalens (gm-tarma.tf)
Guild: Druids (gm-druid.tf)
Guild: Nuns (gm-nun.tf)
Guild: (Old) Lords of Chaos (gm-oldloc.tf)
A. Support
Sending patches/corrections
B. Frequently Asked Questions (FAQ)
C. How to verify package signatures via GnuPG

List of Tables

4.1. GgrTF core macro commands
4.2. GgrTF core 'general' type command bindings
4.3. Special, non-saved variables
4.4. Macro commands
4.5. Arguments common to all binding defination macros
4.6. Arguments specific to generic bindings (/prdefgbind)
4.7. Arguments specific to spell casting and skill usage bindings (/prdefcbind and /prdefsbind)
4.8. Binding defination examples
4.9. Macro commands
4.10. Prot entries
4.11. Macro commands
4.12. Macro commands
4.13. List of HP/SP/EP indicator colours
4.14. List of possible player name lite colours
4.15. Macro commands
4.16. Macro commands
4.17. Party Prots Tracker macro commands
4.18. Party Prots Tracker 'general' type command bindings
4.19. Spellwords translator macro commands
4.20. Macro commands
4.21. Raise/Resurrect/New Body/etc. 'general' type command bindings
4.22. Hit Statistics macro commands
4.23. Reagent Pouch handler macro commands
4.24. Guild: Mages 'cast' type command bindings
4.25. Guild: Mages keybindings
4.26. Guild: Merchants macro commands
4.27. Guild: Merchants 'general' type command bindings
4.28.
4.29. Guild: Alchemists macro commands
4.30. Guild: Alchemists 'general' type command bindings
4.31. Macro commands
4.32. Guild: Barbarian 'general' type command bindings
4.33. Guild: Spiders macro commands
4.34. Guild: Tigers macro commands
4.35. Guild: Tarmalens macro commands
4.36. Guild: Tarmalens 'cast' type command bindings
4.37. Guild: Tarmalens keybindings
4.38. Guild: Druids 'cast' type command bindings
4.39. Guild: Druids 'general' type command bindings
4.40. Guild: Nuns macro commands
4.41. Guild: Nuns 'cast' type command bindings
4.42. Guild: (Old) Lords of Chaos macro commands