Mercurial > hg > batmud > ggrtf
annotate docs/manual.sgml @ 1684:bcb60bb50a5a
Oops, TF5 section had partially been left in.
| author | Matti Hamalainen <ccr@tnsp.org> |
|---|---|
| date | Mon, 01 Apr 2024 23:10:08 +0300 |
| parents | 61eb734a16f3 |
| children |
| rev | line source |
|---|---|
| 1547 | 1 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V5.0//EN" "/usr/share/xml/docbook/schema/dtd/5.0/docbook.dtd"> |
|
624
cc40c7360880
The manual is now pseudo-XML conformant, you have to use normalizeml.pl to convert to syntactically correct XML.
Matti Hamalainen <ccr@tnsp.org>
parents:
622
diff
changeset
|
2 <!-- Define some entities |
| 1673 | 3 <!ENTITY ggrtfver "0.7.5.0"> |
|
1665
dc2ae49143e7
Update http URLs to https.
Matti Hamalainen <ccr@tnsp.org>
parents:
1664
diff
changeset
|
4 <!ENTITY finger "<ulink url='https://www.bat.org/char/$1'>$1</ulink>"> |
| 1060 | 5 <!ENTITY jeskko "<ulink url='http://jeskko.pupunen.net/'>Jarkko Vääräniemi</ulink> (&finger Jeskko;)"> |
|
1665
dc2ae49143e7
Update http URLs to https.
Matti Hamalainen <ccr@tnsp.org>
parents:
1664
diff
changeset
|
6 <!ENTITY ggr "<ulink url='https://tnsp.org/~ccr/'>Matti Hämäläinen</ulink> (&finger Ggr;)"> |
|
dc2ae49143e7
Update http URLs to https.
Matti Hamalainen <ccr@tnsp.org>
parents:
1664
diff
changeset
|
7 <!ENTITY tfurl "<ulink url='https://tinyfugue.sf.net/'>TinyFugue</ulink>"> |
|
dc2ae49143e7
Update http URLs to https.
Matti Hamalainen <ccr@tnsp.org>
parents:
1664
diff
changeset
|
8 <!ENTITY homeurl "<ulink url='https://tnsp.org/~ccr/ggrtf/'>http://tnsp.org/~ccr/ggrtf/</ulink>"> |
|
1650
e3626f2d850e
Update to new repository URLs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1645
diff
changeset
|
9 <!ENTITY hgrepourl "https://tnsp.org/hg/batmud/ggrtf/"> |
|
e3626f2d850e
Update to new repository URLs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1645
diff
changeset
|
10 <!ENTITY hgrepo "<ulink url='https://tnsp.org/hg/batmud/ggrtf/'>Mercurial-repository</ulink>"> |
|
1665
dc2ae49143e7
Update http URLs to https.
Matti Hamalainen <ccr@tnsp.org>
parents:
1664
diff
changeset
|
11 <!ENTITY hgurl "<ulink url='https://www.mercurial-scm.org/'>Mercurial</ulink>"> |
|
dc2ae49143e7
Update http URLs to https.
Matti Hamalainen <ccr@tnsp.org>
parents:
1664
diff
changeset
|
12 <!ENTITY batmudurl "<ulink url='https://www.bat.org/'>BatMUD</ulink>"> |
|
dc2ae49143e7
Update http URLs to https.
Matti Hamalainen <ccr@tnsp.org>
parents:
1664
diff
changeset
|
13 <!ENTITY gnupgurl "<ulink url='https://www.gnupg.org/'>GnuPG</ulink>"> |
| 275 | 14 |
|
1683
61eb734a16f3
Improve docs building process, filter example tfrc to replace few things with XML entities.
Matti Hamalainen <ccr@tnsp.org>
parents:
1681
diff
changeset
|
15 <!ENTITY exampletfrc SYSTEM "example-tfrc-escaped.txt"> |
|
249
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
16 <!ENTITY validval "Valid values:"> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
17 <!ENTITY validonoff "<emphasis>on</emphasis>, <emphasis>off</emphasis>"> |
| 232 | 18 |
| 271 | 19 <!ENTITY colourexplanation " |
| 20 Colours described here may deviate from what you actually | |
|
1230
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
21 see due to differences in terminal emulation programs and settings. |
| 271 | 22 "> |
| 23 | |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
24 <!ENTITY sectmacros_1 "<title>Macro commands</title> |
| 271 | 25 <para><> = required argument, [] = optional argument"> |
| 26 | |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
27 <!ENTITY sectmacros_2 "<section> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
28 <title>Macro commands</title> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
29 <para><> = required argument, [] = optional argument</para> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
30 <table><title>Macro commands</title> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
31 <tgroup cols='2' align='left'> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
32 <thead> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
33 <row> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
34 <entry>Command</entry> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
35 <entry>Description</entry> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
36 </row> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
37 </thead> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
38 <tbody>"> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
39 |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
40 <!ENTITY sectmacros_end "</tbody> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
41 </tgroup> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
42 </table> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
43 </section> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
44 "> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
45 |
| 271 | 46 <!ENTITY paravariables "Variables and user-replaceable macros defined |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
47 by this module are described in a table below. They have specific |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
48 defaults, which you can override in your configuration if you |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
49 re-set/re-define them after loading the module. Please refer to |
| 404 | 50 <link linkend='inst-config'>Setup</link>-section of this manual |
| 271 | 51 or see the example configuration for this module. |
| 52 "> | |
| 53 | |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
54 <!ENTITY sectvariables " |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
55 <title>Settings and user-replaceable macros</title> |
| 271 | 56 <para> |
| 57 ¶variables; | |
| 58 </para> | |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
59 |
| 271 | 60 <table><title></title> |
| 61 <tgroup cols='2' align='left'> | |
| 62 <thead> | |
| 63 <row> | |
| 64 <entry>Variable / macro name</entry> | |
| 65 <entry>Description</entry> | |
| 66 </row> | |
| 67 </thead> | |
| 68 <tbody> | |
| 69 "> | |
| 70 | |
| 71 <!ENTITY sectvariablesend " | |
| 72 </tbody> | |
| 73 </tgroup> | |
| 74 </table> | |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
75 </section> |
| 271 | 76 "> |
| 251 | 77 |
|
624
cc40c7360880
The manual is now pseudo-XML conformant, you have to use normalizeml.pl to convert to syntactically correct XML.
Matti Hamalainen <ccr@tnsp.org>
parents:
622
diff
changeset
|
78 --> |
| 223 | 79 <book> |
| 80 <bookinfo> | |
| 1052 | 81 <title>The GgrTF v&ggrtfver; User's Guide</title> |
| 226 | 82 <authorgroup> |
|
620
b51e42467f2c
Character set conversion ISO-8859-1 -> UTF-8
Matti Hamalainen <ccr@tnsp.org>
parents:
618
diff
changeset
|
83 <author><firstname>Matti</firstname><surname>Hämäläinen</surname></author> |
|
b51e42467f2c
Character set conversion ISO-8859-1 -> UTF-8
Matti Hamalainen <ccr@tnsp.org>
parents:
618
diff
changeset
|
84 <author><firstname>Jarkko</firstname><surname>Vääräniemi</surname></author> |
| 226 | 85 </authorgroup> |
| 223 | 86 <copyright> |
| 1671 | 87 <year>2006-2024</year> |
|
620
b51e42467f2c
Character set conversion ISO-8859-1 -> UTF-8
Matti Hamalainen <ccr@tnsp.org>
parents:
618
diff
changeset
|
88 <holder>Matti Hämäläinen (Ggr Pupunen)</holder> |
| 223 | 89 </copyright> |
| 1671 | 90 <pubdate>2024</pubdate> |
| 223 | 91 |
| 92 <legalnotice> | |
| 93 <para> | |
| 248 | 94 This document is distributed under |
|
1667
c3a98af55092
Update manual license to CC BY-SA 4.0 from 3.0.
Matti Hamalainen <ccr@tnsp.org>
parents:
1665
diff
changeset
|
95 <ulink url="https://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-Share Alike 4.0 International license</ulink>, |
|
c3a98af55092
Update manual license to CC BY-SA 4.0 from 3.0.
Matti Hamalainen <ccr@tnsp.org>
parents:
1665
diff
changeset
|
96 of which full version can be found from <ulink url="https://creativecommons.org/licenses/by-sa/4.0/legalcode">Creative Commons website</ulink>. |
| 223 | 97 </para> |
| 98 | |
| 99 <para> | |
| 248 | 100 THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE |
| 101 COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY | |
| 102 COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS | |
| 103 AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED. | |
| 223 | 104 </para> |
| 105 | |
| 106 <para> | |
| 248 | 107 BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE |
|
1072
c68c152728d8
Upgrade CC-SA license from 2.5 to version 3.0.
Matti Hamalainen <ccr@tnsp.org>
parents:
1071
diff
changeset
|
108 TO BE BOUND BY THE TERMS OF THIS LICENSE. TO THE EXTENT THIS LICENSE MAY |
|
c68c152728d8
Upgrade CC-SA license from 2.5 to version 3.0.
Matti Hamalainen <ccr@tnsp.org>
parents:
1071
diff
changeset
|
109 BE CONSIDERED TO BE A CONTRACT, THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED |
|
c68c152728d8
Upgrade CC-SA license from 2.5 to version 3.0.
Matti Hamalainen <ccr@tnsp.org>
parents:
1071
diff
changeset
|
110 HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS. |
| 223 | 111 </para> |
| 112 </legalnotice> | |
| 113 </bookinfo> | |
| 114 | |
| 226 | 115 <!-- *************************************************************** --> |
| 223 | 116 |
| 226 | 117 <chapter id="preface"><title>Preface</title> |
| 223 | 118 |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
119 <section id="whatisggrtf"><title>What is GgrTF?</title> |
| 233 | 120 |
| 223 | 121 <para> |
|
567
82a3def121a8
Updated intro, hopefully now in better linguistic form.
Matti Hamalainen <ccr@tnsp.org>
parents:
555
diff
changeset
|
122 GgrTF is a <emphasis>framework</emphasis> of AND for triggers to |
|
82a3def121a8
Updated intro, hopefully now in better linguistic form.
Matti Hamalainen <ccr@tnsp.org>
parents:
555
diff
changeset
|
123 ease playing of &batmudurl; with &tfurl; MUD-client. GgrTF is designed for |
|
82a3def121a8
Updated intro, hopefully now in better linguistic form.
Matti Hamalainen <ccr@tnsp.org>
parents:
555
diff
changeset
|
124 modularity and easy development. Our primary development goals |
|
82a3def121a8
Updated intro, hopefully now in better linguistic form.
Matti Hamalainen <ccr@tnsp.org>
parents:
555
diff
changeset
|
125 are good overall quality of code and maintainability. |
|
82a3def121a8
Updated intro, hopefully now in better linguistic form.
Matti Hamalainen <ccr@tnsp.org>
parents:
555
diff
changeset
|
126 These are also some of the key elements, that differentiate |
|
82a3def121a8
Updated intro, hopefully now in better linguistic form.
Matti Hamalainen <ccr@tnsp.org>
parents:
555
diff
changeset
|
127 GgrTF from most other publicly available scripts. |
| 223 | 128 </para> |
| 129 | |
| 130 <para> | |
| 862 | 131 GgrTF is being developed for TF5 of &tfurl; MUD client under Linux |
| 132 and Solaris platforms. Users of GgrTF are mostly users of UNIX-like | |
|
567
82a3def121a8
Updated intro, hopefully now in better linguistic form.
Matti Hamalainen <ccr@tnsp.org>
parents:
555
diff
changeset
|
133 systems, but there are several who run TF under Microsoft Windows |
| 862 | 134 operating system. Version 0.6.9.15 was the last that supported TF4. |
| 248 | 135 </para> |
| 136 | |
| 137 <para> | |
|
669
dda12c2548c8
Updated history and some other small things.
Matti Hamalainen <ccr@tnsp.org>
parents:
642
diff
changeset
|
138 The current version (as of v&ggrtfver; release) has modules |
| 226 | 139 for following character classes: |
| 230 | 140 </para> |
| 141 <itemizedlist> | |
| 711 | 142 <listitem><para><link linkend="usage-magical">Mages</link> (<ulink url="http://www.bat.org/help/guilds?str=The+Brotherhood+of+Wizardry">The Brotherhood of Wizardry</ulink>)</para></listitem> |
| 143 <listitem><para><link linkend="usage-chann">Channellers</link> (<ulink url="http://www.bat.org/help/guilds?str=The+Guild+of+Channellers">The Guild of Channellers</ulink>)</para></listitem> | |
| 144 <listitem><para><link linkend="usage-merchant">Merchants</link> (<ulink url="http://www.bat.org/help/guilds?str=The+Master+Merchants">The Master Merchants</ulink>)</para></listitem> | |
| 145 <listitem><para><link linkend="usage-barb">Barbarians</link> (<ulink url="http://www.bat.org/help/guilds?str=Barbarian+Guild">Barbarian Guild</ulink>)</para></listitem> | |
| 146 <listitem><para><link linkend="usage-loc">LoCs</link> (<ulink url="http://www.bat.org/help/guilds?str=Lords+of+Chaos">Lords of Chaos</ulink>)</para></listitem> | |
| 147 <listitem><para><link linkend="usage-tarma">Tarmalens</link> (<ulink url="http://www.bat.org/help/guilds?str=The+Followers+of+Tarmalen">The Followers of Tarmalen</ulink>)</para></listitem> | |
| 148 <listitem><para><link linkend="usage-druid">Druids</link> (<ulink url="http://www.bat.org/help/guilds?str=The+Humble+Druids">The Humble Druids</ulink>)</para></listitem> | |
| 149 <listitem><para><link linkend="usage-nun">Nuns</link> (<ulink url="http://www.bat.org/help/guilds?str=Sisters+of+Las">Sisters of Las</ulink>)</para></listitem> | |
| 841 | 150 <listitem><para><link linkend="usage-spiders">Spiders</link></para></listitem> |
| 151 <listitem><para><link linkend="usage-tiger">Tigers</link></para></listitem> | |
|
1376
3d73752368ae
docs: Added barebones alchemist section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1364
diff
changeset
|
152 <listitem><para><link linkend="usage-alchemist">Alchemists</link></para></listitem> |
| 230 | 153 </itemizedlist> |
| 154 | |
| 155 <para> | |
| 248 | 156 In non-guild related sense, GgrTF has most of the basics expected from |
| 254 | 157 such triggerset. There is a <link linkend="usage-general-prots">prot-management and reporting |
|
889
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
158 system</link>, <link linkend="usage-general-skillspell">skill</link>- and |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
159 <link linkend="usage-magical">spell</link>-handling, way to |
| 254 | 160 easily <link linkend="usage-general-commands">run commands on each battle round</link> |
| 841 | 161 (and more), plus following special modules: |
| 226 | 162 </para> |
| 163 | |
| 841 | 164 <itemizedlist> |
| 165 <listitem><para><link linkend="usage-pssmangle">'pss'-output mangler</link></para></listitem> | |
| 166 <listitem><para><link linkend="usage-hstats">Hit statistics counter</link></para></listitem> | |
| 167 <listitem><para><link linkend="usage-spellnames">Spellchants to names translator</link></para></listitem> | |
| 168 <listitem><para><link linkend="usage-pplacer">Party member autoplacer</link></para></listitem> | |
| 169 <listitem><para><link linkend="usage-ptracker">Party prot tracker</link></para></listitem> | |
| 170 <listitem><para><link linkend="usage-rpouch">Reagent pouch helper</link></para></listitem> | |
|
969
88b32a56a75e
A bit of documentation for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
956
diff
changeset
|
171 <listitem><para><link linkend="usage-identify">Identify spell beautifier</link></para></listitem> |
| 841 | 172 </itemizedlist> |
| 173 | |
| 174 <para> | |
| 175 And more ... | |
| 176 </para> | |
| 223 | 177 </section> |
| 178 | |
| 254 | 179 <!-- ================================================ --> |
| 223 | 180 |
| 226 | 181 <section id="isggrtfforme"><title>Is GgrTF for Me?</title> |
| 223 | 182 <para> |
| 841 | 183 It is impossible to tell for certain, really. If you are averse |
| 184 of doing some digging of your own, or adjusting some trigger code, | |
| 185 it may not be. GgrTF is meant to work as a "platform" and a base, | |
| 186 not as a complete bells and whistles-type solution. | |
| 187 In the end, you may have just to give it a try. | |
| 555 | 188 </para> |
| 189 | |
| 190 <para> | |
| 191 When I started working on GgrTF, | |
| 192 I was just "scratching an itch", and that itch still continues, | |
| 193 though few others have joined my efforts on scratching. | |
| 254 | 194 During the two years I have been developing GgrTF, most of that |
| 555 | 195 time I've been scratching my own back, doing stuff mostly for myself. |
| 284 | 196 Thus, if you like the design decisions and features I like, |
| 197 play the same guilds as I (though some guilds which I haven't | |
| 555 | 198 ever touched are supported through efforts of other developers) |
| 199 it is likely that you will like GgrTF. | |
| 284 | 200 </para> |
| 201 | |
| 202 <para> | |
| 555 | 203 Also GgrTF is not all that well documented (although that is one |
| 204 thing we are trying remedy) and <emphasis>requires basic knowledge of | |
| 205 how &tfurl;</emphasis> and its macro language works. As such GgrTF | |
| 206 is not a ready out-of-the-box experience for some users and never | |
| 207 will be. <emphasis>However, if you are able to crank it up and working, | |
| 208 and are content with what is readily offered, then it might be something | |
| 209 for you.</emphasis> | |
| 210 </para> | |
| 211 | |
| 212 <para> | |
| 254 | 213 All in all, GgrTF <emphasis>might</emphasis> be something for you, |
| 214 especially if you like things the way I like them. But on the other | |
| 215 hand GgrTF might not be for you, and there are several alternatives | |
| 216 out there for those who do not find it satisfactory. Below I have | |
| 217 tried to list some pros and cons of using GgrTF. | |
| 230 | 218 </para> |
| 284 | 219 |
| 230 | 220 <itemizedlist> |
| 221 <listitem><para>Pros:</para> | |
| 222 <itemizedlist> | |
| 223 <listitem><para>Good general quality of code. As somebody put it, | |
| 233 | 224 "you do not instantly get a headache from just looking at the code."</para></listitem> |
| 225 <listitem><para>Modularity, easily extendable for most part.</para></listitem> | |
| 254 | 226 <listitem><para>Updated regularly, most bugs get fixed in upstream.</para></listitem> |
| 275 | 227 <listitem><para>User-level documentation exists.</para></listitem> |
| 230 | 228 </itemizedlist> |
| 229 </listitem> | |
| 230 | |
| 231 <listitem><para>Cons:</para> | |
| 232 <itemizedlist> | |
| 275 | 233 <listitem><para>Only small number of &batmudurl;'s guilds are specifically supported.</para></listitem> |
| 695 | 234 <listitem><para>Requires bit more programming knowledge than some other solutions.</para></listitem> |
| 392 | 235 <listitem><para>Due to nature of the developer's reincs, is biased |
| 236 towards caster-type functionality than tanks. Thus the support for tank | |
| 695 | 237 guilds is not very good, although some guilds are supported.</para></listitem> |
| 230 | 238 </itemizedlist> |
| 239 </listitem> | |
| 240 | |
| 241 </itemizedlist> | |
| 242 </section> | |
| 243 | |
| 254 | 244 <!-- ================================================ --> |
| 232 | 245 |
| 230 | 246 <section id="ggrtfhistory"><title>History of GgrTF</title> |
| 265 | 247 <subtitle>As told by Ggr</subtitle> |
| 248 | |
| 230 | 249 <para> |
| 841 | 250 <emphasis>Way back in march of 2004, I made one of the worst |
|
669
dda12c2548c8
Updated history and some other small things.
Matti Hamalainen <ccr@tnsp.org>
parents:
642
diff
changeset
|
251 mistakes in my life - I created a character in &batmudurl;.</emphasis> |
|
dda12c2548c8
Updated history and some other small things.
Matti Hamalainen <ccr@tnsp.org>
parents:
642
diff
changeset
|
252 |
| 265 | 253 I never thought of myself to be much of a gamer, I've always |
| 254 been more interested in more technical things, programming | |
|
669
dda12c2548c8
Updated history and some other small things.
Matti Hamalainen <ccr@tnsp.org>
parents:
642
diff
changeset
|
255 and a little bit of digital electronics and hardware, so |
| 265 | 256 mostly my gaming experience consisted of some c64 games, |
|
669
dda12c2548c8
Updated history and some other small things.
Matti Hamalainen <ccr@tnsp.org>
parents:
642
diff
changeset
|
257 Nethack and some CRPGs like Fallout. I guess the RPG statmania |
| 265 | 258 was one reason that got me hooked in the first place, plus |
| 259 the multiplayer interaction and social aspects. | |
| 260 </para> | |
| 261 | |
| 262 <para> | |
|
1202
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
263 Started off playing with plain telnet for the first month or so, |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
264 then installed &tfurl;, because it seemed to be the most popular |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
265 of the clients available for UNIXish platforms. First I didn't use |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
266 any triggers at all, TF was just there to work as better terminal |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
267 and separating the input from output .. and the game was confusing |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
268 enough to start with, triggers would have just complicated things. |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
269 At least I felt so back then. |
| 265 | 270 </para> |
| 271 | |
| 272 <para> | |
|
1202
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
273 At some point, however, my playing style advanced and need for |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
274 automating certain things became apparent. I researched some of |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
275 the available scripts, but most of them were either badly designed, |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
276 full of very apparent mistakes and bugs, or simply not maintained |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
277 anymore. Some people (highbies mainly) seemed to have some good stuff, |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
278 but as usual, they only shared inside small circles of their own. |
| 265 | 279 </para> |
| 280 | |
| 281 <para> | |
|
1202
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
282 Fancying myself as a programmer of some sort, off I went, developing my |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
283 own piece of turf, starting out very simple, expanding and improving |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
284 when needed. That continued for about a year or a bit over, then the |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
285 situation got out of hand - I started "releasing" GgrTF periodically |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
286 on my &batmudurl; related web-page. |
| 223 | 287 </para> |
| 265 | 288 |
| 289 <para> | |
|
1202
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
290 The first ever released version of GgrTF was v0.3.0, which was extremely |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
291 simple and hacky. It supported just channeller/mage stuff and had a broken |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
292 prots management system. The 0.3.x-series continued up to 0.3.13 or so, |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
293 after which some bigger changes were made and 0.4.0 was released. |
| 265 | 294 </para> |
| 295 | |
| 296 <para> | |
|
1202
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
297 At some point of 0.4.x-series development, more people started noticing GgrTF. |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
298 I believe some even started using it, or at least used parts of it in |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
299 their own code. v0.4.x was somewhat short-lived, soon major restructuring |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
300 was done in the prot management system and it was time for 0.5.0. As the |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
301 development progressed, it soon again became apparent that bigger changes |
|
669
dda12c2548c8
Updated history and some other small things.
Matti Hamalainen <ccr@tnsp.org>
parents:
642
diff
changeset
|
302 were needed ... v0.5.5 was the last stable release in that series. |
|
dda12c2548c8
Updated history and some other small things.
Matti Hamalainen <ccr@tnsp.org>
parents:
642
diff
changeset
|
303 </para> |
|
dda12c2548c8
Updated history and some other small things.
Matti Hamalainen <ccr@tnsp.org>
parents:
642
diff
changeset
|
304 |
|
dda12c2548c8
Updated history and some other small things.
Matti Hamalainen <ccr@tnsp.org>
parents:
642
diff
changeset
|
305 <para> |
|
1202
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
306 Development of the new features took somewhat longer time than originally |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
307 expected, there were literally dozens of internal version landmarks |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
308 (v0.5.6.x, v0.5.9.x, v0.5.10.x, v0.5.11.x and finally even v0.6.0-preX |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
309 series), which preceeded the final v0.6.0-release in early august 2006. |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
310 |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
311 This new release marked a major improvement in code quality and number of |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
312 features, and also this user's manual was included for the first time. |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
313 It was also the first time when other people joined up and did some work |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
314 on few features. |
| 265 | 315 </para> |
| 316 | |
| 223 | 317 </section> |
| 318 | |
| 254 | 319 <!-- ================================================ --> |
| 232 | 320 |
| 321 <section id="license"><title>GgrTF License</title> | |
| 322 <para> | |
| 392 | 323 GgrTF is copyrighted (except where mentioned otherwise) |
|
620
b51e42467f2c
Character set conversion ISO-8859-1 -> UTF-8
Matti Hamalainen <ccr@tnsp.org>
parents:
618
diff
changeset
|
324 by Matti Hämäläinen (aka Ggr Pupunen) and |
| 232 | 325 distributed under the GNU General Public License version 2. |
| 326 </para> | |
| 327 | |
| 328 <para> | |
| 329 Complete text of the GNU GPL v2 is included with the code in a file | |
| 330 called COPYING.txt, and is also available | |
| 254 | 331 <ulink url="http://www.gnu.org/licenses/gpl.html">here</ulink>. |
| 232 | 332 </para> |
| 333 </section> | |
| 334 | |
| 223 | 335 </chapter> |
| 336 | |
| 226 | 337 <!-- *************************************************************** --> |
| 338 | |
| 339 <chapter id="installation"><title>Installation</title> | |
| 340 <para> | |
| 275 | 341 This chapter assumes that you have already succesfully installed &tfurl; |
| 342 in your system and you know how to use it (basic commands, loading of | |
| 343 macros, etc.) It is also assumed that you know how to use your operating | |
| 344 system of choice, be it some flavour of UNIX or Windows, although some | |
| 345 parts of the instructions are given in step-by-step manner. | |
| 226 | 346 </para> |
| 347 | |
|
421
17df1b70f898
Added note about tf/-directory being used in examples.
Matti Hamalainen <ccr@tnsp.org>
parents:
418
diff
changeset
|
348 <note> |
|
17df1b70f898
Added note about tf/-directory being used in examples.
Matti Hamalainen <ccr@tnsp.org>
parents:
418
diff
changeset
|
349 <para> |
|
17df1b70f898
Added note about tf/-directory being used in examples.
Matti Hamalainen <ccr@tnsp.org>
parents:
418
diff
changeset
|
350 Throughout this manual, when GgrTF files are referenced in configuration |
| 783 | 351 examples etc., I have used "<emphasis>ggrtf/</emphasis>" -directory as path |
|
956
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
352 where the script files are located relative to your "home directory". |
|
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
353 You may need to substitute it with whatever you have installed your copy of GgrTF |
|
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
354 files in. |
|
421
17df1b70f898
Added note about tf/-directory being used in examples.
Matti Hamalainen <ccr@tnsp.org>
parents:
418
diff
changeset
|
355 </para> |
|
17df1b70f898
Added note about tf/-directory being used in examples.
Matti Hamalainen <ccr@tnsp.org>
parents:
418
diff
changeset
|
356 </note> |
|
17df1b70f898
Added note about tf/-directory being used in examples.
Matti Hamalainen <ccr@tnsp.org>
parents:
418
diff
changeset
|
357 |
| 404 | 358 <para> |
| 359 There are basically two ways how to get GgrTF, release packages and | |
|
1313
65c5d6d53338
Update documentation for Mercurial.
Matti Hamalainen <ccr@tnsp.org>
parents:
1288
diff
changeset
|
360 the Mercurial-repository. Releases are considered as stable snapshots, |
| 275 | 361 which should be relatively bug-free, but releases are done somewhat |
| 281 | 362 infrequently and at least in this phase we don't backport bugfixes to |
| 363 release versions. | |
| 267 | 364 </para> |
|
956
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
365 |
|
772
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
366 <para> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
367 If you are unsure which version to choose, use the latest packaged release. |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
368 </para> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
369 |
|
956
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
370 |
|
772
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
371 <section id="inst-releases"><title>Releases</title> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
372 <para> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
373 To get the latest stable version, head to the downloads-section of |
| 1535 | 374 <ulink url="http://tnsp.org/~ccr/ggrtf/">GgrTF's homepage</ulink> |
|
772
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
375 and pick either the newest tarball (*.tar.gz) or zip-archive (*.zip): |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
376 </para> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
377 <itemizedlist> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
378 <listitem> |
|
1538
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
379 <para>*.tar.gz packages are for UNIX-like systems, such as Linux, *BSD, |
|
772
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
380 etc. Please note that the ZIP-packages are meant for Windows only and WILL |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
381 NOT WORK under UNIX or OS X version of TinyFugue!</para> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
382 </listitem> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
383 <listitem> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
384 <para>*.zip packages are for Windows version of TinyFugue (the files |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
385 have been converted to CRLF line endings.)</para> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
386 </listitem> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
387 </itemizedlist> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
388 <para> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
389 Both package types also have equivalent PGP/&gnupgurl; signature files |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
390 (*.asc), which can be used to cryptographically |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
391 <link linkend="app-verify-sig">verify the authenticity</link> of files. |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
392 </para> |
| 1574 | 393 <para> |
| 394 To "install" the package, you simply unpack it to appropriate directory, | |
| 395 typically under your home directory. Under UNIX-style system: | |
| 396 </para> | |
| 397 | |
| 398 <userinput>cd $HOME</userinput> | |
| 399 <userinput>tar xzvf ggrtf-&ggrtfver;.tar.gz</userinput> | |
| 400 | |
|
772
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
401 |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
402 <para> |
| 1574 | 403 After that, you should have directory $HOME/ggrtf/ with all the *.tf files in it. |
| 404 If so, you can continue to the <link linkend="inst-config">configuration part</link>. | |
|
772
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
405 </para> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
406 |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
407 </section> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
408 |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
409 |
| 1346 | 410 <section id="inst-mercurial"><title>Development version</title> |
| 267 | 411 <para> |
| 275 | 412 Another way to get GgrTF is to go to the very source, the |
| 413 development source repository. This repository contains the latest | |
| 414 bleeding edge features, but is also a fast moving target. Changes | |
|
1557
b922a5f99ad8
Some language improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
1556
diff
changeset
|
415 are directly committed by developers almost in real time, |
| 275 | 416 sometimes what you download may be severely broken. |
| 417 Also the documentation will not be updated for every little change, | |
| 418 so you may have to figure out and work around possible backward | |
| 419 incompatibilities yourself. | |
| 420 </para> | |
| 421 | |
| 422 <para> | |
| 1346 | 423 New features and bugfixes may sometimes be worth taking the risk. |
| 670 | 424 On the other hand, it is all up to what you want and whether you can |
| 425 manage to handle the possibly arising problems. | |
| 275 | 426 </para> |
| 427 | |
| 226 | 428 <para> |
|
1313
65c5d6d53338
Update documentation for Mercurial.
Matti Hamalainen <ccr@tnsp.org>
parents:
1288
diff
changeset
|
429 We utilize &hgurl; (Hg) for GgrTF's version management. Mercurial |
|
1557
b922a5f99ad8
Some language improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
1556
diff
changeset
|
430 is a freely available distributed version control system, for which |
| 281 | 431 there are clients available for most common platforms, including |
| 432 Windows, Linux and other flavours of UNIX. | |
| 226 | 433 </para> |
| 267 | 434 |
| 435 <para> | |
|
1651
86f3d10eafec
Fix reference to old repo location.
Matti Hamalainen <ccr@tnsp.org>
parents:
1650
diff
changeset
|
436 GgrTF's Mercurial repository is hosted at tnsp.org, and is available from following location: |
|
1322
903f92f4b918
Add note about sending patches.
Matti Hamalainen <ccr@tnsp.org>
parents:
1313
diff
changeset
|
437 <ulink url="&hgrepourl;">&hgrepourl;</ulink>. |
| 1346 | 438 The same URL can be used with a web browser to browse version history. |
| 275 | 439 </para> |
| 281 | 440 |
|
629
a80d8bcdef99
Updated some examples, fixed few bugs.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
441 <section id="intro-checking-out"><title>Checking out</title> |
| 275 | 442 <para> |
|
1313
65c5d6d53338
Update documentation for Mercurial.
Matti Hamalainen <ccr@tnsp.org>
parents:
1288
diff
changeset
|
443 You can download (aka "clone") the GgrTF repository with command line |
|
65c5d6d53338
Update documentation for Mercurial.
Matti Hamalainen <ccr@tnsp.org>
parents:
1288
diff
changeset
|
444 Mercurial client with following command: |
| 267 | 445 |
| 1340 | 446 <userinput>hg clone &hgrepourl; dest_dir</userinput> |
| 275 | 447 |
|
1313
65c5d6d53338
Update documentation for Mercurial.
Matti Hamalainen <ccr@tnsp.org>
parents:
1288
diff
changeset
|
448 In which <emphasis>"clone"</emphasis> means making a local copy of the |
| 1340 | 449 repository under directory <emphasis>dest_dir</emphasis>. |
| 275 | 450 </para> |
| 451 | |
| 452 <para> | |
| 453 You will most probably want to download the repository to some | |
| 1340 | 454 specific place, personally I prefer to use ~/ggrtf/ (aka "ggrtf/" |
| 455 under user's home directory) under UNIX. | |
| 456 Thus typically you would use following command: | |
| 457 | |
| 458 <userinput>hg clone &hgrepourl; ~/ggrtf</userinput> | |
| 459 | |
| 1346 | 460 If you are using Windows, and wish to use the development version, you |
| 461 can use the regular Mercurial command line client, or a GUI interface | |
| 1533 | 462 such as <ulink url="http://tortoisehg.bitbucket.org/">TortoiseHg</ulink>. |
| 1346 | 463 </para> |
| 464 | |
| 465 <para> | |
| 466 The procedures for cloning and updating your local copy of the repository | |
| 467 are otherwise similar, except the directory/folder path is different, | |
| 468 under Windows XP the path would be <emphasis>C:\Documents and Settings\<username>\ggrtf\</emphasis>. | |
| 469 For example, if your username is "Ggr", you could use the following command: | |
| 470 | |
| 471 <userinput>hg clone &hgrepourl; "C:\Documents and Settings\Ggr\ggrtf\"</userinput> | |
| 472 | |
| 473 Under Windows Vista and 7, the path is of the format <emphasis>C:\Users\<username>\</emphasis> | |
| 474 </para> | |
| 475 | |
| 275 | 476 </section> |
| 477 | |
|
629
a80d8bcdef99
Updated some examples, fixed few bugs.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
478 <section id="intro-updating"><title>Keeping up to date</title> |
| 275 | 479 <para> |
| 480 After you have checked out your own copy of GgrTF's code repository, | |
|
1313
65c5d6d53338
Update documentation for Mercurial.
Matti Hamalainen <ccr@tnsp.org>
parents:
1288
diff
changeset
|
481 you usually wish to periodically update it. This is done easily with |
|
65c5d6d53338
Update documentation for Mercurial.
Matti Hamalainen <ccr@tnsp.org>
parents:
1288
diff
changeset
|
482 the following commands: |
| 275 | 483 |
| 1346 | 484 <userinput>cd ~/ggrtf</userinput> |
| 485 <userinput>hg pull</userinput> | |
| 486 <userinput>hg update</userinput> | |
| 487 | |
|
1313
65c5d6d53338
Update documentation for Mercurial.
Matti Hamalainen <ccr@tnsp.org>
parents:
1288
diff
changeset
|
488 Notice that since Mercurial is a distributed version management system, you can easily |
|
65c5d6d53338
Update documentation for Mercurial.
Matti Hamalainen <ccr@tnsp.org>
parents:
1288
diff
changeset
|
489 keep your own local changes by committing them (<emphasis>'hg ci'</emphasis>) |
|
65c5d6d53338
Update documentation for Mercurial.
Matti Hamalainen <ccr@tnsp.org>
parents:
1288
diff
changeset
|
490 and then, instead of using 'pull' and 'update', you can use 'hg fetch' to merge |
|
65c5d6d53338
Update documentation for Mercurial.
Matti Hamalainen <ccr@tnsp.org>
parents:
1288
diff
changeset
|
491 your local changesets automatically. Refer to Mercurial documentation. |
|
65c5d6d53338
Update documentation for Mercurial.
Matti Hamalainen <ccr@tnsp.org>
parents:
1288
diff
changeset
|
492 </para> |
| 1346 | 493 <para> |
| 494 If you plan on making modifications to GgrTF, it is recommended that you familiarize | |
| 495 yourself with the basics of Mercurial workflow, making commits, fetching, etc. It | |
| 496 will help you with maintaining your changes locally or sending patches to us. | |
| 497 </para> | |
| 498 | |
|
1313
65c5d6d53338
Update documentation for Mercurial.
Matti Hamalainen <ccr@tnsp.org>
parents:
1288
diff
changeset
|
499 |
| 275 | 500 </section> |
| 501 | |
| 226 | 502 </section> |
| 405 | 503 |
|
956
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
504 </chapter> |
| 226 | 505 |
| 254 | 506 <!-- ================================================ --> |
| 226 | 507 |
|
956
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
508 <chapter id="inst-config"><title>Configuration</title> |
| 226 | 509 <para> |
|
1230
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
510 After extracting GgrTF files into the appropriate directory folder, |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
511 you will need to create (or change) configuration for &tfurl; to load GgrTF |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
512 modules and possibly change some of your settings in &batmudurl;. |
|
306
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
513 </para> |
|
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
514 |
|
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
515 <para> |
|
1230
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
516 If you are upgrading GgrTF from a previous version, it is possible |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
517 that you do not have to change your configuration. But it is neverthless |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
518 recommended that you skim through this section, the ChangeLog and |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
519 module-specific sections of this manual in case of any significant, |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
520 backwards incompatible changes. |
|
315
14204307afda
More explanation about configuration; prot-management
Matti Hamalainen <ccr@tnsp.org>
parents:
314
diff
changeset
|
521 </para> |
|
14204307afda
More explanation about configuration; prot-management
Matti Hamalainen <ccr@tnsp.org>
parents:
314
diff
changeset
|
522 |
|
14204307afda
More explanation about configuration; prot-management
Matti Hamalainen <ccr@tnsp.org>
parents:
314
diff
changeset
|
523 |
|
1230
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
524 <section id="inst-config-tf"><title>TF configuration file</title> |
|
315
14204307afda
More explanation about configuration; prot-management
Matti Hamalainen <ccr@tnsp.org>
parents:
314
diff
changeset
|
525 <para> |
|
1230
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
526 Typical way to use GgrTF is to load the script modules at startup. |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
527 This is accomplished via TinyFugue's configuration file, commonly |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
528 referred as "tfrc", location of which depends on your operating |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
529 system and environment. |
|
315
14204307afda
More explanation about configuration; prot-management
Matti Hamalainen <ccr@tnsp.org>
parents:
314
diff
changeset
|
530 </para> |
|
14204307afda
More explanation about configuration; prot-management
Matti Hamalainen <ccr@tnsp.org>
parents:
314
diff
changeset
|
531 |
|
14204307afda
More explanation about configuration; prot-management
Matti Hamalainen <ccr@tnsp.org>
parents:
314
diff
changeset
|
532 <itemizedlist> |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
533 <listitem><para> |
|
1538
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
534 UNIX-like systems, like Linux: |
|
1230
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
535 <emphasis>~/.tfrc</emphasis> or <emphasis>$HOME/.tfrc</emphasis> |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
536 (aka a file named ".tfrc" in your user home directory.) |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
537 </para></listitem> |
|
315
14204307afda
More explanation about configuration; prot-management
Matti Hamalainen <ccr@tnsp.org>
parents:
314
diff
changeset
|
538 |
|
1230
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
539 <listitem><para> |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
540 DruWare Win32 port of TF: |
| 1346 | 541 Windows XP/2k/NT - <emphasis>C:\Documents and Settings\username\tfrc</emphasis>, |
| 542 | |
| 543 Windows 7/Vista - <emphasis>C:\Users\username\tfrc</emphasis> | |
|
1230
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
544 </para></listitem> |
|
315
14204307afda
More explanation about configuration; prot-management
Matti Hamalainen <ccr@tnsp.org>
parents:
314
diff
changeset
|
545 </itemizedlist> |
|
14204307afda
More explanation about configuration; prot-management
Matti Hamalainen <ccr@tnsp.org>
parents:
314
diff
changeset
|
546 |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
547 <para> |
|
1230
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
548 As a basis for your TF configuration, you can use the example-tfrc.txt |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
549 provided with GgrTF. You will need to edit it to suit your guilds and |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
550 certain settings. However, the example-tfrc is only a suggested layout |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
551 of configuration, mostly to show the order GgrTF requires modules |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
552 and settings to be loaded. It does not contain everything you can possibly |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
553 do with TF. |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
554 </para> |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
555 |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
556 <para> |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
557 Take note of the order of how different parts of GgrTF are loaded and where |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
558 certain variables are set. Important thing is to have the order right, certain |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
559 modules depend on other modules, and while GgrTF will usually print warning message(s) |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
560 if the depencies are not met, sometimes this is not possible and erratic behaviour |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
561 will occur. |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
562 </para> |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
563 |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
564 <screen>&exampletfrc;</screen> |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
565 |
|
1538
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
566 <!-- |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
567 - layout of recommended configuration |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
568 - discussion about modules |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
569 - bindings or not? |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
570 --> |
|
1230
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
571 |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
572 <section id="inst-config-tf-locale"><title>Character set encoding and locales</title> |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
573 <para> |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
574 One thing that is out of scope of GgrTF itself, is the issue of character set |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
575 translation and locales. This basically means the way different characters |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
576 are encoded and interpreted, how different values map to characters and vice versa, |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
577 for example a simple encoding might be A=1, B=2, C=3, etc. |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
578 </para> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
579 |
|
1230
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
580 <para> |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
581 One of the first and most widely used character encodings on computer systems |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
582 is known as <ulink url="http://en.wikipedia.org/wiki/ASCII">7-bit ASCII</ulink>. |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
583 This encoding allows 128 symbols or characters, and was commonly used for decades. |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
584 Unfortunately, 128 symbols is nearly not sufficient enough to represent all the |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
585 different alphabets or symbols used around the world (scandinavian characters, |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
586 cyrillic alphabet, etc.) Thus other encodings were invented, most of them |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
587 incompatible with each other, until introduction of Unicode standard and especially |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
588 <ulink url="http://en.wikipedia.org/wiki/UTF-8">Unicode UTF-8</ulink>. |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
589 </para> |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
590 |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
591 <para> |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
592 The de-facto character set used in BatMUD is called "ISO-8859-1" which is |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
593 a 8-bit encoding that allows 7-bit ASCII characters and 8-bit encoding of |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
594 scandinavian characters (A and O with dots, etc). This is mostly due to |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
595 BatMUD's origin in Finland, where ISO-8859-1 has been most deployed. |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
596 </para> |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
597 |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
598 <para> |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
599 However, increasing number of systems are starting to use Unicode "UTF-8" |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
600 encoding, and other encodings are also still used. Unicode is a good thing |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
601 in itself, and UTF-8 allows compatible 7-bit ASCII characters, but 8-bit |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
602 and over are not compatible with ISO-8859-1. This is why if your system |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
603 uses UTF-8, other people in BatMUD may see your non-ASCII characters |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
604 incorrectly. |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
605 </para> |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
606 |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
607 <para> |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
608 Now that we know the issue, what can we do? Sometimes the solution may |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
609 be very simple, but in many cases rather complex and very dependant |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
610 on your setup - e.g. where you run TF, is it a shell or running locally, etc. |
| 1532 | 611 Below is a list of tips and pointers, which may be of some help. |
|
1230
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
612 </para> |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
613 |
|
1538
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
614 <section id="inst-config-tf-locale-unix"><title>UNIX-likes / Linux</title> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
615 <para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
616 For Linux/UNIX, you need to have the ISO-8859-1 locale installed/configured. |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
617 How this is done depends on your OS distribution. For example in Debian, |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
618 you need to use <userinput>dpkg-reconfigure locales</userinput> and add |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
619 some ISO-8859-1 locale, for example <emphasis>en_US.iso88591</emphasis>. |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
620 </para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
621 |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
622 <para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
623 On Ubuntu, things get a bit more complicated: |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
624 </para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
625 <orderedlist> |
|
1537
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
626 <listitem> |
|
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
627 <para> |
|
1538
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
628 Edit /var/lib/locales/supported.d/local with your favorite editor, |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
629 and on the last line add: <emphasis>en_US.ISO-8859-1 ISO-8859-1</emphasis>. |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
630 It should look something like this: |
|
1537
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
631 </para> |
|
1538
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
632 <screen>en_US.UTF-8 UTF-8 |
|
1537
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
633 en_US.ISO-8859-1 ISO-8859-1</screen> |
|
1538
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
634 </listitem> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
635 <listitem> |
|
1537
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
636 <para> |
|
1538
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
637 Then, run <userinput>sudo dpkg-reconfigure locales</userinput> |
|
1537
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
638 </para> |
|
1538
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
639 </listitem> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
640 </orderedlist> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
641 <para> |
| 1602 | 642 On other Linux distributions and UNIX-like platforms the methods |
|
1538
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
643 for installing locales vary. Your best bet is to |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
644 <ulink url="https://www.google.com/search?q=linux+install+locale+iso-8859-1">Use the Google</ulink>. |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
645 </para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
646 <para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
647 If your system is using some locale other than ISO-8859-1 such as UTF-8, |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
648 you will need to make the terminal use ISO-8859-1 despite the system-global |
|
1597
d1ea70ae13c9
Updated documentation concerning the character set/locale stuff.
Matti Hamalainen <ccr@tnsp.org>
parents:
1596
diff
changeset
|
649 setting, or alternatively use some software like <ulink url="https://www.gnu.org/software/screen/">GNU Screen</ulink> |
|
d1ea70ae13c9
Updated documentation concerning the character set/locale stuff.
Matti Hamalainen <ccr@tnsp.org>
parents:
1596
diff
changeset
|
650 to "translate" between your system's and BatMUD's ISO-8859-1. Some |
|
d1ea70ae13c9
Updated documentation concerning the character set/locale stuff.
Matti Hamalainen <ccr@tnsp.org>
parents:
1596
diff
changeset
|
651 information about how to make GNU Screen do that, can be found |
|
d1ea70ae13c9
Updated documentation concerning the character set/locale stuff.
Matti Hamalainen <ccr@tnsp.org>
parents:
1596
diff
changeset
|
652 from this website: <ulink url="http://aperiodic.net/screen/terminal">http://aperiodic.net/screen/terminal</ulink>. |
|
d1ea70ae13c9
Updated documentation concerning the character set/locale stuff.
Matti Hamalainen <ccr@tnsp.org>
parents:
1596
diff
changeset
|
653 </para> |
|
d1ea70ae13c9
Updated documentation concerning the character set/locale stuff.
Matti Hamalainen <ccr@tnsp.org>
parents:
1596
diff
changeset
|
654 <para> |
|
d1ea70ae13c9
Updated documentation concerning the character set/locale stuff.
Matti Hamalainen <ccr@tnsp.org>
parents:
1596
diff
changeset
|
655 However, if you choose not to use 'screen', you will have to either |
|
d1ea70ae13c9
Updated documentation concerning the character set/locale stuff.
Matti Hamalainen <ccr@tnsp.org>
parents:
1596
diff
changeset
|
656 start your terminal program (inside which TinyFugue will run) with the |
|
d1ea70ae13c9
Updated documentation concerning the character set/locale stuff.
Matti Hamalainen <ccr@tnsp.org>
parents:
1596
diff
changeset
|
657 locale set to ISO-8859-1, OR if your terminal supports the feature, |
|
d1ea70ae13c9
Updated documentation concerning the character set/locale stuff.
Matti Hamalainen <ccr@tnsp.org>
parents:
1596
diff
changeset
|
658 use the following shell script wrapper which will use terminal |
|
d1ea70ae13c9
Updated documentation concerning the character set/locale stuff.
Matti Hamalainen <ccr@tnsp.org>
parents:
1596
diff
changeset
|
659 control codes to change the effective character translation. |
|
d1ea70ae13c9
Updated documentation concerning the character set/locale stuff.
Matti Hamalainen <ccr@tnsp.org>
parents:
1596
diff
changeset
|
660 <emphasis>This feature is not supported by all terminals, XTerm and |
|
d1ea70ae13c9
Updated documentation concerning the character set/locale stuff.
Matti Hamalainen <ccr@tnsp.org>
parents:
1596
diff
changeset
|
661 Rxvt are known to support it, however.</emphasis> |
|
d1ea70ae13c9
Updated documentation concerning the character set/locale stuff.
Matti Hamalainen <ccr@tnsp.org>
parents:
1596
diff
changeset
|
662 You will need to copy+paste the script, or download it |
|
d1ea70ae13c9
Updated documentation concerning the character set/locale stuff.
Matti Hamalainen <ccr@tnsp.org>
parents:
1596
diff
changeset
|
663 <ulink url="http://tnsp.org/~ccr/ggrtf/tf5.sh">from here</ulink>. |
|
1538
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
664 </para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
665 <screen>#!/bin/sh |
|
1537
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
666 SAVE_LANG="$LANG" |
|
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
667 export LANG="en_US.ISO-8859-1" |
|
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
668 printf '\33]701;%s\007' $LANG |
|
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
669 |
|
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
670 /usr/bin/tf5 $* |
|
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
671 |
|
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
672 export LANG="$SAVE_LANG" |
|
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
673 printf '\33]701;%s\007' $LANG</screen> |
|
1538
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
674 <para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
675 You should place the script in some directory in your $PATH. You |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
676 will also need to modify it to point to the correct TinyFugye executable, |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
677 (e.g. change "/usr/bin/tf5" if needed.) Name the script as something |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
678 like "mytf" or rename the real TinyFugue executable as "tf5-bin" and |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
679 the script as "tf5", changing the script to point to tf5-bin. |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
680 </para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
681 <para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
682 Remember to set the script executable by changing |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
683 its permissions, '<emphasis>chmod 0755 /some/where/scriptfile</emphasis>' |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
684 should do it. |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
685 </para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
686 <para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
687 The idea is that you run the script instead of TF directly. The |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
688 script changes your current locale and forces the terminal via |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
689 special terminal control code to use it, and changes it back |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
690 after TF exits. |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
691 </para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
692 </section> <!-- Unix-likes --> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
693 |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
694 |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
695 </section> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
696 |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
697 <section id="inst-config-tf-term"><title>Terminal/keyboard issues</title> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
698 <para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
699 You need to make sure that you have the correct keyboard module(s) loaded. |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
700 For most Linux/UNIX terminals you want to load EITHER or BOTH |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
701 <emphasis>kbd-xterm.tf</emphasis> and <emphasis>kbd-tf5def.tf</emphasis>. |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
702 For TF on Windows and Mac OSX, you may wish to use |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
703 <emphasis>kbd-tf5def.tf</emphasis> only. You may need to experiment. |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
704 </para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
705 <para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
706 Additionally, it may be necessary to enable the so-called "application mode" |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
707 in your terminal. |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
708 </para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
709 <itemizedlist> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
710 <listitem> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
711 <para>In OSX terminal app, the setting can be found in <emphasis>Terminal / |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
712 Preferences / Setting / Advanced</emphasis> and turn on |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
713 "Allow VT100 application keypad mode". |
|
1537
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
714 </para> |
|
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
715 </listitem> |
|
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
716 <listitem> |
|
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
717 <para> |
|
1538
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
718 In PuTTY, the application keypad mode should be enabled by default, |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
719 but if it is not, see the Features panel of PuTTY's configuration, |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
720 see <ulink url="http://the.earth.li/~sgtatham/putty/0.60/htmldoc/Chapter4.html#config-appkeypad">PuTTY documentation here</ulink>. |
|
1537
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
721 </para> |
|
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
722 </listitem> |
|
1230
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
723 </itemizedlist> |
|
1538
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
724 </section> <!-- Terminal --> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
725 |
|
315
14204307afda
More explanation about configuration; prot-management
Matti Hamalainen <ccr@tnsp.org>
parents:
314
diff
changeset
|
726 </section> |
|
14204307afda
More explanation about configuration; prot-management
Matti Hamalainen <ccr@tnsp.org>
parents:
314
diff
changeset
|
727 |
|
14204307afda
More explanation about configuration; prot-management
Matti Hamalainen <ccr@tnsp.org>
parents:
314
diff
changeset
|
728 |
| 404 | 729 <section id="inst-config-batmud"><title>BatMUD settings</title> |
|
315
14204307afda
More explanation about configuration; prot-management
Matti Hamalainen <ccr@tnsp.org>
parents:
314
diff
changeset
|
730 <para> |
|
980
9d3182edd64d
Add note about how BatMUD settings should be copypasted exactly as shown.
Matti Hamalainen <ccr@tnsp.org>
parents:
978
diff
changeset
|
731 Next, log on in BatMUD and change following settings. <emphasis>It is |
|
9d3182edd64d
Add note about how BatMUD settings should be copypasted exactly as shown.
Matti Hamalainen <ccr@tnsp.org>
parents:
978
diff
changeset
|
732 probably best, if you use direct copy & paste to set these, as most of |
|
9d3182edd64d
Add note about how BatMUD settings should be copypasted exactly as shown.
Matti Hamalainen <ccr@tnsp.org>
parents:
978
diff
changeset
|
733 them are required to be set exactly as shown here for GgrTF to work |
|
9d3182edd64d
Add note about how BatMUD settings should be copypasted exactly as shown.
Matti Hamalainen <ccr@tnsp.org>
parents:
978
diff
changeset
|
734 correctly.</emphasis> |
|
306
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
735 </para> |
|
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
736 |
|
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
737 <itemizedlist> |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
738 <listitem><para>Line 'cutter' setting: |
|
954
7d4c1c2e981f
Instead of <screen> tag, use <userinput> where appropriate.
Matti Hamalainen <ccr@tnsp.org>
parents:
950
diff
changeset
|
739 <userinput>cutter 9999</userinput> |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
740 Theoretically, '<emphasis>cutter off</emphasis>' |
|
453
e7d262fb061c
Note about 'cutter' setting was missing, added.
Matti Hamalainen <ccr@tnsp.org>
parents:
449
diff
changeset
|
741 should be better, but in practice I have noticed that |
|
e7d262fb061c
Note about 'cutter' setting was missing, added.
Matti Hamalainen <ccr@tnsp.org>
parents:
449
diff
changeset
|
742 in certain things it simply does not work as expected.</para> |
|
e7d262fb061c
Note about 'cutter' setting was missing, added.
Matti Hamalainen <ccr@tnsp.org>
parents:
449
diff
changeset
|
743 </listitem> |
|
e7d262fb061c
Note about 'cutter' setting was missing, added.
Matti Hamalainen <ccr@tnsp.org>
parents:
449
diff
changeset
|
744 |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
745 <listitem><para>Short score format for regular BatMUD: |
|
978
dc8ee5ec3c66
Add @@ to some command examples, because apparently SOME players have aliased these essential BatMUD commands to something else.
Matti Hamalainen <ccr@tnsp.org>
parents:
972
diff
changeset
|
746 <userinput>@@sc set H:{colorhp}/<maxhp> [{diffhp}] S:{colorsp}/<maxsp> [{diffsp}] E:{colorep}/<maxep> [{diffep}] $:<cash> [{diffcash}] exp:<exp> [{diffexp}]</userinput> |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
747 </para> |
|
306
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
748 </listitem> |
|
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
749 |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
750 <listitem><para>Short score format for HardCore BatMUD (HCBat): |
|
978
dc8ee5ec3c66
Add @@ to some command examples, because apparently SOME players have aliased these essential BatMUD commands to something else.
Matti Hamalainen <ccr@tnsp.org>
parents:
972
diff
changeset
|
751 <userinput>@@sc set H:{colorhp}/<maxhp> S:{colorsp}/<maxsp> E:{colorep}/<maxep> $:<cash> exp:<exp></userinput> |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
752 </para> |
|
306
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
753 </listitem> |
|
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
754 |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
755 <listitem><para>Enable automatic short score (required for automatic updating of HP/SP/EP values on statusline): |
|
1448
8d07f07bd72b
Clarify in the BatMUD configuration / setup section that "sc" should be turned on.
Matti Hamalainen <ccr@tnsp.org>
parents:
1443
diff
changeset
|
756 <userinput>@@sc on</userinput> |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
757 </para> |
| 1449 | 758 <note><para>If you do not wish to not see the 'sc' lines, you can turn on '/gagsc' option.</para></note> |
|
1448
8d07f07bd72b
Clarify in the BatMUD configuration / setup section that "sc" should be turned on.
Matti Hamalainen <ccr@tnsp.org>
parents:
1443
diff
changeset
|
759 </listitem> |
|
8d07f07bd72b
Clarify in the BatMUD configuration / setup section that "sc" should be turned on.
Matti Hamalainen <ccr@tnsp.org>
parents:
1443
diff
changeset
|
760 |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
761 <listitem><para>Prompt: |
|
978
dc8ee5ec3c66
Add @@ to some command examples, because apparently SOME players have aliased these essential BatMUD commands to something else.
Matti Hamalainen <ccr@tnsp.org>
parents:
972
diff
changeset
|
762 <userinput>@@prompt PROMPT:></userinput> |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
763 If you wish, you can add any BatMUD specific data to the prompt |
|
943
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
764 between ":" and ">", this substring will be stored to "status_prompt" TF |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
765 variable, which can be used in /gprompt. Read more in <link |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
766 linkend="usage-general-prompt">prompt setup section</link>.</para> |
|
306
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
767 </listitem> |
|
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
768 |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
769 <listitem><para>Listen to battle round flags: |
|
978
dc8ee5ec3c66
Add @@ to some command examples, because apparently SOME players have aliased these essential BatMUD commands to something else.
Matti Hamalainen <ccr@tnsp.org>
parents:
972
diff
changeset
|
770 <userinput>@@battle rounds</userinput> |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
771 This setting is a toggle, make sure that you set it ON |
| 345 | 772 ("Listening to round flags.") instead of off! |
|
306
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
773 </para> |
|
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
774 </listitem> |
|
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
775 |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
776 <listitem><para>Battle listen-level: |
|
978
dc8ee5ec3c66
Add @@ to some command examples, because apparently SOME players have aliased these essential BatMUD commands to something else.
Matti Hamalainen <ccr@tnsp.org>
parents:
972
diff
changeset
|
777 <userinput>@@battle listen all 2</userinput> |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
778 Listen level should be 2 or 3, if you are using hitstats. |
|
306
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
779 Otherwise it can be 1 or 0, if you prefer silence. |
|
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
780 </para> |
|
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
781 </listitem> |
|
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
782 </itemizedlist> |
|
327
521d0c3233bd
v0.5.10.0: Major cleanup of namespace, many functions and variables renamed
Matti Hamalainen <ccr@tnsp.org>
parents:
323
diff
changeset
|
783 |
|
521d0c3233bd
v0.5.10.0: Major cleanup of namespace, many functions and variables renamed
Matti Hamalainen <ccr@tnsp.org>
parents:
323
diff
changeset
|
784 <para> |
|
521d0c3233bd
v0.5.10.0: Major cleanup of namespace, many functions and variables renamed
Matti Hamalainen <ccr@tnsp.org>
parents:
323
diff
changeset
|
785 In case you do NOT want to change your settings to the way GgrTF needs |
|
1230
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
786 them to be, your only option is to change the regex patterns in GgrTF's |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
787 code to match your preferences (and redo the changes each time you |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
788 upgrade GgrTF.) |
|
327
521d0c3233bd
v0.5.10.0: Major cleanup of namespace, many functions and variables renamed
Matti Hamalainen <ccr@tnsp.org>
parents:
323
diff
changeset
|
789 </para> |
| 226 | 790 </section> |
| 791 | |
|
956
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
792 <!-- |
|
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
793 <section id="inst-config-ggrtf"><title>GgrTF configuration</title> |
|
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
794 <para> |
|
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
795 </para> |
|
315
14204307afda
More explanation about configuration; prot-management
Matti Hamalainen <ccr@tnsp.org>
parents:
314
diff
changeset
|
796 </section> |
|
956
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
797 --> |
| 405 | 798 |
| 226 | 799 </chapter> |
| 800 | |
| 801 <!-- *************************************************************** --> | |
| 223 | 802 |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
803 <chapter id="usage-intro"><title>Usage</title> |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
804 <para> |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
805 This chapter describes the structure of GgrTF, what the |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
806 different modules included in GgrTF are and what functionality |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
807 they provide. There are basically three flavours of modules: generic |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
808 modules that are either required or optional and provide |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
809 functionality unrelated to specific guilds; then there are |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
810 guild-related modules, containing guild-specialties. |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
811 </para> |
| 230 | 812 |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
813 <para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
814 Each module section has short introduction about what is provided |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
815 and section with macro commands and variables available. Some modules |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
816 also have additional information about usage and configuration |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
817 with examples. |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
818 </para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
819 |
|
1263
d56722e12ed8
Remove (comment out) block diagram from documentation, for now.
Matti Hamalainen <ccr@tnsp.org>
parents:
1255
diff
changeset
|
820 <!-- |
| 403 | 821 <para> |
| 822 Following block-diagram represents the structure of GgrTF and | |
| 823 how different components approximately relate to each other: | |
| 824 </para> | |
| 825 | |
| 826 <screenshot> | |
| 827 <mediaobject> | |
| 638 | 828 <imageobject><imagedata fileref="blockdiagram.png" format="PNG" /></imageobject> |
|
624
cc40c7360880
The manual is now pseudo-XML conformant, you have to use normalizeml.pl to convert to syntactically correct XML.
Matti Hamalainen <ccr@tnsp.org>
parents:
622
diff
changeset
|
829 <imageobject><imagedata fileref="blockdiagram.eps" format="EPS" /></imageobject> |
| 403 | 830 <textobject> |
| 831 <phrase>GgrTF's internal structure</phrase> | |
| 832 </textobject> | |
| 833 <caption> | |
| 834 <para>Internal structure and relations of GgrTF components represented as | |
| 835 block-diagram.</para> | |
| 836 </caption> | |
| 837 </mediaobject> | |
| 838 </screenshot> | |
|
1263
d56722e12ed8
Remove (comment out) block diagram from documentation, for now.
Matti Hamalainen <ccr@tnsp.org>
parents:
1255
diff
changeset
|
839 --> |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
840 |
| 248 | 841 <!-- ================================================ --> |
| 230 | 842 |
| 340 | 843 <section id="usage-general"><title>GgrTF core (ggrtf.tf)</title> |
|
249
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
844 <para> |
| 403 | 845 This is the main module and core of GgrTF. It contains helper |
| 846 macro functions used by all the other modules and is thus | |
| 847 always required to be loaded. | |
| 848 It also provides much of the basic functionality, such as: | |
| 276 | 849 </para> |
| 850 | |
| 851 <itemizedlist> | |
| 279 | 852 <listitem><para> |
|
314
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
853 <link linkend="usage-general-statusline">Statusline</link>. |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
854 Provides nice, realtimeish view of your character's current |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
855 condition, applied prots and other such information. |
| 279 | 856 </para></listitem> |
| 857 | |
| 858 <listitem><para> | |
| 859 <link linkend="usage-general-prots">Prot management</link>. | |
| 860 Keeps note of what prots have been cast at you, and provides this | |
| 861 information in various ways. | |
| 862 </para></listitem> | |
| 863 | |
| 841 | 864 <listitem><para> |
| 865 <link linkend="usage-general-curses">Curse/degen/etc tracking</link>. | |
| 866 Tracks what handicaps have been cast at enemies (non-partymembers). | |
| 867 This information is most useful in eq-parties. | |
| 868 </para></listitem> | |
| 869 | |
| 279 | 870 <listitem><para>Battle round handling. Enables commands to be |
| 871 executed each battle round and autopss functionality. | |
| 872 </para></listitem> | |
| 873 | |
|
1220
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
874 <listitem><para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
875 <link linkend="usage-general-hbtick">Heartbeat and tick prediction</link>. |
|
1443
dc60423b8d4b
Change documentation to match the removal of average heartbeat duration field from statusline.
Matti Hamalainen <ccr@tnsp.org>
parents:
1426
diff
changeset
|
876 Display prediction of next "tick" via a heartbeat counter. |
|
1220
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
877 </para></listitem> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
878 |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
879 <listitem><para>Functions for binding command strings to macros, |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
880 or to cast spells and use skills, with or without reporting to |
| 387 | 881 party channel. See <link linkend="usage-general-binds">bindings</link> |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
882 section for more information. |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
883 </para></listitem> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
884 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
885 <listitem><para>Support for <link linkend="usage-general-saves"> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
886 state-saving</link>. Most GgrTF settings can be saved to files |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
887 and reloaded later (for example at startup) with /gsave and /gload |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
888 commands. |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
889 </para></listitem> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
890 |
|
943
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
891 <listitem><para><link linkend="usage-general-prompt">Prompt |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
892 handling and mangling.</link> |
| 279 | 893 </para></listitem> |
| 894 | |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
895 <listitem><para>Automatic "ripaction", which is performed when |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
896 your opponent (monster) dies. This way you can automate small |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
897 inconveniencies like looting and digging of graves. |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
898 </para></listitem> |
| 279 | 899 |
| 900 <listitem><para>Keyboard movement handling and mapping. Bind your | |
| 901 numpad keys to move around, either by walking, walking with peering | |
| 902 in adjacent rooms (useful for merchants) or guiding your ship. | |
| 903 Additional modes may be provided by other optional modules. | |
| 904 </para></listitem> | |
| 905 | |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
906 <listitem><para>Enemy shape string highlighting and reformatting. |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
907 You can make GgrTF mangle 'scan' command's output into |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
908 more readable and convenient form. |
| 279 | 909 </para></listitem> |
| 910 | |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
911 <listitem><para>Keep and display statistics about skills, spells |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
912 and whatnots. ("/stats" command) |
| 279 | 913 </para></listitem> |
|
889
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
914 |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
915 <listitem><para> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
916 <emphasis>Consider-skill reporting</emphasis>: |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
917 Takes output of 'consider' skill and compresses the information |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
918 into one prettyprinted line, which is reported. Output is |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
919 name of the target, estimated experience worth and final |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
920 estimation of target's toughness. |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
921 </para></listitem> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
922 |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
923 <listitem><para> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
924 <emphasis>Combat Damage Analysis reporting</emphasis>: |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
925 Triggers for reporting results of CDA-skill to party report-channel. |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
926 </para></listitem> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
927 |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
928 <listitem><para> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
929 <emphasis>Purse contents prettyprinting</emphasis>: |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
930 Highlites and colorizes the output of 'look at purse', and |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
931 calculates total sum of money (in gold) contained in the purse. |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
932 </para></listitem> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
933 |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
934 <listitem><para> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
935 <emphasis>Camping status handling and reporting</emphasis>: |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
936 Keeps note of whether you can use 'camping' skill. Reports |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
937 the hp/sp/ep gained from resting. |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
938 </para></listitem> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
939 |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
940 <listitem><para> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
941 <emphasis>Ceremony status</emphasis>: |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
942 Tracks status of ceremony, and provides macro "/ceremony", |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
943 which executes ceremony skill only if ceremony is not active currently. |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
944 </para></listitem> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
945 |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
946 <listitem><para> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
947 <emphasis>Path compression for map.tf</emphasis>: |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
948 TinyFugue distribution comes with map.tf, which |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
949 enables easy creation of walkpaths (See "/help map" in TF). |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
950 GgrTF adds an special purpose RLE compressor function, which |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
951 reduces the length of the paths. Additional command to output |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
952 the paths in format that is compatible with BatMUD's |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
953 "command"-aliases is also provided. |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
954 </para></listitem> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
955 |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
956 <listitem><para> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
957 Plus numerous miscellaneous reporting- and helper-triggers. |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
958 </para></listitem> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
959 |
| 276 | 960 </itemizedlist> |
| 961 | |
| 278 | 962 |
| 276 | 963 <section id="usage-general-commands"> |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
964 §macros_1; |
|
249
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
965 </para> |
|
1425
429e4bfbe297
Fetch GgrTF core macro command documentation from the embedded inline docs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1421
diff
changeset
|
966 |
|
429e4bfbe297
Fetch GgrTF core macro command documentation from the embedded inline docs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1421
diff
changeset
|
967 <!-- @commands --> |
|
429e4bfbe297
Fetch GgrTF core macro command documentation from the embedded inline docs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1421
diff
changeset
|
968 <!-- @binds --> |
|
429e4bfbe297
Fetch GgrTF core macro command documentation from the embedded inline docs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1421
diff
changeset
|
969 |
|
429e4bfbe297
Fetch GgrTF core macro command documentation from the embedded inline docs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1421
diff
changeset
|
970 </section> |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
971 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
972 </section> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
973 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
974 <!-- ================================================ --> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
975 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
976 <section id="usage-general-statusline"><title>Statusline</title> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
977 <para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
978 Probably one of the first things that you notice in GgrTF |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
979 is the statusline (or "statusbar" as some prefer). In GgrTF the |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
980 &tfurl; statusline is used to display information that we've |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
981 considered to be important enough for nearly real-time view. |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
982 </para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
983 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
984 <para> |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
985 Statusline is updated synchronously at ticks, skill- and spell |
|
1598
e3683413d8e2
Add notes about settings correctness.
Matti Hamalainen <ccr@tnsp.org>
parents:
1597
diff
changeset
|
986 castings and certain other events. <emphasis>This depends on |
|
e3683413d8e2
Add notes about settings correctness.
Matti Hamalainen <ccr@tnsp.org>
parents:
1597
diff
changeset
|
987 your <link linkend="inst-config-batmud">BatMUD settings</link> |
| 1601 | 988 being correctly set up.</emphasis> If HP/SP/EP etc. information does |
|
1598
e3683413d8e2
Add notes about settings correctness.
Matti Hamalainen <ccr@tnsp.org>
parents:
1597
diff
changeset
|
989 not appear, most likely your 'sc' setting is "wrong", |
|
e3683413d8e2
Add notes about settings correctness.
Matti Hamalainen <ccr@tnsp.org>
parents:
1597
diff
changeset
|
990 and thus does not get parsed by GgrTF. |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
991 </para> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
992 |
|
1684
bcb60bb50a5a
Oops, TF5 section had partially been left in.
Matti Hamalainen <ccr@tnsp.org>
parents:
1683
diff
changeset
|
993 <note> |
|
1678
914961b1e2d2
Update manual a bit, move gm-tf5 module stuff to statusline section and
Matti Hamalainen <ccr@tnsp.org>
parents:
1673
diff
changeset
|
994 <para> |
|
914961b1e2d2
Update manual a bit, move gm-tf5 module stuff to statusline section and
Matti Hamalainen <ccr@tnsp.org>
parents:
1673
diff
changeset
|
995 <emphasis>The functionality of the statusline depends on |
|
914961b1e2d2
Update manual a bit, move gm-tf5 module stuff to statusline section and
Matti Hamalainen <ccr@tnsp.org>
parents:
1673
diff
changeset
|
996 your <link linkend="inst-config-batmud">BatMUD settings</link> |
|
914961b1e2d2
Update manual a bit, move gm-tf5 module stuff to statusline section and
Matti Hamalainen <ccr@tnsp.org>
parents:
1673
diff
changeset
|
997 being correctly set up.</emphasis> If HP/SP/EP etc. information does |
|
914961b1e2d2
Update manual a bit, move gm-tf5 module stuff to statusline section and
Matti Hamalainen <ccr@tnsp.org>
parents:
1673
diff
changeset
|
998 not appear, most likely your 'sc' setting is "wrong", |
|
914961b1e2d2
Update manual a bit, move gm-tf5 module stuff to statusline section and
Matti Hamalainen <ccr@tnsp.org>
parents:
1673
diff
changeset
|
999 and thus does not get parsed by GgrTF. |
|
914961b1e2d2
Update manual a bit, move gm-tf5 module stuff to statusline section and
Matti Hamalainen <ccr@tnsp.org>
parents:
1673
diff
changeset
|
1000 </para> |
|
914961b1e2d2
Update manual a bit, move gm-tf5 module stuff to statusline section and
Matti Hamalainen <ccr@tnsp.org>
parents:
1673
diff
changeset
|
1001 </note> |
|
914961b1e2d2
Update manual a bit, move gm-tf5 module stuff to statusline section and
Matti Hamalainen <ccr@tnsp.org>
parents:
1673
diff
changeset
|
1002 |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1003 <screenshot> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1004 <mediaobject> |
|
1678
914961b1e2d2
Update manual a bit, move gm-tf5 module stuff to statusline section and
Matti Hamalainen <ccr@tnsp.org>
parents:
1673
diff
changeset
|
1005 <imageobject><imagedata fileref="statusbar_tf5.gif" format="GIF" /></imageobject> |
|
914961b1e2d2
Update manual a bit, move gm-tf5 module stuff to statusline section and
Matti Hamalainen <ccr@tnsp.org>
parents:
1673
diff
changeset
|
1006 <imageobject><imagedata fileref="statusbar_tf5.eps" format="EPS" /></imageobject> |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1007 <textobject> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1008 <phrase>GgrTF statusline</phrase> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1009 </textobject> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1010 <caption> |
|
1678
914961b1e2d2
Update manual a bit, move gm-tf5 module stuff to statusline section and
Matti Hamalainen <ccr@tnsp.org>
parents:
1673
diff
changeset
|
1011 <para>Example of typical basic GgrTF statusline in TF5.</para> |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1012 </caption> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1013 </mediaobject> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1014 </screenshot> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1015 |
|
1678
914961b1e2d2
Update manual a bit, move gm-tf5 module stuff to statusline section and
Matti Hamalainen <ccr@tnsp.org>
parents:
1673
diff
changeset
|
1016 <itemizedlist> |
|
914961b1e2d2
Update manual a bit, move gm-tf5 module stuff to statusline section and
Matti Hamalainen <ccr@tnsp.org>
parents:
1673
diff
changeset
|
1017 <listitem><para> |
|
914961b1e2d2
Update manual a bit, move gm-tf5 module stuff to statusline section and
Matti Hamalainen <ccr@tnsp.org>
parents:
1673
diff
changeset
|
1018 Enhanced 2-row statusline: First line contains HP/SP/EP- and |
|
914961b1e2d2
Update manual a bit, move gm-tf5 module stuff to statusline section and
Matti Hamalainen <ccr@tnsp.org>
parents:
1673
diff
changeset
|
1019 skill/spell/etc- information as usual. Prot status has been |
|
914961b1e2d2
Update manual a bit, move gm-tf5 module stuff to statusline section and
Matti Hamalainen <ccr@tnsp.org>
parents:
1673
diff
changeset
|
1020 moved to the second line. |
|
914961b1e2d2
Update manual a bit, move gm-tf5 module stuff to statusline section and
Matti Hamalainen <ccr@tnsp.org>
parents:
1673
diff
changeset
|
1021 </para></listitem> |
|
914961b1e2d2
Update manual a bit, move gm-tf5 module stuff to statusline section and
Matti Hamalainen <ccr@tnsp.org>
parents:
1673
diff
changeset
|
1022 |
|
914961b1e2d2
Update manual a bit, move gm-tf5 module stuff to statusline section and
Matti Hamalainen <ccr@tnsp.org>
parents:
1673
diff
changeset
|
1023 </itemizedlist> |
|
914961b1e2d2
Update manual a bit, move gm-tf5 module stuff to statusline section and
Matti Hamalainen <ccr@tnsp.org>
parents:
1673
diff
changeset
|
1024 |
|
914961b1e2d2
Update manual a bit, move gm-tf5 module stuff to statusline section and
Matti Hamalainen <ccr@tnsp.org>
parents:
1673
diff
changeset
|
1025 <!-- |
|
914961b1e2d2
Update manual a bit, move gm-tf5 module stuff to statusline section and
Matti Hamalainen <ccr@tnsp.org>
parents:
1673
diff
changeset
|
1026 - example configuration |
|
914961b1e2d2
Update manual a bit, move gm-tf5 module stuff to statusline section and
Matti Hamalainen <ccr@tnsp.org>
parents:
1673
diff
changeset
|
1027 - document special variables |
|
914961b1e2d2
Update manual a bit, move gm-tf5 module stuff to statusline section and
Matti Hamalainen <ccr@tnsp.org>
parents:
1673
diff
changeset
|
1028 --> |
|
914961b1e2d2
Update manual a bit, move gm-tf5 module stuff to statusline section and
Matti Hamalainen <ccr@tnsp.org>
parents:
1673
diff
changeset
|
1029 |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1030 <orderedlist> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1031 <listitem><para>Current hit points / hit points maximum.</para></listitem> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1032 <listitem><para>Current spell points / spell points maximum.</para></listitem> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1033 <listitem><para>Current endurance points / endurance points maximum.</para></listitem> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1034 <listitem><para>[2 light green characters] Last moved direction.</para></listitem> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1035 <listitem><para>["C"] Ceremony status. (Dark blue = inactive/no ceremony; White = ceremony active)</para></listitem> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1036 <listitem><para>["S"] Spell status. (Dark blue = no spell going; White = spellcasting)</para></listitem> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1037 <listitem><para>["K"] Skill status. (Dark blue = no skill going; White = using a skill)</para></listitem> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1038 <listitem><para>["c"] Camping status. (Light green = ready to camp; Red = camping active/skill ongoing; Yellow = camping not available, or recovering from previous camping.)</para></listitem> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1039 <listitem><para><link linkend="usage-general-prots">Currently active prots</link> in short format.</para></listitem> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1040 </orderedlist> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1041 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1042 <para> |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1043 First three elements of the statusbar describe your character's |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1044 current hit-, spell- and endurance-points. These values are |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1045 color-coded for better visual clarity. One element shows |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1046 current value and maximum value, as shown in screenshot below: |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1047 </para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1048 |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1049 <screenshot> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1050 <mediaobject> |
|
624
cc40c7360880
The manual is now pseudo-XML conformant, you have to use normalizeml.pl to convert to syntactically correct XML.
Matti Hamalainen <ccr@tnsp.org>
parents:
622
diff
changeset
|
1051 <imageobject><imagedata fileref="statusbar_ep.gif" format="GIF" /></imageobject> |
|
cc40c7360880
The manual is now pseudo-XML conformant, you have to use normalizeml.pl to convert to syntactically correct XML.
Matti Hamalainen <ccr@tnsp.org>
parents:
622
diff
changeset
|
1052 <imageobject><imagedata fileref="statusbar_ep.eps" format="EPS" /></imageobject> |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1053 <textobject> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1054 <phrase>Endurance Points-part of statusline</phrase> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1055 </textobject> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1056 <caption> |
| 392 | 1057 <para>Example of how endurance points are shown. "E:" denotes Endurance, |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1058 "134" is the current value (colorcoded) and "246" is the maximum |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1059 endurance your character has. |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1060 </para> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1061 </caption> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1062 </mediaobject> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1063 </screenshot> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1064 |
|
943
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1065 </section> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1066 |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1067 <!-- ================================================ --> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1068 |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1069 <section id="usage-general-prompt"><title>Prompt configuration</title> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1070 <para> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1071 In addition to basic prompt handling, GgrTF offers very flexible and |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1072 extensible way of presenting the game prompt. Internal TF variables |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1073 can be shown, even simple TF macro snippets executed to show the prompt |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1074 as the user wishes. Also, in GgrTF v0.6.11.3 and later, it is possible to |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1075 have custom BatMUD data in the prompt (see 'help prompt' in BatMUD). |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1076 </para> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1077 <para> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1078 To get started, you need to have a basic prompt setting in BatMUD, |
|
1065
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
1079 as it is required to have GgrTF handle it properly. The basic setting is |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
1080 presented below, and we'll get to the more complex ones later. |
|
943
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1081 |
|
954
7d4c1c2e981f
Instead of <screen> tag, use <userinput> where appropriate.
Matti Hamalainen <ccr@tnsp.org>
parents:
950
diff
changeset
|
1082 <userinput>prompt PROMPT:></userinput> |
|
943
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1083 |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1084 After setting the BatMUD prompt, you can start configuring how GgrTF |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1085 "mangles" your prompt. This is done by using "/gprompt" command macro |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1086 (or alternatively editing the saved configuration files and "set_gprompt" |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1087 setting.) There are myriad of ways of how and what things can be done, |
|
1065
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
1088 mostly limited by your imagination. Some examples are presented below: |
|
943
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1089 </para> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1090 |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1091 <orderedlist> |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1092 <listitem> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1093 <para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1094 <userinput>/gprompt ></userinput> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1095 Set prompt to show only ">" and nothing more. |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1096 </para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1097 </listitem> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1098 <listitem> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1099 <para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1100 <userinput>/gprompt %{status_cast}></userinput> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1101 Show currently in-progress skill or spell in prompt. |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1102 </para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1103 </listitem> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1104 <listitem> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1105 <para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1106 <userinput>/gprompt @{BCred}%{status_cast}@{n}@{BCwhite}>@{n}</userinput> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1107 TinyFugue color attributes can be used also. |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1108 </para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1109 </listitem> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1110 <listitem> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1111 <para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1112 <userinput>/gprompt @{$[prgetnlite(status_hp,status_hpm)]}%{status_hp}@{n}@{BCwhite}>@{n}</userinput> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1113 Above would print your hp, lited similarly to the statusbar HP/SP/EP display. |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1114 It is possible to use almost any kind of substitutions and call TF functions. |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1115 </para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1116 </listitem> |
|
943
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1117 </orderedlist> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1118 |
|
1075
122c463704e1
Add note about /gprompt attribute formatting not working with earlier betas of TF5.
Matti Hamalainen <ccr@tnsp.org>
parents:
1074
diff
changeset
|
1119 <note><para> |
|
122c463704e1
Add note about /gprompt attribute formatting not working with earlier betas of TF5.
Matti Hamalainen <ccr@tnsp.org>
parents:
1074
diff
changeset
|
1120 Using TF attribute formatting (e.g. colours) in prompt only works |
|
122c463704e1
Add note about /gprompt attribute formatting not working with earlier betas of TF5.
Matti Hamalainen <ccr@tnsp.org>
parents:
1074
diff
changeset
|
1121 with TF 5.0 beta 8 and later. If running under earlier version, GgrTF |
|
122c463704e1
Add note about /gprompt attribute formatting not working with earlier betas of TF5.
Matti Hamalainen <ccr@tnsp.org>
parents:
1074
diff
changeset
|
1122 disables this feature. |
|
122c463704e1
Add note about /gprompt attribute formatting not working with earlier betas of TF5.
Matti Hamalainen <ccr@tnsp.org>
parents:
1074
diff
changeset
|
1123 </para></note> |
|
122c463704e1
Add note about /gprompt attribute formatting not working with earlier betas of TF5.
Matti Hamalainen <ccr@tnsp.org>
parents:
1074
diff
changeset
|
1124 |
|
943
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1125 <para> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1126 As you can see, lots of things can be done, and only fraction of ideas |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1127 are represented here. However, in addition to what GgrTF and TF offer, |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1128 it is also possible to add BatMUD specific information into the prompt. |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1129 As you remember, we set up the basic prompt above to "PROMPT:>". |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1130 The user definable data can be put between the colon (":") and greater than |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1131 (">") sign, and it gets parsed by GgrTF. Observe following example: |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1132 |
|
954
7d4c1c2e981f
Instead of <screen> tag, use <userinput> where appropriate.
Matti Hamalainen <ccr@tnsp.org>
parents:
950
diff
changeset
|
1133 <userinput>prompt PROMPT:<hp>/<sp>/<ep>|<eqset>></userinput> |
|
943
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1134 |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1135 Above prompt setting would make the BatMUD prompt show something like: |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1136 |
|
954
7d4c1c2e981f
Instead of <screen> tag, use <userinput> where appropriate.
Matti Hamalainen <ccr@tnsp.org>
parents:
950
diff
changeset
|
1137 <userinput>PROMPT:663/636/333|spr></userinput> |
|
943
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1138 |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1139 Where the numbers represent your hp, sp and ep, and 'spr' is the work |
|
943
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1140 eqset, as described by 'help prompt'. This string gets parsed into a TF variable |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1141 called "status_prompt", which can be then used in GgrTF's prompt. Examples |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1142 follow: |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1143 </para> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1144 |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1145 <orderedlist> |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1146 <listitem> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1147 <para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1148 <userinput>/gprompt %{status_prompt}></userinput> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1149 This simple example would just prompt the grabbed BatMUD data with |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1150 greater than sign in the end. |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1151 </para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1152 </listitem> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1153 <listitem> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1154 <para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1155 <userinput>/gprompt @{BCgreen}%{status_prompt}@{n}></userinput> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1156 Same as above, but coloured bright green. |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1157 </para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1158 </listitem> |
|
943
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1159 </orderedlist> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1160 |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1161 <para> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1162 The prompt can contain any BatMUD data, as long as it is formatted as |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1163 "PROMPT:your data here>". |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1164 </para> |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1165 |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1166 </section> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1167 |
|
943
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1168 |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1169 <!-- ================================================ --> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1170 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1171 <section id="usage-general-saves"><title>State-saving</title> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1172 <para> |
| 390 | 1173 State-saving is an awfully awkward name for GgrTF's functionality for |
| 1174 saving your settings and other interesting data for later | |
|
978
dc8ee5ec3c66
Add @@ to some command examples, because apparently SOME players have aliased these essential BatMUD commands to something else.
Matti Hamalainen <ccr@tnsp.org>
parents:
972
diff
changeset
|
1175 retrieval. Settings get saved and thus restored later, |
| 390 | 1176 but this functionality is not automatic by default, you have to set it |
| 1177 up so if you wish - GgrTF only provides you the functions for loading | |
| 1178 and saving, making it to happen automagically is up to you. | |
|
978
dc8ee5ec3c66
Add @@ to some command examples, because apparently SOME players have aliased these essential BatMUD commands to something else.
Matti Hamalainen <ccr@tnsp.org>
parents:
972
diff
changeset
|
1179 How to do this is discussed further below. |
| 390 | 1180 </para> |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1181 |
|
629
a80d8bcdef99
Updated some examples, fixed few bugs.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
1182 <section id="usage-general-saves-whatis"><title>What is saved?</title> |
| 390 | 1183 <para> |
| 1184 <emphasis>Almost</emphasis> all settings (hidden or visible) | |
| 1185 get saved, but there are certain global settings that you | |
| 391 | 1186 have to set yourself in your TF configuration. These |
| 392 | 1187 settings are discussed in sub-section below. |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1188 </para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1189 |
| 390 | 1190 <para> |
| 1191 It should also be noted, that there are actually <emphasis>two | |
| 1192 different types of data (or variables) that is saved into two | |
| 1193 different files</emphasis>. In GgrTF, these two types of data | |
| 1194 are called <emphasis>pre- and post-init settings</emphasis>, and the | |
| 1195 two savefiles are named accordingly. Pre-init settings are | |
| 1196 variables that need to be defined before the main modules | |
| 1197 of GgrTF are loaded in TF's startup configuration (certain | |
| 1198 functionality depends on this). Post-init variables can | |
| 1199 (and sometimes <emphasis>must</emphasis>) be set after loading | |
| 1200 of all modules. | |
| 1201 </para> | |
| 1202 </section> | |
| 1203 | |
|
629
a80d8bcdef99
Updated some examples, fixed few bugs.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
1204 <section id="usage-general-saves-special"><title>Special, non-saved variables</title> |
| 390 | 1205 <para> |
| 1206 There are currently three special GgrTF variables, which you have to | |
|
1230
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
1207 set yourself in your TF's startup configuration (.tfrc). |
| 390 | 1208 These variables <emphasis>MUST</emphasis> be set before loading |
| 1209 of ANY GgrTF modules, otherwise things start breaking and the | |
| 1210 state-saving system does not work correctly. | |
| 1211 </para> | |
| 1212 | |
| 1052 | 1213 <table><title>Special, non-saved variables</title> |
| 390 | 1214 <tgroup cols="3" align="left"> |
| 1215 <thead> | |
| 1216 <row> | |
| 1217 <entry>Variable</entry> | |
| 1218 <entry>Description</entry> | |
| 1219 <entry>Example</entry> | |
| 1220 </row> | |
| 1221 </thead> | |
| 1222 <tbody> | |
| 1223 <row> | |
| 1224 <entry>set_plrname</entry> | |
| 1225 <entry> | |
| 1226 Your character's name, written in correct case. | |
| 1227 </entry> | |
| 1228 <entry>/set set_plrname=Ggr</entry> | |
| 1229 </row> | |
| 1230 | |
| 1231 <row> | |
| 1232 <entry>set_datapath</entry> | |
| 1233 <entry>Path to the directory where you want your savefiles to reside. If | |
| 1234 left empty, current working directory is used (the directory you started TF | |
| 1235 from.)</entry> | |
| 1236 <entry>/set set_datapath=</entry> | |
| 1237 </row> | |
| 1238 | |
| 1239 <row> | |
| 1240 <entry>set_saveprefix</entry> | |
| 1241 <entry> | |
| 1242 This string is used as prefix of the two savefiles, so the actual | |
| 401 | 1243 savefiles are "<emphasis><prefix>pre.tf</emphasis>" and |
| 1244 "<emphasis><prefix>post.tf</emphasis>". This is useful, | |
| 390 | 1245 if you play regular BatMUD and HCBat, so you can use different values |
| 1246 for either. | |
| 1247 </entry> | |
| 1248 <entry>/set set_saveprefix=bat-</entry> | |
| 1249 </row> | |
| 1250 | |
| 1251 </tbody> | |
| 1252 </tgroup> | |
| 1253 </table> | |
| 1254 | |
| 1255 </section> | |
| 1256 | |
| 1257 | |
| 392 | 1258 <section id="usage-general-saves-setup"><title>How to setup TF for state-saving</title> |
| 390 | 1259 <para> |
| 393 | 1260 Getting GgrTF's state-saving to work requires some changes to your |
| 841 | 1261 TF configuration, and possibly setting up a savefile directory |
| 390 | 1262 </para> |
| 393 | 1263 |
| 1264 <para> | |
| 841 | 1265 A simplified example configuration layout is presented below with only |
| 1266 the state-saving related parts, please refer to | |
|
956
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
1267 <link linkend="inst-config-tf">setup</link>-section of this |
| 401 | 1268 manual for a more detailed example. Pay close attention to the order |
| 1269 how things are done, it is very important! | |
| 393 | 1270 </para> |
| 1271 | |
| 950 | 1272 <screen>;; Set directory path where savefiles will be stored |
|
1065
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
1273 /eval /set set_datapath=%{HOME}/.ggrtf/ |
| 841 | 1274 |
| 1275 ;; Set prefix string for savefile names | |
|
1065
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
1276 /eval /set set_saveprefix=bat- |
| 393 | 1277 |
| 841 | 1278 ;; Load the special pre-init module which loads pre-init |
| 1279 ;; settings from the savefiles. This needs to be done | |
| 1280 ;; before loading any other GgrTF modules. | |
|
629
a80d8bcdef99
Updated some examples, fixed few bugs.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
1281 /gloadmod ggrtf-pre.tf |
| 393 | 1282 |
| 841 | 1283 ;; Load GgrTF core module |
|
629
a80d8bcdef99
Updated some examples, fixed few bugs.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
1284 /gloadmod ggrtf.tf |
| 393 | 1285 |
| 1286 ;; Load other additional modules | |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
1287 /gloadmod gm-magical.tf |
| 841 | 1288 ; etc etc. |
| 1289 | |
| 1290 ;; Load and restore other previously saved settings. | |
| 1291 ;; This should be done after loading any GgrTF modules. | |
| 393 | 1292 /gload |
| 1293 </screen> | |
| 1294 | |
| 1295 <para> | |
| 401 | 1296 When you have edited your TF configuration, you need to (re-)start |
| 1297 it, change settings the way you want them to be and finally issue | |
| 1298 "/gsave" command to get settings saved. <emphasis>After saving, | |
| 1299 you may also want to examine the pre-init -savefile, because it | |
| 1300 contains certain settings that cannot be changed run-time | |
| 1301 </emphasis>. So, here are the steps in short again: | |
| 393 | 1302 </para> |
| 401 | 1303 |
| 403 | 1304 <orderedlist> |
| 401 | 1305 <listitem><para> |
| 841 | 1306 <emphasis>Edit TF configuration (see example above)</emphasis>: |
| 1307 Add <emphasis>set_datapath</emphasis>, <emphasis>set_saveprefix</emphasis> | |
| 1308 settings and add commands to load <emphasis>ggrtf-pre.tf</emphasis> module | |
| 1309 and <emphasis>/gload</emphasis> command. | |
| 1310 </para></listitem> | |
|
1534
ad7cfb90c328
Oops, the manual SGML has been broken for a while due to accidentally
Matti Hamalainen <ccr@tnsp.org>
parents:
1533
diff
changeset
|
1311 <listitem><para> |
| 403 | 1312 <emphasis>Re-start TF</emphasis>: |
| 841 | 1313 In order to create the initial savefiles with default settings, |
| 1314 you need to (re-)start TF, so that the save-state system is enabled. | |
| 401 | 1315 </para></listitem> |
| 1316 <listitem><para> | |
| 403 | 1317 <emphasis>Change settings</emphasis>: |
| 401 | 1318 Change GgrTF settings (listed via /opts etc.) to accommodate |
| 1319 your desires. | |
| 1320 </para></listitem> | |
| 1321 <listitem><para> | |
| 403 | 1322 <emphasis>Save initial settings</emphasis>: |
| 401 | 1323 Issue "/gsave" to get settings saved. |
| 1324 </para></listitem> | |
| 1325 <listitem><para> | |
| 403 | 1326 <emphasis>Optionally edit pre-init settings</emphasis>: |
| 401 | 1327 Certain settings are saved into the pre-init savefile (actual |
| 1328 filename is dependant on what you set "set_saveprefix" to). | |
| 1329 GgrTF does not offer any special interface to change these settings, | |
| 1330 you have to edit this file by hand, if you wish to change the defaults. | |
| 1331 </para></listitem> | |
| 403 | 1332 </orderedlist> |
| 401 | 1333 |
| 393 | 1334 </section> |
| 1335 | |
| 1336 <section><title>How to make state-saving automatic</title> | |
| 1337 <para> | |
| 1338 In previous example, I only described how settings get restored | |
| 1339 (as TF loads and initializes GgrTF), but how to get settings | |
| 1340 saved automatically too? | |
| 1341 </para> | |
| 1342 | |
| 1343 <para> | |
| 1344 The answer lies in &tfurl;'s event hooks. It is possible to | |
| 1345 define a hook, which is executed when TF disconnects from a world. | |
| 1346 By setting this hook to perform "/gsave", we can automatize the | |
| 1347 process of saving settings. Add following line to your TF configuration: | |
| 1348 | |
|
954
7d4c1c2e981f
Instead of <screen> tag, use <userinput> where appropriate.
Matti Hamalainen <ccr@tnsp.org>
parents:
950
diff
changeset
|
1349 <userinput>/def -hDISCONNECT mydisconnect = /gsave</userinput> |
| 393 | 1350 |
| 1351 There is one gotcha: if you don't want to keep saving the statistical | |
| 1352 values, but only the settings, you may want to add a "/greset" in the soup: | |
| 1353 | |
|
954
7d4c1c2e981f
Instead of <screen> tag, use <userinput> where appropriate.
Matti Hamalainen <ccr@tnsp.org>
parents:
950
diff
changeset
|
1354 <userinput>/def -hDISCONNECT mydisconnect = /greset%;/gsave</userinput> |
| 393 | 1355 |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1356 </para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1357 |
| 390 | 1358 </section> |
| 1359 | |
| 1360 | |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1361 §macros_2; |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1362 <row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1363 <entry>/gsave</entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1364 <entry> |
|
972
ea85d502d46f
Misc. typo fixes and minor reorganization.
Matti Hamalainen <ccr@tnsp.org>
parents:
969
diff
changeset
|
1365 Save all GgrTF settings and certain other TF variables. |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1366 </entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1367 </row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1368 <row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1369 <entry>/gload</entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1370 <entry> |
|
1065
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
1371 Load GgrTF settings. Only post-init settings get loaded by this command, |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
1372 to get pre-init settings in effect, you will have to restart TF. |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1373 </entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1374 </row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1375 <row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1376 <entry>/greset</entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1377 <entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1378 Reset all skill/spell counters and statistics. Notice that issuing |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1379 this command also requires executing of "/gsave" if you want to save |
| 393 | 1380 the zeroed statistics, otherwise the currently saved statistics will be |
|
972
ea85d502d46f
Misc. typo fixes and minor reorganization.
Matti Hamalainen <ccr@tnsp.org>
parents:
969
diff
changeset
|
1381 restored on next /gload. |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1382 </entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1383 </row> |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1384 §macros_end; |
| 276 | 1385 |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1386 </section> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1387 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1388 <!-- ================================================ --> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1389 |
| 387 | 1390 <section id="usage-general-binds"><title>Command bindings</title> |
| 1391 <para> | |
| 1392 GgrTF's core provides few macros for defining "bindings", which | |
| 1393 are a way to create commands that look like normal MUD commands | |
| 1394 but are actually intercepted by &tfurl; and executed appropriately. | |
| 1395 These bindings can be used to easily define shorthands for casting | |
| 1396 spells, using skills, executing macros, etc. GgrTF bindings offer | |
| 1397 an easy way to define skill/spell commands with automatic party | |
|
994
c40eabb80393
Add few lines of explanation about bindings.
Matti Hamalainen <ccr@tnsp.org>
parents:
988
diff
changeset
|
1398 reporting (or without it). <emphasis>Simply put, bindings are |
|
c40eabb80393
Add few lines of explanation about bindings.
Matti Hamalainen <ccr@tnsp.org>
parents:
988
diff
changeset
|
1399 similar to BatMUD "command" aliases, but client-side and with |
|
c40eabb80393
Add few lines of explanation about bindings.
Matti Hamalainen <ccr@tnsp.org>
parents:
988
diff
changeset
|
1400 extra abilities (but also with some limitations.)</emphasis> |
| 387 | 1401 </para> |
| 1402 | |
| 1403 <para> | |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1404 In GgrTF, there are <emphasis>optional pre-defined bindings</emphasis>, |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1405 which can be enabled at your consideration. These pre-defined bindings |
|
806
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1406 are defined in the relevant modules, and can be enabled at load-time |
|
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1407 with a setting ("opt_bindings"). See below section <link |
| 807 | 1408 linkend="usage-general-binds-setup">for enabling bindings</link>. |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1409 </para> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1410 |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1411 <para> |
|
994
c40eabb80393
Add few lines of explanation about bindings.
Matti Hamalainen <ccr@tnsp.org>
parents:
988
diff
changeset
|
1412 Now, you might be asking why would anyone need bindings? |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1413 Indeed, you can already use BatMUD's command aliases for such things, but |
| 387 | 1414 the number of command aliases in BatMUD is limited and if you run out of |
|
584
4cbf7693af1e
Document <> and - in prot reporting.
Matti Hamalainen <ccr@tnsp.org>
parents:
583
diff
changeset
|
1415 space, you have to remove some less used ones. Sometimes you have to |
|
4cbf7693af1e
Document <> and - in prot reporting.
Matti Hamalainen <ccr@tnsp.org>
parents:
583
diff
changeset
|
1416 redefine lots just because you are reincarnating... and you can not execute |
| 387 | 1417 macros with command aliases. |
| 1418 </para> | |
| 1419 | |
| 1420 <para> | |
| 1421 There are many benefits to using bindings, but they do have some | |
|
584
4cbf7693af1e
Document <> and - in prot reporting.
Matti Hamalainen <ccr@tnsp.org>
parents:
583
diff
changeset
|
1422 drawbacks: |
| 387 | 1423 </para> |
| 1424 | |
| 1425 <itemizedlist> | |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1426 <listitem> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1427 <para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1428 <emphasis>Limitations of TF's parsing</emphasis>: |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1429 Because of the nature how bindings are defined and parsed, |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1430 you can only use one binded command per line. |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1431 For example, let's assume "aoa" is binding to cast Armour of Aether |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1432 and "clair" is a binding to use clairvoyance. Thus, someone |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1433 might want to command: |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1434 |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1435 <userinput>aoa ggr%;clair</userinput> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1436 |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1437 Unfortunately, this does not work as might be expected. Because TF does |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1438 not evaluate binding as an expression, the "ggr%;clair"-part |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1439 is used as a literal argument to "aoa" binding. In effect the |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1440 command would try to cast Armour of Aether at player "ggr%;clair". |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1441 </para> |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1442 </listitem> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1443 |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1444 <listitem> |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1445 <para> |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1446 <emphasis>BatMUD commands and GgrTF bindings cannot be mixed</emphasis>: |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1447 Because the bindings are actually intercepted by TF before the line gets |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1448 passed to BatMUD's parser, you can't combine multiple bindings or BatMUD |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1449 commands on the line. For example, assuming "aoa" is again a binding |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1450 and "hop" is an emote: |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1451 |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1452 <userinput>hop jeskko;aoa ggr</userinput> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1453 |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1454 One might easily assume, that the result would be to first hop |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1455 around player or thing named Jeskko, and then cast Armour of Aether |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1456 at Ggr. Unfortunately the latter would just produce an error, as |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1457 it would be instead passed to BatMUD's interpreter and not handled |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1458 as a binding by TF! |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1459 </para> |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1460 </listitem> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1461 |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1462 <listitem> |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1463 <para> |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1464 <emphasis>Limitations of GgrTF's binding system</emphasis>: |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1465 There are certain limitations what kind of bindings you can define |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1466 with the current functionality provided by GgrTF. Bindings that |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1467 require complex parameters (more than one optional argument), |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1468 are not possible - you are better off using BatMUD's command |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1469 aliases for those. |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1470 </para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1471 </listitem> |
| 387 | 1472 </itemizedlist> |
| 1473 | |
| 393 | 1474 |
| 1475 <section><title>Defining bindings</title> | |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1476 <para> |
| 393 | 1477 Now we know the limitations of this system - let's see how to define some basic |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1478 command bindings! |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1479 </para> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1480 |
| 950 | 1481 <screen>/prdefgbind -s"cere" -c"/ceremony" -n |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1482 /prdefcbind -s"nf" -c"Neutralize Field" -n |
| 950 | 1483 /prdefsbind -s"fire" -c"Fire Building" -n</screen> |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1484 |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1485 <para> |
| 393 | 1486 Above we have have listed all three (3) classes of binding defination |
| 390 | 1487 macros supported by GgrTF. First defines a generic command binding |
| 1488 to execute "/ceremony" macro when user commands "cere". | |
| 1489 Second binding defines a spell casting command to cast "Neutralize Field" | |
| 1490 when user commands "nf". And the third binding defines a skill | |
| 1491 usage command to use "Fire Building". So basically we have | |
| 1492 three types of bindings: | |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1493 </para> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1494 |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1495 <itemizedlist> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1496 <listitem><para> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1497 <emphasis>/prdefgbind</emphasis>: |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1498 Defines a generic binding, in which the action ("-c" parameter) |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1499 can be almost anything, like a TF macro, or BatMUD command. |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1500 </para></listitem> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1501 |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1502 <listitem><para> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1503 <emphasis>/prdefcbind</emphasis>: |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1504 Defines a casting binding, the action is the name of the spell |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1505 to be casted. |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1506 </para></listitem> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1507 |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1508 <listitem><para> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1509 <emphasis>/prdefsbind</emphasis>: |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1510 Defines a skill usage binding, action argument being name of the |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1511 skill to be executed. |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1512 </para></listitem> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1513 </itemizedlist> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1514 |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1515 <para> |
| 390 | 1516 Each of these defination macros require at least two arguments: |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1517 the name for the binding command ("-s" option) and the action ("-c" option). |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1518 There are other optional arguments, which affect aspects of the |
| 390 | 1519 command binding to be defined. The argument options and their |
| 1520 meanings are listed below: | |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1521 </para> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1522 |
| 390 | 1523 <table><title>Arguments common to all binding defination macros</title> |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1524 <tgroup cols="2" align="left"> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1525 <thead> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1526 <row> |
| 390 | 1527 <entry>Option</entry> |
| 1528 <entry>Description</entry> | |
| 1529 </row> | |
| 1530 </thead> | |
| 1531 <tbody> | |
| 1532 <row> | |
| 1533 <entry>-s"name"</entry> | |
| 1534 <entry>Specifies the name of the command binding. | |
| 1535 This is basically the string you type to use the command, | |
| 1536 after which come the optional arguments. | |
| 1537 </entry> | |
| 1538 </row> | |
| 1539 <row> | |
| 1540 <entry>-n</entry> | |
| 1541 <entry> | |
| 1542 Tells GgrTF that the binding does NOT accept arguments. | |
| 1543 Anything following the command binding invocation is ignored. | |
| 1544 This also affects the possible reporting output of the binding. | |
| 1545 </entry> | |
| 1546 </row> | |
| 1547 </tbody> | |
| 1548 </tgroup> | |
| 1549 </table> | |
| 1550 | |
| 1551 <table><title>Arguments specific to generic bindings (/prdefgbind)</title> | |
| 1552 <tgroup cols="2" align="left"> | |
| 1553 <thead> | |
| 1554 <row> | |
| 1555 <entry>Option</entry> | |
| 1556 <entry>Description</entry> | |
| 1557 </row> | |
| 1558 </thead> | |
| 1559 <tbody> | |
| 1560 <row> | |
| 1561 <entry>-c"action"</entry> | |
| 1562 <entry> | |
| 1563 Specifies the action, aka what the binding <emphasis>does</emphasis>. | |
| 1564 For generic bindings, the action is a literal, so it can be a | |
| 1565 TF macro or BatMUD command. | |
| 1566 </entry> | |
| 1567 </row> | |
| 1568 </tbody> | |
| 1569 </tgroup> | |
| 1570 </table> | |
| 1571 | |
| 1572 <table><title>Arguments specific to spell casting and skill usage bindings (/prdefcbind and /prdefsbind)</title> | |
| 1573 <tgroup cols="2" align="left"> | |
| 1574 <thead> | |
| 1575 <row> | |
| 1576 <entry>Option</entry> | |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1577 <entry>Description</entry> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1578 </row> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1579 </thead> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1580 <tbody> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1581 <row> |
| 390 | 1582 <entry>-c"action"</entry> |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1583 <entry> |
| 390 | 1584 Specifies name of the spell to be cast or skill to be used. |
| 1585 </entry> | |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1586 </row> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1587 <row> |
| 390 | 1588 <entry>-d"message"</entry> |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1589 <entry> |
| 390 | 1590 This option overrides the default message string used for reporting |
| 1591 (see also option "-q" below). | |
| 1592 </entry> | |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1593 </row> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1594 <row> |
| 390 | 1595 <entry>-q</entry> |
| 1596 <entry> | |
| 1597 Makes the binding "quiet", suppresses any reporting. By default, | |
| 1598 spell casting binding reports the action on party report-channel, | |
| 1599 but specifying this option disables it. | |
| 1600 </entry> | |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1601 </row> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1602 </tbody> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1603 </tgroup> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1604 </table> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1605 |
| 390 | 1606 <para> |
| 1607 More examples, now with short explanations: | |
| 1608 </para> | |
| 1609 | |
| 1610 <table><title>Binding defination examples</title> | |
| 1611 <tgroup cols="2" align="left"> | |
| 1612 <thead> | |
| 1613 <row> | |
| 1614 <entry>Definition</entry> | |
| 1615 <entry>Description</entry> | |
| 1616 </row> | |
| 1617 </thead> | |
| 1618 <tbody> | |
| 1619 <row> | |
| 1620 <entry>/prdefgbind -s"repu" -c"/showrep" -n</entry> | |
| 1621 <entry> | |
| 1622 Generic binding, which executes /showrep macro and takes no arguments. | |
| 1623 </entry> | |
| 1624 </row> | |
| 1625 <row> | |
| 1626 <entry>/prdefsbind -s"er" -c"Enrage" -n</entry> | |
| 1627 <entry> | |
| 1628 Skill binding for barbarian "Enrage" skill. Also takes no | |
| 1629 arguments. | |
| 1630 </entry> | |
| 1631 </row> | |
| 1632 <row> | |
| 1633 <entry>/prdefcbind -s"shelter" -c"Shelter" -n -d"Sheltering ..."</entry> | |
| 1634 <entry> | |
| 1635 Spell casting binding, for casting conjurer spell "Shelter". | |
| 1636 Takes no arguments and uses specific reporting string (default | |
| 1637 would be "Shelter ...", but since it sounds bit stupid we want to | |
| 1638 use "Sheltering ..." instead.) | |
| 1639 </entry> | |
| 1640 </row> | |
| 1641 <row> | |
| 1642 <entry>/prdefcbind -s"dmp" -c"Dispel Magical Protection"</entry> | |
| 1643 <entry> | |
| 1644 Another spell casting binding for a conjurer spell, which takes | |
| 1645 (and requires) a player's name as argument. | |
| 1646 </entry> | |
| 1647 </row> | |
| 1648 <row> | |
| 1649 <entry>/prdefcbind -s"sl" -c"Star Light" -q</entry> | |
| 1650 <entry> | |
| 1651 Yet another spell casting bind, this time for druid spell "Star Light". | |
| 1652 Since this is a blasting spell, it is not really useful to report | |
| 1653 that we are casting it, so we suppress any reporting. Argument is | |
| 1654 accepted. | |
| 1655 </entry> | |
| 1656 </row> | |
| 1657 </tbody> | |
| 1658 </tgroup> | |
| 1659 </table> | |
| 1660 | |
| 1661 <para> | |
| 1662 As of now, you should be able to define bindings of your own. You can define | |
|
806
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1663 them in your .tfrc or make another file for them. |
|
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1664 </para> |
|
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1665 |
|
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1666 </section> |
|
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1667 |
|
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1668 |
| 807 | 1669 <section id="usage-general-binds-setup"><title>Enabling bindings</title> |
|
806
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1670 <para> |
|
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1671 A special variable called "opt_bindings" controls whether the various |
|
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1672 /prdef*bind macros will actually define any binding at all. If this |
|
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1673 variable is set to value "on", bindings will be defined, otherwise not. |
| 390 | 1674 </para> |
|
806
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1675 <para> |
|
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1676 This is also the way how pre-defined GgrTF bindings are made optional. |
|
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1677 By defining "opt_bindings" before loading GgrTF modules, user |
|
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1678 can choose to enable or disable the default bindings, even "per-module" |
|
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1679 by changing the value of opt_bindings before each module loading in |
|
1230
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
1680 .tfrc. |
|
806
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1681 </para> |
|
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1682 <para> |
|
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1683 It should be noted, that "opt_bindings" is a saveable setting, that gets |
|
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1684 stored by /gsave and restored by ggrtf-pre.tf Please refer to |
|
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1685 <link linkend="inst-config">setup</link>- and <link |
|
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1686 linkend="usage-general-saves">state saving</link>- sections |
|
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1687 for more information. |
|
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1688 </para> |
| 387 | 1689 </section> |
| 1690 | |
|
995
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1691 <section id="usage-general-binds-list"><title>Bindings listing</title> |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1692 <para> |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1693 All defined GgrTF bindings can be listed via the <emphasis>/binds</emphasis> |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1694 command. Below is represented an commented example of such output. |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1695 </para> |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1696 <screen> |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1697 ,----------------. |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1698 | GgrTF Bindings | |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1699 +----------------+----------------------------------------------------. |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1700 | pprots | G | /pprots | ? | |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1701 | rpouch | G | /rpouch | ? | |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1702 | ad | C | Aura Detection | Yes | |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1703 | invis | C | Invisibility | Yes | |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1704 | float | C | Floating | Yes | |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1705 | ww | C | Water Walking | Yes | |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1706 | seeinvis | C | See Invisible | Yes | |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1707 | seemagic | C | See Magic | Yes | |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1708 | cere | G | /ceremony | ? | |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1709 | curses | G | /curses | ? | |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1710 | prots | G | /prots | ? | |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1711 `---------------------------------------------------------------------' |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1712 </screen> |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1713 <itemizedlist> |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1714 <listitem><para>1st column lists the binded command name</para></listitem> |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1715 <listitem><para>2nd column shows the type of the binding: "G" = |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1716 general (for example a macro invocation); "C" = cast/spell; "K" = skill.</para></listitem> |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1717 <listitem><para>3rd column is the performed action, which has varying |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1718 meaning depending on the binding type. For skill and spell bindings, |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1719 corresponding skill/spell name is shown. Generic bindings show the actual |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1720 command executed.</para></listitem> |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1721 <listitem><para>4th and last column shows whether the binding produces |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1722 any report output; for generic bindings this is not applicable and shows |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1723 question mark ("?") instead.</para></listitem> |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1724 </itemizedlist> |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1725 |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1726 </section> |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1727 |
| 393 | 1728 </section> |
| 1729 | |
| 387 | 1730 <!-- ================================================ --> |
| 1731 | |
|
889
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
1732 <section id="usage-general-prmove"><title>Keyboard numpad hooks</title> |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1733 <para> |
| 392 | 1734 GgrTF provides a mechanism for routing keyboard numpad bindings so that |
| 393 | 1735 different functionality can be swapped in as needed. Core module offers |
| 1736 three modes: walk (normal walking around); peer (walking around with | |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1737 automatic peering to adjacent directions, useful for <link |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1738 linkend="usage-merchant">merchants</link>; ship (control ship movement). |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1739 |
| 393 | 1740 Certain other modules provide additional modes (see <link |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1741 linkend="usage-tgtcast">targetted cast module</link>, utilized by |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1742 <link linkend="usage-tarma">tarmalen</link> and <link linkend="usage-mage">mage</link> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1743 modules, for example.) |
| 392 | 1744 </para> |
| 1745 | |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1746 <note> |
|
1065
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
1747 <para>Keyboard hooks require working numpad, etc. key bindings. Modules |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
1748 are provided for two most common cases in <emphasis>kbd-*.tf</emphasis> |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
1749 files. Some terminals may require several kbd-* modules to be loaded, |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
1750 you may have to experiment. It is also possible that your terminal |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
1751 is not supported by those modules and you have to write your own, |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
1752 in such case you may try contacting &ggr; for assistance. However, |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
1753 it is also entirely possible that your terminal does not provide |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
1754 the required 'application mode' at all, which will make things difficult. |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1755 </para> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1756 </note> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1757 |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1758 §macros_2; |
| 392 | 1759 <row> |
| 1760 <entry>/move [setting]</entry> | |
| 393 | 1761 <entry>Set the mode used for numpad bindings. Valid values are |
| 1762 shown if command is given without arguments. Core GgrTF module | |
| 1763 provides following three modes: <emphasis>move</emphasis>, | |
| 1764 <emphasis>peer</emphasis> and <emphasis>ship</emphasis> | |
| 1765 </entry> | |
| 392 | 1766 </row> |
| 1767 | |
| 1768 <row> | |
| 1769 <entry>/peer [regexp]</entry> | |
| 393 | 1770 <entry> |
| 1771 Set the regular expression used for grepping the output of 'peer' | |
| 1772 command used in "/move peer" mode. | |
| 1773 </entry> | |
| 1774 </row> | |
| 1775 | |
| 1776 <row> | |
| 1777 <entry>/cruise</entry> | |
| 1778 <entry>Toggle ship cruising speed on/off (off = sail)</entry> | |
| 392 | 1779 </row> |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1780 §macros_end; |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1781 |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1782 </section> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1783 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1784 <!-- ================================================ --> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1785 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1786 <section id="usage-general-prots"><title>Prot management</title> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1787 <para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1788 One very important aspect of any script is the prot management. |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1789 GgrTF contains a flexible and easy to extend prot management system, |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1790 which supports basic, stacking and renewable prots. Special cases |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1791 are also supported, like unstun and conjurer typeprots. |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1792 </para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1793 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1794 <para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1795 For actually displaying the active prots information, GgrTF offers |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1796 various methods. The <link linkend="usage-general-statusline"> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1797 statusline</link> shows the currently active prots in short form |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1798 (without duration times). Macro command "/prots" can be invoked to |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1799 locally echo the active prots in long form. |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1800 Finally, a special BatMUD emote, 'tweak', can be used to trigger |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1801 reporting of active prots to party report-channel (the 'tweak' emote |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1802 was chosen for this purpose due to it being the de-facto standard |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1803 for prot reporting triggers.) |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1804 </para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1805 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1806 <para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1807 Classes of prots supported by GgrTF are roughly the following: |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1808 </para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1809 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1810 <itemizedlist> |
|
584
4cbf7693af1e
Document <> and - in prot reporting.
Matti Hamalainen <ccr@tnsp.org>
parents:
583
diff
changeset
|
1811 <listitem><para>Harmful effects/curses/handicaps</para></listitem> |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1812 <listitem><para>Basic utility prots (infravision, water walking, floating, invisibility, etc.)</para></listitem> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1813 <listitem><para>Conjurer prots (minor- and major typeprots, stickyness)</para></listitem> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1814 <listitem><para>Evil priest (protection from good, paranoia)</para></listitem> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1815 <listitem><para>Tarmalen (unpain, blessing of tarmalen, lifelink, enhanced vitality)</para></listitem> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1816 <listitem><para>Nun (protection from evil, soul shield, heavenly protection, mana shield)</para></listitem> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1817 <listitem><para>Templar (shield of faith, blessing of faerwon)</para></listitem> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1818 <listitem><para>Psionicist (levitation, force shield)</para></listitem> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1819 <listitem><para>Druid (flex shield, earth power, earth skin, earth blood, vine mantle, regeneration)</para></listitem> |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1820 <listitem><para>etc...</para></listitem> |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1821 </itemizedlist> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1822 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1823 <para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1824 The string describing active prots consists of entries with |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1825 abbreviated name of the prot, current duration (from casting), |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1826 possible number of stackings and optional stickiness-indicator |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1827 for sticky conjuprots. The entries are separated with vertical |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1828 line character (sometimes called the pipe). |
| 787 | 1829 Some examples of prot entries with explanations are shown in table below. |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1830 </para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1831 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1832 <table><title>Prot entries</title> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1833 <tgroup cols="2" align="left"> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1834 <thead> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1835 <row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1836 <entry>Entry</entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1837 <entry>Description</entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1838 </row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1839 </thead> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1840 <tbody> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1841 <row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1842 <entry>Unst[1m9s]</entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1843 <entry>Unstun with duration of 1 minutes, 9 seconds.</entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1844 </row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1845 <row> |
| 787 | 1846 <entry>+AoA[7m19s]</entry> |
| 1847 <entry>Sticky Armour of Aether.</entry> | |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1848 </row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1849 <row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1850 <entry>Infra(2)[0m2s]</entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1851 <entry>Infravision stacked at 2 levels.</entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1852 </row> |
|
584
4cbf7693af1e
Document <> and - in prot reporting.
Matti Hamalainen <ccr@tnsp.org>
parents:
583
diff
changeset
|
1853 <row> |
|
4cbf7693af1e
Document <> and - in prot reporting.
Matti Hamalainen <ccr@tnsp.org>
parents:
583
diff
changeset
|
1854 <entry>Unst<2>[7m19s]</entry> |
|
4cbf7693af1e
Document <> and - in prot reporting.
Matti Hamalainen <ccr@tnsp.org>
parents:
583
diff
changeset
|
1855 <entry>Unstun that has been weakened 2 times.</entry> |
|
4cbf7693af1e
Document <> and - in prot reporting.
Matti Hamalainen <ccr@tnsp.org>
parents:
583
diff
changeset
|
1856 </row> |
|
4cbf7693af1e
Document <> and - in prot reporting.
Matti Hamalainen <ccr@tnsp.org>
parents:
583
diff
changeset
|
1857 <row> |
|
4cbf7693af1e
Document <> and - in prot reporting.
Matti Hamalainen <ccr@tnsp.org>
parents:
583
diff
changeset
|
1858 <entry>-Forget[3m5s]</entry> |
|
4cbf7693af1e
Document <> and - in prot reporting.
Matti Hamalainen <ccr@tnsp.org>
parents:
583
diff
changeset
|
1859 <entry>'Forget' curse that has been active for 3 minutes and 5 seconds.</entry> |
|
4cbf7693af1e
Document <> and - in prot reporting.
Matti Hamalainen <ccr@tnsp.org>
parents:
583
diff
changeset
|
1860 </row> |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1861 </tbody> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1862 </tgroup> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1863 </table> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1864 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1865 <para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1866 Simple example session featuring some protting action in GgrTF: |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1867 </para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1868 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1869 <screen> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1870 <userinput>tweak jeskko</userinput> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1871 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1872 You tweak Jeskko's nose mischievously. |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1873 Jeskko [report]: Unst[1h1m13s] |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1874 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1875 <userinput>unp jeskko</userinput> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1876 |
|
1065
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
1877 Ggr [report]: Unpain -> jeskko |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1878 GgrTF: ---- SPELL START ---- (393) |
|
1065
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
1879 GgrTF: 'unpain' -> jeskko |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1880 Unpain: ##### [5] |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1881 You skillfully cast the spell with greater haste. |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1882 Unpain: ## [2] |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1883 Unpain: # [1] |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1884 GgrTF: ---- SPELL DONE ---- in [3] rounds! [0m9s] |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1885 You utter the magic words (unpain) |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1886 You cast the spell successfully. |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1887 H:506/506 [] S:805/941 [-136] E:246/246 [] $:6499 [] exp:68202 [] |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1888 Jeskko [report]: Unpain ON! |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1889 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1890 <userinput>tweak jeskko</userinput> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1891 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1892 You tweak Jeskko's nose mischievously. |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1893 Jeskko [report]: Unst[1h4m25s] | Unp[2m35s] |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1894 </screen> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1895 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1896 |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1897 §macros_2; |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1898 <row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1899 <entry>/prots</entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1900 <entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1901 Show any currently active prots on you. The output is only echoed |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1902 locally, use BatMUD 'tweak me' emote to list prots to party |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1903 report-channel. |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1904 </entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1905 </row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1906 <row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1907 <entry>/cprots</entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1908 <entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1909 This command clears all prots on you. It is meant for those cases |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1910 where GgrTF is either bugging and does not notice a prot dropping, |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1911 or any other reason when you need to remove all prots at your |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1912 discretion. |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1913 </entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1914 </row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1915 <row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1916 <entry>tweak <target></entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1917 <entry> |
|
943
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1918 BatMUD's 'tweak' emote is used to report prots to party |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1919 report-channel. |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1920 </entry> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1921 </row> |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1922 §macros_end; |
|
943
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1923 |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1924 </section> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1925 |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1926 <!-- ================================================ --> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1927 |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1928 <section id="usage-general-curses"><title>Curse management</title> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1929 <para> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1930 Often an important aspect while bashing those nasty eq-monsters dead, |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1931 is to keep track of any handicapping spells or skills cast against the |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1932 said monster. GgrTF's curse handling is made just for that, it |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1933 tracks most common handicaps cast at non-partymembers. |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1934 </para> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1935 <para> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1936 <emphasis>Notice! To work fully, this feature requires <link |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1937 linkend="usage-pssmangle">PSS-mangler</link> module to be loaded |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1938 and in use. |
|
943
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1939 </emphasis> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1940 While curse tracking does work without it, curses cast by other |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1941 entities than party members will be counted also, which can be |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1942 counterproductive. |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1943 </para> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1944 |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1945 §macros_2; |
|
943
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1946 <row> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1947 <entry>/curses</entry> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1948 <entry> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1949 Echo status of tracked curses to yourself (e.g. not shown to others.) |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1950 </entry> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1951 </row> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1952 <row> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1953 <entry>twirl <target></entry> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1954 <entry> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
1955 BatMUD's 'twirl' emote is used to report curses to party report-channel. |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1956 </entry> |
|
1203
796e24a218a4
Oops, a </row> tag was missing.
Matti Hamalainen <ccr@tnsp.org>
parents:
1202
diff
changeset
|
1957 </row> |
|
1157
25cee31780bc
Add note about /cursewarn setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
1156
diff
changeset
|
1958 <row> |
|
25cee31780bc
Add note about /cursewarn setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
1156
diff
changeset
|
1959 <entry>/cursewarn</entry> |
|
25cee31780bc
Add note about /cursewarn setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
1156
diff
changeset
|
1960 <entry> |
|
25cee31780bc
Add note about /cursewarn setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
1156
diff
changeset
|
1961 Toggles informing about curses that are soon about to expire. The |
|
25cee31780bc
Add note about /cursewarn setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
1156
diff
changeset
|
1962 warning occurse when 20% of the "maximum" curse duration is left. |
|
25cee31780bc
Add note about /cursewarn setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
1156
diff
changeset
|
1963 (These maximum durations are set in GgrTF's main module.) |
|
25cee31780bc
Add note about /cursewarn setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
1156
diff
changeset
|
1964 </entry> |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1965 </row> |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1966 §macros_end; |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1967 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1968 </section> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1969 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1970 <!-- ================================================ --> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1971 |
|
1220
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1972 <section id="usage-general-hbtick"><title>Heartbeat and tick prediction</title> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1973 |
| 1222 | 1974 <!-- |
|
1220
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1975 <note> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1976 <para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1977 <emphasis>WARNING! There is a high likelihood, that this code may |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1978 not work correctly in all situations.</emphasis> And if it doesn't, |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1979 you can send complaints to nearest trashbin. |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1980 </para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1981 </note> |
| 1222 | 1982 --> |
|
1220
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1983 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1984 <para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1985 Since version 0.6.14, GgrTF provides an <emphasis>experimental</emphasis> feature for |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1986 predicting heartbeat duration and ticks. This can be useful if you |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1987 wish to time your regen breaks nicely, or when to enter combat again |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1988 (heartbeat factors in with the so-called initial battle round, or |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1989 so called "zero round"). |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1990 </para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1991 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1992 <para> |
|
1443
dc60423b8d4b
Change documentation to match the removal of average heartbeat duration field from statusline.
Matti Hamalainen <ccr@tnsp.org>
parents:
1426
diff
changeset
|
1993 The usage of this feature is simple: There is one new field displayed |
|
1220
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1994 on the <link linkend="usage-general-statusline">statusline</link>, the |
|
1443
dc60423b8d4b
Change documentation to match the removal of average heartbeat duration field from statusline.
Matti Hamalainen <ccr@tnsp.org>
parents:
1426
diff
changeset
|
1995 value labeled as "T" shows number of heartbeats from last tick, next tick |
|
1220
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1996 usually occurs at 9 or 10. It should always be 10, but due to how we |
|
1443
dc60423b8d4b
Change documentation to match the removal of average heartbeat duration field from statusline.
Matti Hamalainen <ccr@tnsp.org>
parents:
1426
diff
changeset
|
1997 "force" simulated HBs and interaction with fast metabolism, they will |
|
dc60423b8d4b
Change documentation to match the removal of average heartbeat duration field from statusline.
Matti Hamalainen <ccr@tnsp.org>
parents:
1426
diff
changeset
|
1998 not always match the real ones. |
|
1220
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1999 <emphasis>First tick after leaving battle will not usually be predicted |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2000 correctly, but the situation should normalize after it.</emphasis> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2001 </para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2002 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2003 <note> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2004 <para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2005 You can also utilize a stethoscope, and it should, at least theoretically |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2006 make the HB and tick prediction accurate, but who knows... fastmeta is a bitch. |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2007 </para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2008 <para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2009 <emphasis>Stethoscope is an item, available from Arelium's tinkerer's toolshop.</emphasis> |
|
1443
dc60423b8d4b
Change documentation to match the removal of average heartbeat duration field from statusline.
Matti Hamalainen <ccr@tnsp.org>
parents:
1426
diff
changeset
|
2010 You can use it by applying, 'apply stethoscope to ggr'. Easiest way is to |
|
dc60423b8d4b
Change documentation to match the removal of average heartbeat duration field from statusline.
Matti Hamalainen <ccr@tnsp.org>
parents:
1426
diff
changeset
|
2011 add that to your eqset swapping commands. |
|
1220
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2012 </para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2013 </note> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2014 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2015 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2016 <section id="usage-general-hbtick-details"><title>Technical details</title> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2017 <para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2018 One might ask, how does this all work? This is where it gets |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2019 a little bit murky, because we are largely working on assumptions |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2020 on how things like heartbeat work in BatMUD. So it might not be |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2021 correct, there may be things that have been overlooked, etc. |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2022 </para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2023 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2024 <para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2025 First of all, here are some things that the predictor code assumes: |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2026 </para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2027 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2028 <itemizedlist> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2029 <listitem><para>Heartbeat duration (delta) is 3.0 seconds to start |
|
1443
dc60423b8d4b
Change documentation to match the removal of average heartbeat duration field from statusline.
Matti Hamalainen <ccr@tnsp.org>
parents:
1426
diff
changeset
|
2030 with, we adjust slowly towards the player's "real" average heartbeat |
|
1220
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2031 frequency. |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2032 </para></listitem> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2033 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2034 <listitem><para>One tick is always 10 heartbeats. |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2035 </para></listitem> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2036 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2037 <listitem><para>Battle rounds are always around ~3s, |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2038 not withstanding +/- lag and slight variation due to driver issues. |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2039 </para></listitem> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2040 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2041 <listitem><para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2042 Spell rounds, cast and skill finishes occur on heartbeat. |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2043 Thus we can use these to time heartbeats, when filtering out fastmeta. |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2044 </para></listitem> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2045 </itemizedlist> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2046 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2047 <para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2048 Basically what we do in the code is as follows: |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2049 </para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2050 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2051 <orderedlist> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2052 <listitem><para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2053 Start a TF timer that runs gheartbeat_timer() at ~20Hz. |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2054 </para></listitem> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2055 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2056 <listitem><para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2057 In gheartbeat_sc (ran on each 'sc') we check if we seem to have |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2058 ticked by checking sp/ep deltas against threshold values. |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2059 We also try to discard 'sc' events caused by things that |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2060 may not be heartbeats (fires, crystals, heal alls, etc.) |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2061 </para></listitem> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2062 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2063 <listitem> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2064 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2065 <para>In gheartbeat_timer() we check for:</para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2066 <itemizedlist> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2067 <listitem><para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2068 Ongoing battle, check when last round went off, disable battle |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2069 if it was "too long" ago. |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2070 </para></listitem> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2071 <listitem><para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2072 Check when last hb was, simulate / force a hb if it was too |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2073 long ago. |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2074 </para></listitem> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2075 <listitem><para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2076 Check if we need to "force" a tick, and do that. |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2077 </para></listitem> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2078 </itemizedlist> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2079 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2080 </listitem> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2081 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2082 </orderedlist> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2083 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2084 <para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2085 Based on these, we keep a running average of heartbeat duration |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2086 to predict incoming heartbeats and ticks. The average starts at 3s, |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2087 which is the basic BatMUD heartbeat without fast metabolism or such. |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2088 </para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2089 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2090 <note> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2091 <para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2092 If you are interested in some debug-spam produced by the predictor, |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2093 you can enable it via <emphasis>/set hb_debug=1</emphasis> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2094 </para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2095 </note> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2096 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2097 </section> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2098 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2099 </section> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2100 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2101 <!-- ================================================ --> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2102 |
|
889
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
2103 <section id="usage-general-skillspell"><title>Skill handling</title> |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
2104 <para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
2105 </para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
2106 </section> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
2107 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
2108 <!-- ================================================ --> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
2109 |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
2110 <section id="usage-magical"><title>Magical guilds support (gm-magical.tf)</title> |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2111 <para> |
| 275 | 2112 Base module for all things magical. This module is <emphasis>required</emphasis> |
| 2113 for supporting spells/casting. It is not necessary for being the receiving | |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2114 end of prots or such. Several modules are dependant on this module, most |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2115 importantly those guild-specific modules that use magic. |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2116 </para> |
| 275 | 2117 |
| 2118 <para> | |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2119 Even in the case your guild does not use magic spells (nomad guilds), having |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2120 this module loaded is not harmful, so you can keep it in your configuration |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2121 at all times. |
| 275 | 2122 </para> |
| 2123 | |
|
889
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
2124 <itemizedlist> |
|
890
a864a635d545
Add information about resist reporting, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
889
diff
changeset
|
2125 <listitem><para>Basic code for blast hit and resistance reporting |
|
a864a635d545
Add information about resist reporting, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
889
diff
changeset
|
2126 (some types, such as channeller guild blasts, are added by guild-specific modules). |
|
889
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
2127 </para></listitem> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
2128 <listitem><para>Spell round reporting. Enables you to optionally |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
2129 spam your fellow players with information how many rounds are left |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
2130 until your spell goes off. |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
2131 </para></listitem> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
2132 </itemizedlist> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
2133 |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2134 </section> |
|
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2135 |
| 248 | 2136 <!-- ================================================ --> |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2137 |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
2138 <section id="usage-pssmangle"><title>PSS-mangler (gm-pssmangle.tf)</title> |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2139 <para> |
|
414
b13a94bd4ee5
Added section skeleton for GgrTF::PartyPlacer
Matti Hamalainen <ccr@tnsp.org>
parents:
410
diff
changeset
|
2140 This module provides support for filtering the output of |
|
b13a94bd4ee5
Added section skeleton for GgrTF::PartyPlacer
Matti Hamalainen <ccr@tnsp.org>
parents:
410
diff
changeset
|
2141 <emphasis>pss</emphasis> (<emphasis>party status short</emphasis>) |
|
b13a94bd4ee5
Added section skeleton for GgrTF::PartyPlacer
Matti Hamalainen <ccr@tnsp.org>
parents:
410
diff
changeset
|
2142 -command. It captures the status and prettyprints it out as a |
|
b13a94bd4ee5
Added section skeleton for GgrTF::PartyPlacer
Matti Hamalainen <ccr@tnsp.org>
parents:
410
diff
changeset
|
2143 3x3 table (as 9-man party formation) with player names and their |
|
b13a94bd4ee5
Added section skeleton for GgrTF::PartyPlacer
Matti Hamalainen <ccr@tnsp.org>
parents:
410
diff
changeset
|
2144 status information in compact format. |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2145 </para> |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2146 |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2147 <para> |
|
314
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2148 The HP/SP/EP values are coloured in accordance to what percentage the |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2149 player currently has of his maximum. Additionally varying colouring of |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2150 player's name is used to indicate possible states of <emphasis>rest, |
|
1596
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2151 unconsciousness, stun, formation, etc.</emphasis>. |
|
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2152 </para> |
|
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2153 |
|
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2154 <para>There is also an number indicator for <emphasis>number of rescuers |
|
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2155 </emphasis> when in stunned or unconscious state, but this is normally |
|
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2156 hidden. It appears on the left side of player's name, when available. |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2157 </para> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2158 |
| 261 | 2159 <para> |
|
314
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2160 This module hooks to GgrTF's autopss-functionality (toggleable with |
|
449
725695d31f21
Updated /pstatus -> pss and /pss -> /autopss accordingly.
Matti Hamalainen <ccr@tnsp.org>
parents:
422
diff
changeset
|
2161 <link linkend="usage-general-commands">/autopss</link> option). A normally issued |
| 271 | 2162 'pss' command does not trigger the mangling functionality, but you can use |
|
449
725695d31f21
Updated /pstatus -> pss and /pss -> /autopss accordingly.
Matti Hamalainen <ccr@tnsp.org>
parents:
422
diff
changeset
|
2163 <emphasis>/pss</emphasis> macro or bind that to 'pss'. (See <link |
| 387 | 2164 linkend="usage-general-binds">Bindings</link>-section for more information.) |
| 261 | 2165 </para> |
| 2166 | |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2167 <screenshot> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2168 <mediaobject> |
|
624
cc40c7360880
The manual is now pseudo-XML conformant, you have to use normalizeml.pl to convert to syntactically correct XML.
Matti Hamalainen <ccr@tnsp.org>
parents:
622
diff
changeset
|
2169 <imageobject><imagedata fileref="pss_normal.gif" format="GIF" /></imageobject> |
|
cc40c7360880
The manual is now pseudo-XML conformant, you have to use normalizeml.pl to convert to syntactically correct XML.
Matti Hamalainen <ccr@tnsp.org>
parents:
622
diff
changeset
|
2170 <imageobject><imagedata fileref="pss_normal.eps" format="EPS" /></imageobject> |
|
314
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2171 <textobject> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2172 <phrase>Typical first row</phrase> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2173 </textobject> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2174 <caption> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2175 <para> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2176 Typical output of PSS-mangler in a party with first row filled. Toivo |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2177 and Jeskko are near their maximum hp/sp/ep, but Ggr has taken some |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2178 damage (yellow HP) and is almost out of endurance points (red EP). |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2179 </para> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2180 </caption> |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2181 </mediaobject> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2182 </screenshot> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2183 |
| 267 | 2184 <screenshot> |
| 2185 <mediaobject> | |
|
624
cc40c7360880
The manual is now pseudo-XML conformant, you have to use normalizeml.pl to convert to syntactically correct XML.
Matti Hamalainen <ccr@tnsp.org>
parents:
622
diff
changeset
|
2186 <imageobject><imagedata fileref="pss_stun.gif" format="GIF" /></imageobject> |
|
cc40c7360880
The manual is now pseudo-XML conformant, you have to use normalizeml.pl to convert to syntactically correct XML.
Matti Hamalainen <ccr@tnsp.org>
parents:
622
diff
changeset
|
2187 <imageobject><imagedata fileref="pss_stun.eps" format="EPS" /></imageobject> |
|
314
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2188 <textobject> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2189 <phrase>Stunned</phrase> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2190 </textobject> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2191 <caption> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2192 <para> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2193 In this screenshot example, Jeskko has become stunned (his name is |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2194 coloured in bright red). Also, Jeskko has lost some hitpoints |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2195 (dark green HP) and has only moderate amount of endurance left |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2196 (light yellow EP). <emphasis>(No Jeskkos were actually harmed |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2197 in producing this simulated situation.)</emphasis> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2198 </para> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2199 </caption> |
| 267 | 2200 </mediaobject> |
| 2201 </screenshot> | |
| 2202 | |
| 2203 <screenshot> | |
| 2204 <mediaobject> | |
|
624
cc40c7360880
The manual is now pseudo-XML conformant, you have to use normalizeml.pl to convert to syntactically correct XML.
Matti Hamalainen <ccr@tnsp.org>
parents:
622
diff
changeset
|
2205 <imageobject><imagedata fileref="pss_uncon.gif" format="GIF" /></imageobject> |
|
cc40c7360880
The manual is now pseudo-XML conformant, you have to use normalizeml.pl to convert to syntactically correct XML.
Matti Hamalainen <ccr@tnsp.org>
parents:
622
diff
changeset
|
2206 <imageobject><imagedata fileref="pss_uncon.eps" format="EPS" /></imageobject> |
|
314
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2207 <textobject> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2208 <phrase>Unconscious</phrase> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2209 </textobject> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2210 <caption> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2211 <para> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2212 This screenshot shows how Toivo has taken some serious damage from |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2213 a blast to the backrow, and has become unconscious. White on bright |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2214 red background is used to highlight a unconscious player's name, |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2215 hopefully catching your attention. |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2216 </para> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2217 </caption> |
| 267 | 2218 </mediaobject> |
| 2219 </screenshot> | |
| 2220 | |
| 2221 | |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2222 <section><title>HP/SP/EP colours</title> |
| 271 | 2223 <para> |
| 2224 List of possible indicator colours and their meanings. &colourexplanation; | |
| 2225 </para> | |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2226 |
| 271 | 2227 |
| 1060 | 2228 <table><title>List of HP/SP/EP indicator colours</title> |
|
1545
fe83084ff7e1
Fix some table column width.
Matti Hamalainen <ccr@tnsp.org>
parents:
1544
diff
changeset
|
2229 <tgroup cols="3" align="left"> |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2230 <thead> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2231 <row> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2232 <entry>Colour</entry> |
| 271 | 2233 <entry>Background</entry> |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2234 <entry>Explanation</entry> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2235 </row> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2236 </thead> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2237 <tbody> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2238 <row> |
| 271 | 2239 <entry>Bright White</entry> |
| 2240 <entry>Bright Red</entry> | |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2241 <entry>Negative value (x < 0)</entry> |
| 267 | 2242 </row> |
| 2243 <row> | |
| 271 | 2244 <entry>Bright Red</entry> |
| 2245 <entry>-</entry> | |
| 267 | 2246 <entry>Less than 16% of max</entry> |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2247 </row> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2248 <row> |
| 267 | 2249 <entry>Red (dark)</entry> |
| 271 | 2250 <entry>-</entry> |
| 267 | 2251 <entry>Less than 33% of max</entry> |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2252 </row> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2253 <row> |
| 267 | 2254 <entry>Yellow (dark)</entry> |
| 271 | 2255 <entry>-</entry> |
| 267 | 2256 <entry>Less than 49% of max</entry> |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2257 </row> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2258 <row> |
| 271 | 2259 <entry>Bright Yellow</entry> |
| 2260 <entry>-</entry> | |
| 267 | 2261 <entry>Less than 66% of max</entry> |
| 2262 </row> | |
| 2263 <row> | |
| 2264 <entry>Green (dark)</entry> | |
| 271 | 2265 <entry>-</entry> |
| 267 | 2266 <entry>Less than 85% of max</entry> |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2267 </row> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2268 <row> |
| 271 | 2269 <entry>Bright Green</entry> |
| 2270 <entry>-</entry> | |
| 267 | 2271 <entry>More than 85% of max</entry> |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2272 </row> |
| 267 | 2273 </tbody> |
| 2274 </tgroup> | |
| 2275 </table> | |
| 2276 </section> | |
| 2277 | |
| 2278 <section><title>Player name colours</title> | |
| 271 | 2279 <para> |
| 2280 List of possible name colours and their meanings. &colourexplanation; | |
| 2281 </para> | |
| 267 | 2282 |
| 1060 | 2283 <table><title>List of possible player name lite colours</title> |
|
1545
fe83084ff7e1
Fix some table column width.
Matti Hamalainen <ccr@tnsp.org>
parents:
1544
diff
changeset
|
2284 <tgroup cols="3" align="left"> |
| 267 | 2285 <thead> |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2286 <row> |
| 267 | 2287 <entry>Colour</entry> |
| 272 | 2288 <entry>Background</entry> |
| 267 | 2289 <entry>State description</entry> |
| 2290 </row> | |
| 2291 </thead> | |
| 2292 <tbody> | |
| 2293 <row> | |
| 271 | 2294 <entry>Bright White</entry> |
| 2295 <entry>-</entry> | |
| 267 | 2296 <entry>Normal</entry> |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2297 </row> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2298 <row> |
|
1596
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2299 <entry>Bright Black</entry> |
|
849
b9d2598660e0
Add idle status indication to pss-mangler.
Matti Hamalainen <ccr@tnsp.org>
parents:
847
diff
changeset
|
2300 <entry>-</entry> |
|
b9d2598660e0
Add idle status indication to pss-mangler.
Matti Hamalainen <ccr@tnsp.org>
parents:
847
diff
changeset
|
2301 <entry>Idle</entry> |
|
b9d2598660e0
Add idle status indication to pss-mangler.
Matti Hamalainen <ccr@tnsp.org>
parents:
847
diff
changeset
|
2302 </row> |
|
b9d2598660e0
Add idle status indication to pss-mangler.
Matti Hamalainen <ccr@tnsp.org>
parents:
847
diff
changeset
|
2303 <row> |
| 271 | 2304 <entry>Bright White</entry> |
| 2305 <entry>Bright Red</entry> | |
| 267 | 2306 <entry>Unconscious (unc)</entry> |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2307 </row> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2308 <row> |
| 271 | 2309 <entry>Bright Red</entry> |
| 2310 <entry>-</entry> | |
| 267 | 2311 <entry>Stunned (stun)</entry> |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2312 </row> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2313 <row> |
| 267 | 2314 <entry>Magenta</entry> |
| 271 | 2315 <entry>-</entry> |
|
1596
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2316 <entry>In form (form), or member (mbr)</entry> |
|
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2317 </row> |
|
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2318 <row> |
|
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2319 <entry>Cyan</entry> |
|
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2320 <entry>-</entry> |
|
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2321 <entry>Resting/camping/meditating (rest)</entry> |
|
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2322 </row> |
|
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2323 <row> |
|
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2324 <entry>Bright White</entry> |
|
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2325 <entry>Blue</entry> |
|
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2326 <entry>"Glaced" (NPC special)</entry> |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2327 </row> |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2328 §macros_end; |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2329 |
| 276 | 2330 <section> |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2331 §macros_1; |
| 276 | 2332 </para> |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2333 |
| 271 | 2334 <table><title>Macro commands</title> |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2335 <tgroup cols="2" align="left"> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2336 <thead> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2337 <row> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2338 <entry>Command</entry> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2339 <entry>Description</entry> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2340 </row> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2341 </thead> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2342 <tbody> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2343 <row> |
|
773
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2344 <entry>/prettypss</entry> |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2345 <entry>Toggle 'pss' output mangling/prettifying. If set off, normal |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2346 plain 'pss' output is passed through unfiltered.</entry> |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2347 </row> |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2348 <row> |
|
449
725695d31f21
Updated /pstatus -> pss and /pss -> /autopss accordingly.
Matti Hamalainen <ccr@tnsp.org>
parents:
422
diff
changeset
|
2349 <entry>/pss</entry> |
|
773
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2350 <entry>Show party status.</entry> |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2351 </row> |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2352 <row> |
|
449
725695d31f21
Updated /pstatus -> pss and /pss -> /autopss accordingly.
Matti Hamalainen <ccr@tnsp.org>
parents:
422
diff
changeset
|
2353 <entry>/autopss</entry> |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2354 <entry>Toggle automatic party status reporting. (Defined elsewhere)</entry> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2355 </row> |
|
773
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2356 <row> |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2357 <entry>/fullparty</entry> |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2358 <entry>If enabled, mangled output always shows full 3x3 party formation, |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2359 even if all rows aren't filled. When disabled, only the first used rows |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2360 are shown.</entry> |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2361 </row> |
|
943
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
2362 <row> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
2363 <entry>/diffpss</entry> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
2364 <entry>Shows diff-values of hp/sp/ep if enabled.</entry> |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
2365 </row> |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2366 </tbody> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2367 </tgroup> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2368 </table> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2369 </section> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2370 |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2371 </section> |
|
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2372 |
| 248 | 2373 <!-- ================================================ --> |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2374 |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
2375 <section id="usage-pplacer"><title>Party Placer (gm-pplacer.tf)</title> |
|
414
b13a94bd4ee5
Added section skeleton for GgrTF::PartyPlacer
Matti Hamalainen <ccr@tnsp.org>
parents:
410
diff
changeset
|
2376 <para> |
|
546
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
2377 This module provides functionality for saving and restoring |
|
703
20f20c1e8548
Updated copyright notices; Cosmetic cleanups; Updates to documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
695
diff
changeset
|
2378 party formation (placement of members). Two simple to use macros can be |
|
1385
6fb66ee3ae03
docs: Clarify functionality of party placer module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1381
diff
changeset
|
2379 issued to save the current formation and restore it as needed. |
|
6fb66ee3ae03
docs: Clarify functionality of party placer module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1381
diff
changeset
|
2380 Current flower BatMUD provides an in-game implementation via |
|
6fb66ee3ae03
docs: Clarify functionality of party placer module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1381
diff
changeset
|
2381 'party store' and 'party restore' commands, which may be preferable |
|
6fb66ee3ae03
docs: Clarify functionality of party placer module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1381
diff
changeset
|
2382 over this module for some people. |
|
546
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
2383 </para> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
2384 |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
2385 <para> |
|
1385
6fb66ee3ae03
docs: Clarify functionality of party placer module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1381
diff
changeset
|
2386 <emphasis>However, the functionality of this module is somewhat |
|
6fb66ee3ae03
docs: Clarify functionality of party placer module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1381
diff
changeset
|
2387 better than the stock BatMUD commands, and will work under certain |
|
6fb66ee3ae03
docs: Clarify functionality of party placer module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1381
diff
changeset
|
2388 situations when the 'party restore' command does not, for example |
|
6fb66ee3ae03
docs: Clarify functionality of party placer module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1381
diff
changeset
|
2389 when some party members are missing from the room. |
|
6fb66ee3ae03
docs: Clarify functionality of party placer module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1381
diff
changeset
|
2390 </emphasis> |
|
6fb66ee3ae03
docs: Clarify functionality of party placer module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1381
diff
changeset
|
2391 </para> |
|
6fb66ee3ae03
docs: Clarify functionality of party placer module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1381
diff
changeset
|
2392 |
|
6fb66ee3ae03
docs: Clarify functionality of party placer module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1381
diff
changeset
|
2393 <para> |
|
6fb66ee3ae03
docs: Clarify functionality of party placer module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1381
diff
changeset
|
2394 NOTICE! This module requires |
|
546
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
2395 <link linkend="usage-pssmangle">PSS-mangler</link> module to be loaded! |
|
414
b13a94bd4ee5
Added section skeleton for GgrTF::PartyPlacer
Matti Hamalainen <ccr@tnsp.org>
parents:
410
diff
changeset
|
2396 </para> |
|
b13a94bd4ee5
Added section skeleton for GgrTF::PartyPlacer
Matti Hamalainen <ccr@tnsp.org>
parents:
410
diff
changeset
|
2397 |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2398 §macros_2; |
|
414
b13a94bd4ee5
Added section skeleton for GgrTF::PartyPlacer
Matti Hamalainen <ccr@tnsp.org>
parents:
410
diff
changeset
|
2399 <row> |
|
546
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
2400 <entry>/ppsave</entry> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
2401 <entry>Save current party formation. Positions of party members |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
2402 in current formation are stored. |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
2403 </entry> |
|
414
b13a94bd4ee5
Added section skeleton for GgrTF::PartyPlacer
Matti Hamalainen <ccr@tnsp.org>
parents:
410
diff
changeset
|
2404 </row> |
|
b13a94bd4ee5
Added section skeleton for GgrTF::PartyPlacer
Matti Hamalainen <ccr@tnsp.org>
parents:
410
diff
changeset
|
2405 <row> |
|
546
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
2406 <entry>/ppreset</entry> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
2407 <entry>Resets or restores the party formation to the one saved |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
2408 previously. Restoring occurs fully automatically. |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
2409 </entry> |
|
414
b13a94bd4ee5
Added section skeleton for GgrTF::PartyPlacer
Matti Hamalainen <ccr@tnsp.org>
parents:
410
diff
changeset
|
2410 </row> |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2411 §macros_end; |
|
414
b13a94bd4ee5
Added section skeleton for GgrTF::PartyPlacer
Matti Hamalainen <ccr@tnsp.org>
parents:
410
diff
changeset
|
2412 |
|
b13a94bd4ee5
Added section skeleton for GgrTF::PartyPlacer
Matti Hamalainen <ccr@tnsp.org>
parents:
410
diff
changeset
|
2413 </section> |
|
b13a94bd4ee5
Added section skeleton for GgrTF::PartyPlacer
Matti Hamalainen <ccr@tnsp.org>
parents:
410
diff
changeset
|
2414 |
|
b13a94bd4ee5
Added section skeleton for GgrTF::PartyPlacer
Matti Hamalainen <ccr@tnsp.org>
parents:
410
diff
changeset
|
2415 <!-- ================================================ --> |
|
b13a94bd4ee5
Added section skeleton for GgrTF::PartyPlacer
Matti Hamalainen <ccr@tnsp.org>
parents:
410
diff
changeset
|
2416 |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
2417 <section id="usage-ptracker"><title>Party Prots Tracker (gm-ptracker.tf)</title> |
|
1166
230eb7ac1960
Add note about obsoleteness of GgrTF::Ptracker module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1157
diff
changeset
|
2418 <note><para> |
|
230eb7ac1960
Add note about obsoleteness of GgrTF::Ptracker module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1157
diff
changeset
|
2419 <emphasis>This module is practically obsolete and deprecated in flower BatMUD, because of |
|
230eb7ac1960
Add note about obsoleteness of GgrTF::Ptracker module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1157
diff
changeset
|
2420 the in-game 'party prots' command that does essentially the same thing. |
|
230eb7ac1960
Add note about obsoleteness of GgrTF::Ptracker module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1157
diff
changeset
|
2421 </emphasis> |
|
230eb7ac1960
Add note about obsoleteness of GgrTF::Ptracker module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1157
diff
changeset
|
2422 It is possible that this module will be removed in future. |
|
230eb7ac1960
Add note about obsoleteness of GgrTF::Ptracker module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1157
diff
changeset
|
2423 </para></note> |
|
230eb7ac1960
Add note about obsoleteness of GgrTF::Ptracker module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1157
diff
changeset
|
2424 |
|
703
20f20c1e8548
Updated copyright notices; Cosmetic cleanups; Updates to documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
695
diff
changeset
|
2425 <para> |
| 1099 | 2426 Module for showing prots (and similar effects) affecting your party members. |
| 2427 Tracking these effects can be done in two separate ways: 1) Old way (compatible | |
| 2428 with HCBat also) is keeping account of different prot up/down messages on the | |
| 2429 party and report channels. 2) New way is via 'show effects' command available | |
|
1104
850b0245b763
Add some more notes about ptracker and 'show effects'.
Matti Hamalainen <ccr@tnsp.org>
parents:
1103
diff
changeset
|
2430 in the normal BatMUD. The 'show effects' method is recommended, because of |
|
850b0245b763
Add some more notes about ptracker and 'show effects'.
Matti Hamalainen <ccr@tnsp.org>
parents:
1103
diff
changeset
|
2431 generally better accuracy. <emphasis>It should also be noted that there is a |
|
850b0245b763
Add some more notes about ptracker and 'show effects'.
Matti Hamalainen <ccr@tnsp.org>
parents:
1103
diff
changeset
|
2432 difference in the output between these two methods. "Manually" tracked prots |
|
850b0245b763
Add some more notes about ptracker and 'show effects'.
Matti Hamalainen <ccr@tnsp.org>
parents:
1103
diff
changeset
|
2433 show elapsed time of the effect, but with 'show effects' mode, the remaining |
|
850b0245b763
Add some more notes about ptracker and 'show effects'.
Matti Hamalainen <ccr@tnsp.org>
parents:
1103
diff
changeset
|
2434 time is shown.</emphasis> |
|
773
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2435 </para> |
| 1099 | 2436 <note><para> |
| 2437 Due to the way the up/down message tracking works, it depends on your | |
| 2438 party members to use <emphasis>working, non-broken</emphasis> triggers | |
| 2439 which use up/down messages that are recognizable to the ptracker module. | |
| 1225 | 2440 However, this does not affect 'show effects' mode in any way. |
| 1099 | 2441 </para></note> |
| 2442 | |
|
773
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2443 <screen> |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2444 .------------+-----+-----+-----+-----+-----+-----+-----+-----+ |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2445 | | Flex|WarEs|EMelo| AoA|MFire| AoH| Uns| Unp| |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2446 +------------+-----+-----+-----+-----+-----+-----+-----+-----+ |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2447 |Blayke | 0:07| 1:25| 0:49| 1:55| 1:43| 2:03| | | |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2448 |Yar | | 1:25| | 1:40| 0:07| |21:34| | |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2449 |Kheldor | | 1:24| 0:48| 1:12| 0:41| 2:17|24:40| | |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2450 |Alorn | | 1:25| 0:49| | | | | 6:49| |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2451 |Acentaja | | 1:25| 0:49| | | 1:31| | | |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2452 |Malcom | | 1:25| 0:49| | | 1:10| | | |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2453 |Jrj | | | | | | 6:22| | | |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2454 |Daria | | | | | | | | | |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2455 |Ggr | | 1:25| 0:49| | |20:13| | | |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2456 `------------+-----+-----+-----+-----+-----+-----+-----+-----+ |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2457 </screen> |
|
703
20f20c1e8548
Updated copyright notices; Cosmetic cleanups; Updates to documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
695
diff
changeset
|
2458 |
|
20f20c1e8548
Updated copyright notices; Cosmetic cleanups; Updates to documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
695
diff
changeset
|
2459 <para> |
|
20f20c1e8548
Updated copyright notices; Cosmetic cleanups; Updates to documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
695
diff
changeset
|
2460 <emphasis>NOTICE! This module requires |
|
20f20c1e8548
Updated copyright notices; Cosmetic cleanups; Updates to documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
695
diff
changeset
|
2461 <link linkend="usage-pssmangle">PSS-mangler</link> module to be loaded! |
|
1104
850b0245b763
Add some more notes about ptracker and 'show effects'.
Matti Hamalainen <ccr@tnsp.org>
parents:
1103
diff
changeset
|
2462 </emphasis> Also remember to issue at least one "/pss" command after |
|
850b0245b763
Add some more notes about ptracker and 'show effects'.
Matti Hamalainen <ccr@tnsp.org>
parents:
1103
diff
changeset
|
2463 the party is formed, to make the party members known to PSS-mangler |
|
850b0245b763
Add some more notes about ptracker and 'show effects'.
Matti Hamalainen <ccr@tnsp.org>
parents:
1103
diff
changeset
|
2464 and prot tracker. |
|
703
20f20c1e8548
Updated copyright notices; Cosmetic cleanups; Updates to documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
695
diff
changeset
|
2465 </para> |
|
20f20c1e8548
Updated copyright notices; Cosmetic cleanups; Updates to documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
695
diff
changeset
|
2466 |
|
1103
6100e266c4da
Add explanation about not all effects/prots being shown by the prot tracker module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1101
diff
changeset
|
2467 <note><para> |
|
6100e266c4da
Add explanation about not all effects/prots being shown by the prot tracker module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1101
diff
changeset
|
2468 It should be noted that the prot tracker only supports a limited set of |
|
6100e266c4da
Add explanation about not all effects/prots being shown by the prot tracker module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1101
diff
changeset
|
2469 effects, e.g. it only lists effects/prots that are widely considered to be |
|
6100e266c4da
Add explanation about not all effects/prots being shown by the prot tracker module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1101
diff
changeset
|
2470 of some interest in eq parties. Showing everything would just waste screen |
|
6100e266c4da
Add explanation about not all effects/prots being shown by the prot tracker module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1101
diff
changeset
|
2471 estate and make it less readable. |
|
6100e266c4da
Add explanation about not all effects/prots being shown by the prot tracker module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1101
diff
changeset
|
2472 </para></note> |
|
6100e266c4da
Add explanation about not all effects/prots being shown by the prot tracker module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1101
diff
changeset
|
2473 |
|
1065
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2474 <!-- @commands --> |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2475 <!-- @binds --> |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2476 <!-- @keybinds --> |
|
703
20f20c1e8548
Updated copyright notices; Cosmetic cleanups; Updates to documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
695
diff
changeset
|
2477 |
|
20f20c1e8548
Updated copyright notices; Cosmetic cleanups; Updates to documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
695
diff
changeset
|
2478 </section> |
|
20f20c1e8548
Updated copyright notices; Cosmetic cleanups; Updates to documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
695
diff
changeset
|
2479 |
|
20f20c1e8548
Updated copyright notices; Cosmetic cleanups; Updates to documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
695
diff
changeset
|
2480 <!-- ================================================ --> |
|
20f20c1e8548
Updated copyright notices; Cosmetic cleanups; Updates to documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
695
diff
changeset
|
2481 |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
2482 <section id="usage-spellnames"><title>Spellwords translator (gm-spellnames.tf)</title> |
|
280
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2483 <para> |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2484 This module adds in translating of spellwords to actual spell names. |
| 1060 | 2485 It is very much based on original work of &finger Cutter; and &finger Dazzt;, |
|
280
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2486 well known highbie BatMUD players. Their code is used and re-licensed |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2487 under GPL with permission. |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2488 </para> |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2489 |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2490 <para> |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2491 The translator works by printing the spell name in parentheses |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2492 on the line where the spellwords are. The translated name can |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2493 optionally replace the spellwords or it can be printed after them. |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2494 </para> |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2495 |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2496 <para> |
|
280
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2497 The spell name can be, if enabled, optionally printed in special |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2498 colour formatting, which is based on the general class/type of the spell. |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2499 This visual hinting can help you to notice if dangerous or |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2500 otherwise interesting spells are cast. |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2501 </para> |
| 271 | 2502 |
|
280
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2503 <para> |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2504 Uncolorized examples of spellwords translator's output: |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2505 </para> |
| 271 | 2506 |
|
280
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2507 <screen> |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2508 You utter the magic words (unstun) |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2509 |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2510 You utter the magic words 'Paxus' (unstun) |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2511 |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2512 Acolyte waves his index finger while uttering (flame arrow) |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2513 |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2514 Murrough throws a pinch of magic dust in air and chants (lightning storm) |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2515 </screen> |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2516 |
| 1060 | 2517 <!-- @commands --> |
| 271 | 2518 |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2519 </section> |
|
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2520 |
| 248 | 2521 <!-- ================================================ --> |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2522 |
|
1065
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2523 <section id="usage-tgtcast"><title>Numpad targetted casting (gm-tgtcast.tf)</title> |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2524 <para> |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2525 </para> |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2526 |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2527 <note> |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2528 <para> |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2529 This module requires the <link linkend="usage-pssmangle">PSS-mangler</link> module. |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2530 </para> |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2531 </note> |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2532 |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2533 </section> |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2534 |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2535 <!-- ================================================ --> |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2536 |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
2537 <section id="usage-hc"><title>HCBat support (gm-hcbat.tf)</title> |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2538 <para> |
| 262 | 2539 Due to the age of Hard Core BatMUD's current codebase and conceptual |
| 2540 differences, several exceptions and workarounds are needed to | |
| 2541 improve GgrTF's compatibility with the HCBat environment. | |
| 2542 This module tries to provide the glue to make it happen. | |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2543 </para> |
| 262 | 2544 |
| 2545 <para> | |
| 2546 Purpose of this module is dissimilar to others, as it is meant | |
| 2547 to contain almost everything related to peculiarities and | |
| 2548 differences of HCBat. We do not have separate | |
| 2549 guild-specific modules for HCBat, the code needed to | |
| 2550 catch the differences is either in this module or in some | |
| 2551 special cases in the guild-specific modules. | |
| 2552 </para> | |
| 2553 | |
| 2554 <para> | |
| 2555 At the moment this module is rather simple, only replacing | |
| 2556 GgrTF's output macros to work around the lack of 'party report' | |
| 2557 -channel in HCBat. In future more functionality may be added, | |
| 2558 feel free to report bugs/incompatibilities to us. | |
| 2559 </para> | |
| 2560 | |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2561 </section> |
|
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2562 |
| 248 | 2563 <!-- ================================================ --> |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2564 |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
2565 <section id="usage-rais"><title>Raise/Resurrect/New Body/etc. (gm-rais.tf)</title> |
| 230 | 2566 <para> |
| 317 | 2567 This module contains utility functionality for everyone who casts |
| 2568 different types of dead raising spells, including "raise dead", | |
| 2569 "resurrect", "new body", "reincarnation", etc. | |
| 230 | 2570 </para> |
| 317 | 2571 |
| 2572 <para> | |
| 2573 Automatic list is kept of people who have accepted some such service | |
| 2574 from you, along with information what spell was requested. List can | |
| 2575 be viewed, and you can launch a cast at the latest accept or by | |
| 2576 specifying a player's name, cast his/her request. | |
| 2577 </para> | |
| 2578 | |
| 379 | 2579 <para> |
| 387 | 2580 You can either directly use the macros or use <link |
| 2581 linkend="usage-general-binds">command bindings</link> | |
| 2582 to have shorthand commands instead. | |
| 379 | 2583 </para> |
| 2584 | |
| 317 | 2585 <screenshot> |
| 2586 <mediaobject> | |
|
624
cc40c7360880
The manual is now pseudo-XML conformant, you have to use normalizeml.pl to convert to syntactically correct XML.
Matti Hamalainen <ccr@tnsp.org>
parents:
622
diff
changeset
|
2587 <imageobject><imagedata fileref="rais_list.gif" format="GIF" /></imageobject> |
|
cc40c7360880
The manual is now pseudo-XML conformant, you have to use normalizeml.pl to convert to syntactically correct XML.
Matti Hamalainen <ccr@tnsp.org>
parents:
622
diff
changeset
|
2588 <imageobject><imagedata fileref="rais_list.eps" format="EPS" /></imageobject> |
| 317 | 2589 <textobject> |
| 2590 <phrase>List of accepts</phrase> | |
| 2591 </textobject> | |
| 2592 <caption> | |
| 2593 <para> | |
|
583
4bc4bc602eaf
Renamed macros acpt_* -> ac*
Matti Hamalainen <ccr@tnsp.org>
parents:
567
diff
changeset
|
2594 An example output of "/aclist" macro, listing the players |
| 379 | 2595 who have accepted services from you and respective requested |
| 2596 spells for each. The time field shows how much | |
| 317 | 2597 time has passed from the accept. |
| 2598 </para> | |
| 2599 </caption> | |
| 2600 </mediaobject> | |
| 2601 </screenshot> | |
| 2602 | |
| 2603 <table><title>Macro commands</title> | |
|
1545
fe83084ff7e1
Fix some table column width.
Matti Hamalainen <ccr@tnsp.org>
parents:
1544
diff
changeset
|
2604 <tgroup cols="2" align="left"> |
| 317 | 2605 <thead> |
| 2606 <row> | |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2607 <entry>Command</entry> |
| 317 | 2608 <entry>Description</entry> |
| 2609 </row> | |
| 2610 </thead> | |
| 2611 <tbody> | |
| 2612 <row> | |
|
583
4bc4bc602eaf
Renamed macros acpt_* -> ac*
Matti Hamalainen <ccr@tnsp.org>
parents:
567
diff
changeset
|
2613 <entry>/aclist</entry> |
| 317 | 2614 <entry> |
| 2615 View list of people who have accepted something from you. | |
| 2616 </entry> | |
| 2617 </row> | |
| 2618 <row> | |
|
583
4bc4bc602eaf
Renamed macros acpt_* -> ac*
Matti Hamalainen <ccr@tnsp.org>
parents:
567
diff
changeset
|
2619 <entry>/accast [name]</entry> |
| 317 | 2620 <entry> |
| 2621 Cast Last-type functionality. Without arguments casts the LATEST | |
| 2622 requested spell. Optionally you can specify a name of the player | |
| 2623 and the spell requested by him/her is cast. | |
| 2624 </entry> | |
| 2625 </row> | |
| 2626 <row> | |
|
583
4bc4bc602eaf
Renamed macros acpt_* -> ac*
Matti Hamalainen <ccr@tnsp.org>
parents:
567
diff
changeset
|
2627 <entry>/acclear</entry> |
| 317 | 2628 <entry> |
| 379 | 2629 Clears the list. Useful, if the automatic removal |
| 2630 malfunctions for some reason. (For example, if target | |
| 2631 uses 'pray' to become alive again, there is no message | |
| 2632 provided to the caster.) | |
| 317 | 2633 </entry> |
| 2634 </row> | |
| 2635 </tbody> | |
| 2636 </tgroup> | |
| 2637 </table> | |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2638 |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2639 <!-- @binds --> |
| 317 | 2640 |
| 230 | 2641 </section> |
| 2642 | |
| 248 | 2643 <!-- ================================================ --> |
| 230 | 2644 |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
2645 <section id="usage-hstats"><title>Hit Statistics (gm-hitstats.tf)</title> |
|
773
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2646 <para> |
|
774
89661ef754b4
Incomplete documentation of hit statistics module.
Matti Hamalainen <ccr@tnsp.org>
parents:
773
diff
changeset
|
2647 Provides triggers for automatic gathering of melee hit statistics. |
|
988
930c1485903f
Added few details about hitstats module.
Matti Hamalainen <ccr@tnsp.org>
parents:
980
diff
changeset
|
2648 This functionality is not without limitations, in some cases hits may become |
|
930c1485903f
Added few details about hitstats module.
Matti Hamalainen <ccr@tnsp.org>
parents:
980
diff
changeset
|
2649 erraneously counted (such as Templar guild 'holy strike' skill being counted |
|
930c1485903f
Added few details about hitstats module.
Matti Hamalainen <ccr@tnsp.org>
parents:
980
diff
changeset
|
2650 as bludgeon strike) but it gives you a general impression about what kinds |
|
930c1485903f
Added few details about hitstats module.
Matti Hamalainen <ccr@tnsp.org>
parents:
980
diff
changeset
|
2651 of hits you mostly deal out. |
|
930c1485903f
Added few details about hitstats module.
Matti Hamalainen <ccr@tnsp.org>
parents:
980
diff
changeset
|
2652 </para> |
|
930c1485903f
Added few details about hitstats module.
Matti Hamalainen <ccr@tnsp.org>
parents:
980
diff
changeset
|
2653 |
|
930c1485903f
Added few details about hitstats module.
Matti Hamalainen <ccr@tnsp.org>
parents:
980
diff
changeset
|
2654 <para> |
|
930c1485903f
Added few details about hitstats module.
Matti Hamalainen <ccr@tnsp.org>
parents:
980
diff
changeset
|
2655 Only certain weapon/hit types are currently supported by the code. |
|
930c1485903f
Added few details about hitstats module.
Matti Hamalainen <ccr@tnsp.org>
parents:
980
diff
changeset
|
2656 In order to get any hit counts, you need to define what weapon types |
|
1224
87ecb4223beb
Update description of supported hit types to match the list.
Matti Hamalainen <ccr@tnsp.org>
parents:
1222
diff
changeset
|
2657 you use. Currently following general hit/weapon classes are supported: |
|
773
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2658 </para> |
|
1007
8c3b1463a0d9
Added some notes to hitstats documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1005
diff
changeset
|
2659 |
|
988
930c1485903f
Added few details about hitstats module.
Matti Hamalainen <ccr@tnsp.org>
parents:
980
diff
changeset
|
2660 <itemizedlist> |
|
1074
832d49b91c3d
Moved command documentation to embedded TFDoc; Added whip hit messages; Updated description of supported hit types to match the reality.
Matti Hamalainen <ccr@tnsp.org>
parents:
1072
diff
changeset
|
2661 <listitem><para><emphasis>none</emphasis> - This is just a clear/off setting.</para></listitem> |
|
1562
998654bf0b6c
Add missing attack message types to manual.
Matti Hamalainen <ccr@tnsp.org>
parents:
1557
diff
changeset
|
2662 |
|
1074
832d49b91c3d
Moved command documentation to embedded TFDoc; Added whip hit messages; Updated description of supported hit types to match the reality.
Matti Hamalainen <ccr@tnsp.org>
parents:
1072
diff
changeset
|
2663 <listitem><para><emphasis>bash</emphasis> - Blunt weapons (bludgeons, etc.)</para></listitem> |
|
832d49b91c3d
Moved command documentation to embedded TFDoc; Added whip hit messages; Updated description of supported hit types to match the reality.
Matti Hamalainen <ccr@tnsp.org>
parents:
1072
diff
changeset
|
2664 <listitem><para><emphasis>pierce</emphasis> - Impaling weapons (some polearms, some short blades.)</para></listitem> |
|
832d49b91c3d
Moved command documentation to embedded TFDoc; Added whip hit messages; Updated description of supported hit types to match the reality.
Matti Hamalainen <ccr@tnsp.org>
parents:
1072
diff
changeset
|
2665 <listitem><para><emphasis>slash</emphasis> - Slashing weapons (long blades, axes, some short blades, some polearms.)</para></listitem> |
|
832d49b91c3d
Moved command documentation to embedded TFDoc; Added whip hit messages; Updated description of supported hit types to match the reality.
Matti Hamalainen <ccr@tnsp.org>
parents:
1072
diff
changeset
|
2666 <listitem><para><emphasis>shield</emphasis> - Shield bash.</para></listitem> |
|
832d49b91c3d
Moved command documentation to embedded TFDoc; Added whip hit messages; Updated description of supported hit types to match the reality.
Matti Hamalainen <ccr@tnsp.org>
parents:
1072
diff
changeset
|
2667 <listitem><para><emphasis>whip</emphasis> - Whip hits.</para></listitem> |
|
832d49b91c3d
Moved command documentation to embedded TFDoc; Added whip hit messages; Updated description of supported hit types to match the reality.
Matti Hamalainen <ccr@tnsp.org>
parents:
1072
diff
changeset
|
2668 <listitem><para><emphasis>tiger</emphasis> - Tiger style martial arts.</para></listitem> |
|
832d49b91c3d
Moved command documentation to embedded TFDoc; Added whip hit messages; Updated description of supported hit types to match the reality.
Matti Hamalainen <ccr@tnsp.org>
parents:
1072
diff
changeset
|
2669 <listitem><para><emphasis>monk</emphasis> - Monk style martial arts.</para></listitem> |
|
832d49b91c3d
Moved command documentation to embedded TFDoc; Added whip hit messages; Updated description of supported hit types to match the reality.
Matti Hamalainen <ccr@tnsp.org>
parents:
1072
diff
changeset
|
2670 <listitem><para><emphasis>unarmed</emphasis> - Untrained unarmed attacks.</para></listitem> |
|
1562
998654bf0b6c
Add missing attack message types to manual.
Matti Hamalainen <ccr@tnsp.org>
parents:
1557
diff
changeset
|
2671 <listitem><para><emphasis>claw</emphasis> - Natural unarmed claw attacks.</para></listitem> |
|
998654bf0b6c
Add missing attack message types to manual.
Matti Hamalainen <ccr@tnsp.org>
parents:
1557
diff
changeset
|
2672 <listitem><para><emphasis>bite</emphasis> - Biting attacks.</para></listitem> |
|
988
930c1485903f
Added few details about hitstats module.
Matti Hamalainen <ccr@tnsp.org>
parents:
980
diff
changeset
|
2673 </itemizedlist> |
|
930c1485903f
Added few details about hitstats module.
Matti Hamalainen <ccr@tnsp.org>
parents:
980
diff
changeset
|
2674 |
|
1007
8c3b1463a0d9
Added some notes to hitstats documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1005
diff
changeset
|
2675 <note><para> |
|
8c3b1463a0d9
Added some notes to hitstats documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1005
diff
changeset
|
2676 It should be noted, that the code does not differentiate between |
|
1074
832d49b91c3d
Moved command documentation to embedded TFDoc; Added whip hit messages; Updated description of supported hit types to match the reality.
Matti Hamalainen <ccr@tnsp.org>
parents:
1072
diff
changeset
|
2677 wielded weapons or limbs. <emphasis>This means, that if you are wielding |
|
832d49b91c3d
Moved command documentation to embedded TFDoc; Added whip hit messages; Updated description of supported hit types to match the reality.
Matti Hamalainen <ccr@tnsp.org>
parents:
1072
diff
changeset
|
2678 multiple weapons of same type, hits from those are counted as one weapon. |
|
832d49b91c3d
Moved command documentation to embedded TFDoc; Added whip hit messages; Updated description of supported hit types to match the reality.
Matti Hamalainen <ccr@tnsp.org>
parents:
1072
diff
changeset
|
2679 Same applies to unarmed hits too, of course. |
|
832d49b91c3d
Moved command documentation to embedded TFDoc; Added whip hit messages; Updated description of supported hit types to match the reality.
Matti Hamalainen <ccr@tnsp.org>
parents:
1072
diff
changeset
|
2680 </emphasis> |
|
1007
8c3b1463a0d9
Added some notes to hitstats documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1005
diff
changeset
|
2681 </para></note> |
|
8c3b1463a0d9
Added some notes to hitstats documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1005
diff
changeset
|
2682 |
|
988
930c1485903f
Added few details about hitstats module.
Matti Hamalainen <ccr@tnsp.org>
parents:
980
diff
changeset
|
2683 <para> |
|
930c1485903f
Added few details about hitstats module.
Matti Hamalainen <ccr@tnsp.org>
parents:
980
diff
changeset
|
2684 Example of /hstats output: |
|
930c1485903f
Added few details about hitstats module.
Matti Hamalainen <ccr@tnsp.org>
parents:
980
diff
changeset
|
2685 </para> |
|
774
89661ef754b4
Incomplete documentation of hit statistics module.
Matti Hamalainen <ccr@tnsp.org>
parents:
773
diff
changeset
|
2686 <screen> |
|
943
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
2687 ,----------------------. |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
2688 | GgrTF Hit Statistics | |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
2689 +-----------------------------------------------. |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
2690 +-| Axes/Long blades |----------------------| |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
2691 |horribly shred : ( 0): 2 ( 11)| |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
2692 |shred : ( 0): 7 ( 41)| |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
2693 |incise : ( 0): 8 ( 47)| |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
2694 |tear : 21 ( 3): ( 0)| |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
2695 |cut : 462 ( 72): ( 0)| |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
2696 |lightly cut : 157 ( 24): ( 0)| |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
2697 | | |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
2698 +-----------------------------------------------' |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
2699 +-| Totals |-------------------------------------------+ |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
2700 | Hits..: 640 ( 76%) | Crits: 17 ( 2%) | |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
2701 | Misses: 192 ( 23%) | Total hit types: 6 | |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
2702 +----------------------------------------------+-------' |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
2703 | Dodges..: 3 | Parries..: | |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
2704 | Tumbles.: | Stuns....: | |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
2705 | Ripostes: | Stun mano: | |
|
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
2706 `----------------------------------------------' |
|
774
89661ef754b4
Incomplete documentation of hit statistics module.
Matti Hamalainen <ccr@tnsp.org>
parents:
773
diff
changeset
|
2707 </screen> |
|
943
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
2708 |
|
774
89661ef754b4
Incomplete documentation of hit statistics module.
Matti Hamalainen <ccr@tnsp.org>
parents:
773
diff
changeset
|
2709 <para> |
|
972
ea85d502d46f
Misc. typo fixes and minor reorganization.
Matti Hamalainen <ccr@tnsp.org>
parents:
969
diff
changeset
|
2710 Format of hits described above is: |
|
1007
8c3b1463a0d9
Added some notes to hitstats documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1005
diff
changeset
|
2711 | Hit name : number of hits of this type (percentage): number of crits of this type (percentage) | |
|
774
89661ef754b4
Incomplete documentation of hit statistics module.
Matti Hamalainen <ccr@tnsp.org>
parents:
773
diff
changeset
|
2712 </para> |
|
89661ef754b4
Incomplete documentation of hit statistics module.
Matti Hamalainen <ccr@tnsp.org>
parents:
773
diff
changeset
|
2713 |
|
988
930c1485903f
Added few details about hitstats module.
Matti Hamalainen <ccr@tnsp.org>
parents:
980
diff
changeset
|
2714 <note><para> |
|
930c1485903f
Added few details about hitstats module.
Matti Hamalainen <ccr@tnsp.org>
parents:
980
diff
changeset
|
2715 <emphasis>Hit stats REQUIRES the TF terminal window width |
|
930c1485903f
Added few details about hitstats module.
Matti Hamalainen <ccr@tnsp.org>
parents:
980
diff
changeset
|
2716 to be 95 columns or more!</emphasis> If you are using TF in smaller |
|
930c1485903f
Added few details about hitstats module.
Matti Hamalainen <ccr@tnsp.org>
parents:
980
diff
changeset
|
2717 smaller window and can't make it wider, then you are out of luck. |
|
930c1485903f
Added few details about hitstats module.
Matti Hamalainen <ccr@tnsp.org>
parents:
980
diff
changeset
|
2718 </para></note> |
|
972
ea85d502d46f
Misc. typo fixes and minor reorganization.
Matti Hamalainen <ccr@tnsp.org>
parents:
969
diff
changeset
|
2719 |
|
1074
832d49b91c3d
Moved command documentation to embedded TFDoc; Added whip hit messages; Updated description of supported hit types to match the reality.
Matti Hamalainen <ccr@tnsp.org>
parents:
1072
diff
changeset
|
2720 <!-- @commands --> |
|
832d49b91c3d
Moved command documentation to embedded TFDoc; Added whip hit messages; Updated description of supported hit types to match the reality.
Matti Hamalainen <ccr@tnsp.org>
parents:
1072
diff
changeset
|
2721 <!-- @binds --> |
|
832d49b91c3d
Moved command documentation to embedded TFDoc; Added whip hit messages; Updated description of supported hit types to match the reality.
Matti Hamalainen <ccr@tnsp.org>
parents:
1072
diff
changeset
|
2722 <!-- @keybinds --> |
|
773
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2723 |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2724 </section> |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2725 |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2726 <!-- ================================================ --> |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2727 |
|
1377
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2728 <section id="usage-identify"><title>Identify output beautifier (gm-identify.tf)</title> |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2729 <para> |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2730 Provides a simpler and more readable view of 'identify' spell's output. |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2731 Not all information can be caught gracefully, however, and thus you should |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2732 refer to the raw output for details such as "tales" and other special information. |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2733 </para> |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2734 |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2735 <para> |
|
1563
d8c04a55d1d4
Move reagent pouch command documentation to tfdoc inline docs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1562
diff
changeset
|
2736 The module also supports merchant belt's 'weigh' command for catching |
|
d8c04a55d1d4
Move reagent pouch command documentation to tfdoc inline docs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1562
diff
changeset
|
2737 the item's weight, if the belt is worn and <emphasis>/havebelt</emphasis> |
|
d8c04a55d1d4
Move reagent pouch command documentation to tfdoc inline docs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1562
diff
changeset
|
2738 setting of the merchant module is enabled. |
|
d8c04a55d1d4
Move reagent pouch command documentation to tfdoc inline docs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1562
diff
changeset
|
2739 </para> |
|
d8c04a55d1d4
Move reagent pouch command documentation to tfdoc inline docs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1562
diff
changeset
|
2740 |
|
d8c04a55d1d4
Move reagent pouch command documentation to tfdoc inline docs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1562
diff
changeset
|
2741 <para> |
|
1377
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2742 Example of output: |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2743 </para> |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2744 <screen> |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2745 +-| General |----------------------------------------------------------------+ |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2746 | Item....: a pair of stylish blue breeches | |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2747 | Name....: blue breeches | |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2748 | Handles.: 'breeches', 'stylish blue breeches', 'silk breeches' and | |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2749 | 'pants' | |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2750 | Names...: Molotov, Belse and Ekkivekki | |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2751 | Slots...: leg and leg | |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2752 | Material: silk | |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2753 +----------------------------------------------------------------------------+ |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2754 | In game.: 2y, 104d, 16h, 13min and 58s | Condition: great | |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2755 | Size....: somewhat small | Maxcond..: AWESOME | |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2756 | Worth...: 8851 | Quality..: superb | |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2757 | Weight..: almost weightless | Weight/kg: 0.050 | |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2758 +-| Stats |------------------------------------------------------------------+ |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2759 | insignificantly improve your wis | |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2760 +-| Misc |-------------------------------------------------------------------+ |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2761 | Worn....: Ekkivekki for 48d, 17h, 13min and 9s, Prince charming for 2h, | |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2762 | 5min and 44s and Slobber for 157d, 14h, 48min and 52s | |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2763 | Wielded.: | |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2764 +----------------------------------------------------------------------------+ |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2765 </screen> |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2766 |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2767 <!-- @commands --> |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2768 <!-- @binds --> |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2769 <!-- @keybinds --> |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2770 |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2771 </section> |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2772 |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2773 <!-- ================================================ --> |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2774 |
|
956
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
2775 <section id="usage-rpouch"><title>Reagent Pouch handler (gm-rpouch.tf)</title> |
|
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
2776 <para> |
|
999
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2777 This module provides utilities for reagent pouch handling, especially useful |
|
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2778 for mages and merchants. It also has a reagent pouch mangler/beautifier, |
|
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2779 which attempts to make the pouch contents more readable. |
|
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2780 </para> |
|
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2781 |
|
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2782 <para> |
|
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2783 Example output (uncoloured) of looking at a reagent pouch: |
|
956
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
2784 </para> |
|
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
2785 <screen> |
|
999
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2786 This is a large pouch for the storing of reagents for spells. You can store |
|
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2787 reagents over reboots in this. It cannot hold anything else. |
|
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2788 Syntax: store <item> in <this> |
|
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2789 extract [amount] <item> from <this> take <power/standard/poor> |
|
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2790 set_default_reagent <this> to <power/standard/poor> |
|
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2791 transfer <number> <reagent> from <here> to <there> [take <power level>] |
|
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2792 Some commands allow the use of 'all' in places. |
|
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2793 It is labeled as 'pussi'. |
|
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2794 The label can be set with 'label' command. |
|
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2795 578 | Acid Blast ( 578, 0, 0) (Olivine powder) |
|
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2796 477 | Acid Storm ( 477, 0, 0) (Interlocked rings) |
|
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2797 436 | Blast Vacuum ( 436, 0, 0) (Bronze marble) |
|
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2798 417 | Lightning Shield ( 417, 0, 0) (Iron rod) |
|
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2799 397 | Armour of Aether ( 397, 0, 0) (Highsteel disc) |
|
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2800 388 | Magic Eruption ( 388, 0, 0) (Platinum hammer) |
|
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2801 341 | Lava Blast ( 341, 0, 0) (Granite sphere) |
|
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2802 272 | Electrocution ( 272, 0, 0) (Electrum wire) |
|
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2803 263 | Aura of Wind ( 263, 0, 0) (Leather bag) |
|
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2804 91 | Golden Arrow ( 91, 0, 0) (Copper rod) |
|
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2805 71 | Shield of Detoxification ( 71, 0, 0) (Amethyst crystal) |
|
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2806 It is surrounded by a yellow glow. |
|
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2807 This item is in superb condition. |
|
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2808 It looks very very heavy. |
|
956
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
2809 </screen> |
|
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
2810 |
|
972
ea85d502d46f
Misc. typo fixes and minor reorganization.
Matti Hamalainen <ccr@tnsp.org>
parents:
969
diff
changeset
|
2811 <note><para> |
|
ea85d502d46f
Misc. typo fixes and minor reorganization.
Matti Hamalainen <ccr@tnsp.org>
parents:
969
diff
changeset
|
2812 Currently only POWER reagents are handled by the /rpouch commands! |
|
ea85d502d46f
Misc. typo fixes and minor reorganization.
Matti Hamalainen <ccr@tnsp.org>
parents:
969
diff
changeset
|
2813 Any standard or poor reagents will not be touched by the code in |
|
ea85d502d46f
Misc. typo fixes and minor reorganization.
Matti Hamalainen <ccr@tnsp.org>
parents:
969
diff
changeset
|
2814 this module. |
|
ea85d502d46f
Misc. typo fixes and minor reorganization.
Matti Hamalainen <ccr@tnsp.org>
parents:
969
diff
changeset
|
2815 </para></note> |
|
ea85d502d46f
Misc. typo fixes and minor reorganization.
Matti Hamalainen <ccr@tnsp.org>
parents:
969
diff
changeset
|
2816 |
|
1563
d8c04a55d1d4
Move reagent pouch command documentation to tfdoc inline docs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1562
diff
changeset
|
2817 <!-- @commands --> |
|
956
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
2818 |
|
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
2819 </section> |
|
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
2820 |
|
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
2821 <!-- ================================================ --> |
|
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
2822 |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
2823 <section id="usage-chann"><title>Guild: Channellers (gm-chann.tf)</title> |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2824 <para> |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2825 Game-elements specific to channellers guild are supported and |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2826 enhanced by this module. At the moment, no special commands are |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2827 provided, all things are automagic. This module requires the generic |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2828 <link linkend="usage-magical">magical guilds support module</link>. |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2829 </para> |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
2830 |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2831 <itemizedlist> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2832 <listitem><para> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2833 <emphasis>Channeller aura</emphasis>: |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2834 Keeps note of your aura status and duration. If aura is up, |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2835 it is notified in GgrTF's <link linkend="usage-general-statusline">statusline</link>. |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2836 If your aura is weakening, that also is noted, reminding you |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2837 to recharge. |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2838 </para></listitem> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2839 <listitem><para> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2840 <emphasis>Blast resistance reporting</emphasis>: |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2841 Adds support for channeller blasts into blast resistance |
|
889
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
2842 reporting feature of <link linkend="usage-magical">magical guilds module</link>. |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2843 </para></listitem> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2844 <listitem><para>And other miscellaneous lesser features, such as |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2845 fail and fumble handling, mana transfer cap reporting, etc. |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2846 </para></listitem> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2847 </itemizedlist> |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
2848 |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2849 <!-- @commands --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2850 <!-- @binds --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2851 <!-- @keybinds --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2852 |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2853 </section> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2854 |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2855 <!-- ================================================ --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2856 |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2857 <section id="usage-mage"><title>Guild: Mages (gm-mage.tf)</title> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2858 <para> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2859 Provides command bindings for all mage blast types (singles and areas) |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2860 and optional key bindings for blasting and conjurer prot casting. |
|
1065
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2861 </para> |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2862 |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2863 <note><para> |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2864 This module requires the generic |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2865 <link linkend="usage-magical">magical guilds support module</link>. |
|
1065
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2866 The keybinds require <link linkend="usage-tgtcast">targetted cast</link> module. |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2867 </para></note> |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2868 |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2869 <!-- @commands --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2870 <!-- @binds --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2871 <!-- @keybinds --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2872 |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2873 </section> |
|
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2874 |
| 248 | 2875 <!-- ================================================ --> |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2876 |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
2877 <section id="usage-merchant"><title>Guild: Merchants (gm-merchant.tf)</title> |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2878 <para> |
| 263 | 2879 This module provides, in addition to basic skill/spell fail/fumble |
| 233 | 2880 handling, several helper macros, which may ease your work as merchant. |
|
249
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2881 Many of the command macros support "autotargetting", which basically |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2882 means that you can walk in outerworld and just type "/lj" for |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2883 lumberjacking and "/mine" for mining and GgrTF usually knows what |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2884 to do. Some macros require bit more specific arguments. |
| 233 | 2885 </para> |
| 2886 | |
| 2887 <para> | |
| 2888 There is also support for merchant belt, which can be enabled if | |
| 2889 you have one available. In case your belt is not complete or is | |
| 2890 totally non-existent, the system has semi-automatic tool wielding | |
| 2891 functionality: if you use /lj and then /mine, the macros will | |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2892 automagically change to proper tools (saw -> hammer/pick). The |
| 787 | 2893 system is not perfect and sometimes it may fail, however. |
| 233 | 2894 </para> |
| 2895 | |
| 2896 <para> | |
|
1071
a728ef32c77e
Add hint to merchant module documentation about usefulness of reagent pouch module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1069
diff
changeset
|
2897 Hint: Another useful module for merchants is the |
|
a728ef32c77e
Add hint to merchant module documentation about usefulness of reagent pouch module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1069
diff
changeset
|
2898 <link linkend="usage-rpouch">reagent pouch handler</link>. It provides |
|
a728ef32c77e
Add hint to merchant module documentation about usefulness of reagent pouch module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1069
diff
changeset
|
2899 several useful functions for handling reagents. |
|
a728ef32c77e
Add hint to merchant module documentation about usefulness of reagent pouch module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1069
diff
changeset
|
2900 </para> |
|
a728ef32c77e
Add hint to merchant module documentation about usefulness of reagent pouch module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1069
diff
changeset
|
2901 |
|
a728ef32c77e
Add hint to merchant module documentation about usefulness of reagent pouch module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1069
diff
changeset
|
2902 <para> |
| 271 | 2903 Notice that you probably MUST redefine some of these |
|
249
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2904 macros and default settings in your TF configuration file! |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2905 (See <link linkend="usage-merchant-settings">Settings</link>-section below.) |
| 233 | 2906 </para> |
| 2907 | |
|
1069
1b81712b6261
Improve merchant module documentation, move things to embedded TFDocs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1065
diff
changeset
|
2908 <note><para> |
|
1b81712b6261
Improve merchant module documentation, move things to embedded TFDocs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1065
diff
changeset
|
2909 In below table: (*) = autotargets, (!) = moves items to item target |
|
1b81712b6261
Improve merchant module documentation, move things to embedded TFDocs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1065
diff
changeset
|
2910 </para></note> |
|
1b81712b6261
Improve merchant module documentation, move things to embedded TFDocs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1065
diff
changeset
|
2911 |
|
1b81712b6261
Improve merchant module documentation, move things to embedded TFDocs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1065
diff
changeset
|
2912 <!-- @commands --> |
|
1b81712b6261
Improve merchant module documentation, move things to embedded TFDocs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1065
diff
changeset
|
2913 <!-- @binds --> |
|
1b81712b6261
Improve merchant module documentation, move things to embedded TFDocs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1065
diff
changeset
|
2914 <!-- @keybinds --> |
|
249
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2915 |
| 271 | 2916 <section id="usage-merchant-settings"> |
| 2917 §variables; | |
|
249
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2918 <row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2919 <entry>mtool_mine</entry> |
| 251 | 2920 <entry>Tool(s) for mining. Example: <emphasis>/set mtool_mine=pick 1,pick 2</emphasis></entry> |
|
249
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2921 </row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2922 <row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2923 <entry>mtool_lj</entry> |
| 251 | 2924 <entry>Tool(s) for lumberjacking. Example: <emphasis>/set mtool_lj=saw</emphasis></entry> |
|
249
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2925 </row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2926 <row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2927 <entry>mtool_bs</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2928 <entry>Tool(s) for blacksmithing.</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2929 </row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2930 <row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2931 <entry>mtool_cp</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2932 <entry>Tool(s) for carpentry.</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2933 </row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2934 <row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2935 <entry>mtool_gc</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2936 <entry>Tool(s) for gem cutting.</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2937 </row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2938 <row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2939 <entry>mtool_gb</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2940 <entry>Tool(s) for glassblowing.</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2941 </row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2942 <row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2943 <entry>mtool_ma</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2944 <entry>Tool(s) for masonry.</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2945 </row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2946 <row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2947 <entry>mtool_sw</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2948 <entry>Tool(s) for sewing.</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2949 </row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2950 <row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2951 <entry>mtool_sc</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2952 <entry>Tool(s) for sculpture skill.</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2953 </row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2954 <row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2955 <entry>mforge_*</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2956 <entry>Forges/workbenches for skills (similar to mtool_* variables)</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2957 </row> |
| 271 | 2958 §variablesend; |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2959 |
|
249
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2960 |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2961 </section> |
|
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2962 |
| 248 | 2963 <!-- ================================================ --> |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2964 |
|
1376
3d73752368ae
docs: Added barebones alchemist section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1364
diff
changeset
|
2965 <section id="usage-alchemist"><title>Guild: Alchemists (gm-alchemist.tf)</title> |
|
3d73752368ae
docs: Added barebones alchemist section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1364
diff
changeset
|
2966 <para> |
|
1378
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
2967 Alchemist module provides several macros that can be very helpful with |
|
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
2968 potion making and other alchemist activities. Commands for easier handling of |
|
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
2969 herb jars and organ cans, command macro that automates potion mixing to great degree and |
|
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
2970 additional helper for potion research. |
|
1376
3d73752368ae
docs: Added barebones alchemist section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1364
diff
changeset
|
2971 </para> |
|
3d73752368ae
docs: Added barebones alchemist section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1364
diff
changeset
|
2972 |
|
1378
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
2973 <para> |
|
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
2974 Potion research is a big part of alchemist guild activities, but also one of the more |
|
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
2975 tedious ones. It requires juggling with organs, herbs and minerals, keeping book of findings, etc. |
|
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
2976 GgrTF alchemist module will come to help, as it automates getting the herb and organ from your containers, |
|
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
2977 submitting the finished potion concoction flask to authenticator and stores results in a text file. |
|
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
2978 </para> |
|
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
2979 |
|
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
2980 <para> |
|
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
2981 Furthermore, the said text file is written in a specific format, that can be used with |
|
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
2982 an external utility called AlchTool, developed by Jeskko and yours truly (Ggr). This PHP-based |
|
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
2983 web utility can greatly increase your potion research efficiency. Currently (as of March 2011) |
|
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
2984 AlchTool is in "beta"-phase of version 2, but the code can be retrieved from Pupunen Mercurial |
|
1650
e3626f2d850e
Update to new repository URLs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1645
diff
changeset
|
2985 repository at <ulink url="https://tnsp.org/hg/batmud/alchtool/">https://tnsp.org/hg/batmud/alchtool/</ulink>. |
|
1378
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
2986 </para> |
|
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
2987 |
|
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
2988 <para> |
|
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
2989 Default location of the results text file is user's home directory, in file called <emphasis>alch_results.txt</emphasis>, |
|
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
2990 but this can be changed by altering <emphasis>galch_file</emphasis> TF variable, for example: |
|
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
2991 |
|
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
2992 <userinput>/eval /set galch_file=%{HOME}/someotherfile.txt</userinput> |
|
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
2993 |
|
1380
27c5c0603192
Add note about setting galch_file variable.
Matti Hamalainen <ccr@tnsp.org>
parents:
1379
diff
changeset
|
2994 You should put this, if you wish to, in your tfrc file AFTER the loading of alchemist module. |
|
27c5c0603192
Add note about setting galch_file variable.
Matti Hamalainen <ccr@tnsp.org>
parents:
1379
diff
changeset
|
2995 </para> |
|
27c5c0603192
Add note about setting galch_file variable.
Matti Hamalainen <ccr@tnsp.org>
parents:
1379
diff
changeset
|
2996 |
|
1376
3d73752368ae
docs: Added barebones alchemist section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1364
diff
changeset
|
2997 <!-- @commands --> |
|
3d73752368ae
docs: Added barebones alchemist section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1364
diff
changeset
|
2998 <!-- @binds --> |
|
3d73752368ae
docs: Added barebones alchemist section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1364
diff
changeset
|
2999 <!-- @keybinds --> |
|
3d73752368ae
docs: Added barebones alchemist section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1364
diff
changeset
|
3000 |
|
3d73752368ae
docs: Added barebones alchemist section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1364
diff
changeset
|
3001 </section> |
|
3d73752368ae
docs: Added barebones alchemist section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1364
diff
changeset
|
3002 |
|
3d73752368ae
docs: Added barebones alchemist section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1364
diff
changeset
|
3003 <!-- ================================================ --> |
|
3d73752368ae
docs: Added barebones alchemist section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1364
diff
changeset
|
3004 |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
3005 <section id="usage-barb"><title>Guild: Barbarian (gm-barb.tf)</title> |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
3006 <para> |
| 263 | 3007 Provides a translator for barbarian reputation bar, reputation |
| 254 | 3008 difference calculator and handler for automated looting and burning. |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
3009 </para> |
|
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
3010 |
| 276 | 3011 <section> |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3012 §macros_1; |
| 271 | 3013 </para> |
|
236
11b8e0016dcb
Added some information about ggrtf-barb.tf -module
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
235
diff
changeset
|
3014 |
| 271 | 3015 <table><title>Macro commands</title> |
|
800
eeddfde43980
Fix barb module documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
787
diff
changeset
|
3016 <tgroup cols="3" align="left"> |
|
236
11b8e0016dcb
Added some information about ggrtf-barb.tf -module
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
235
diff
changeset
|
3017 <thead> |
|
11b8e0016dcb
Added some information about ggrtf-barb.tf -module
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
235
diff
changeset
|
3018 <row> |
|
800
eeddfde43980
Fix barb module documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
787
diff
changeset
|
3019 <entry>Binding</entry> |
|
eeddfde43980
Fix barb module documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
787
diff
changeset
|
3020 <entry>Macro</entry> |
|
236
11b8e0016dcb
Added some information about ggrtf-barb.tf -module
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
235
diff
changeset
|
3021 <entry>Description</entry> |
|
11b8e0016dcb
Added some information about ggrtf-barb.tf -module
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
235
diff
changeset
|
3022 </row> |
|
11b8e0016dcb
Added some information about ggrtf-barb.tf -module
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
235
diff
changeset
|
3023 </thead> |
|
11b8e0016dcb
Added some information about ggrtf-barb.tf -module
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
235
diff
changeset
|
3024 <tbody> |
|
11b8e0016dcb
Added some information about ggrtf-barb.tf -module
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
235
diff
changeset
|
3025 <row> |
|
800
eeddfde43980
Fix barb module documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
787
diff
changeset
|
3026 <entry>repu</entry> |
|
eeddfde43980
Fix barb module documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
787
diff
changeset
|
3027 <entry>/showrep</entry> |
|
314
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3028 <entry> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3029 Prints your current reputation and reputation difference |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3030 from previous invoking of the command. |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3031 </entry> |
|
236
11b8e0016dcb
Added some information about ggrtf-barb.tf -module
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
235
diff
changeset
|
3032 </row> |
|
11b8e0016dcb
Added some information about ggrtf-barb.tf -module
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
235
diff
changeset
|
3033 <row> |
|
800
eeddfde43980
Fix barb module documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
787
diff
changeset
|
3034 <entry>lb</entry> |
|
eeddfde43980
Fix barb module documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
787
diff
changeset
|
3035 <entry>/lootburn</entry> |
|
314
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3036 <entry> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3037 Starts looting and burning skill, lights a torch, waits for couple |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3038 of seconds and drops corpses from inventory. After burning the torch |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3039 is extinguished and current reputation printed out. Then action |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3040 determined by "/burnaction"-setting (see below) is executed. |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3041 If a skillbreak is detected, corpse dropping will be cancelled |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3042 immediately. |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3043 </entry> |
|
236
11b8e0016dcb
Added some information about ggrtf-barb.tf -module
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
235
diff
changeset
|
3044 </row> |
|
11b8e0016dcb
Added some information about ggrtf-barb.tf -module
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
235
diff
changeset
|
3045 <row> |
|
800
eeddfde43980
Fix barb module documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
787
diff
changeset
|
3046 <entry></entry> |
|
237
6c495ddc7d4d
forgot <action> from burnaction
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
236
diff
changeset
|
3047 <entry>/burnaction <action></entry> |
|
314
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3048 <entry> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3049 Sets the action done after finished burning. Available options are: |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3050 <emphasis>none</emphasis>, <emphasis>cash</emphasis> (drop small coins) |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3051 and <emphasis>noeq</emphasis> (drop low coins and noeq). |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3052 </entry> |
|
236
11b8e0016dcb
Added some information about ggrtf-barb.tf -module
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
235
diff
changeset
|
3053 </row> |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3054 §macros_end; |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3055 |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3056 <!-- @commands --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3057 <!-- @binds --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3058 <!-- @keybinds --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3059 |
|
236
11b8e0016dcb
Added some information about ggrtf-barb.tf -module
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
235
diff
changeset
|
3060 </section> |
|
11b8e0016dcb
Added some information about ggrtf-barb.tf -module
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
235
diff
changeset
|
3061 |
| 248 | 3062 <!-- ================================================ --> |
| 3063 | |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
3064 <section id="usage-spiders"><title>Guild: Spiders (gm-spider.tf)</title> |
|
239
34b7bb0a3395
Some info about spiders module.
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
238
diff
changeset
|
3065 <para> |
|
1065
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
3066 Provides very basic management help for spider demons, plus lites for |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
3067 spider servants. |
|
249
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
3068 </para> |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
3069 |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3070 <!-- @commands --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3071 <!-- @binds --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3072 <!-- @keybinds --> |
|
249
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
3073 |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
3074 </section> |
|
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
3075 |
| 248 | 3076 <!-- ================================================ --> |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
3077 |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
3078 <section id="usage-tiger"><title>Guild: Tigers (gm-tiger.tf)</title> |
| 841 | 3079 <para> |
| 3080 Reporting of succesful and failed 'tiger claw' hits, lites for | |
| 3081 claw and mak reputation gains. | |
| 3082 </para> | |
| 3083 | |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3084 <!-- @commands --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3085 <!-- @binds --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3086 <!-- @keybinds --> |
| 841 | 3087 |
| 3088 </section> | |
| 3089 | |
| 3090 <!-- ================================================ --> | |
| 3091 | |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
3092 <section id="usage-tarma"><title>Guild: Tarmalens (gm-tarma.tf)</title> |
| 387 | 3093 <para> |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3094 Provides command bindings for most common tarmalen spells. Triggers |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3095 for tracking latest heal alls cast (of course, only those that have |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3096 'hit' you are counted.) Optional keybindings for heals, party heals, etc. |
|
1065
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
3097 </para> |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
3098 |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
3099 <note><para> |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
3100 This module requires the generic |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
3101 <link linkend="usage-magical">magical guilds support module</link>. |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3102 The keybinds require <link linkend="usage-tgtcast">targetted cast</link> module. |
|
1065
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
3103 </para></note> |
| 387 | 3104 |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3105 <!-- @commands --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3106 <!-- @binds --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3107 <!-- @keybinds --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3108 |
| 387 | 3109 </section> |
| 3110 | |
| 3111 <!-- ================================================ --> | |
| 3112 | |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
3113 <section id="usage-druid"><title>Guild: Druids (gm-druid.tf)</title> |
| 387 | 3114 <para> |
|
394
ed989c51b94e
v0.5.11.3: Moved functionality from temp to tarmalen module and
Matti Hamalainen <ccr@tnsp.org>
parents:
393
diff
changeset
|
3115 Barebones module with default bindings for some druid spells and |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3116 support for fails/fumbles. You will probably also want to use |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3117 the <link linkend="usage-rais">raise module</link>, which provides |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3118 help for casting reincarnations (along with raises, resurrects, etc.) |
| 387 | 3119 </para> |
| 3120 | |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3121 <!-- @commands --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3122 <!-- @binds --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3123 <!-- @keybinds --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3124 |
| 387 | 3125 </section> |
| 3126 | |
| 3127 <!-- ================================================ --> | |
| 3128 | |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
3129 <section id="usage-nun"><title>Guild: Nuns (gm-nun.tf)</title> |
|
489
77c5862dd858
Removed some outdated comments concerning TF5 support.
Matti Hamalainen <ccr@tnsp.org>
parents:
454
diff
changeset
|
3130 <para> |
|
1065
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
3131 Includes several useful functions for nuns, such as relic identification messages |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
3132 translator, useful command macros, prayer hour reminder (acts as a "prot"), |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
3133 simple task status keeper, counter+lite for accomplished tasks, turn message |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
3134 translator, etc. |
|
489
77c5862dd858
Removed some outdated comments concerning TF5 support.
Matti Hamalainen <ccr@tnsp.org>
parents:
454
diff
changeset
|
3135 </para> |
|
77c5862dd858
Removed some outdated comments concerning TF5 support.
Matti Hamalainen <ccr@tnsp.org>
parents:
454
diff
changeset
|
3136 |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3137 <!-- @commands --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3138 <!-- @binds --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3139 <!-- @keybinds --> |
|
703
20f20c1e8548
Updated copyright notices; Cosmetic cleanups; Updates to documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
695
diff
changeset
|
3140 |
|
489
77c5862dd858
Removed some outdated comments concerning TF5 support.
Matti Hamalainen <ccr@tnsp.org>
parents:
454
diff
changeset
|
3141 </section> |
|
77c5862dd858
Removed some outdated comments concerning TF5 support.
Matti Hamalainen <ccr@tnsp.org>
parents:
454
diff
changeset
|
3142 |
|
77c5862dd858
Removed some outdated comments concerning TF5 support.
Matti Hamalainen <ccr@tnsp.org>
parents:
454
diff
changeset
|
3143 <!-- ================================================ --> |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
3144 |
|
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
3145 <section id="usage-loc"><title>Guild: (Old) Lords of Chaos (gm-oldloc.tf)</title> |
| 254 | 3146 <para> |
| 271 | 3147 Very barebones module with support for "blood" ripaction and |
| 3148 fail/fumble handling. | |
| 3149 </para> | |
| 3150 | |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3151 <!-- @commands --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3152 <!-- @binds --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3153 <!-- @keybinds --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3154 |
| 271 | 3155 </section> |
| 254 | 3156 |
| 230 | 3157 </chapter> |
| 3158 | |
| 3159 <!-- *************************************************************** --> | |
| 3160 | |
| 781 | 3161 <appendix id="support"><title>Support</title> |
| 259 | 3162 |
|
546
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3163 <itemizedlist> |
|
1629
be076ff19370
Remove references to bugtracker, as it has decayed due to bitrot.
Matti Hamalainen <ccr@tnsp.org>
parents:
1623
diff
changeset
|
3164 <listitem><para>There is no support. GgrTF development has been |
|
be076ff19370
Remove references to bugtracker, as it has decayed due to bitrot.
Matti Hamalainen <ccr@tnsp.org>
parents:
1623
diff
changeset
|
3165 in maintenance mode for several years. You can still report bugs |
|
be076ff19370
Remove references to bugtracker, as it has decayed due to bitrot.
Matti Hamalainen <ccr@tnsp.org>
parents:
1623
diff
changeset
|
3166 via tells or e-mail, but do not expect that they will be necessarily |
|
be076ff19370
Remove references to bugtracker, as it has decayed due to bitrot.
Matti Hamalainen <ccr@tnsp.org>
parents:
1623
diff
changeset
|
3167 acted upon. |
| 1630 | 3168 </para> |
|
546
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3169 <itemizedlist> |
| 549 | 3170 <listitem><para>Take your time to <emphasis>think</emphasis> |
| 3171 while writing, and before submitting your report. Good rule of | |
| 3172 thumb is to include all information that you think might be | |
| 3173 relevant, but no more than that! | |
|
546
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3174 </para></listitem> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3175 |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3176 <listitem><para> |
| 549 | 3177 Remember to include information about your system and environment, |
| 3178 (*NIX/Linux/Windows), version of &tfurl; ("/ver" command in TF), | |
|
943
62b1971f9772
v0.6.11.4-svn; Prompt handling improvements (enable colour lites in prompt, function execution); Handle @{} codes in /opts panel better; Many documentation updates related to prompt, and other things.
Matti Hamalainen <ccr@tnsp.org>
parents:
896
diff
changeset
|
3179 and version of GgrTF ("/gver" command). |
|
546
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3180 </para></listitem> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3181 </itemizedlist> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3182 </listitem> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3183 |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3184 <listitem><para>We do not provide support for usage, please refer |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3185 to the user's manual and only in case the issue is not documented, |
|
1681
63e789382fc6
Remove some obsolete support information, and update few bits.
Matti Hamalainen <ccr@tnsp.org>
parents:
1678
diff
changeset
|
3186 you might be eligible to ask about it. You should primarily |
|
63e789382fc6
Remove some obsolete support information, and update few bits.
Matti Hamalainen <ccr@tnsp.org>
parents:
1678
diff
changeset
|
3187 ask other GgrTF or TinyFugue users. |
|
546
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3188 </para></listitem> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3189 |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3190 <listitem><para>Neither we provide technical support for extending |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3191 GgrTF, nor documentation of the internals. You'll have to figure out |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3192 the workings yourself. |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3193 </para></listitem> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3194 |
|
1681
63e789382fc6
Remove some obsolete support information, and update few bits.
Matti Hamalainen <ccr@tnsp.org>
parents:
1678
diff
changeset
|
3195 <listitem><para>Be ready to be contacted, in case |
|
546
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3196 help and/or more information is required with debugging your issue(s). |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3197 </para></listitem> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3198 |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3199 </itemizedlist> |
|
1322
903f92f4b918
Add note about sending patches.
Matti Hamalainen <ccr@tnsp.org>
parents:
1313
diff
changeset
|
3200 |
|
903f92f4b918
Add note about sending patches.
Matti Hamalainen <ccr@tnsp.org>
parents:
1313
diff
changeset
|
3201 <section id="patches"><title>Sending patches/corrections</title> |
|
903f92f4b918
Add note about sending patches.
Matti Hamalainen <ccr@tnsp.org>
parents:
1313
diff
changeset
|
3202 <para> |
|
903f92f4b918
Add note about sending patches.
Matti Hamalainen <ccr@tnsp.org>
parents:
1313
diff
changeset
|
3203 If you have prepared a fix for some bug or a new feature, you can send us a patch. |
|
903f92f4b918
Add note about sending patches.
Matti Hamalainen <ccr@tnsp.org>
parents:
1313
diff
changeset
|
3204 <emphasis>A changeset patch made against current Mercurial repository head/tip is highly preferred</emphasis>, |
|
1323
bcfde549790f
Improve patch creation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
1322
diff
changeset
|
3205 short instructions on how to do that can be found below. You will probably need to refer to |
|
1618
2344fa8c992b
Update links to Mercurial website.
Matti Hamalainen <ccr@tnsp.org>
parents:
1614
diff
changeset
|
3206 <ulink url="http://www.mercurial-scm.org/guide/">Mercurial guide</ulink> for generic |
|
1681
63e789382fc6
Remove some obsolete support information, and update few bits.
Matti Hamalainen <ccr@tnsp.org>
parents:
1678
diff
changeset
|
3207 Mercurial usage instructions and how to set it up. |
|
1322
903f92f4b918
Add note about sending patches.
Matti Hamalainen <ccr@tnsp.org>
parents:
1313
diff
changeset
|
3208 </para> |
|
903f92f4b918
Add note about sending patches.
Matti Hamalainen <ccr@tnsp.org>
parents:
1313
diff
changeset
|
3209 </section> |
|
903f92f4b918
Add note about sending patches.
Matti Hamalainen <ccr@tnsp.org>
parents:
1313
diff
changeset
|
3210 |
| 781 | 3211 </appendix> |
| 259 | 3212 |
| 3213 <!-- ================================================ --> | |
| 3214 | |
| 781 | 3215 <appendix id="faq"><title>Frequently Asked Questions (FAQ)</title> |
| 259 | 3216 <qandaset> |
| 3217 <qandaentry> | |
| 3218 <question> | |
| 270 | 3219 <para>Is "Grizzt" included in the documentation?</para> |
| 3220 </question> | |
| 3221 <answer> | |
| 3222 <para>Unfortunately no. Grizzt may be included in some future version, though.</para> | |
| 3223 </answer> | |
| 3224 </qandaentry> | |
|
314
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3225 |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3226 <qandaentry> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3227 <question> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3228 <para>When will next version of GgrTF be released?</para> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3229 </question> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3230 <answer> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3231 <para>"When it's done."</para> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3232 </answer> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3233 </qandaentry> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3234 |
|
331
806a7cf5e8de
Add FAQ entry about gagging of round flag.
Matti Hamalainen <ccr@tnsp.org>
parents:
327
diff
changeset
|
3235 |
|
806a7cf5e8de
Add FAQ entry about gagging of round flag.
Matti Hamalainen <ccr@tnsp.org>
parents:
327
diff
changeset
|
3236 <qandaentry> |
|
806a7cf5e8de
Add FAQ entry about gagging of round flag.
Matti Hamalainen <ccr@tnsp.org>
parents:
327
diff
changeset
|
3237 <question> |
|
546
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3238 <para>How to get rid of the battle round flag/marker?</para> |
|
331
806a7cf5e8de
Add FAQ entry about gagging of round flag.
Matti Hamalainen <ccr@tnsp.org>
parents:
327
diff
changeset
|
3239 </question> |
|
806a7cf5e8de
Add FAQ entry about gagging of round flag.
Matti Hamalainen <ccr@tnsp.org>
parents:
327
diff
changeset
|
3240 <answer> |
|
806a7cf5e8de
Add FAQ entry about gagging of round flag.
Matti Hamalainen <ccr@tnsp.org>
parents:
327
diff
changeset
|
3241 <para> |
|
978
dc8ee5ec3c66
Add @@ to some command examples, because apparently SOME players have aliased these essential BatMUD commands to something else.
Matti Hamalainen <ccr@tnsp.org>
parents:
972
diff
changeset
|
3242 The BatMUD battle round marker (long line of asterisks "*") is required for |
|
dc8ee5ec3c66
Add @@ to some command examples, because apparently SOME players have aliased these essential BatMUD commands to something else.
Matti Hamalainen <ccr@tnsp.org>
parents:
972
diff
changeset
|
3243 GgrTF's internal functionality, but you can gag it with following piece of |
|
546
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3244 code (add it to your .tfrc or similar): |
|
331
806a7cf5e8de
Add FAQ entry about gagging of round flag.
Matti Hamalainen <ccr@tnsp.org>
parents:
327
diff
changeset
|
3245 </para> |
|
806a7cf5e8de
Add FAQ entry about gagging of round flag.
Matti Hamalainen <ccr@tnsp.org>
parents:
327
diff
changeset
|
3246 <screen> |
| 345 | 3247 /test prlist_insert("event_battle_round", "myroundgag") |
| 3248 /def -i myroundgag = /substitute -ag | |
|
331
806a7cf5e8de
Add FAQ entry about gagging of round flag.
Matti Hamalainen <ccr@tnsp.org>
parents:
327
diff
changeset
|
3249 </screen> |
|
806a7cf5e8de
Add FAQ entry about gagging of round flag.
Matti Hamalainen <ccr@tnsp.org>
parents:
327
diff
changeset
|
3250 <para> |
|
806a7cf5e8de
Add FAQ entry about gagging of round flag.
Matti Hamalainen <ccr@tnsp.org>
parents:
327
diff
changeset
|
3251 The first line adds macro "myroundgag" to be executed on each round marker, |
|
806a7cf5e8de
Add FAQ entry about gagging of round flag.
Matti Hamalainen <ccr@tnsp.org>
parents:
327
diff
changeset
|
3252 the second line defines that macro and sets it to gag the round marker. |
|
806a7cf5e8de
Add FAQ entry about gagging of round flag.
Matti Hamalainen <ccr@tnsp.org>
parents:
327
diff
changeset
|
3253 </para> |
|
806a7cf5e8de
Add FAQ entry about gagging of round flag.
Matti Hamalainen <ccr@tnsp.org>
parents:
327
diff
changeset
|
3254 </answer> |
|
806a7cf5e8de
Add FAQ entry about gagging of round flag.
Matti Hamalainen <ccr@tnsp.org>
parents:
327
diff
changeset
|
3255 </qandaentry> |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
3256 |
|
381
6af6df52fefd
v0.5.11.2: Removed tick predictor, it wasn't working anyway;
Matti Hamalainen <ccr@tnsp.org>
parents:
379
diff
changeset
|
3257 |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
3258 <qandaentry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
3259 <question> |
|
1448
8d07f07bd72b
Clarify in the BatMUD configuration / setup section that "sc" should be turned on.
Matti Hamalainen <ccr@tnsp.org>
parents:
1443
diff
changeset
|
3260 <para>My statusline is not updating, why? (HP/SP/EP values not updating)</para> |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
3261 </question> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
3262 <answer> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
3263 <para> |
|
1448
8d07f07bd72b
Clarify in the BatMUD configuration / setup section that "sc" should be turned on.
Matti Hamalainen <ccr@tnsp.org>
parents:
1443
diff
changeset
|
3264 Maybe you haven't set up your 'short score' or 'prompt' in BatMUD or there is some |
|
8d07f07bd72b
Clarify in the BatMUD configuration / setup section that "sc" should be turned on.
Matti Hamalainen <ccr@tnsp.org>
parents:
1443
diff
changeset
|
3265 typo in the setting. See <link linkend="inst-config-batmud">setup-section</link> |
| 1449 | 3266 for how to do that properly. If you wish that 'sc' line to not be visible, you can turn on '/gagsc' option. |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
3267 </para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
3268 </answer> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
3269 </qandaentry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
3270 |
| 392 | 3271 <qandaentry> |
| 3272 <question> | |
| 3273 <para>How can I get my settings saved automatically? Or can I?</para> | |
| 3274 </question> | |
| 3275 <answer> | |
|
454
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3276 <para>Automatic saving and loading is possible, please refer to |
| 392 | 3277 <link linkend="usage-general-saves">state-saving</link> |
|
956
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
3278 and <link linkend="inst-config-tf">setup</link> -sections of |
| 392 | 3279 this manual for more information. |
| 3280 </para> | |
| 3281 </answer> | |
| 3282 </qandaentry> | |
|
454
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3283 |
|
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3284 <qandaentry> |
|
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3285 <question> |
|
546
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3286 <para>A spell/prot cast by others at me registers in prot-reporting, |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3287 but does not work when I cast it on myself!</para> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3288 </question> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3289 <answer> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3290 <para> |
|
1629
be076ff19370
Remove references to bugtracker, as it has decayed due to bitrot.
Matti Hamalainen <ccr@tnsp.org>
parents:
1623
diff
changeset
|
3291 This is most likely a bug, please report the issue via e-mail. |
|
be076ff19370
Remove references to bugtracker, as it has decayed due to bitrot.
Matti Hamalainen <ccr@tnsp.org>
parents:
1623
diff
changeset
|
3292 Remember to include the lines you get when you |
|
546
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3293 cast the spell on yourself (aka the "prot goes up"-line). |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3294 </para> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3295 <para> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3296 Also see the next question below. |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3297 </para> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3298 </answer> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3299 </qandaentry> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3300 |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3301 <qandaentry> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3302 <!-- |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3303 <question> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3304 <para>Some prots do not register / are not noticed by GgrTF</para> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3305 </question> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3306 --> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3307 <question> |
|
454
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3308 <para>Sometimes the <link linkend="usage-spellnames"> |
|
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3309 spellword translator</link> does not work, what gives?</para> |
|
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3310 </question> |
|
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3311 <answer> |
|
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3312 <para>Your 'cutter'-setting might be too small, the default |
|
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3313 in BatMUD is 80, which adds hard linefeeds too early on a line, |
|
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3314 thus breaking many triggers of GgrTF, including GgrTF::Spellnames |
|
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3315 module. 'cutter 9999' or 'cutter off' should fix this problem. |
|
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3316 </para> |
|
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3317 |
|
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3318 <para>Please refer to <link linkend="inst-config-batmud"> |
|
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3319 BatMUD settings</link> -section of this manual for correct |
|
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3320 in-game settings. |
|
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3321 </para> |
|
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3322 </answer> |
|
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3323 </qandaentry> |
|
546
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3324 |
|
642
1be950a666af
Added note about TF5 module requiring 5.0 beta 7 or later.
Matti Hamalainen <ccr@tnsp.org>
parents:
638
diff
changeset
|
3325 <qandaentry> |
|
1be950a666af
Added note about TF5 module requiring 5.0 beta 7 or later.
Matti Hamalainen <ccr@tnsp.org>
parents:
638
diff
changeset
|
3326 <question> |
|
1be950a666af
Added note about TF5 module requiring 5.0 beta 7 or later.
Matti Hamalainen <ccr@tnsp.org>
parents:
638
diff
changeset
|
3327 <para>The <link linkend="usage-tf5">TF5 module</link> does not work! I am |
|
1be950a666af
Added note about TF5 module requiring 5.0 beta 7 or later.
Matti Hamalainen <ccr@tnsp.org>
parents:
638
diff
changeset
|
3328 using TF 5.0 beta 6 or older.</para> |
|
1be950a666af
Added note about TF5 module requiring 5.0 beta 7 or later.
Matti Hamalainen <ccr@tnsp.org>
parents:
638
diff
changeset
|
3329 </question> |
|
1be950a666af
Added note about TF5 module requiring 5.0 beta 7 or later.
Matti Hamalainen <ccr@tnsp.org>
parents:
638
diff
changeset
|
3330 <answer> |
|
1be950a666af
Added note about TF5 module requiring 5.0 beta 7 or later.
Matti Hamalainen <ccr@tnsp.org>
parents:
638
diff
changeset
|
3331 <para> |
|
1be950a666af
Added note about TF5 module requiring 5.0 beta 7 or later.
Matti Hamalainen <ccr@tnsp.org>
parents:
638
diff
changeset
|
3332 The functionality used by the TF5 module was introduced in TF 5.0 beta 7, |
|
1be950a666af
Added note about TF5 module requiring 5.0 beta 7 or later.
Matti Hamalainen <ccr@tnsp.org>
parents:
638
diff
changeset
|
3333 so you need to have that or a later version. |
|
1be950a666af
Added note about TF5 module requiring 5.0 beta 7 or later.
Matti Hamalainen <ccr@tnsp.org>
parents:
638
diff
changeset
|
3334 </para> |
|
1be950a666af
Added note about TF5 module requiring 5.0 beta 7 or later.
Matti Hamalainen <ccr@tnsp.org>
parents:
638
diff
changeset
|
3335 </answer> |
|
1be950a666af
Added note about TF5 module requiring 5.0 beta 7 or later.
Matti Hamalainen <ccr@tnsp.org>
parents:
638
diff
changeset
|
3336 </qandaentry> |
|
1529
74fe408138cc
Add an FAQ item about numpad/keypad problems.
Matti Hamalainen <ccr@tnsp.org>
parents:
1526
diff
changeset
|
3337 |
|
74fe408138cc
Add an FAQ item about numpad/keypad problems.
Matti Hamalainen <ccr@tnsp.org>
parents:
1526
diff
changeset
|
3338 <qandaentry> |
|
74fe408138cc
Add an FAQ item about numpad/keypad problems.
Matti Hamalainen <ccr@tnsp.org>
parents:
1526
diff
changeset
|
3339 <question> |
|
74fe408138cc
Add an FAQ item about numpad/keypad problems.
Matti Hamalainen <ccr@tnsp.org>
parents:
1526
diff
changeset
|
3340 <para>The keypad/numpad functionality (movement, targetting) is not working.</para> |
|
74fe408138cc
Add an FAQ item about numpad/keypad problems.
Matti Hamalainen <ccr@tnsp.org>
parents:
1526
diff
changeset
|
3341 </question> |
|
74fe408138cc
Add an FAQ item about numpad/keypad problems.
Matti Hamalainen <ccr@tnsp.org>
parents:
1526
diff
changeset
|
3342 <answer> |
|
1539
78268db92315
Oops, a missing para-tag. Fixed.
Matti Hamalainen <ccr@tnsp.org>
parents:
1538
diff
changeset
|
3343 <para> |
|
1538
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
3344 Make sure you have configured your terminal correctly, |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
3345 refer to <link linkend="inst-config-tf-term">terminal configuration</link> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
3346 section for more information. |
|
1539
78268db92315
Oops, a missing para-tag. Fixed.
Matti Hamalainen <ccr@tnsp.org>
parents:
1538
diff
changeset
|
3347 </para> |
|
1529
74fe408138cc
Add an FAQ item about numpad/keypad problems.
Matti Hamalainen <ccr@tnsp.org>
parents:
1526
diff
changeset
|
3348 </answer> |
|
74fe408138cc
Add an FAQ item about numpad/keypad problems.
Matti Hamalainen <ccr@tnsp.org>
parents:
1526
diff
changeset
|
3349 </qandaentry> |
| 270 | 3350 <!-- |
| 3351 <qandaentry> | |
| 3352 <question> | |
| 259 | 3353 <para></para> |
| 3354 </question> | |
| 3355 <answer> | |
| 3356 <para> | |
| 3357 </para> | |
| 3358 </answer> | |
| 3359 </qandaentry> | |
| 270 | 3360 --> |
| 3361 </qandaset> | |
| 781 | 3362 |
| 3363 </appendix> | |
| 259 | 3364 |
|
772
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3365 <!-- ================================================ --> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3366 |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3367 <appendix id="app-verify-sig"><title>How to verify package signatures via |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3368 GnuPG</title> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3369 <para> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3370 If you wish, you may verify the tarball package signatures with GnuPG, |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3371 in case you want to be sure that you are getting unmodified files directly |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3372 from the upstream. To do that, use the following commands: |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3373 </para> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3374 |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3375 <itemizedlist> |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
3376 <listitem> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
3377 <para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
3378 Retrieve Matti Hämäläinen's public key from a keyserver: |
| 1572 | 3379 <userinput>gpg --keyserver wwwkeys.pgp.net --recv-keys 0x307BAAE3</userinput> |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
3380 </para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
3381 </listitem> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
3382 <listitem> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
3383 <para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
3384 Verify the package signature (assuming you have downloaded both the file and signature): |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
3385 <userinput>gpg --verify ggrtf-&ggrtfver;.tar.gz.asc</userinput> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
3386 If the data is untampered, you should get a result like 'gpg: Good |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
3387 signature from "Matti Hamalainen (ccr) <ccr@tnsp.org>"' |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
3388 </para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
3389 </listitem> |
|
772
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3390 </itemizedlist> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3391 |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3392 <para> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3393 Please refer to GnuPG or PGP documentation for more information about |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3394 their usage. A great introduction to PKI, cryptography and public key |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3395 signing, the <ulink url="http://www.gnupg.org/gph/en/manual.html"> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3396 GNU Privacy Handbook</ulink> is available from GnuPG project. |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3397 (Versions in other languages and formats, including PDF, are available |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3398 from <ulink url="http://www.gnupg.org/documentation/guides.en.html"> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3399 http://www.gnupg.org/documentation/guides.en.html</ulink>.) |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3400 </para> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3401 </appendix> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3402 |
| 223 | 3403 </book> |