The GgrTF User's Guide

Matti Hämäläinen

Jarkko Vääräniemi

This document is distributed under Creative Commons Attribution-ShareAlike 2.5 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. THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.

2009


Table of Contents

1. Preface
What is GgrTF?
Is GgrTF for Me?
History of GgrTF
GgrTF License
2. Installation
Getting GgrTF
Releases
Subversion-repository
Configuration
TF configuration
BatMUD settings
3. Usage
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
A. Support
B. Frequently Asked Questions (FAQ)
C. How to verify package signatures via GnuPG

List of Tables

3.1. Macro commands
3.2. Variables
3.3. Macro commands
3.4. Arguments common to all binding defination macros
3.5. Arguments specific to generic bindings (/prdefgbind)
3.6. Arguments specific to spell casting and skill usage bindings (/prdefcbind and /prdefsbind)
3.7. Binding defination examples
3.8. Macro commands
3.9. Prot entries
3.10. Commands
3.11. Commands
3.12.
3.13.
3.14. Macro commands
3.15. Macro commands
3.16. Macro commands
3.17. Macro commands
3.18. Macro commands
3.19. Macro commands
3.20. Macro commands
3.21. Unfinished / buggy macros
3.22.
3.23. Macro commands
3.24. Macro commands
3.25. Macro commands