Mercurial > hg > batmud > ggrtf
annotate docs/manual.sgml @ 1650:e3626f2d850e
Update to new repository URLs.
| author | Matti Hamalainen <ccr@tnsp.org> |
|---|---|
| date | Fri, 12 Mar 2021 14:38:04 +0200 |
| parents | 4e4498b4558c |
| children | 86f3d10eafec |
| 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 |
| 1638 | 3 <!ENTITY ggrtfver "0.7.4.1"> |
| 1060 | 4 <!ENTITY finger "<ulink url='http://www.bat.org/char/$1'>$1</ulink>"> |
| 5 <!ENTITY jeskko "<ulink url='http://jeskko.pupunen.net/'>Jarkko Vääräniemi</ulink> (&finger Jeskko;)"> | |
| 6 <!ENTITY ggr "<ulink url='http://tnsp.org/~ccr/'>Matti Hämäläinen</ulink> (&finger Ggr;)"> | |
| 714 | 7 <!ENTITY tfurl "<ulink url='http://tinyfugue.sf.net/'>TinyFugue</ulink>"> |
|
1039
f8b0688f9a36
Update some URLs in manual.
Matti Hamalainen <ccr@tnsp.org>
parents:
1011
diff
changeset
|
8 <!ENTITY homeurl "<ulink url='http://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>"> |
|
1618
2344fa8c992b
Update links to Mercurial website.
Matti Hamalainen <ccr@tnsp.org>
parents:
1614
diff
changeset
|
11 <!ENTITY hgurl "<ulink url='http://www.mercurial-scm.org/'>Mercurial</ulink>"> |
| 275 | 12 <!ENTITY batmudurl "<ulink url='http://www.bat.org/'>BatMUD</ulink>"> |
|
1343
aa5e08538992
Update Mercurial repo URLs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1340
diff
changeset
|
13 <!ENTITY pupuneturl "<ulink url='http://pupunen.net/'>pupunen.net</ulink>"> |
| 275 | 14 <!ENTITY gnupgurl "<ulink url='http://www.gnupg.org/'>GnuPG</ulink>"> |
| 15 | |
| 841 | 16 <!ENTITY exampletfrc SYSTEM "../example-tfrc.txt"> |
|
249
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
17 <!ENTITY validval "Valid values:"> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
18 <!ENTITY validonoff "<emphasis>on</emphasis>, <emphasis>off</emphasis>"> |
| 232 | 19 |
| 271 | 20 <!ENTITY colourexplanation " |
| 21 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
|
22 see due to differences in terminal emulation programs and settings. |
| 271 | 23 "> |
| 24 | |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
25 <!ENTITY sectmacros_1 "<title>Macro commands</title> |
| 271 | 26 <para><> = required argument, [] = optional argument"> |
| 27 | |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
28 <!ENTITY sectmacros_2 "<section> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
29 <title>Macro commands</title> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
30 <para><> = required argument, [] = optional argument</para> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
31 <table><title>Macro commands</title> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
32 <tgroup cols='2' align='left'> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
33 <thead> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
34 <row> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
35 <entry>Command</entry> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
36 <entry>Description</entry> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
37 </row> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
38 </thead> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
39 <tbody>"> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
40 |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
41 <!ENTITY sectmacros_end "</tbody> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
42 </tgroup> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
43 </table> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
44 </section> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
45 "> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
46 |
| 271 | 47 <!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
|
48 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
|
49 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
|
50 re-set/re-define them after loading the module. Please refer to |
| 404 | 51 <link linkend='inst-config'>Setup</link>-section of this manual |
| 271 | 52 or see the example configuration for this module. |
| 53 "> | |
| 54 | |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
55 <!ENTITY sectvariables " |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
56 <title>Settings and user-replaceable macros</title> |
| 271 | 57 <para> |
| 58 ¶variables; | |
| 59 </para> | |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
60 |
| 271 | 61 <table><title></title> |
| 62 <tgroup cols='2' align='left'> | |
| 63 <thead> | |
| 64 <row> | |
| 65 <entry>Variable / macro name</entry> | |
| 66 <entry>Description</entry> | |
| 67 </row> | |
| 68 </thead> | |
| 69 <tbody> | |
| 70 "> | |
| 71 | |
| 72 <!ENTITY sectvariablesend " | |
| 73 </tbody> | |
| 74 </tgroup> | |
| 75 </table> | |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
76 </section> |
| 271 | 77 "> |
| 251 | 78 |
|
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
|
79 --> |
| 223 | 80 <book> |
| 81 <bookinfo> | |
| 1052 | 82 <title>The GgrTF v&ggrtfver; User's Guide</title> |
| 226 | 83 <authorgroup> |
|
620
b51e42467f2c
Character set conversion ISO-8859-1 -> UTF-8
Matti Hamalainen <ccr@tnsp.org>
parents:
618
diff
changeset
|
84 <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
|
85 <author><firstname>Jarkko</firstname><surname>Vääräniemi</surname></author> |
| 226 | 86 </authorgroup> |
| 223 | 87 <copyright> |
| 1645 | 88 <year>2006-2021</year> |
|
620
b51e42467f2c
Character set conversion ISO-8859-1 -> UTF-8
Matti Hamalainen <ccr@tnsp.org>
parents:
618
diff
changeset
|
89 <holder>Matti Hämäläinen (Ggr Pupunen)</holder> |
| 223 | 90 </copyright> |
| 1645 | 91 <pubdate>2021</pubdate> |
| 223 | 92 |
| 93 <legalnotice> | |
| 94 <para> | |
| 248 | 95 This document is distributed under |
|
1072
c68c152728d8
Upgrade CC-SA license from 2.5 to version 3.0.
Matti Hamalainen <ccr@tnsp.org>
parents:
1071
diff
changeset
|
96 <ulink url="http://creativecommons.org/licenses/by-sa/3.0/">Creative Commons Attribution-Share Alike 3.0 license</ulink>, |
|
c68c152728d8
Upgrade CC-SA license from 2.5 to version 3.0.
Matti Hamalainen <ccr@tnsp.org>
parents:
1071
diff
changeset
|
97 of which full version can be found from <ulink url="http://creativecommons.org/licenses/by-sa/3.0/legalcode">Creative Commons website</ulink>. |
| 223 | 98 </para> |
| 99 | |
| 100 <para> | |
| 248 | 101 THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE |
| 102 COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY | |
| 103 COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS | |
| 104 AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED. | |
| 223 | 105 </para> |
| 106 | |
| 107 <para> | |
| 248 | 108 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
|
109 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
|
110 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
|
111 HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS. |
| 223 | 112 </para> |
| 113 </legalnotice> | |
| 114 </bookinfo> | |
| 115 | |
| 226 | 116 <!-- *************************************************************** --> |
| 223 | 117 |
| 226 | 118 <chapter id="preface"><title>Preface</title> |
| 223 | 119 |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
120 <section id="whatisggrtf"><title>What is GgrTF?</title> |
| 233 | 121 |
| 223 | 122 <para> |
|
567
82a3def121a8
Updated intro, hopefully now in better linguistic form.
Matti Hamalainen <ccr@tnsp.org>
parents:
555
diff
changeset
|
123 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
|
124 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
|
125 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
|
126 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
|
127 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
|
128 GgrTF from most other publicly available scripts. |
| 223 | 129 </para> |
| 130 | |
| 131 <para> | |
| 862 | 132 GgrTF is being developed for TF5 of &tfurl; MUD client under Linux |
| 133 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
|
134 systems, but there are several who run TF under Microsoft Windows |
| 862 | 135 operating system. Version 0.6.9.15 was the last that supported TF4. |
| 248 | 136 </para> |
| 137 | |
| 138 <para> | |
|
669
dda12c2548c8
Updated history and some other small things.
Matti Hamalainen <ccr@tnsp.org>
parents:
642
diff
changeset
|
139 The current version (as of v&ggrtfver; release) has modules |
| 226 | 140 for following character classes: |
| 230 | 141 </para> |
| 142 <itemizedlist> | |
| 711 | 143 <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> |
| 144 <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> | |
| 145 <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> | |
| 146 <listitem><para><link linkend="usage-barb">Barbarians</link> (<ulink url="http://www.bat.org/help/guilds?str=Barbarian+Guild">Barbarian Guild</ulink>)</para></listitem> | |
| 147 <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> | |
| 148 <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> | |
| 149 <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> | |
| 150 <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 | 151 <listitem><para><link linkend="usage-spiders">Spiders</link></para></listitem> |
| 152 <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
|
153 <listitem><para><link linkend="usage-alchemist">Alchemists</link></para></listitem> |
| 230 | 154 </itemizedlist> |
| 155 | |
| 156 <para> | |
| 248 | 157 In non-guild related sense, GgrTF has most of the basics expected from |
| 254 | 158 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
|
159 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
|
160 <link linkend="usage-magical">spell</link>-handling, way to |
| 254 | 161 easily <link linkend="usage-general-commands">run commands on each battle round</link> |
| 841 | 162 (and more), plus following special modules: |
| 226 | 163 </para> |
| 164 | |
| 841 | 165 <itemizedlist> |
| 166 <listitem><para><link linkend="usage-pssmangle">'pss'-output mangler</link></para></listitem> | |
| 167 <listitem><para><link linkend="usage-hstats">Hit statistics counter</link></para></listitem> | |
| 168 <listitem><para><link linkend="usage-spellnames">Spellchants to names translator</link></para></listitem> | |
| 169 <listitem><para><link linkend="usage-pplacer">Party member autoplacer</link></para></listitem> | |
| 170 <listitem><para><link linkend="usage-ptracker">Party prot tracker</link></para></listitem> | |
| 171 <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
|
172 <listitem><para><link linkend="usage-identify">Identify spell beautifier</link></para></listitem> |
| 841 | 173 </itemizedlist> |
| 174 | |
| 175 <para> | |
| 176 And more ... | |
| 177 </para> | |
| 223 | 178 </section> |
| 179 | |
| 254 | 180 <!-- ================================================ --> |
| 223 | 181 |
| 226 | 182 <section id="isggrtfforme"><title>Is GgrTF for Me?</title> |
| 223 | 183 <para> |
| 841 | 184 It is impossible to tell for certain, really. If you are averse |
| 185 of doing some digging of your own, or adjusting some trigger code, | |
| 186 it may not be. GgrTF is meant to work as a "platform" and a base, | |
| 187 not as a complete bells and whistles-type solution. | |
| 188 In the end, you may have just to give it a try. | |
| 555 | 189 </para> |
| 190 | |
| 191 <para> | |
| 192 When I started working on GgrTF, | |
| 193 I was just "scratching an itch", and that itch still continues, | |
| 194 though few others have joined my efforts on scratching. | |
| 254 | 195 During the two years I have been developing GgrTF, most of that |
| 555 | 196 time I've been scratching my own back, doing stuff mostly for myself. |
| 284 | 197 Thus, if you like the design decisions and features I like, |
| 198 play the same guilds as I (though some guilds which I haven't | |
| 555 | 199 ever touched are supported through efforts of other developers) |
| 200 it is likely that you will like GgrTF. | |
| 284 | 201 </para> |
| 202 | |
| 203 <para> | |
| 555 | 204 Also GgrTF is not all that well documented (although that is one |
| 205 thing we are trying remedy) and <emphasis>requires basic knowledge of | |
| 206 how &tfurl;</emphasis> and its macro language works. As such GgrTF | |
| 207 is not a ready out-of-the-box experience for some users and never | |
| 208 will be. <emphasis>However, if you are able to crank it up and working, | |
| 209 and are content with what is readily offered, then it might be something | |
| 210 for you.</emphasis> | |
| 211 </para> | |
| 212 | |
| 213 <para> | |
| 254 | 214 All in all, GgrTF <emphasis>might</emphasis> be something for you, |
| 215 especially if you like things the way I like them. But on the other | |
| 216 hand GgrTF might not be for you, and there are several alternatives | |
| 217 out there for those who do not find it satisfactory. Below I have | |
| 218 tried to list some pros and cons of using GgrTF. | |
| 230 | 219 </para> |
| 284 | 220 |
| 230 | 221 <itemizedlist> |
| 222 <listitem><para>Pros:</para> | |
| 223 <itemizedlist> | |
| 224 <listitem><para>Good general quality of code. As somebody put it, | |
| 233 | 225 "you do not instantly get a headache from just looking at the code."</para></listitem> |
| 226 <listitem><para>Modularity, easily extendable for most part.</para></listitem> | |
| 254 | 227 <listitem><para>Updated regularly, most bugs get fixed in upstream.</para></listitem> |
| 275 | 228 <listitem><para>User-level documentation exists.</para></listitem> |
| 230 | 229 </itemizedlist> |
| 230 </listitem> | |
| 231 | |
| 232 <listitem><para>Cons:</para> | |
| 233 <itemizedlist> | |
| 275 | 234 <listitem><para>Only small number of &batmudurl;'s guilds are specifically supported.</para></listitem> |
| 695 | 235 <listitem><para>Requires bit more programming knowledge than some other solutions.</para></listitem> |
| 392 | 236 <listitem><para>Due to nature of the developer's reincs, is biased |
| 237 towards caster-type functionality than tanks. Thus the support for tank | |
| 695 | 238 guilds is not very good, although some guilds are supported.</para></listitem> |
| 230 | 239 </itemizedlist> |
| 240 </listitem> | |
| 241 | |
| 242 </itemizedlist> | |
| 243 </section> | |
| 244 | |
| 254 | 245 <!-- ================================================ --> |
| 232 | 246 |
| 230 | 247 <section id="ggrtfhistory"><title>History of GgrTF</title> |
| 265 | 248 <subtitle>As told by Ggr</subtitle> |
| 249 | |
| 230 | 250 <para> |
| 841 | 251 <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
|
252 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
|
253 |
| 265 | 254 I never thought of myself to be much of a gamer, I've always |
| 255 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
|
256 and a little bit of digital electronics and hardware, so |
| 265 | 257 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
|
258 Nethack and some CRPGs like Fallout. I guess the RPG statmania |
| 265 | 259 was one reason that got me hooked in the first place, plus |
| 260 the multiplayer interaction and social aspects. | |
| 261 </para> | |
| 262 | |
| 263 <para> | |
|
1202
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
264 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
|
265 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
|
266 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
|
267 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
|
268 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
|
269 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
|
270 At least I felt so back then. |
| 265 | 271 </para> |
| 272 | |
| 273 <para> | |
|
1202
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
274 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
|
275 automating certain things became apparent. I researched some of |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
276 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
|
277 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
|
278 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
|
279 but as usual, they only shared inside small circles of their own. |
| 265 | 280 </para> |
| 281 | |
| 282 <para> | |
|
1202
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
283 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
|
284 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
|
285 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
|
286 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
|
287 on my &batmudurl; related web-page. |
| 223 | 288 </para> |
| 265 | 289 |
| 290 <para> | |
|
1202
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
291 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
|
292 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
|
293 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
|
294 after which some bigger changes were made and 0.4.0 was released. |
| 265 | 295 </para> |
| 296 | |
| 297 <para> | |
|
1202
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
298 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
|
299 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
|
300 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
|
301 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
|
302 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
|
303 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
|
304 </para> |
|
dda12c2548c8
Updated history and some other small things.
Matti Hamalainen <ccr@tnsp.org>
parents:
642
diff
changeset
|
305 |
|
dda12c2548c8
Updated history and some other small things.
Matti Hamalainen <ccr@tnsp.org>
parents:
642
diff
changeset
|
306 <para> |
|
1202
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
307 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
|
308 expected, there were literally dozens of internal version landmarks |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
309 (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
|
310 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
|
311 |
|
8930a7bf1229
Clean up the history section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1166
diff
changeset
|
312 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
|
313 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
|
314 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
|
315 on few features. |
| 265 | 316 </para> |
| 317 | |
| 223 | 318 </section> |
| 319 | |
| 254 | 320 <!-- ================================================ --> |
| 232 | 321 |
| 322 <section id="license"><title>GgrTF License</title> | |
| 323 <para> | |
| 392 | 324 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
|
325 by Matti Hämäläinen (aka Ggr Pupunen) and |
| 232 | 326 distributed under the GNU General Public License version 2. |
| 327 </para> | |
| 328 | |
| 329 <para> | |
| 330 Complete text of the GNU GPL v2 is included with the code in a file | |
| 331 called COPYING.txt, and is also available | |
| 254 | 332 <ulink url="http://www.gnu.org/licenses/gpl.html">here</ulink>. |
| 232 | 333 </para> |
| 334 </section> | |
| 335 | |
| 223 | 336 </chapter> |
| 337 | |
| 226 | 338 <!-- *************************************************************** --> |
| 339 | |
| 340 <chapter id="installation"><title>Installation</title> | |
| 341 <para> | |
| 275 | 342 This chapter assumes that you have already succesfully installed &tfurl; |
| 343 in your system and you know how to use it (basic commands, loading of | |
| 344 macros, etc.) It is also assumed that you know how to use your operating | |
| 345 system of choice, be it some flavour of UNIX or Windows, although some | |
| 346 parts of the instructions are given in step-by-step manner. | |
| 226 | 347 </para> |
| 348 | |
|
421
17df1b70f898
Added note about tf/-directory being used in examples.
Matti Hamalainen <ccr@tnsp.org>
parents:
418
diff
changeset
|
349 <note> |
|
17df1b70f898
Added note about tf/-directory being used in examples.
Matti Hamalainen <ccr@tnsp.org>
parents:
418
diff
changeset
|
350 <para> |
|
17df1b70f898
Added note about tf/-directory being used in examples.
Matti Hamalainen <ccr@tnsp.org>
parents:
418
diff
changeset
|
351 Throughout this manual, when GgrTF files are referenced in configuration |
| 783 | 352 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
|
353 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
|
354 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
|
355 files in. |
|
421
17df1b70f898
Added note about tf/-directory being used in examples.
Matti Hamalainen <ccr@tnsp.org>
parents:
418
diff
changeset
|
356 </para> |
|
17df1b70f898
Added note about tf/-directory being used in examples.
Matti Hamalainen <ccr@tnsp.org>
parents:
418
diff
changeset
|
357 </note> |
|
17df1b70f898
Added note about tf/-directory being used in examples.
Matti Hamalainen <ccr@tnsp.org>
parents:
418
diff
changeset
|
358 |
| 404 | 359 <para> |
| 360 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
|
361 the Mercurial-repository. Releases are considered as stable snapshots, |
| 275 | 362 which should be relatively bug-free, but releases are done somewhat |
| 281 | 363 infrequently and at least in this phase we don't backport bugfixes to |
| 364 release versions. | |
| 267 | 365 </para> |
|
956
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
366 |
|
772
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
367 <para> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
368 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
|
369 </para> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
370 |
|
956
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
371 |
|
772
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
372 <section id="inst-releases"><title>Releases</title> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
373 <para> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
374 To get the latest stable version, head to the downloads-section of |
| 1535 | 375 <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
|
376 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
|
377 </para> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
378 <itemizedlist> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
379 <listitem> |
|
1538
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
380 <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
|
381 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
|
382 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
|
383 </listitem> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
384 <listitem> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
385 <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
|
386 have been converted to CRLF line endings.)</para> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
387 </listitem> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
388 </itemizedlist> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
389 <para> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
390 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
|
391 (*.asc), which can be used to cryptographically |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
392 <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
|
393 </para> |
| 1574 | 394 <para> |
| 395 To "install" the package, you simply unpack it to appropriate directory, | |
| 396 typically under your home directory. Under UNIX-style system: | |
| 397 </para> | |
| 398 | |
| 399 <userinput>cd $HOME</userinput> | |
| 400 <userinput>tar xzvf ggrtf-&ggrtfver;.tar.gz</userinput> | |
| 401 | |
|
772
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
402 |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
403 <para> |
| 1574 | 404 After that, you should have directory $HOME/ggrtf/ with all the *.tf files in it. |
| 405 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
|
406 </para> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
407 |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
408 </section> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
409 |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
410 |
| 1346 | 411 <section id="inst-mercurial"><title>Development version</title> |
| 267 | 412 <para> |
| 275 | 413 Another way to get GgrTF is to go to the very source, the |
| 414 development source repository. This repository contains the latest | |
| 415 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
|
416 are directly committed by developers almost in real time, |
| 275 | 417 sometimes what you download may be severely broken. |
| 418 Also the documentation will not be updated for every little change, | |
| 419 so you may have to figure out and work around possible backward | |
| 420 incompatibilities yourself. | |
| 421 </para> | |
| 422 | |
| 423 <para> | |
| 1346 | 424 New features and bugfixes may sometimes be worth taking the risk. |
| 670 | 425 On the other hand, it is all up to what you want and whether you can |
| 426 manage to handle the possibly arising problems. | |
| 275 | 427 </para> |
| 428 | |
| 226 | 429 <para> |
|
1313
65c5d6d53338
Update documentation for Mercurial.
Matti Hamalainen <ccr@tnsp.org>
parents:
1288
diff
changeset
|
430 We utilize &hgurl; (Hg) for GgrTF's version management. Mercurial |
|
1557
b922a5f99ad8
Some language improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
1556
diff
changeset
|
431 is a freely available distributed version control system, for which |
| 281 | 432 there are clients available for most common platforms, including |
| 433 Windows, Linux and other flavours of UNIX. | |
| 226 | 434 </para> |
| 267 | 435 |
| 436 <para> | |
|
1313
65c5d6d53338
Update documentation for Mercurial.
Matti Hamalainen <ccr@tnsp.org>
parents:
1288
diff
changeset
|
437 GgrTF's Mercurial repository is graciously hosted by &jeskko; |
| 275 | 438 at &pupuneturl;, and is available from following location: |
|
1322
903f92f4b918
Add note about sending patches.
Matti Hamalainen <ccr@tnsp.org>
parents:
1313
diff
changeset
|
439 <ulink url="&hgrepourl;">&hgrepourl;</ulink>. |
| 1346 | 440 The same URL can be used with a web browser to browse version history. |
| 275 | 441 </para> |
| 281 | 442 |
|
629
a80d8bcdef99
Updated some examples, fixed few bugs.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
443 <section id="intro-checking-out"><title>Checking out</title> |
| 275 | 444 <para> |
|
1313
65c5d6d53338
Update documentation for Mercurial.
Matti Hamalainen <ccr@tnsp.org>
parents:
1288
diff
changeset
|
445 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
|
446 Mercurial client with following command: |
| 267 | 447 |
| 1340 | 448 <userinput>hg clone &hgrepourl; dest_dir</userinput> |
| 275 | 449 |
|
1313
65c5d6d53338
Update documentation for Mercurial.
Matti Hamalainen <ccr@tnsp.org>
parents:
1288
diff
changeset
|
450 In which <emphasis>"clone"</emphasis> means making a local copy of the |
| 1340 | 451 repository under directory <emphasis>dest_dir</emphasis>. |
| 275 | 452 </para> |
| 453 | |
| 454 <para> | |
| 455 You will most probably want to download the repository to some | |
| 1340 | 456 specific place, personally I prefer to use ~/ggrtf/ (aka "ggrtf/" |
| 457 under user's home directory) under UNIX. | |
| 458 Thus typically you would use following command: | |
| 459 | |
| 460 <userinput>hg clone &hgrepourl; ~/ggrtf</userinput> | |
| 461 | |
| 1346 | 462 If you are using Windows, and wish to use the development version, you |
| 463 can use the regular Mercurial command line client, or a GUI interface | |
| 1533 | 464 such as <ulink url="http://tortoisehg.bitbucket.org/">TortoiseHg</ulink>. |
| 1346 | 465 </para> |
| 466 | |
| 467 <para> | |
| 468 The procedures for cloning and updating your local copy of the repository | |
| 469 are otherwise similar, except the directory/folder path is different, | |
| 470 under Windows XP the path would be <emphasis>C:\Documents and Settings\<username>\ggrtf\</emphasis>. | |
| 471 For example, if your username is "Ggr", you could use the following command: | |
| 472 | |
| 473 <userinput>hg clone &hgrepourl; "C:\Documents and Settings\Ggr\ggrtf\"</userinput> | |
| 474 | |
| 475 Under Windows Vista and 7, the path is of the format <emphasis>C:\Users\<username>\</emphasis> | |
| 476 </para> | |
| 477 | |
| 275 | 478 </section> |
| 479 | |
|
629
a80d8bcdef99
Updated some examples, fixed few bugs.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
480 <section id="intro-updating"><title>Keeping up to date</title> |
| 275 | 481 <para> |
| 482 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
|
483 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
|
484 the following commands: |
| 275 | 485 |
| 1346 | 486 <userinput>cd ~/ggrtf</userinput> |
| 487 <userinput>hg pull</userinput> | |
| 488 <userinput>hg update</userinput> | |
| 489 | |
|
1313
65c5d6d53338
Update documentation for Mercurial.
Matti Hamalainen <ccr@tnsp.org>
parents:
1288
diff
changeset
|
490 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
|
491 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
|
492 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
|
493 your local changesets automatically. Refer to Mercurial documentation. |
|
65c5d6d53338
Update documentation for Mercurial.
Matti Hamalainen <ccr@tnsp.org>
parents:
1288
diff
changeset
|
494 </para> |
| 1346 | 495 <para> |
| 496 If you plan on making modifications to GgrTF, it is recommended that you familiarize | |
| 497 yourself with the basics of Mercurial workflow, making commits, fetching, etc. It | |
| 498 will help you with maintaining your changes locally or sending patches to us. | |
| 499 </para> | |
| 500 | |
|
1313
65c5d6d53338
Update documentation for Mercurial.
Matti Hamalainen <ccr@tnsp.org>
parents:
1288
diff
changeset
|
501 |
| 275 | 502 </section> |
| 503 | |
| 226 | 504 </section> |
| 405 | 505 |
|
956
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
506 </chapter> |
| 226 | 507 |
| 254 | 508 <!-- ================================================ --> |
| 226 | 509 |
|
956
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
510 <chapter id="inst-config"><title>Configuration</title> |
| 226 | 511 <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
|
512 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
|
513 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
|
514 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
|
515 </para> |
|
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
516 |
|
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
517 <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
|
518 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
|
519 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
|
520 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
|
521 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
|
522 backwards incompatible changes. |
|
315
14204307afda
More explanation about configuration; prot-management
Matti Hamalainen <ccr@tnsp.org>
parents:
314
diff
changeset
|
523 </para> |
|
14204307afda
More explanation about configuration; prot-management
Matti Hamalainen <ccr@tnsp.org>
parents:
314
diff
changeset
|
524 |
|
14204307afda
More explanation about configuration; prot-management
Matti Hamalainen <ccr@tnsp.org>
parents:
314
diff
changeset
|
525 |
|
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 <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
|
527 <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
|
528 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
|
529 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
|
530 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
|
531 system and environment. |
|
315
14204307afda
More explanation about configuration; prot-management
Matti Hamalainen <ccr@tnsp.org>
parents:
314
diff
changeset
|
532 </para> |
|
14204307afda
More explanation about configuration; prot-management
Matti Hamalainen <ccr@tnsp.org>
parents:
314
diff
changeset
|
533 |
|
14204307afda
More explanation about configuration; prot-management
Matti Hamalainen <ccr@tnsp.org>
parents:
314
diff
changeset
|
534 <itemizedlist> |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
535 <listitem><para> |
|
1538
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
536 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
|
537 <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
|
538 (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
|
539 </para></listitem> |
|
315
14204307afda
More explanation about configuration; prot-management
Matti Hamalainen <ccr@tnsp.org>
parents:
314
diff
changeset
|
540 |
|
1230
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
541 <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
|
542 DruWare Win32 port of TF: |
| 1346 | 543 Windows XP/2k/NT - <emphasis>C:\Documents and Settings\username\tfrc</emphasis>, |
| 544 | |
| 545 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
|
546 </para></listitem> |
|
315
14204307afda
More explanation about configuration; prot-management
Matti Hamalainen <ccr@tnsp.org>
parents:
314
diff
changeset
|
547 </itemizedlist> |
|
14204307afda
More explanation about configuration; prot-management
Matti Hamalainen <ccr@tnsp.org>
parents:
314
diff
changeset
|
548 |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
549 <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
|
550 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
|
551 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
|
552 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
|
553 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
|
554 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
|
555 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
|
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 |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
558 <para> |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
559 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
|
560 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
|
561 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
|
562 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
|
563 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
|
564 </para> |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
565 |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
566 <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
|
567 |
|
1538
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
568 <!-- |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
569 - layout of recommended configuration |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
570 - discussion about modules |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
571 - bindings or not? |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
572 --> |
|
1230
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
573 |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
574 <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
|
575 <para> |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
576 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
|
577 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
|
578 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
|
579 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
|
580 </para> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
581 |
|
1230
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
582 <para> |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
583 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
|
584 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
|
585 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
|
586 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
|
587 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
|
588 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
|
589 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
|
590 <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
|
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 |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
593 <para> |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
594 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
|
595 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
|
596 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
|
597 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
|
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 |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
600 <para> |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
601 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
|
602 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
|
603 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
|
604 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
|
605 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
|
606 incorrectly. |
|
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 |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
609 <para> |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
610 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
|
611 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
|
612 on your setup - e.g. where you run TF, is it a shell or running locally, etc. |
| 1532 | 613 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
|
614 </para> |
|
8ef19c746981
Cleanups, add more information about configuration, add information about locales and character encodings.
Matti Hamalainen <ccr@tnsp.org>
parents:
1225
diff
changeset
|
615 |
|
1538
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
616 <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
|
617 <para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
618 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
|
619 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
|
620 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
|
621 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
|
622 </para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
623 |
|
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 On Ubuntu, things get a bit more complicated: |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
626 </para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
627 <orderedlist> |
|
1537
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
628 <listitem> |
|
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
629 <para> |
|
1538
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
630 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
|
631 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
|
632 It should look something like this: |
|
1537
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
633 </para> |
|
1538
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
634 <screen>en_US.UTF-8 UTF-8 |
|
1537
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
635 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
|
636 </listitem> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
637 <listitem> |
|
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 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
|
640 </para> |
|
1538
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
641 </listitem> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
642 </orderedlist> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
643 <para> |
| 1602 | 644 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
|
645 for installing locales vary. Your best bet is to |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
646 <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
|
647 </para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
648 <para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
649 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
|
650 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
|
651 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
|
652 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
|
653 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
|
654 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
|
655 </para> |
|
d1ea70ae13c9
Updated documentation concerning the character set/locale stuff.
Matti Hamalainen <ccr@tnsp.org>
parents:
1596
diff
changeset
|
656 <para> |
|
d1ea70ae13c9
Updated documentation concerning the character set/locale stuff.
Matti Hamalainen <ccr@tnsp.org>
parents:
1596
diff
changeset
|
657 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
|
658 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
|
659 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
|
660 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
|
661 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
|
662 <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
|
663 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
|
664 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
|
665 <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
|
666 </para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
667 <screen>#!/bin/sh |
|
1537
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
668 SAVE_LANG="$LANG" |
|
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
669 export LANG="en_US.ISO-8859-1" |
|
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
670 printf '\33]701;%s\007' $LANG |
|
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 /usr/bin/tf5 $* |
|
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
673 |
|
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
674 export LANG="$SAVE_LANG" |
|
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
675 printf '\33]701;%s\007' $LANG</screen> |
|
1538
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
676 <para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
677 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
|
678 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
|
679 (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
|
680 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
|
681 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
|
682 </para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
683 <para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
684 Remember to set the script executable by changing |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
685 its permissions, '<emphasis>chmod 0755 /some/where/scriptfile</emphasis>' |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
686 should do it. |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
687 </para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
688 <para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
689 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
|
690 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
|
691 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
|
692 after TF exits. |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
693 </para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
694 </section> <!-- Unix-likes --> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
695 |
|
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> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
698 |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
699 <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
|
700 <para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
701 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
|
702 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
|
703 <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
|
704 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
|
705 <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
|
706 </para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
707 <para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
708 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
|
709 in your terminal. |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
710 </para> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
711 <itemizedlist> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
712 <listitem> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
713 <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
|
714 Preferences / Setting / Advanced</emphasis> and turn on |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
715 "Allow VT100 application keypad mode". |
|
1537
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
716 </para> |
|
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
717 </listitem> |
|
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
718 <listitem> |
|
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
719 <para> |
|
1538
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
720 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
|
721 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
|
722 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
|
723 </para> |
|
6ca679191afd
Add some information about configuring locales.
Matti Hamalainen <ccr@tnsp.org>
parents:
1536
diff
changeset
|
724 </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
|
725 </itemizedlist> |
|
1538
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
726 </section> <!-- Terminal --> |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
727 |
|
315
14204307afda
More explanation about configuration; prot-management
Matti Hamalainen <ccr@tnsp.org>
parents:
314
diff
changeset
|
728 </section> |
|
14204307afda
More explanation about configuration; prot-management
Matti Hamalainen <ccr@tnsp.org>
parents:
314
diff
changeset
|
729 |
|
14204307afda
More explanation about configuration; prot-management
Matti Hamalainen <ccr@tnsp.org>
parents:
314
diff
changeset
|
730 |
| 404 | 731 <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
|
732 <para> |
|
980
9d3182edd64d
Add note about how BatMUD settings should be copypasted exactly as shown.
Matti Hamalainen <ccr@tnsp.org>
parents:
978
diff
changeset
|
733 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
|
734 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
|
735 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
|
736 correctly.</emphasis> |
|
306
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
737 </para> |
|
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
738 |
|
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
739 <itemizedlist> |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
740 <listitem><para>Line 'cutter' setting: |
|
954
7d4c1c2e981f
Instead of <screen> tag, use <userinput> where appropriate.
Matti Hamalainen <ccr@tnsp.org>
parents:
950
diff
changeset
|
741 <userinput>cutter 9999</userinput> |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
742 Theoretically, '<emphasis>cutter off</emphasis>' |
|
453
e7d262fb061c
Note about 'cutter' setting was missing, added.
Matti Hamalainen <ccr@tnsp.org>
parents:
449
diff
changeset
|
743 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
|
744 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
|
745 </listitem> |
|
e7d262fb061c
Note about 'cutter' setting was missing, added.
Matti Hamalainen <ccr@tnsp.org>
parents:
449
diff
changeset
|
746 |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
747 <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
|
748 <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
|
749 </para> |
|
306
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
750 </listitem> |
|
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
751 |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
752 <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
|
753 <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
|
754 </para> |
|
306
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
755 </listitem> |
|
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
756 |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
757 <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
|
758 <userinput>@@sc on</userinput> |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
759 </para> |
| 1449 | 760 <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
|
761 </listitem> |
|
8d07f07bd72b
Clarify in the BatMUD configuration / setup section that "sc" should be turned on.
Matti Hamalainen <ccr@tnsp.org>
parents:
1443
diff
changeset
|
762 |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
763 <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
|
764 <userinput>@@prompt PROMPT:></userinput> |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
765 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
|
766 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
|
767 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
|
768 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
|
769 </listitem> |
|
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
770 |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
771 <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
|
772 <userinput>@@battle rounds</userinput> |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
773 This setting is a toggle, make sure that you set it ON |
| 345 | 774 ("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
|
775 </para> |
|
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
776 </listitem> |
|
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
777 |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
778 <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
|
779 <userinput>@@battle listen all 2</userinput> |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
780 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
|
781 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
|
782 </para> |
|
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
783 </listitem> |
|
006531a8109f
Updates to setup-section and fixes to others.
Matti Hamalainen <ccr@tnsp.org>
parents:
284
diff
changeset
|
784 </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
|
785 |
|
521d0c3233bd
v0.5.10.0: Major cleanup of namespace, many functions and variables renamed
Matti Hamalainen <ccr@tnsp.org>
parents:
323
diff
changeset
|
786 <para> |
|
521d0c3233bd
v0.5.10.0: Major cleanup of namespace, many functions and variables renamed
Matti Hamalainen <ccr@tnsp.org>
parents:
323
diff
changeset
|
787 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
|
788 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
|
789 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
|
790 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
|
791 </para> |
| 226 | 792 </section> |
| 793 | |
|
956
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
794 <!-- |
|
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
795 <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
|
796 <para> |
|
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
797 </para> |
|
315
14204307afda
More explanation about configuration; prot-management
Matti Hamalainen <ccr@tnsp.org>
parents:
314
diff
changeset
|
798 </section> |
|
956
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
799 --> |
| 405 | 800 |
| 226 | 801 </chapter> |
| 802 | |
| 803 <!-- *************************************************************** --> | |
| 223 | 804 |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
805 <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
|
806 <para> |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
807 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
|
808 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
|
809 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
|
810 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
|
811 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
|
812 guild-related modules, containing guild-specialties. |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
813 </para> |
| 230 | 814 |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
815 <para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
816 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
|
817 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
|
818 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
|
819 with examples. |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
820 </para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
821 |
|
1263
d56722e12ed8
Remove (comment out) block diagram from documentation, for now.
Matti Hamalainen <ccr@tnsp.org>
parents:
1255
diff
changeset
|
822 <!-- |
| 403 | 823 <para> |
| 824 Following block-diagram represents the structure of GgrTF and | |
| 825 how different components approximately relate to each other: | |
| 826 </para> | |
| 827 | |
| 828 <screenshot> | |
| 829 <mediaobject> | |
| 638 | 830 <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
|
831 <imageobject><imagedata fileref="blockdiagram.eps" format="EPS" /></imageobject> |
| 403 | 832 <textobject> |
| 833 <phrase>GgrTF's internal structure</phrase> | |
| 834 </textobject> | |
| 835 <caption> | |
| 836 <para>Internal structure and relations of GgrTF components represented as | |
| 837 block-diagram.</para> | |
| 838 </caption> | |
| 839 </mediaobject> | |
| 840 </screenshot> | |
|
1263
d56722e12ed8
Remove (comment out) block diagram from documentation, for now.
Matti Hamalainen <ccr@tnsp.org>
parents:
1255
diff
changeset
|
841 --> |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
842 |
| 248 | 843 <!-- ================================================ --> |
| 230 | 844 |
| 340 | 845 <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
|
846 <para> |
| 403 | 847 This is the main module and core of GgrTF. It contains helper |
| 848 macro functions used by all the other modules and is thus | |
| 849 always required to be loaded. | |
| 850 It also provides much of the basic functionality, such as: | |
| 276 | 851 </para> |
| 852 | |
| 853 <itemizedlist> | |
| 279 | 854 <listitem><para> |
|
314
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
855 <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
|
856 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
|
857 condition, applied prots and other such information. |
| 279 | 858 </para></listitem> |
| 859 | |
| 860 <listitem><para> | |
| 861 <link linkend="usage-general-prots">Prot management</link>. | |
| 862 Keeps note of what prots have been cast at you, and provides this | |
| 863 information in various ways. | |
| 864 </para></listitem> | |
| 865 | |
| 841 | 866 <listitem><para> |
| 867 <link linkend="usage-general-curses">Curse/degen/etc tracking</link>. | |
| 868 Tracks what handicaps have been cast at enemies (non-partymembers). | |
| 869 This information is most useful in eq-parties. | |
| 870 </para></listitem> | |
| 871 | |
| 279 | 872 <listitem><para>Battle round handling. Enables commands to be |
| 873 executed each battle round and autopss functionality. | |
| 874 </para></listitem> | |
| 875 | |
|
1220
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
876 <listitem><para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
877 <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
|
878 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
|
879 </para></listitem> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
880 |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
881 <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
|
882 or to cast spells and use skills, with or without reporting to |
| 387 | 883 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
|
884 section for more information. |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
885 </para></listitem> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
886 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
887 <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
|
888 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
|
889 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
|
890 commands. |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
891 </para></listitem> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
892 |
|
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
|
893 <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
|
894 handling and mangling.</link> |
| 279 | 895 </para></listitem> |
| 896 | |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
897 <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
|
898 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
|
899 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
|
900 </para></listitem> |
| 279 | 901 |
| 902 <listitem><para>Keyboard movement handling and mapping. Bind your | |
| 903 numpad keys to move around, either by walking, walking with peering | |
| 904 in adjacent rooms (useful for merchants) or guiding your ship. | |
| 905 Additional modes may be provided by other optional modules. | |
| 906 </para></listitem> | |
| 907 | |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
908 <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
|
909 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
|
910 more readable and convenient form. |
| 279 | 911 </para></listitem> |
| 912 | |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
913 <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
|
914 and whatnots. ("/stats" command) |
| 279 | 915 </para></listitem> |
|
889
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
916 |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
917 <listitem><para> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
918 <emphasis>Consider-skill reporting</emphasis>: |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
919 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
|
920 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
|
921 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
|
922 estimation of target's toughness. |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
923 </para></listitem> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
924 |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
925 <listitem><para> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
926 <emphasis>Combat Damage Analysis reporting</emphasis>: |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
927 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
|
928 </para></listitem> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
929 |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
930 <listitem><para> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
931 <emphasis>Purse contents prettyprinting</emphasis>: |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
932 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
|
933 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
|
934 </para></listitem> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
935 |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
936 <listitem><para> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
937 <emphasis>Camping status handling and reporting</emphasis>: |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
938 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
|
939 the hp/sp/ep gained from resting. |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
940 </para></listitem> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
941 |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
942 <listitem><para> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
943 <emphasis>Ceremony status</emphasis>: |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
944 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
|
945 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
|
946 </para></listitem> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
947 |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
948 <listitem><para> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
949 <emphasis>Path compression for map.tf</emphasis>: |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
950 TinyFugue distribution comes with map.tf, which |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
951 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
|
952 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
|
953 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
|
954 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
|
955 "command"-aliases is also provided. |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
956 </para></listitem> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
957 |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
958 <listitem><para> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
959 Plus numerous miscellaneous reporting- and helper-triggers. |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
960 </para></listitem> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
961 |
| 276 | 962 </itemizedlist> |
| 963 | |
| 278 | 964 |
| 276 | 965 <section id="usage-general-commands"> |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
966 §macros_1; |
|
249
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
967 </para> |
|
1425
429e4bfbe297
Fetch GgrTF core macro command documentation from the embedded inline docs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1421
diff
changeset
|
968 |
|
429e4bfbe297
Fetch GgrTF core macro command documentation from the embedded inline docs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1421
diff
changeset
|
969 <!-- @commands --> |
|
429e4bfbe297
Fetch GgrTF core macro command documentation from the embedded inline docs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1421
diff
changeset
|
970 <!-- @binds --> |
|
429e4bfbe297
Fetch GgrTF core macro command documentation from the embedded inline docs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1421
diff
changeset
|
971 |
|
429e4bfbe297
Fetch GgrTF core macro command documentation from the embedded inline docs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1421
diff
changeset
|
972 </section> |
|
343
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 </section> |
|
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 <!-- ================================================ --> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
977 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
978 <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
|
979 <para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
980 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
|
981 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
|
982 &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
|
983 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
|
984 </para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
985 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
986 <para> |
| 862 | 987 The basic one-row statusline of GgrTF is meant for compatibility, |
| 988 <link linkend="usage-tf5">TF5 support module</link> provides another | |
| 989 version, enhanced to take advantage of newer TF5 beta features | |
| 990 (TF 5.0 beta 7 or later required). | |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
991 </para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
992 |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
993 <para> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
994 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
|
995 castings and certain other events. <emphasis>This depends on |
|
e3683413d8e2
Add notes about settings correctness.
Matti Hamalainen <ccr@tnsp.org>
parents:
1597
diff
changeset
|
996 your <link linkend="inst-config-batmud">BatMUD settings</link> |
| 1601 | 997 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
|
998 not appear, most likely your 'sc' setting is "wrong", |
|
e3683413d8e2
Add notes about settings correctness.
Matti Hamalainen <ccr@tnsp.org>
parents:
1597
diff
changeset
|
999 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
|
1000 </para> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1001 |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1002 <screenshot> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1003 <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
|
1004 <imageobject><imagedata fileref="statusbar.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
|
1005 <imageobject><imagedata fileref="statusbar.eps" format="EPS" /></imageobject> |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1006 <textobject> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1007 <phrase>GgrTF statusline</phrase> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1008 </textobject> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1009 <caption> |
| 862 | 1010 <para>Example of typical basic GgrTF statusline.</para> |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1011 </caption> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1012 </mediaobject> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1013 </screenshot> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1014 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1015 <orderedlist> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1016 <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
|
1017 <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
|
1018 <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
|
1019 <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
|
1020 <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
|
1021 <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
|
1022 <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
|
1023 <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
|
1024 <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
|
1025 </orderedlist> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1026 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1027 <para> |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1028 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
|
1029 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
|
1030 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
|
1031 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
|
1032 </para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1033 |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1034 <screenshot> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1035 <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
|
1036 <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
|
1037 <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
|
1038 <textobject> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1039 <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
|
1040 </textobject> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1041 <caption> |
| 392 | 1042 <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
|
1043 "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
|
1044 endurance your character has. |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1045 </para> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1046 </caption> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1047 </mediaobject> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1048 </screenshot> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1049 |
|
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
|
1050 </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
|
1051 |
|
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
|
1052 <!-- ================================================ --> |
|
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
|
1053 |
|
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
|
1054 <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
|
1055 <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
|
1056 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
|
1057 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
|
1058 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
|
1059 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
|
1060 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
|
1061 </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
|
1062 <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
|
1063 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
|
1064 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
|
1065 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
|
1066 |
|
954
7d4c1c2e981f
Instead of <screen> tag, use <userinput> where appropriate.
Matti Hamalainen <ccr@tnsp.org>
parents:
950
diff
changeset
|
1067 <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
|
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 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
|
1070 "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
|
1071 (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
|
1072 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
|
1073 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
|
1074 </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
|
1075 |
|
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 <orderedlist> |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1077 <listitem> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1078 <para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1079 <userinput>/gprompt ></userinput> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1080 Set prompt to show only ">" and nothing more. |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1081 </para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1082 </listitem> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1083 <listitem> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1084 <para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1085 <userinput>/gprompt %{status_cast}></userinput> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1086 Show currently in-progress skill or spell in prompt. |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1087 </para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1088 </listitem> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1089 <listitem> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1090 <para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1091 <userinput>/gprompt @{BCred}%{status_cast}@{n}@{BCwhite}>@{n}</userinput> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1092 TinyFugue color attributes can be used also. |
|
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 </listitem> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1095 <listitem> |
|
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 <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
|
1098 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
|
1099 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
|
1100 </para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1101 </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
|
1102 </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
|
1103 |
|
1075
122c463704e1
Add note about /gprompt attribute formatting not working with earlier betas of TF5.
Matti Hamalainen <ccr@tnsp.org>
parents:
1074
diff
changeset
|
1104 <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
|
1105 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
|
1106 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
|
1107 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
|
1108 </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
|
1109 |
|
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
|
1110 <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
|
1111 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
|
1112 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
|
1113 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
|
1114 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
|
1115 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
|
1116 (">") 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
|
1117 |
|
954
7d4c1c2e981f
Instead of <screen> tag, use <userinput> where appropriate.
Matti Hamalainen <ccr@tnsp.org>
parents:
950
diff
changeset
|
1118 <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
|
1119 |
|
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
|
1120 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
|
1121 |
|
954
7d4c1c2e981f
Instead of <screen> tag, use <userinput> where appropriate.
Matti Hamalainen <ccr@tnsp.org>
parents:
950
diff
changeset
|
1122 <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
|
1123 |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1124 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
|
1125 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
|
1126 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
|
1127 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
|
1128 </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
|
1129 |
|
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 <orderedlist> |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1131 <listitem> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1132 <para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1133 <userinput>/gprompt %{status_prompt}></userinput> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1134 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
|
1135 greater than sign in the end. |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1136 </para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1137 </listitem> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1138 <listitem> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1139 <para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1140 <userinput>/gprompt @{BCgreen}%{status_prompt}@{n}></userinput> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1141 Same as above, but coloured bright green. |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1142 </para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1143 </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
|
1144 </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
|
1145 |
|
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
|
1146 <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
|
1147 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
|
1148 "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
|
1149 </para> |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1150 |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1151 </section> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1152 |
|
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
|
1153 |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1154 <!-- ================================================ --> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1155 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1156 <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
|
1157 <para> |
| 390 | 1158 State-saving is an awfully awkward name for GgrTF's functionality for |
| 1159 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
|
1160 retrieval. Settings get saved and thus restored later, |
| 390 | 1161 but this functionality is not automatic by default, you have to set it |
| 1162 up so if you wish - GgrTF only provides you the functions for loading | |
| 1163 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
|
1164 How to do this is discussed further below. |
| 390 | 1165 </para> |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1166 |
|
629
a80d8bcdef99
Updated some examples, fixed few bugs.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
1167 <section id="usage-general-saves-whatis"><title>What is saved?</title> |
| 390 | 1168 <para> |
| 1169 <emphasis>Almost</emphasis> all settings (hidden or visible) | |
| 1170 get saved, but there are certain global settings that you | |
| 391 | 1171 have to set yourself in your TF configuration. These |
| 392 | 1172 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
|
1173 </para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1174 |
| 390 | 1175 <para> |
| 1176 It should also be noted, that there are actually <emphasis>two | |
| 1177 different types of data (or variables) that is saved into two | |
| 1178 different files</emphasis>. In GgrTF, these two types of data | |
| 1179 are called <emphasis>pre- and post-init settings</emphasis>, and the | |
| 1180 two savefiles are named accordingly. Pre-init settings are | |
| 1181 variables that need to be defined before the main modules | |
| 1182 of GgrTF are loaded in TF's startup configuration (certain | |
| 1183 functionality depends on this). Post-init variables can | |
| 1184 (and sometimes <emphasis>must</emphasis>) be set after loading | |
| 1185 of all modules. | |
| 1186 </para> | |
| 1187 </section> | |
| 1188 | |
|
629
a80d8bcdef99
Updated some examples, fixed few bugs.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
1189 <section id="usage-general-saves-special"><title>Special, non-saved variables</title> |
| 390 | 1190 <para> |
| 1191 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
|
1192 set yourself in your TF's startup configuration (.tfrc). |
| 390 | 1193 These variables <emphasis>MUST</emphasis> be set before loading |
| 1194 of ANY GgrTF modules, otherwise things start breaking and the | |
| 1195 state-saving system does not work correctly. | |
| 1196 </para> | |
| 1197 | |
| 1052 | 1198 <table><title>Special, non-saved variables</title> |
| 390 | 1199 <tgroup cols="3" align="left"> |
| 1200 <thead> | |
| 1201 <row> | |
| 1202 <entry>Variable</entry> | |
| 1203 <entry>Description</entry> | |
| 1204 <entry>Example</entry> | |
| 1205 </row> | |
| 1206 </thead> | |
| 1207 <tbody> | |
| 1208 <row> | |
| 1209 <entry>set_plrname</entry> | |
| 1210 <entry> | |
| 1211 Your character's name, written in correct case. | |
| 1212 </entry> | |
| 1213 <entry>/set set_plrname=Ggr</entry> | |
| 1214 </row> | |
| 1215 | |
| 1216 <row> | |
| 1217 <entry>set_datapath</entry> | |
| 1218 <entry>Path to the directory where you want your savefiles to reside. If | |
| 1219 left empty, current working directory is used (the directory you started TF | |
| 1220 from.)</entry> | |
| 1221 <entry>/set set_datapath=</entry> | |
| 1222 </row> | |
| 1223 | |
| 1224 <row> | |
| 1225 <entry>set_saveprefix</entry> | |
| 1226 <entry> | |
| 1227 This string is used as prefix of the two savefiles, so the actual | |
| 401 | 1228 savefiles are "<emphasis><prefix>pre.tf</emphasis>" and |
| 1229 "<emphasis><prefix>post.tf</emphasis>". This is useful, | |
| 390 | 1230 if you play regular BatMUD and HCBat, so you can use different values |
| 1231 for either. | |
| 1232 </entry> | |
| 1233 <entry>/set set_saveprefix=bat-</entry> | |
| 1234 </row> | |
| 1235 | |
| 1236 </tbody> | |
| 1237 </tgroup> | |
| 1238 </table> | |
| 1239 | |
| 1240 </section> | |
| 1241 | |
| 1242 | |
| 392 | 1243 <section id="usage-general-saves-setup"><title>How to setup TF for state-saving</title> |
| 390 | 1244 <para> |
| 393 | 1245 Getting GgrTF's state-saving to work requires some changes to your |
| 841 | 1246 TF configuration, and possibly setting up a savefile directory |
| 390 | 1247 </para> |
| 393 | 1248 |
| 1249 <para> | |
| 841 | 1250 A simplified example configuration layout is presented below with only |
| 1251 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
|
1252 <link linkend="inst-config-tf">setup</link>-section of this |
| 401 | 1253 manual for a more detailed example. Pay close attention to the order |
| 1254 how things are done, it is very important! | |
| 393 | 1255 </para> |
| 1256 | |
| 950 | 1257 <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
|
1258 /eval /set set_datapath=%{HOME}/.ggrtf/ |
| 841 | 1259 |
| 1260 ;; 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
|
1261 /eval /set set_saveprefix=bat- |
| 393 | 1262 |
| 841 | 1263 ;; Load the special pre-init module which loads pre-init |
| 1264 ;; settings from the savefiles. This needs to be done | |
| 1265 ;; before loading any other GgrTF modules. | |
|
629
a80d8bcdef99
Updated some examples, fixed few bugs.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
1266 /gloadmod ggrtf-pre.tf |
| 393 | 1267 |
| 841 | 1268 ;; Load GgrTF core module |
|
629
a80d8bcdef99
Updated some examples, fixed few bugs.
Matti Hamalainen <ccr@tnsp.org>
parents:
625
diff
changeset
|
1269 /gloadmod ggrtf.tf |
| 393 | 1270 |
| 1271 ;; Load other additional modules | |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
1272 /gloadmod gm-magical.tf |
| 841 | 1273 ; etc etc. |
| 1274 | |
| 1275 ;; Load and restore other previously saved settings. | |
| 1276 ;; This should be done after loading any GgrTF modules. | |
| 393 | 1277 /gload |
| 1278 </screen> | |
| 1279 | |
| 1280 <para> | |
| 401 | 1281 When you have edited your TF configuration, you need to (re-)start |
| 1282 it, change settings the way you want them to be and finally issue | |
| 1283 "/gsave" command to get settings saved. <emphasis>After saving, | |
| 1284 you may also want to examine the pre-init -savefile, because it | |
| 1285 contains certain settings that cannot be changed run-time | |
| 1286 </emphasis>. So, here are the steps in short again: | |
| 393 | 1287 </para> |
| 401 | 1288 |
| 403 | 1289 <orderedlist> |
| 401 | 1290 <listitem><para> |
| 841 | 1291 <emphasis>Edit TF configuration (see example above)</emphasis>: |
| 1292 Add <emphasis>set_datapath</emphasis>, <emphasis>set_saveprefix</emphasis> | |
| 1293 settings and add commands to load <emphasis>ggrtf-pre.tf</emphasis> module | |
| 1294 and <emphasis>/gload</emphasis> command. | |
| 1295 </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
|
1296 <listitem><para> |
| 403 | 1297 <emphasis>Re-start TF</emphasis>: |
| 841 | 1298 In order to create the initial savefiles with default settings, |
| 1299 you need to (re-)start TF, so that the save-state system is enabled. | |
| 401 | 1300 </para></listitem> |
| 1301 <listitem><para> | |
| 403 | 1302 <emphasis>Change settings</emphasis>: |
| 401 | 1303 Change GgrTF settings (listed via /opts etc.) to accommodate |
| 1304 your desires. | |
| 1305 </para></listitem> | |
| 1306 <listitem><para> | |
| 403 | 1307 <emphasis>Save initial settings</emphasis>: |
| 401 | 1308 Issue "/gsave" to get settings saved. |
| 1309 </para></listitem> | |
| 1310 <listitem><para> | |
| 403 | 1311 <emphasis>Optionally edit pre-init settings</emphasis>: |
| 401 | 1312 Certain settings are saved into the pre-init savefile (actual |
| 1313 filename is dependant on what you set "set_saveprefix" to). | |
| 1314 GgrTF does not offer any special interface to change these settings, | |
| 1315 you have to edit this file by hand, if you wish to change the defaults. | |
| 1316 </para></listitem> | |
| 403 | 1317 </orderedlist> |
| 401 | 1318 |
| 393 | 1319 </section> |
| 1320 | |
| 1321 <section><title>How to make state-saving automatic</title> | |
| 1322 <para> | |
| 1323 In previous example, I only described how settings get restored | |
| 1324 (as TF loads and initializes GgrTF), but how to get settings | |
| 1325 saved automatically too? | |
| 1326 </para> | |
| 1327 | |
| 1328 <para> | |
| 1329 The answer lies in &tfurl;'s event hooks. It is possible to | |
| 1330 define a hook, which is executed when TF disconnects from a world. | |
| 1331 By setting this hook to perform "/gsave", we can automatize the | |
| 1332 process of saving settings. Add following line to your TF configuration: | |
| 1333 | |
|
954
7d4c1c2e981f
Instead of <screen> tag, use <userinput> where appropriate.
Matti Hamalainen <ccr@tnsp.org>
parents:
950
diff
changeset
|
1334 <userinput>/def -hDISCONNECT mydisconnect = /gsave</userinput> |
| 393 | 1335 |
| 1336 There is one gotcha: if you don't want to keep saving the statistical | |
| 1337 values, but only the settings, you may want to add a "/greset" in the soup: | |
| 1338 | |
|
954
7d4c1c2e981f
Instead of <screen> tag, use <userinput> where appropriate.
Matti Hamalainen <ccr@tnsp.org>
parents:
950
diff
changeset
|
1339 <userinput>/def -hDISCONNECT mydisconnect = /greset%;/gsave</userinput> |
| 393 | 1340 |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1341 </para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1342 |
| 390 | 1343 </section> |
| 1344 | |
| 1345 | |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1346 §macros_2; |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1347 <row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1348 <entry>/gsave</entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1349 <entry> |
|
972
ea85d502d46f
Misc. typo fixes and minor reorganization.
Matti Hamalainen <ccr@tnsp.org>
parents:
969
diff
changeset
|
1350 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
|
1351 </entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1352 </row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1353 <row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1354 <entry>/gload</entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1355 <entry> |
|
1065
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
1356 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
|
1357 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
|
1358 </entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1359 </row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1360 <row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1361 <entry>/greset</entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1362 <entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1363 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
|
1364 this command also requires executing of "/gsave" if you want to save |
| 393 | 1365 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
|
1366 restored on next /gload. |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1367 </entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1368 </row> |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1369 §macros_end; |
| 276 | 1370 |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1371 </section> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1372 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1373 <!-- ================================================ --> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1374 |
| 387 | 1375 <section id="usage-general-binds"><title>Command bindings</title> |
| 1376 <para> | |
| 1377 GgrTF's core provides few macros for defining "bindings", which | |
| 1378 are a way to create commands that look like normal MUD commands | |
| 1379 but are actually intercepted by &tfurl; and executed appropriately. | |
| 1380 These bindings can be used to easily define shorthands for casting | |
| 1381 spells, using skills, executing macros, etc. GgrTF bindings offer | |
| 1382 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
|
1383 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
|
1384 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
|
1385 extra abilities (but also with some limitations.)</emphasis> |
| 387 | 1386 </para> |
| 1387 | |
| 1388 <para> | |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1389 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
|
1390 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
|
1391 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
|
1392 with a setting ("opt_bindings"). See below section <link |
| 807 | 1393 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
|
1394 </para> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1395 |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1396 <para> |
|
994
c40eabb80393
Add few lines of explanation about bindings.
Matti Hamalainen <ccr@tnsp.org>
parents:
988
diff
changeset
|
1397 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
|
1398 Indeed, you can already use BatMUD's command aliases for such things, but |
| 387 | 1399 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
|
1400 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
|
1401 redefine lots just because you are reincarnating... and you can not execute |
| 387 | 1402 macros with command aliases. |
| 1403 </para> | |
| 1404 | |
| 1405 <para> | |
| 1406 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
|
1407 drawbacks: |
| 387 | 1408 </para> |
| 1409 | |
| 1410 <itemizedlist> | |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1411 <listitem> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1412 <para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1413 <emphasis>Limitations of TF's parsing</emphasis>: |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1414 Because of the nature how bindings are defined and parsed, |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1415 you can only use one binded command per line. |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1416 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
|
1417 and "clair" is a binding to use clairvoyance. Thus, someone |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1418 might want to command: |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1419 |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1420 <userinput>aoa ggr%;clair</userinput> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1421 |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1422 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
|
1423 not evaluate binding as an expression, the "ggr%;clair"-part |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1424 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
|
1425 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
|
1426 </para> |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1427 </listitem> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1428 |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1429 <listitem> |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1430 <para> |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1431 <emphasis>BatMUD commands and GgrTF bindings cannot be mixed</emphasis>: |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1432 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
|
1433 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
|
1434 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
|
1435 and "hop" is an emote: |
|
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 <userinput>hop jeskko;aoa ggr</userinput> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1438 |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1439 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
|
1440 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
|
1441 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
|
1442 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
|
1443 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
|
1444 </para> |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1445 </listitem> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1446 |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1447 <listitem> |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1448 <para> |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1449 <emphasis>Limitations of GgrTF's binding system</emphasis>: |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1450 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
|
1451 with the current functionality provided by GgrTF. Bindings that |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1452 require complex parameters (more than one optional argument), |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1453 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
|
1454 aliases for those. |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1455 </para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
1456 </listitem> |
| 387 | 1457 </itemizedlist> |
| 1458 | |
| 393 | 1459 |
| 1460 <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
|
1461 <para> |
| 393 | 1462 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
|
1463 command bindings! |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1464 </para> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1465 |
| 950 | 1466 <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
|
1467 /prdefcbind -s"nf" -c"Neutralize Field" -n |
| 950 | 1468 /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
|
1469 |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1470 <para> |
| 393 | 1471 Above we have have listed all three (3) classes of binding defination |
| 390 | 1472 macros supported by GgrTF. First defines a generic command binding |
| 1473 to execute "/ceremony" macro when user commands "cere". | |
| 1474 Second binding defines a spell casting command to cast "Neutralize Field" | |
| 1475 when user commands "nf". And the third binding defines a skill | |
| 1476 usage command to use "Fire Building". So basically we have | |
| 1477 three types of bindings: | |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1478 </para> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1479 |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1480 <itemizedlist> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1481 <listitem><para> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1482 <emphasis>/prdefgbind</emphasis>: |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1483 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
|
1484 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
|
1485 </para></listitem> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1486 |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1487 <listitem><para> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1488 <emphasis>/prdefcbind</emphasis>: |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1489 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
|
1490 to be casted. |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1491 </para></listitem> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1492 |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1493 <listitem><para> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1494 <emphasis>/prdefsbind</emphasis>: |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1495 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
|
1496 skill to be executed. |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1497 </para></listitem> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1498 </itemizedlist> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1499 |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1500 <para> |
| 390 | 1501 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
|
1502 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
|
1503 There are other optional arguments, which affect aspects of the |
| 390 | 1504 command binding to be defined. The argument options and their |
| 1505 meanings are listed below: | |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1506 </para> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1507 |
| 390 | 1508 <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
|
1509 <tgroup cols="2" align="left"> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1510 <thead> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1511 <row> |
| 390 | 1512 <entry>Option</entry> |
| 1513 <entry>Description</entry> | |
| 1514 </row> | |
| 1515 </thead> | |
| 1516 <tbody> | |
| 1517 <row> | |
| 1518 <entry>-s"name"</entry> | |
| 1519 <entry>Specifies the name of the command binding. | |
| 1520 This is basically the string you type to use the command, | |
| 1521 after which come the optional arguments. | |
| 1522 </entry> | |
| 1523 </row> | |
| 1524 <row> | |
| 1525 <entry>-n</entry> | |
| 1526 <entry> | |
| 1527 Tells GgrTF that the binding does NOT accept arguments. | |
| 1528 Anything following the command binding invocation is ignored. | |
| 1529 This also affects the possible reporting output of the binding. | |
| 1530 </entry> | |
| 1531 </row> | |
| 1532 </tbody> | |
| 1533 </tgroup> | |
| 1534 </table> | |
| 1535 | |
| 1536 <table><title>Arguments specific to generic bindings (/prdefgbind)</title> | |
| 1537 <tgroup cols="2" align="left"> | |
| 1538 <thead> | |
| 1539 <row> | |
| 1540 <entry>Option</entry> | |
| 1541 <entry>Description</entry> | |
| 1542 </row> | |
| 1543 </thead> | |
| 1544 <tbody> | |
| 1545 <row> | |
| 1546 <entry>-c"action"</entry> | |
| 1547 <entry> | |
| 1548 Specifies the action, aka what the binding <emphasis>does</emphasis>. | |
| 1549 For generic bindings, the action is a literal, so it can be a | |
| 1550 TF macro or BatMUD command. | |
| 1551 </entry> | |
| 1552 </row> | |
| 1553 </tbody> | |
| 1554 </tgroup> | |
| 1555 </table> | |
| 1556 | |
| 1557 <table><title>Arguments specific to spell casting and skill usage bindings (/prdefcbind and /prdefsbind)</title> | |
| 1558 <tgroup cols="2" align="left"> | |
| 1559 <thead> | |
| 1560 <row> | |
| 1561 <entry>Option</entry> | |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1562 <entry>Description</entry> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1563 </row> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1564 </thead> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1565 <tbody> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1566 <row> |
| 390 | 1567 <entry>-c"action"</entry> |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1568 <entry> |
| 390 | 1569 Specifies name of the spell to be cast or skill to be used. |
| 1570 </entry> | |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1571 </row> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1572 <row> |
| 390 | 1573 <entry>-d"message"</entry> |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1574 <entry> |
| 390 | 1575 This option overrides the default message string used for reporting |
| 1576 (see also option "-q" below). | |
| 1577 </entry> | |
|
389
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 <row> |
| 390 | 1580 <entry>-q</entry> |
| 1581 <entry> | |
| 1582 Makes the binding "quiet", suppresses any reporting. By default, | |
| 1583 spell casting binding reports the action on party report-channel, | |
| 1584 but specifying this option disables it. | |
| 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 </tbody> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1588 </tgroup> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1589 </table> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
1590 |
| 390 | 1591 <para> |
| 1592 More examples, now with short explanations: | |
| 1593 </para> | |
| 1594 | |
| 1595 <table><title>Binding defination examples</title> | |
| 1596 <tgroup cols="2" align="left"> | |
| 1597 <thead> | |
| 1598 <row> | |
| 1599 <entry>Definition</entry> | |
| 1600 <entry>Description</entry> | |
| 1601 </row> | |
| 1602 </thead> | |
| 1603 <tbody> | |
| 1604 <row> | |
| 1605 <entry>/prdefgbind -s"repu" -c"/showrep" -n</entry> | |
| 1606 <entry> | |
| 1607 Generic binding, which executes /showrep macro and takes no arguments. | |
| 1608 </entry> | |
| 1609 </row> | |
| 1610 <row> | |
| 1611 <entry>/prdefsbind -s"er" -c"Enrage" -n</entry> | |
| 1612 <entry> | |
| 1613 Skill binding for barbarian "Enrage" skill. Also takes no | |
| 1614 arguments. | |
| 1615 </entry> | |
| 1616 </row> | |
| 1617 <row> | |
| 1618 <entry>/prdefcbind -s"shelter" -c"Shelter" -n -d"Sheltering ..."</entry> | |
| 1619 <entry> | |
| 1620 Spell casting binding, for casting conjurer spell "Shelter". | |
| 1621 Takes no arguments and uses specific reporting string (default | |
| 1622 would be "Shelter ...", but since it sounds bit stupid we want to | |
| 1623 use "Sheltering ..." instead.) | |
| 1624 </entry> | |
| 1625 </row> | |
| 1626 <row> | |
| 1627 <entry>/prdefcbind -s"dmp" -c"Dispel Magical Protection"</entry> | |
| 1628 <entry> | |
| 1629 Another spell casting binding for a conjurer spell, which takes | |
| 1630 (and requires) a player's name as argument. | |
| 1631 </entry> | |
| 1632 </row> | |
| 1633 <row> | |
| 1634 <entry>/prdefcbind -s"sl" -c"Star Light" -q</entry> | |
| 1635 <entry> | |
| 1636 Yet another spell casting bind, this time for druid spell "Star Light". | |
| 1637 Since this is a blasting spell, it is not really useful to report | |
| 1638 that we are casting it, so we suppress any reporting. Argument is | |
| 1639 accepted. | |
| 1640 </entry> | |
| 1641 </row> | |
| 1642 </tbody> | |
| 1643 </tgroup> | |
| 1644 </table> | |
| 1645 | |
| 1646 <para> | |
| 1647 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
|
1648 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
|
1649 </para> |
|
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1650 |
|
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1651 </section> |
|
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1652 |
|
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1653 |
| 807 | 1654 <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
|
1655 <para> |
|
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1656 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
|
1657 /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
|
1658 variable is set to value "on", bindings will be defined, otherwise not. |
| 390 | 1659 </para> |
|
806
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1660 <para> |
|
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1661 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
|
1662 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
|
1663 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
|
1664 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
|
1665 .tfrc. |
|
806
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1666 </para> |
|
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1667 <para> |
|
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1668 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
|
1669 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
|
1670 <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
|
1671 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
|
1672 for more information. |
|
dc4859b3ff98
Add a section about how bindings are enabled.
Matti Hamalainen <ccr@tnsp.org>
parents:
800
diff
changeset
|
1673 </para> |
| 387 | 1674 </section> |
| 1675 | |
|
995
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1676 <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
|
1677 <para> |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1678 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
|
1679 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
|
1680 </para> |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1681 <screen> |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1682 ,----------------. |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1683 | GgrTF Bindings | |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1684 +----------------+----------------------------------------------------. |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1685 | pprots | G | /pprots | ? | |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1686 | rpouch | G | /rpouch | ? | |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1687 | ad | C | Aura Detection | Yes | |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1688 | invis | C | Invisibility | Yes | |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1689 | float | C | Floating | Yes | |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1690 | ww | C | Water Walking | Yes | |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1691 | seeinvis | C | See Invisible | Yes | |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1692 | seemagic | C | See Magic | Yes | |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1693 | cere | G | /ceremony | ? | |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1694 | curses | G | /curses | ? | |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1695 | prots | G | /prots | ? | |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1696 `---------------------------------------------------------------------' |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1697 </screen> |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1698 <itemizedlist> |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1699 <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
|
1700 <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
|
1701 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
|
1702 <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
|
1703 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
|
1704 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
|
1705 command executed.</para></listitem> |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1706 <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
|
1707 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
|
1708 question mark ("?") instead.</para></listitem> |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1709 </itemizedlist> |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1710 |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1711 </section> |
|
061ca577a894
Added section about /binds command output, with explanations.
Matti Hamalainen <ccr@tnsp.org>
parents:
994
diff
changeset
|
1712 |
| 393 | 1713 </section> |
| 1714 | |
| 387 | 1715 <!-- ================================================ --> |
| 1716 | |
|
889
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
1717 <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
|
1718 <para> |
| 392 | 1719 GgrTF provides a mechanism for routing keyboard numpad bindings so that |
| 393 | 1720 different functionality can be swapped in as needed. Core module offers |
| 1721 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
|
1722 automatic peering to adjacent directions, useful for <link |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1723 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
|
1724 |
| 393 | 1725 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
|
1726 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
|
1727 <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
|
1728 modules, for example.) |
| 392 | 1729 </para> |
| 1730 | |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1731 <note> |
|
1065
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
1732 <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
|
1733 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
|
1734 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
|
1735 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
|
1736 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
|
1737 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
|
1738 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
|
1739 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
|
1740 </para> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1741 </note> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1742 |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1743 §macros_2; |
| 392 | 1744 <row> |
| 1745 <entry>/move [setting]</entry> | |
| 393 | 1746 <entry>Set the mode used for numpad bindings. Valid values are |
| 1747 shown if command is given without arguments. Core GgrTF module | |
| 1748 provides following three modes: <emphasis>move</emphasis>, | |
| 1749 <emphasis>peer</emphasis> and <emphasis>ship</emphasis> | |
| 1750 </entry> | |
| 392 | 1751 </row> |
| 1752 | |
| 1753 <row> | |
| 1754 <entry>/peer [regexp]</entry> | |
| 393 | 1755 <entry> |
| 1756 Set the regular expression used for grepping the output of 'peer' | |
| 1757 command used in "/move peer" mode. | |
| 1758 </entry> | |
| 1759 </row> | |
| 1760 | |
| 1761 <row> | |
| 1762 <entry>/cruise</entry> | |
| 1763 <entry>Toggle ship cruising speed on/off (off = sail)</entry> | |
| 392 | 1764 </row> |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1765 §macros_end; |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1766 |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1767 </section> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1768 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1769 <!-- ================================================ --> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1770 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1771 <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
|
1772 <para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1773 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
|
1774 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
|
1775 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
|
1776 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
|
1777 </para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1778 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1779 <para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1780 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
|
1781 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
|
1782 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
|
1783 (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
|
1784 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
|
1785 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
|
1786 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
|
1787 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
|
1788 for prot reporting triggers.) |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1789 </para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1790 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1791 <para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1792 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
|
1793 </para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1794 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1795 <itemizedlist> |
|
584
4cbf7693af1e
Document <> and - in prot reporting.
Matti Hamalainen <ccr@tnsp.org>
parents:
583
diff
changeset
|
1796 <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
|
1797 <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
|
1798 <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
|
1799 <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
|
1800 <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
|
1801 <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
|
1802 <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
|
1803 <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
|
1804 <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
|
1805 <listitem><para>etc...</para></listitem> |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1806 </itemizedlist> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1807 |
|
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 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
|
1810 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
|
1811 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
|
1812 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
|
1813 line character (sometimes called the pipe). |
| 787 | 1814 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
|
1815 </para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1816 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1817 <table><title>Prot entries</title> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1818 <tgroup cols="2" align="left"> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1819 <thead> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1820 <row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1821 <entry>Entry</entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1822 <entry>Description</entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1823 </row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1824 </thead> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1825 <tbody> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1826 <row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1827 <entry>Unst[1m9s]</entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1828 <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
|
1829 </row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1830 <row> |
| 787 | 1831 <entry>+AoA[7m19s]</entry> |
| 1832 <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
|
1833 </row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1834 <row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1835 <entry>Infra(2)[0m2s]</entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1836 <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
|
1837 </row> |
|
584
4cbf7693af1e
Document <> and - in prot reporting.
Matti Hamalainen <ccr@tnsp.org>
parents:
583
diff
changeset
|
1838 <row> |
|
4cbf7693af1e
Document <> and - in prot reporting.
Matti Hamalainen <ccr@tnsp.org>
parents:
583
diff
changeset
|
1839 <entry>Unst<2>[7m19s]</entry> |
|
4cbf7693af1e
Document <> and - in prot reporting.
Matti Hamalainen <ccr@tnsp.org>
parents:
583
diff
changeset
|
1840 <entry>Unstun that has been weakened 2 times.</entry> |
|
4cbf7693af1e
Document <> and - in prot reporting.
Matti Hamalainen <ccr@tnsp.org>
parents:
583
diff
changeset
|
1841 </row> |
|
4cbf7693af1e
Document <> and - in prot reporting.
Matti Hamalainen <ccr@tnsp.org>
parents:
583
diff
changeset
|
1842 <row> |
|
4cbf7693af1e
Document <> and - in prot reporting.
Matti Hamalainen <ccr@tnsp.org>
parents:
583
diff
changeset
|
1843 <entry>-Forget[3m5s]</entry> |
|
4cbf7693af1e
Document <> and - in prot reporting.
Matti Hamalainen <ccr@tnsp.org>
parents:
583
diff
changeset
|
1844 <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
|
1845 </row> |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1846 </tbody> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1847 </tgroup> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1848 </table> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1849 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1850 <para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1851 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
|
1852 </para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1853 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1854 <screen> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1855 <userinput>tweak jeskko</userinput> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1856 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1857 You tweak Jeskko's nose mischievously. |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1858 Jeskko [report]: Unst[1h1m13s] |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1859 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1860 <userinput>unp jeskko</userinput> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1861 |
|
1065
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
1862 Ggr [report]: Unpain -> jeskko |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1863 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
|
1864 GgrTF: 'unpain' -> jeskko |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1865 Unpain: ##### [5] |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1866 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
|
1867 Unpain: ## [2] |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1868 Unpain: # [1] |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1869 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
|
1870 You utter the magic words (unpain) |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1871 You cast the spell successfully. |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1872 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
|
1873 Jeskko [report]: Unpain ON! |
|
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>tweak jeskko</userinput> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1876 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1877 You tweak Jeskko's nose mischievously. |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1878 Jeskko [report]: Unst[1h4m25s] | Unp[2m35s] |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1879 </screen> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1880 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1881 |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1882 §macros_2; |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1883 <row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1884 <entry>/prots</entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1885 <entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1886 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
|
1887 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
|
1888 report-channel. |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1889 </entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1890 </row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1891 <row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1892 <entry>/cprots</entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1893 <entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1894 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
|
1895 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
|
1896 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
|
1897 discretion. |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1898 </entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1899 </row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1900 <row> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1901 <entry>tweak <target></entry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1902 <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
|
1903 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
|
1904 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
|
1905 </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
|
1906 </row> |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1907 §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
|
1908 |
|
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
|
1909 </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
|
1910 |
|
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
|
1911 <!-- ================================================ --> |
|
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
|
1912 |
|
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
|
1913 <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
|
1914 <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
|
1915 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
|
1916 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
|
1917 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
|
1918 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
|
1919 </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
|
1920 <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
|
1921 <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
|
1922 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
|
1923 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
|
1924 </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
|
1925 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
|
1926 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
|
1927 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
|
1928 </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
|
1929 |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1930 §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
|
1931 <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
|
1932 <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
|
1933 <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
|
1934 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
|
1935 </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
|
1936 </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
|
1937 <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
|
1938 <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
|
1939 <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
|
1940 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
|
1941 </entry> |
|
1203
796e24a218a4
Oops, a </row> tag was missing.
Matti Hamalainen <ccr@tnsp.org>
parents:
1202
diff
changeset
|
1942 </row> |
|
1157
25cee31780bc
Add note about /cursewarn setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
1156
diff
changeset
|
1943 <row> |
|
25cee31780bc
Add note about /cursewarn setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
1156
diff
changeset
|
1944 <entry>/cursewarn</entry> |
|
25cee31780bc
Add note about /cursewarn setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
1156
diff
changeset
|
1945 <entry> |
|
25cee31780bc
Add note about /cursewarn setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
1156
diff
changeset
|
1946 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
|
1947 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
|
1948 (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
|
1949 </entry> |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1950 </row> |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
1951 §macros_end; |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1952 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1953 </section> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1954 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1955 <!-- ================================================ --> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
1956 |
|
1220
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1957 <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
|
1958 |
| 1222 | 1959 <!-- |
|
1220
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1960 <note> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1961 <para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1962 <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
|
1963 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
|
1964 you can send complaints to nearest trashbin. |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1965 </para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1966 </note> |
| 1222 | 1967 --> |
|
1220
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1968 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1969 <para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1970 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
|
1971 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
|
1972 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
|
1973 (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
|
1974 so called "zero round"). |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1975 </para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1976 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1977 <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
|
1978 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
|
1979 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
|
1980 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
|
1981 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
|
1982 "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
|
1983 not always match the real ones. |
|
1220
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1984 <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
|
1985 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
|
1986 </para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1987 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1988 <note> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1989 <para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1990 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
|
1991 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
|
1992 </para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1993 <para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1994 <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
|
1995 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
|
1996 add that to your eqset swapping commands. |
|
1220
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1997 </para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1998 </note> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
1999 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2000 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2001 <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
|
2002 <para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2003 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
|
2004 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
|
2005 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
|
2006 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
|
2007 </para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2008 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2009 <para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2010 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
|
2011 </para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2012 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2013 <itemizedlist> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2014 <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
|
2015 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
|
2016 frequency. |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2017 </para></listitem> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2018 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2019 <listitem><para>One tick is always 10 heartbeats. |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2020 </para></listitem> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2021 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2022 <listitem><para>Battle rounds are always around ~3s, |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2023 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
|
2024 </para></listitem> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2025 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2026 <listitem><para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2027 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
|
2028 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
|
2029 </para></listitem> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2030 </itemizedlist> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2031 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2032 <para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2033 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
|
2034 </para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2035 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2036 <orderedlist> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2037 <listitem><para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2038 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
|
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 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
|
2043 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
|
2044 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
|
2045 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
|
2046 </para></listitem> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2047 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2048 <listitem> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2049 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2050 <para>In gheartbeat_timer() we check for:</para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2051 <itemizedlist> |
|
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 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
|
2054 if it was "too long" ago. |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2055 </para></listitem> |
|
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 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
|
2058 long ago. |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2059 </para></listitem> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2060 <listitem><para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2061 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
|
2062 </para></listitem> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2063 </itemizedlist> |
|
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 </listitem> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2066 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2067 </orderedlist> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2068 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2069 <para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2070 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
|
2071 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
|
2072 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
|
2073 </para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2074 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2075 <note> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2076 <para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2077 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
|
2078 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
|
2079 </para> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2080 </note> |
|
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 </section> |
|
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 </section> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2085 |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2086 <!-- ================================================ --> |
|
5d19404bec6b
Add documentation about heartbeat/tick predictor.
Matti Hamalainen <ccr@tnsp.org>
parents:
1203
diff
changeset
|
2087 |
|
889
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
2088 <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
|
2089 <para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
2090 </para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
2091 </section> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
2092 |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
2093 <!-- ================================================ --> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
2094 |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
2095 <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
|
2096 <para> |
| 275 | 2097 Base module for all things magical. This module is <emphasis>required</emphasis> |
| 2098 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
|
2099 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
|
2100 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
|
2101 </para> |
| 275 | 2102 |
| 2103 <para> | |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2104 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
|
2105 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
|
2106 at all times. |
| 275 | 2107 </para> |
| 2108 | |
|
889
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
2109 <itemizedlist> |
|
890
a864a635d545
Add information about resist reporting, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
889
diff
changeset
|
2110 <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
|
2111 (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
|
2112 </para></listitem> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
2113 <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
|
2114 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
|
2115 until your spell goes off. |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
2116 </para></listitem> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
2117 </itemizedlist> |
|
09f63922c16b
Remove references to misc module; general reorganizing.
Matti Hamalainen <ccr@tnsp.org>
parents:
882
diff
changeset
|
2118 |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2119 </section> |
|
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2120 |
| 248 | 2121 <!-- ================================================ --> |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2122 |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
2123 <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
|
2124 <para> |
|
414
b13a94bd4ee5
Added section skeleton for GgrTF::PartyPlacer
Matti Hamalainen <ccr@tnsp.org>
parents:
410
diff
changeset
|
2125 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
|
2126 <emphasis>pss</emphasis> (<emphasis>party status short</emphasis>) |
|
b13a94bd4ee5
Added section skeleton for GgrTF::PartyPlacer
Matti Hamalainen <ccr@tnsp.org>
parents:
410
diff
changeset
|
2127 -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
|
2128 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
|
2129 status information in compact format. |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2130 </para> |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2131 |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2132 <para> |
|
314
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2133 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
|
2134 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
|
2135 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
|
2136 unconsciousness, stun, formation, etc.</emphasis>. |
|
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2137 </para> |
|
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2138 |
|
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2139 <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
|
2140 </emphasis> when in stunned or unconscious state, but this is normally |
|
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2141 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
|
2142 </para> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2143 |
| 261 | 2144 <para> |
|
314
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2145 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
|
2146 <link linkend="usage-general-commands">/autopss</link> option). A normally issued |
| 271 | 2147 '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
|
2148 <emphasis>/pss</emphasis> macro or bind that to 'pss'. (See <link |
| 387 | 2149 linkend="usage-general-binds">Bindings</link>-section for more information.) |
| 261 | 2150 </para> |
| 2151 | |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2152 <screenshot> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2153 <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
|
2154 <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
|
2155 <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
|
2156 <textobject> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2157 <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
|
2158 </textobject> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2159 <caption> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2160 <para> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2161 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
|
2162 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
|
2163 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
|
2164 </para> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2165 </caption> |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2166 </mediaobject> |
|
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 |
| 267 | 2169 <screenshot> |
| 2170 <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
|
2171 <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
|
2172 <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
|
2173 <textobject> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2174 <phrase>Stunned</phrase> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2175 </textobject> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2176 <caption> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2177 <para> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2178 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
|
2179 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
|
2180 (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
|
2181 (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
|
2182 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
|
2183 </para> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2184 </caption> |
| 267 | 2185 </mediaobject> |
| 2186 </screenshot> | |
| 2187 | |
| 2188 <screenshot> | |
| 2189 <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
|
2190 <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
|
2191 <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
|
2192 <textobject> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2193 <phrase>Unconscious</phrase> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2194 </textobject> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2195 <caption> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2196 <para> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2197 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
|
2198 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
|
2199 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
|
2200 hopefully catching your attention. |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2201 </para> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2202 </caption> |
| 267 | 2203 </mediaobject> |
| 2204 </screenshot> | |
| 2205 | |
| 2206 | |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2207 <section><title>HP/SP/EP colours</title> |
| 271 | 2208 <para> |
| 2209 List of possible indicator colours and their meanings. &colourexplanation; | |
| 2210 </para> | |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2211 |
| 271 | 2212 |
| 1060 | 2213 <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
|
2214 <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
|
2215 <thead> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2216 <row> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2217 <entry>Colour</entry> |
| 271 | 2218 <entry>Background</entry> |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2219 <entry>Explanation</entry> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2220 </row> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2221 </thead> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2222 <tbody> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2223 <row> |
| 271 | 2224 <entry>Bright White</entry> |
| 2225 <entry>Bright Red</entry> | |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2226 <entry>Negative value (x < 0)</entry> |
| 267 | 2227 </row> |
| 2228 <row> | |
| 271 | 2229 <entry>Bright Red</entry> |
| 2230 <entry>-</entry> | |
| 267 | 2231 <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
|
2232 </row> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2233 <row> |
| 267 | 2234 <entry>Red (dark)</entry> |
| 271 | 2235 <entry>-</entry> |
| 267 | 2236 <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
|
2237 </row> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2238 <row> |
| 267 | 2239 <entry>Yellow (dark)</entry> |
| 271 | 2240 <entry>-</entry> |
| 267 | 2241 <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
|
2242 </row> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2243 <row> |
| 271 | 2244 <entry>Bright Yellow</entry> |
| 2245 <entry>-</entry> | |
| 267 | 2246 <entry>Less than 66% of max</entry> |
| 2247 </row> | |
| 2248 <row> | |
| 2249 <entry>Green (dark)</entry> | |
| 271 | 2250 <entry>-</entry> |
| 267 | 2251 <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
|
2252 </row> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2253 <row> |
| 271 | 2254 <entry>Bright Green</entry> |
| 2255 <entry>-</entry> | |
| 267 | 2256 <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
|
2257 </row> |
| 267 | 2258 </tbody> |
| 2259 </tgroup> | |
| 2260 </table> | |
| 2261 </section> | |
| 2262 | |
| 2263 <section><title>Player name colours</title> | |
| 271 | 2264 <para> |
| 2265 List of possible name colours and their meanings. &colourexplanation; | |
| 2266 </para> | |
| 267 | 2267 |
| 1060 | 2268 <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
|
2269 <tgroup cols="3" align="left"> |
| 267 | 2270 <thead> |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2271 <row> |
| 267 | 2272 <entry>Colour</entry> |
| 272 | 2273 <entry>Background</entry> |
| 267 | 2274 <entry>State description</entry> |
| 2275 </row> | |
| 2276 </thead> | |
| 2277 <tbody> | |
| 2278 <row> | |
| 271 | 2279 <entry>Bright White</entry> |
| 2280 <entry>-</entry> | |
| 267 | 2281 <entry>Normal</entry> |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2282 </row> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2283 <row> |
|
1596
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2284 <entry>Bright Black</entry> |
|
849
b9d2598660e0
Add idle status indication to pss-mangler.
Matti Hamalainen <ccr@tnsp.org>
parents:
847
diff
changeset
|
2285 <entry>-</entry> |
|
b9d2598660e0
Add idle status indication to pss-mangler.
Matti Hamalainen <ccr@tnsp.org>
parents:
847
diff
changeset
|
2286 <entry>Idle</entry> |
|
b9d2598660e0
Add idle status indication to pss-mangler.
Matti Hamalainen <ccr@tnsp.org>
parents:
847
diff
changeset
|
2287 </row> |
|
b9d2598660e0
Add idle status indication to pss-mangler.
Matti Hamalainen <ccr@tnsp.org>
parents:
847
diff
changeset
|
2288 <row> |
| 271 | 2289 <entry>Bright White</entry> |
| 2290 <entry>Bright Red</entry> | |
| 267 | 2291 <entry>Unconscious (unc)</entry> |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2292 </row> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2293 <row> |
| 271 | 2294 <entry>Bright Red</entry> |
| 2295 <entry>-</entry> | |
| 267 | 2296 <entry>Stunned (stun)</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> |
| 267 | 2299 <entry>Magenta</entry> |
| 271 | 2300 <entry>-</entry> |
|
1596
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2301 <entry>In form (form), or member (mbr)</entry> |
|
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2302 </row> |
|
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2303 <row> |
|
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2304 <entry>Cyan</entry> |
|
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2305 <entry>-</entry> |
|
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2306 <entry>Resting/camping/meditating (rest)</entry> |
|
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2307 </row> |
|
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2308 <row> |
|
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2309 <entry>Bright White</entry> |
|
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2310 <entry>Blue</entry> |
|
5d563bcc3a78
Update documentation slightly.
Matti Hamalainen <ccr@tnsp.org>
parents:
1587
diff
changeset
|
2311 <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
|
2312 </row> |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2313 §macros_end; |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2314 |
| 276 | 2315 <section> |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2316 §macros_1; |
| 276 | 2317 </para> |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2318 |
| 271 | 2319 <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
|
2320 <tgroup cols="2" align="left"> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2321 <thead> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2322 <row> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2323 <entry>Command</entry> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2324 <entry>Description</entry> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2325 </row> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2326 </thead> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2327 <tbody> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2328 <row> |
|
773
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2329 <entry>/prettypss</entry> |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2330 <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
|
2331 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
|
2332 </row> |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2333 <row> |
|
449
725695d31f21
Updated /pstatus -> pss and /pss -> /autopss accordingly.
Matti Hamalainen <ccr@tnsp.org>
parents:
422
diff
changeset
|
2334 <entry>/pss</entry> |
|
773
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2335 <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
|
2336 </row> |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2337 <row> |
|
449
725695d31f21
Updated /pstatus -> pss and /pss -> /autopss accordingly.
Matti Hamalainen <ccr@tnsp.org>
parents:
422
diff
changeset
|
2338 <entry>/autopss</entry> |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2339 <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
|
2340 </row> |
|
773
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2341 <row> |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2342 <entry>/fullparty</entry> |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2343 <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
|
2344 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
|
2345 are shown.</entry> |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2346 </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
|
2347 <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
|
2348 <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
|
2349 <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
|
2350 </row> |
|
258
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2351 </tbody> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2352 </tgroup> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2353 </table> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2354 </section> |
|
ee077893e923
Added new screenshots (from pss-mangler), some manual improvements.
Matti Hamalainen <ccr@tnsp.org>
parents:
255
diff
changeset
|
2355 |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2356 </section> |
|
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2357 |
| 248 | 2358 <!-- ================================================ --> |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2359 |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
2360 <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
|
2361 <para> |
|
546
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
2362 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
|
2363 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
|
2364 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
|
2365 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
|
2366 '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
|
2367 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
|
2368 </para> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
2369 |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
2370 <para> |
|
1385
6fb66ee3ae03
docs: Clarify functionality of party placer module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1381
diff
changeset
|
2371 <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
|
2372 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
|
2373 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
|
2374 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
|
2375 </emphasis> |
|
6fb66ee3ae03
docs: Clarify functionality of party placer module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1381
diff
changeset
|
2376 </para> |
|
6fb66ee3ae03
docs: Clarify functionality of party placer module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1381
diff
changeset
|
2377 |
|
6fb66ee3ae03
docs: Clarify functionality of party placer module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1381
diff
changeset
|
2378 <para> |
|
6fb66ee3ae03
docs: Clarify functionality of party placer module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1381
diff
changeset
|
2379 NOTICE! This module requires |
|
546
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
2380 <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
|
2381 </para> |
|
b13a94bd4ee5
Added section skeleton for GgrTF::PartyPlacer
Matti Hamalainen <ccr@tnsp.org>
parents:
410
diff
changeset
|
2382 |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2383 §macros_2; |
|
414
b13a94bd4ee5
Added section skeleton for GgrTF::PartyPlacer
Matti Hamalainen <ccr@tnsp.org>
parents:
410
diff
changeset
|
2384 <row> |
|
546
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
2385 <entry>/ppsave</entry> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
2386 <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
|
2387 in current formation are stored. |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
2388 </entry> |
|
414
b13a94bd4ee5
Added section skeleton for GgrTF::PartyPlacer
Matti Hamalainen <ccr@tnsp.org>
parents:
410
diff
changeset
|
2389 </row> |
|
b13a94bd4ee5
Added section skeleton for GgrTF::PartyPlacer
Matti Hamalainen <ccr@tnsp.org>
parents:
410
diff
changeset
|
2390 <row> |
|
546
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
2391 <entry>/ppreset</entry> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
2392 <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
|
2393 previously. Restoring occurs fully automatically. |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
2394 </entry> |
|
414
b13a94bd4ee5
Added section skeleton for GgrTF::PartyPlacer
Matti Hamalainen <ccr@tnsp.org>
parents:
410
diff
changeset
|
2395 </row> |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2396 §macros_end; |
|
414
b13a94bd4ee5
Added section skeleton for GgrTF::PartyPlacer
Matti Hamalainen <ccr@tnsp.org>
parents:
410
diff
changeset
|
2397 |
|
b13a94bd4ee5
Added section skeleton for GgrTF::PartyPlacer
Matti Hamalainen <ccr@tnsp.org>
parents:
410
diff
changeset
|
2398 </section> |
|
b13a94bd4ee5
Added section skeleton for GgrTF::PartyPlacer
Matti Hamalainen <ccr@tnsp.org>
parents:
410
diff
changeset
|
2399 |
|
b13a94bd4ee5
Added section skeleton for GgrTF::PartyPlacer
Matti Hamalainen <ccr@tnsp.org>
parents:
410
diff
changeset
|
2400 <!-- ================================================ --> |
|
b13a94bd4ee5
Added section skeleton for GgrTF::PartyPlacer
Matti Hamalainen <ccr@tnsp.org>
parents:
410
diff
changeset
|
2401 |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
2402 <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
|
2403 <note><para> |
|
230eb7ac1960
Add note about obsoleteness of GgrTF::Ptracker module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1157
diff
changeset
|
2404 <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
|
2405 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
|
2406 </emphasis> |
|
230eb7ac1960
Add note about obsoleteness of GgrTF::Ptracker module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1157
diff
changeset
|
2407 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
|
2408 </para></note> |
|
230eb7ac1960
Add note about obsoleteness of GgrTF::Ptracker module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1157
diff
changeset
|
2409 |
|
703
20f20c1e8548
Updated copyright notices; Cosmetic cleanups; Updates to documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
695
diff
changeset
|
2410 <para> |
| 1099 | 2411 Module for showing prots (and similar effects) affecting your party members. |
| 2412 Tracking these effects can be done in two separate ways: 1) Old way (compatible | |
| 2413 with HCBat also) is keeping account of different prot up/down messages on the | |
| 2414 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
|
2415 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
|
2416 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
|
2417 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
|
2418 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
|
2419 time is shown.</emphasis> |
|
773
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2420 </para> |
| 1099 | 2421 <note><para> |
| 2422 Due to the way the up/down message tracking works, it depends on your | |
| 2423 party members to use <emphasis>working, non-broken</emphasis> triggers | |
| 2424 which use up/down messages that are recognizable to the ptracker module. | |
| 1225 | 2425 However, this does not affect 'show effects' mode in any way. |
| 1099 | 2426 </para></note> |
| 2427 | |
|
773
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2428 <screen> |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2429 .------------+-----+-----+-----+-----+-----+-----+-----+-----+ |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2430 | | 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
|
2431 +------------+-----+-----+-----+-----+-----+-----+-----+-----+ |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2432 |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
|
2433 |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
|
2434 |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
|
2435 |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
|
2436 |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
|
2437 |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
|
2438 |Jrj | | | | | | 6:22| | | |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2439 |Daria | | | | | | | | | |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2440 |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
|
2441 `------------+-----+-----+-----+-----+-----+-----+-----+-----+ |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2442 </screen> |
|
703
20f20c1e8548
Updated copyright notices; Cosmetic cleanups; Updates to documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
695
diff
changeset
|
2443 |
|
20f20c1e8548
Updated copyright notices; Cosmetic cleanups; Updates to documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
695
diff
changeset
|
2444 <para> |
|
20f20c1e8548
Updated copyright notices; Cosmetic cleanups; Updates to documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
695
diff
changeset
|
2445 <emphasis>NOTICE! This module requires |
|
20f20c1e8548
Updated copyright notices; Cosmetic cleanups; Updates to documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
695
diff
changeset
|
2446 <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
|
2447 </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
|
2448 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
|
2449 and prot tracker. |
|
703
20f20c1e8548
Updated copyright notices; Cosmetic cleanups; Updates to documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
695
diff
changeset
|
2450 </para> |
|
20f20c1e8548
Updated copyright notices; Cosmetic cleanups; Updates to documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
695
diff
changeset
|
2451 |
|
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
|
2452 <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
|
2453 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
|
2454 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
|
2455 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
|
2456 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
|
2457 </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
|
2458 |
|
1065
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2459 <!-- @commands --> |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2460 <!-- @binds --> |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2461 <!-- @keybinds --> |
|
703
20f20c1e8548
Updated copyright notices; Cosmetic cleanups; Updates to documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
695
diff
changeset
|
2462 |
|
20f20c1e8548
Updated copyright notices; Cosmetic cleanups; Updates to documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
695
diff
changeset
|
2463 </section> |
|
20f20c1e8548
Updated copyright notices; Cosmetic cleanups; Updates to documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
695
diff
changeset
|
2464 |
|
20f20c1e8548
Updated copyright notices; Cosmetic cleanups; Updates to documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
695
diff
changeset
|
2465 <!-- ================================================ --> |
|
20f20c1e8548
Updated copyright notices; Cosmetic cleanups; Updates to documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
695
diff
changeset
|
2466 |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
2467 <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
|
2468 <para> |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2469 This module adds in translating of spellwords to actual spell names. |
| 1060 | 2470 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
|
2471 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
|
2472 under GPL with permission. |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2473 </para> |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2474 |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2475 <para> |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2476 The translator works by printing the spell name in parentheses |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2477 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
|
2478 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
|
2479 </para> |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2480 |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2481 <para> |
|
280
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2482 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
|
2483 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
|
2484 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
|
2485 otherwise interesting spells are cast. |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2486 </para> |
| 271 | 2487 |
|
280
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 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
|
2490 </para> |
| 271 | 2491 |
|
280
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2492 <screen> |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2493 You utter the magic words (unstun) |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2494 |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2495 You utter the magic words 'Paxus' (unstun) |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2496 |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2497 Acolyte waves his index finger while uttering (flame arrow) |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2498 |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2499 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
|
2500 </screen> |
|
266b73905c1e
Information about spellwords translator.
Matti Hamalainen <ccr@tnsp.org>
parents:
279
diff
changeset
|
2501 |
| 1060 | 2502 <!-- @commands --> |
| 271 | 2503 |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2504 </section> |
|
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2505 |
| 248 | 2506 <!-- ================================================ --> |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2507 |
|
1065
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2508 <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
|
2509 <para> |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2510 </para> |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2511 |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2512 <note> |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2513 <para> |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2514 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
|
2515 </para> |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2516 </note> |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2517 |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2518 </section> |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2519 |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2520 <!-- ================================================ --> |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2521 |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
2522 <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
|
2523 <para> |
| 262 | 2524 Due to the age of Hard Core BatMUD's current codebase and conceptual |
| 2525 differences, several exceptions and workarounds are needed to | |
| 2526 improve GgrTF's compatibility with the HCBat environment. | |
| 2527 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
|
2528 </para> |
| 262 | 2529 |
| 2530 <para> | |
| 2531 Purpose of this module is dissimilar to others, as it is meant | |
| 2532 to contain almost everything related to peculiarities and | |
| 2533 differences of HCBat. We do not have separate | |
| 2534 guild-specific modules for HCBat, the code needed to | |
| 2535 catch the differences is either in this module or in some | |
| 2536 special cases in the guild-specific modules. | |
| 2537 </para> | |
| 2538 | |
| 2539 <para> | |
| 2540 At the moment this module is rather simple, only replacing | |
| 2541 GgrTF's output macros to work around the lack of 'party report' | |
| 2542 -channel in HCBat. In future more functionality may be added, | |
| 2543 feel free to report bugs/incompatibilities to us. | |
| 2544 </para> | |
| 2545 | |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2546 </section> |
|
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2547 |
| 248 | 2548 <!-- ================================================ --> |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2549 |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
2550 <section id="usage-tf5"><title>TinyFugue 5 support (gm-tf5.tf)</title> |
|
314
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2551 <para> |
| 422 | 2552 This is a special enhancement module for those who use GgrTF |
|
703
20f20c1e8548
Updated copyright notices; Cosmetic cleanups; Updates to documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
695
diff
changeset
|
2553 with &tfurl; version 5.0 (beta 7 and LATER). Although GgrTF should work with TF5 |
| 422 | 2554 without this module, you may wish to take benefit of the |
| 2555 enhanced features designed for TF5 this module provides. | |
|
314
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2556 </para> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2557 |
|
1065
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2558 <note> |
|
642
1be950a666af
Added note about TF5 module requiring 5.0 beta 7 or later.
Matti Hamalainen <ccr@tnsp.org>
parents:
638
diff
changeset
|
2559 <para> |
|
1065
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2560 The code in this module uses features available on TF 5.0 beta 7 |
|
642
1be950a666af
Added note about TF5 module requiring 5.0 beta 7 or later.
Matti Hamalainen <ccr@tnsp.org>
parents:
638
diff
changeset
|
2561 and later, it will NOT work correctly in older betas! |
|
1be950a666af
Added note about TF5 module requiring 5.0 beta 7 or later.
Matti Hamalainen <ccr@tnsp.org>
parents:
638
diff
changeset
|
2562 </para> |
|
1598
e3683413d8e2
Add notes about settings correctness.
Matti Hamalainen <ccr@tnsp.org>
parents:
1597
diff
changeset
|
2563 <para> |
|
e3683413d8e2
Add notes about settings correctness.
Matti Hamalainen <ccr@tnsp.org>
parents:
1597
diff
changeset
|
2564 <emphasis>The functionality of the statusline depends on |
|
e3683413d8e2
Add notes about settings correctness.
Matti Hamalainen <ccr@tnsp.org>
parents:
1597
diff
changeset
|
2565 your <link linkend="inst-config-batmud">BatMUD settings</link> |
| 1601 | 2566 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
|
2567 not appear, most likely your 'sc' setting is "wrong", |
|
e3683413d8e2
Add notes about settings correctness.
Matti Hamalainen <ccr@tnsp.org>
parents:
1597
diff
changeset
|
2568 and thus does not get parsed by GgrTF. |
|
e3683413d8e2
Add notes about settings correctness.
Matti Hamalainen <ccr@tnsp.org>
parents:
1597
diff
changeset
|
2569 </para> |
|
1065
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2570 </note> |
|
642
1be950a666af
Added note about TF5 module requiring 5.0 beta 7 or later.
Matti Hamalainen <ccr@tnsp.org>
parents:
638
diff
changeset
|
2571 |
| 638 | 2572 <screenshot> |
| 2573 <mediaobject> | |
| 2574 <imageobject><imagedata fileref="statusbar_tf5.gif" format="GIF" /></imageobject> | |
| 2575 <imageobject><imagedata fileref="statusbar_tf5.eps" format="EPS" /></imageobject> | |
| 2576 <textobject> | |
| 2577 <phrase>GgrTF statusline</phrase> | |
| 2578 </textobject> | |
| 2579 <caption> | |
| 2580 <para>Example of typical basic GgrTF statusline in TF5.</para> | |
| 2581 </caption> | |
| 2582 </mediaobject> | |
| 2583 </screenshot> | |
| 2584 | |
|
314
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2585 <itemizedlist> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2586 <listitem><para> |
| 422 | 2587 Enhanced 2-row statusline: First line contains HP/SP/EP- and |
|
314
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2588 skill/spell/etc- information as usual. Prot status has been |
| 422 | 2589 moved to the second line. |
|
314
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2590 </para></listitem> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2591 |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2592 </itemizedlist> |
| 422 | 2593 |
| 2594 <!-- | |
| 2595 - example configuration | |
| 2596 - document special variables | |
| 317 | 2597 --> |
|
314
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2598 </section> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2599 |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2600 <!-- ================================================ --> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
2601 |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
2602 <section id="usage-rais"><title>Raise/Resurrect/New Body/etc. (gm-rais.tf)</title> |
| 230 | 2603 <para> |
| 317 | 2604 This module contains utility functionality for everyone who casts |
| 2605 different types of dead raising spells, including "raise dead", | |
| 2606 "resurrect", "new body", "reincarnation", etc. | |
| 230 | 2607 </para> |
| 317 | 2608 |
| 2609 <para> | |
| 2610 Automatic list is kept of people who have accepted some such service | |
| 2611 from you, along with information what spell was requested. List can | |
| 2612 be viewed, and you can launch a cast at the latest accept or by | |
| 2613 specifying a player's name, cast his/her request. | |
| 2614 </para> | |
| 2615 | |
| 379 | 2616 <para> |
| 387 | 2617 You can either directly use the macros or use <link |
| 2618 linkend="usage-general-binds">command bindings</link> | |
| 2619 to have shorthand commands instead. | |
| 379 | 2620 </para> |
| 2621 | |
| 317 | 2622 <screenshot> |
| 2623 <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
|
2624 <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
|
2625 <imageobject><imagedata fileref="rais_list.eps" format="EPS" /></imageobject> |
| 317 | 2626 <textobject> |
| 2627 <phrase>List of accepts</phrase> | |
| 2628 </textobject> | |
| 2629 <caption> | |
| 2630 <para> | |
|
583
4bc4bc602eaf
Renamed macros acpt_* -> ac*
Matti Hamalainen <ccr@tnsp.org>
parents:
567
diff
changeset
|
2631 An example output of "/aclist" macro, listing the players |
| 379 | 2632 who have accepted services from you and respective requested |
| 2633 spells for each. The time field shows how much | |
| 317 | 2634 time has passed from the accept. |
| 2635 </para> | |
| 2636 </caption> | |
| 2637 </mediaobject> | |
| 2638 </screenshot> | |
| 2639 | |
| 2640 <table><title>Macro commands</title> | |
|
1545
fe83084ff7e1
Fix some table column width.
Matti Hamalainen <ccr@tnsp.org>
parents:
1544
diff
changeset
|
2641 <tgroup cols="2" align="left"> |
| 317 | 2642 <thead> |
| 2643 <row> | |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2644 <entry>Command</entry> |
| 317 | 2645 <entry>Description</entry> |
| 2646 </row> | |
| 2647 </thead> | |
| 2648 <tbody> | |
| 2649 <row> | |
|
583
4bc4bc602eaf
Renamed macros acpt_* -> ac*
Matti Hamalainen <ccr@tnsp.org>
parents:
567
diff
changeset
|
2650 <entry>/aclist</entry> |
| 317 | 2651 <entry> |
| 2652 View list of people who have accepted something from you. | |
| 2653 </entry> | |
| 2654 </row> | |
| 2655 <row> | |
|
583
4bc4bc602eaf
Renamed macros acpt_* -> ac*
Matti Hamalainen <ccr@tnsp.org>
parents:
567
diff
changeset
|
2656 <entry>/accast [name]</entry> |
| 317 | 2657 <entry> |
| 2658 Cast Last-type functionality. Without arguments casts the LATEST | |
| 2659 requested spell. Optionally you can specify a name of the player | |
| 2660 and the spell requested by him/her is cast. | |
| 2661 </entry> | |
| 2662 </row> | |
| 2663 <row> | |
|
583
4bc4bc602eaf
Renamed macros acpt_* -> ac*
Matti Hamalainen <ccr@tnsp.org>
parents:
567
diff
changeset
|
2664 <entry>/acclear</entry> |
| 317 | 2665 <entry> |
| 379 | 2666 Clears the list. Useful, if the automatic removal |
| 2667 malfunctions for some reason. (For example, if target | |
| 2668 uses 'pray' to become alive again, there is no message | |
| 2669 provided to the caster.) | |
| 317 | 2670 </entry> |
| 2671 </row> | |
| 2672 </tbody> | |
| 2673 </tgroup> | |
| 2674 </table> | |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2675 |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2676 <!-- @binds --> |
| 317 | 2677 |
| 230 | 2678 </section> |
| 2679 | |
| 248 | 2680 <!-- ================================================ --> |
| 230 | 2681 |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
2682 <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
|
2683 <para> |
|
774
89661ef754b4
Incomplete documentation of hit statistics module.
Matti Hamalainen <ccr@tnsp.org>
parents:
773
diff
changeset
|
2684 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
|
2685 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
|
2686 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
|
2687 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
|
2688 of hits you mostly deal out. |
|
930c1485903f
Added few details about hitstats module.
Matti Hamalainen <ccr@tnsp.org>
parents:
980
diff
changeset
|
2689 </para> |
|
930c1485903f
Added few details about hitstats module.
Matti Hamalainen <ccr@tnsp.org>
parents:
980
diff
changeset
|
2690 |
|
930c1485903f
Added few details about hitstats module.
Matti Hamalainen <ccr@tnsp.org>
parents:
980
diff
changeset
|
2691 <para> |
|
930c1485903f
Added few details about hitstats module.
Matti Hamalainen <ccr@tnsp.org>
parents:
980
diff
changeset
|
2692 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
|
2693 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
|
2694 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
|
2695 </para> |
|
1007
8c3b1463a0d9
Added some notes to hitstats documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1005
diff
changeset
|
2696 |
|
988
930c1485903f
Added few details about hitstats module.
Matti Hamalainen <ccr@tnsp.org>
parents:
980
diff
changeset
|
2697 <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
|
2698 <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
|
2699 |
|
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
|
2700 <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
|
2701 <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
|
2702 <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
|
2703 <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
|
2704 <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
|
2705 <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
|
2706 <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
|
2707 <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
|
2708 <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
|
2709 <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
|
2710 </itemizedlist> |
|
930c1485903f
Added few details about hitstats module.
Matti Hamalainen <ccr@tnsp.org>
parents:
980
diff
changeset
|
2711 |
|
1007
8c3b1463a0d9
Added some notes to hitstats documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1005
diff
changeset
|
2712 <note><para> |
|
8c3b1463a0d9
Added some notes to hitstats documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1005
diff
changeset
|
2713 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
|
2714 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
|
2715 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
|
2716 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
|
2717 </emphasis> |
|
1007
8c3b1463a0d9
Added some notes to hitstats documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1005
diff
changeset
|
2718 </para></note> |
|
8c3b1463a0d9
Added some notes to hitstats documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1005
diff
changeset
|
2719 |
|
988
930c1485903f
Added few details about hitstats module.
Matti Hamalainen <ccr@tnsp.org>
parents:
980
diff
changeset
|
2720 <para> |
|
930c1485903f
Added few details about hitstats module.
Matti Hamalainen <ccr@tnsp.org>
parents:
980
diff
changeset
|
2721 Example of /hstats output: |
|
930c1485903f
Added few details about hitstats module.
Matti Hamalainen <ccr@tnsp.org>
parents:
980
diff
changeset
|
2722 </para> |
|
774
89661ef754b4
Incomplete documentation of hit statistics module.
Matti Hamalainen <ccr@tnsp.org>
parents:
773
diff
changeset
|
2723 <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
|
2724 ,----------------------. |
|
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
|
2725 | 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
|
2726 +-----------------------------------------------. |
|
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
|
2727 +-| 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
|
2728 |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
|
2729 |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
|
2730 |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
|
2731 |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
|
2732 |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
|
2733 |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
|
2734 | | |
|
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
|
2735 +-----------------------------------------------' |
|
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
|
2736 +-| 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
|
2737 | 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
|
2738 | 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
|
2739 +----------------------------------------------+-------' |
|
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
|
2740 | 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
|
2741 | 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
|
2742 | 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
|
2743 `----------------------------------------------' |
|
774
89661ef754b4
Incomplete documentation of hit statistics module.
Matti Hamalainen <ccr@tnsp.org>
parents:
773
diff
changeset
|
2744 </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
|
2745 |
|
774
89661ef754b4
Incomplete documentation of hit statistics module.
Matti Hamalainen <ccr@tnsp.org>
parents:
773
diff
changeset
|
2746 <para> |
|
972
ea85d502d46f
Misc. typo fixes and minor reorganization.
Matti Hamalainen <ccr@tnsp.org>
parents:
969
diff
changeset
|
2747 Format of hits described above is: |
|
1007
8c3b1463a0d9
Added some notes to hitstats documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1005
diff
changeset
|
2748 | 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
|
2749 </para> |
|
89661ef754b4
Incomplete documentation of hit statistics module.
Matti Hamalainen <ccr@tnsp.org>
parents:
773
diff
changeset
|
2750 |
|
988
930c1485903f
Added few details about hitstats module.
Matti Hamalainen <ccr@tnsp.org>
parents:
980
diff
changeset
|
2751 <note><para> |
|
930c1485903f
Added few details about hitstats module.
Matti Hamalainen <ccr@tnsp.org>
parents:
980
diff
changeset
|
2752 <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
|
2753 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
|
2754 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
|
2755 </para></note> |
|
972
ea85d502d46f
Misc. typo fixes and minor reorganization.
Matti Hamalainen <ccr@tnsp.org>
parents:
969
diff
changeset
|
2756 |
|
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
|
2757 <!-- @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
|
2758 <!-- @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
|
2759 <!-- @keybinds --> |
|
773
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2760 |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2761 </section> |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2762 |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2763 <!-- ================================================ --> |
|
cb2413912904
Update pssmangler, and ptracker sections. Add skeleton hstats section.
Matti Hamalainen <ccr@tnsp.org>
parents:
772
diff
changeset
|
2764 |
|
1377
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2765 <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
|
2766 <para> |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2767 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
|
2768 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
|
2769 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
|
2770 </para> |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2771 |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2772 <para> |
|
1563
d8c04a55d1d4
Move reagent pouch command documentation to tfdoc inline docs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1562
diff
changeset
|
2773 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
|
2774 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
|
2775 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
|
2776 </para> |
|
d8c04a55d1d4
Move reagent pouch command documentation to tfdoc inline docs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1562
diff
changeset
|
2777 |
|
d8c04a55d1d4
Move reagent pouch command documentation to tfdoc inline docs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1562
diff
changeset
|
2778 <para> |
|
1377
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2779 Example of output: |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2780 </para> |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2781 <screen> |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2782 +-| General |----------------------------------------------------------------+ |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2783 | Item....: a pair of stylish blue breeches | |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2784 | Name....: blue breeches | |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2785 | Handles.: 'breeches', 'stylish blue breeches', 'silk breeches' and | |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2786 | 'pants' | |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2787 | Names...: Molotov, Belse and Ekkivekki | |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2788 | Slots...: leg and leg | |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2789 | Material: silk | |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2790 +----------------------------------------------------------------------------+ |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2791 | 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
|
2792 | Size....: somewhat small | Maxcond..: AWESOME | |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2793 | Worth...: 8851 | Quality..: superb | |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2794 | Weight..: almost weightless | Weight/kg: 0.050 | |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2795 +-| Stats |------------------------------------------------------------------+ |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2796 | insignificantly improve your wis | |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2797 +-| Misc |-------------------------------------------------------------------+ |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2798 | 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
|
2799 | 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
|
2800 | Wielded.: | |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2801 +----------------------------------------------------------------------------+ |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2802 </screen> |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2803 |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2804 <!-- @commands --> |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2805 <!-- @binds --> |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2806 <!-- @keybinds --> |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2807 |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2808 </section> |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2809 |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2810 <!-- ================================================ --> |
|
91d712edde9f
Added section for Identify module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1376
diff
changeset
|
2811 |
|
956
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
2812 <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
|
2813 <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
|
2814 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
|
2815 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
|
2816 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
|
2817 </para> |
|
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2818 |
|
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2819 <para> |
|
53b64fd4ffea
Added 'screenshot' of reagent pouch mangler, and a general module description for rpouch.
Matti Hamalainen <ccr@tnsp.org>
parents:
995
diff
changeset
|
2820 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
|
2821 </para> |
|
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
2822 <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
|
2823 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
|
2824 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
|
2825 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
|
2826 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
|
2827 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
|
2828 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
|
2829 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
|
2830 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
|
2831 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
|
2832 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
|
2833 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
|
2834 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
|
2835 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
|
2836 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
|
2837 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
|
2838 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
|
2839 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
|
2840 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
|
2841 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
|
2842 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
|
2843 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
|
2844 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
|
2845 It looks very very heavy. |
|
956
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
2846 </screen> |
|
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
2847 |
|
972
ea85d502d46f
Misc. typo fixes and minor reorganization.
Matti Hamalainen <ccr@tnsp.org>
parents:
969
diff
changeset
|
2848 <note><para> |
|
ea85d502d46f
Misc. typo fixes and minor reorganization.
Matti Hamalainen <ccr@tnsp.org>
parents:
969
diff
changeset
|
2849 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
|
2850 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
|
2851 this module. |
|
ea85d502d46f
Misc. typo fixes and minor reorganization.
Matti Hamalainen <ccr@tnsp.org>
parents:
969
diff
changeset
|
2852 </para></note> |
|
ea85d502d46f
Misc. typo fixes and minor reorganization.
Matti Hamalainen <ccr@tnsp.org>
parents:
969
diff
changeset
|
2853 |
|
1563
d8c04a55d1d4
Move reagent pouch command documentation to tfdoc inline docs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1562
diff
changeset
|
2854 <!-- @commands --> |
|
956
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
2855 |
|
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
2856 </section> |
|
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
2857 |
|
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
2858 <!-- ================================================ --> |
|
3b2205de6054
More work on the manual and CSS stylesheet.
Matti Hamalainen <ccr@tnsp.org>
parents:
954
diff
changeset
|
2859 |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
2860 <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
|
2861 <para> |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2862 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
|
2863 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
|
2864 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
|
2865 <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
|
2866 </para> |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
2867 |
|
389
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2868 <itemizedlist> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2869 <listitem><para> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2870 <emphasis>Channeller aura</emphasis>: |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2871 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
|
2872 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
|
2873 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
|
2874 to recharge. |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2875 </para></listitem> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2876 <listitem><para> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2877 <emphasis>Blast resistance reporting</emphasis>: |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2878 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
|
2879 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
|
2880 </para></listitem> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2881 <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
|
2882 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
|
2883 </para></listitem> |
|
30f38a49143d
Lots of updates and half-finished new content added.
Matti Hamalainen <ccr@tnsp.org>
parents:
387
diff
changeset
|
2884 </itemizedlist> |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
2885 |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2886 <!-- @commands --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2887 <!-- @binds --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2888 <!-- @keybinds --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2889 |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2890 </section> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2891 |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2892 <!-- ================================================ --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2893 |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2894 <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
|
2895 <para> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2896 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
|
2897 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
|
2898 </para> |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2899 |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
2900 <note><para> |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2901 This module requires the generic |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2902 <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
|
2903 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
|
2904 </para></note> |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2905 |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2906 <!-- @commands --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2907 <!-- @binds --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2908 <!-- @keybinds --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2909 |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2910 </section> |
|
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2911 |
| 248 | 2912 <!-- ================================================ --> |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2913 |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
2914 <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
|
2915 <para> |
| 263 | 2916 This module provides, in addition to basic skill/spell fail/fumble |
| 233 | 2917 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
|
2918 Many of the command macros support "autotargetting", which basically |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2919 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
|
2920 lumberjacking and "/mine" for mining and GgrTF usually knows what |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2921 to do. Some macros require bit more specific arguments. |
| 233 | 2922 </para> |
| 2923 | |
| 2924 <para> | |
| 2925 There is also support for merchant belt, which can be enabled if | |
| 2926 you have one available. In case your belt is not complete or is | |
| 2927 totally non-existent, the system has semi-automatic tool wielding | |
| 2928 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
|
2929 automagically change to proper tools (saw -> hammer/pick). The |
| 787 | 2930 system is not perfect and sometimes it may fail, however. |
| 233 | 2931 </para> |
| 2932 | |
| 2933 <para> | |
|
1071
a728ef32c77e
Add hint to merchant module documentation about usefulness of reagent pouch module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1069
diff
changeset
|
2934 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
|
2935 <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
|
2936 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
|
2937 </para> |
|
a728ef32c77e
Add hint to merchant module documentation about usefulness of reagent pouch module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1069
diff
changeset
|
2938 |
|
a728ef32c77e
Add hint to merchant module documentation about usefulness of reagent pouch module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1069
diff
changeset
|
2939 <para> |
| 271 | 2940 Notice that you probably MUST redefine some of these |
|
249
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2941 macros and default settings in your TF configuration file! |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2942 (See <link linkend="usage-merchant-settings">Settings</link>-section below.) |
| 233 | 2943 </para> |
| 2944 | |
|
1069
1b81712b6261
Improve merchant module documentation, move things to embedded TFDocs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1065
diff
changeset
|
2945 <note><para> |
|
1b81712b6261
Improve merchant module documentation, move things to embedded TFDocs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1065
diff
changeset
|
2946 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
|
2947 </para></note> |
|
1b81712b6261
Improve merchant module documentation, move things to embedded TFDocs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1065
diff
changeset
|
2948 |
|
1b81712b6261
Improve merchant module documentation, move things to embedded TFDocs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1065
diff
changeset
|
2949 <!-- @commands --> |
|
1b81712b6261
Improve merchant module documentation, move things to embedded TFDocs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1065
diff
changeset
|
2950 <!-- @binds --> |
|
1b81712b6261
Improve merchant module documentation, move things to embedded TFDocs.
Matti Hamalainen <ccr@tnsp.org>
parents:
1065
diff
changeset
|
2951 <!-- @keybinds --> |
|
249
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2952 |
| 271 | 2953 <section id="usage-merchant-settings"> |
| 2954 §variables; | |
|
249
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2955 <row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2956 <entry>mtool_mine</entry> |
| 251 | 2957 <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
|
2958 </row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2959 <row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2960 <entry>mtool_lj</entry> |
| 251 | 2961 <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
|
2962 </row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2963 <row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2964 <entry>mtool_bs</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2965 <entry>Tool(s) for blacksmithing.</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2966 </row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2967 <row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2968 <entry>mtool_cp</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2969 <entry>Tool(s) for carpentry.</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2970 </row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2971 <row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2972 <entry>mtool_gc</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2973 <entry>Tool(s) for gem cutting.</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2974 </row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2975 <row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2976 <entry>mtool_gb</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2977 <entry>Tool(s) for glassblowing.</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2978 </row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2979 <row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2980 <entry>mtool_ma</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2981 <entry>Tool(s) for masonry.</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2982 </row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2983 <row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2984 <entry>mtool_sw</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2985 <entry>Tool(s) for sewing.</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2986 </row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2987 <row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2988 <entry>mtool_sc</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2989 <entry>Tool(s) for sculpture skill.</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2990 </row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2991 <row> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2992 <entry>mforge_*</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2993 <entry>Forges/workbenches for skills (similar to mtool_* variables)</entry> |
|
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2994 </row> |
| 271 | 2995 §variablesend; |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
2996 |
|
249
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
2997 |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2998 </section> |
|
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
2999 |
| 248 | 3000 <!-- ================================================ --> |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
3001 |
|
1376
3d73752368ae
docs: Added barebones alchemist section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1364
diff
changeset
|
3002 <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
|
3003 <para> |
|
1378
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
3004 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
|
3005 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
|
3006 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
|
3007 additional helper for potion research. |
|
1376
3d73752368ae
docs: Added barebones alchemist section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1364
diff
changeset
|
3008 </para> |
|
3d73752368ae
docs: Added barebones alchemist section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1364
diff
changeset
|
3009 |
|
1378
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
3010 <para> |
|
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
3011 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
|
3012 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
|
3013 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
|
3014 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
|
3015 </para> |
|
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
3016 |
|
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
3017 <para> |
|
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
3018 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
|
3019 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
|
3020 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
|
3021 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
|
3022 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
|
3023 </para> |
|
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
3024 |
|
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
3025 <para> |
|
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
3026 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
|
3027 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
|
3028 |
|
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
3029 <userinput>/eval /set galch_file=%{HOME}/someotherfile.txt</userinput> |
|
fbf2af8e3128
Improve documentation of alchemist module.
Matti Hamalainen <ccr@tnsp.org>
parents:
1377
diff
changeset
|
3030 |
|
1380
27c5c0603192
Add note about setting galch_file variable.
Matti Hamalainen <ccr@tnsp.org>
parents:
1379
diff
changeset
|
3031 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
|
3032 </para> |
|
27c5c0603192
Add note about setting galch_file variable.
Matti Hamalainen <ccr@tnsp.org>
parents:
1379
diff
changeset
|
3033 |
|
1376
3d73752368ae
docs: Added barebones alchemist section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1364
diff
changeset
|
3034 <!-- @commands --> |
|
3d73752368ae
docs: Added barebones alchemist section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1364
diff
changeset
|
3035 <!-- @binds --> |
|
3d73752368ae
docs: Added barebones alchemist section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1364
diff
changeset
|
3036 <!-- @keybinds --> |
|
3d73752368ae
docs: Added barebones alchemist section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1364
diff
changeset
|
3037 |
|
3d73752368ae
docs: Added barebones alchemist section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1364
diff
changeset
|
3038 </section> |
|
3d73752368ae
docs: Added barebones alchemist section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1364
diff
changeset
|
3039 |
|
3d73752368ae
docs: Added barebones alchemist section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1364
diff
changeset
|
3040 <!-- ================================================ --> |
|
3d73752368ae
docs: Added barebones alchemist section.
Matti Hamalainen <ccr@tnsp.org>
parents:
1364
diff
changeset
|
3041 |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
3042 <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
|
3043 <para> |
| 263 | 3044 Provides a translator for barbarian reputation bar, reputation |
| 254 | 3045 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
|
3046 </para> |
|
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
3047 |
| 276 | 3048 <section> |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3049 §macros_1; |
| 271 | 3050 </para> |
|
236
11b8e0016dcb
Added some information about ggrtf-barb.tf -module
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
235
diff
changeset
|
3051 |
| 271 | 3052 <table><title>Macro commands</title> |
|
800
eeddfde43980
Fix barb module documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
787
diff
changeset
|
3053 <tgroup cols="3" align="left"> |
|
236
11b8e0016dcb
Added some information about ggrtf-barb.tf -module
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
235
diff
changeset
|
3054 <thead> |
|
11b8e0016dcb
Added some information about ggrtf-barb.tf -module
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
235
diff
changeset
|
3055 <row> |
|
800
eeddfde43980
Fix barb module documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
787
diff
changeset
|
3056 <entry>Binding</entry> |
|
eeddfde43980
Fix barb module documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
787
diff
changeset
|
3057 <entry>Macro</entry> |
|
236
11b8e0016dcb
Added some information about ggrtf-barb.tf -module
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
235
diff
changeset
|
3058 <entry>Description</entry> |
|
11b8e0016dcb
Added some information about ggrtf-barb.tf -module
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
235
diff
changeset
|
3059 </row> |
|
11b8e0016dcb
Added some information about ggrtf-barb.tf -module
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
235
diff
changeset
|
3060 </thead> |
|
11b8e0016dcb
Added some information about ggrtf-barb.tf -module
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
235
diff
changeset
|
3061 <tbody> |
|
11b8e0016dcb
Added some information about ggrtf-barb.tf -module
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
235
diff
changeset
|
3062 <row> |
|
800
eeddfde43980
Fix barb module documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
787
diff
changeset
|
3063 <entry>repu</entry> |
|
eeddfde43980
Fix barb module documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
787
diff
changeset
|
3064 <entry>/showrep</entry> |
|
314
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3065 <entry> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3066 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
|
3067 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
|
3068 </entry> |
|
236
11b8e0016dcb
Added some information about ggrtf-barb.tf -module
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
235
diff
changeset
|
3069 </row> |
|
11b8e0016dcb
Added some information about ggrtf-barb.tf -module
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
235
diff
changeset
|
3070 <row> |
|
800
eeddfde43980
Fix barb module documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
787
diff
changeset
|
3071 <entry>lb</entry> |
|
eeddfde43980
Fix barb module documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
787
diff
changeset
|
3072 <entry>/lootburn</entry> |
|
314
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3073 <entry> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3074 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
|
3075 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
|
3076 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
|
3077 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
|
3078 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
|
3079 immediately. |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3080 </entry> |
|
236
11b8e0016dcb
Added some information about ggrtf-barb.tf -module
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
235
diff
changeset
|
3081 </row> |
|
11b8e0016dcb
Added some information about ggrtf-barb.tf -module
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
235
diff
changeset
|
3082 <row> |
|
800
eeddfde43980
Fix barb module documentation a bit.
Matti Hamalainen <ccr@tnsp.org>
parents:
787
diff
changeset
|
3083 <entry></entry> |
|
237
6c495ddc7d4d
forgot <action> from burnaction
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
236
diff
changeset
|
3084 <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
|
3085 <entry> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3086 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
|
3087 <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
|
3088 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
|
3089 </entry> |
|
236
11b8e0016dcb
Added some information about ggrtf-barb.tf -module
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
235
diff
changeset
|
3090 </row> |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3091 §macros_end; |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3092 |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3093 <!-- @commands --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3094 <!-- @binds --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3095 <!-- @keybinds --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3096 |
|
236
11b8e0016dcb
Added some information about ggrtf-barb.tf -module
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
235
diff
changeset
|
3097 </section> |
|
11b8e0016dcb
Added some information about ggrtf-barb.tf -module
Jarkko Vaaraniemi <jeskko@pupunen.net>
parents:
235
diff
changeset
|
3098 |
| 248 | 3099 <!-- ================================================ --> |
| 3100 | |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
3101 <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
|
3102 <para> |
|
1065
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
3103 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
|
3104 spider servants. |
|
249
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
3105 </para> |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
3106 |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3107 <!-- @commands --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3108 <!-- @binds --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3109 <!-- @keybinds --> |
|
249
c864584906a2
Improvements in merchant section.
Matti Hamalainen <ccr@tnsp.org>
parents:
248
diff
changeset
|
3110 |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
3111 </section> |
|
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
3112 |
| 248 | 3113 <!-- ================================================ --> |
|
231
2399b7d96036
More twiddling on manual, no actual content.
Matti Hamalainen <ccr@tnsp.org>
parents:
230
diff
changeset
|
3114 |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
3115 <section id="usage-tiger"><title>Guild: Tigers (gm-tiger.tf)</title> |
| 841 | 3116 <para> |
| 3117 Reporting of succesful and failed 'tiger claw' hits, lites for | |
| 3118 claw and mak reputation gains. | |
| 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 --> |
| 841 | 3124 |
| 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-tarma"><title>Guild: Tarmalens (gm-tarma.tf)</title> |
| 387 | 3130 <para> |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3131 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
|
3132 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
|
3133 '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
|
3134 </para> |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
3135 |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
3136 <note><para> |
|
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
3137 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
|
3138 <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
|
3139 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
|
3140 </para></note> |
| 387 | 3141 |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3142 <!-- @commands --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3143 <!-- @binds --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3144 <!-- @keybinds --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3145 |
| 387 | 3146 </section> |
| 3147 | |
| 3148 <!-- ================================================ --> | |
| 3149 | |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
3150 <section id="usage-druid"><title>Guild: Druids (gm-druid.tf)</title> |
| 387 | 3151 <para> |
|
394
ed989c51b94e
v0.5.11.3: Moved functionality from temp to tarmalen module and
Matti Hamalainen <ccr@tnsp.org>
parents:
393
diff
changeset
|
3152 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
|
3153 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
|
3154 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
|
3155 help for casting reincarnations (along with raises, resurrects, etc.) |
| 387 | 3156 </para> |
| 3157 | |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3158 <!-- @commands --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3159 <!-- @binds --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3160 <!-- @keybinds --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3161 |
| 387 | 3162 </section> |
| 3163 | |
| 3164 <!-- ================================================ --> | |
| 3165 | |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
3166 <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
|
3167 <para> |
|
1065
98dd57c1fc5e
Move some documentation from manual to embedded tfdoc in the scripts.
Matti Hamalainen <ccr@tnsp.org>
parents:
1060
diff
changeset
|
3168 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
|
3169 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
|
3170 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
|
3171 translator, etc. |
|
489
77c5862dd858
Removed some outdated comments concerning TF5 support.
Matti Hamalainen <ccr@tnsp.org>
parents:
454
diff
changeset
|
3172 </para> |
|
77c5862dd858
Removed some outdated comments concerning TF5 support.
Matti Hamalainen <ccr@tnsp.org>
parents:
454
diff
changeset
|
3173 |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3174 <!-- @commands --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3175 <!-- @binds --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3176 <!-- @keybinds --> |
|
703
20f20c1e8548
Updated copyright notices; Cosmetic cleanups; Updates to documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
695
diff
changeset
|
3177 |
|
489
77c5862dd858
Removed some outdated comments concerning TF5 support.
Matti Hamalainen <ccr@tnsp.org>
parents:
454
diff
changeset
|
3178 </section> |
|
77c5862dd858
Removed some outdated comments concerning TF5 support.
Matti Hamalainen <ccr@tnsp.org>
parents:
454
diff
changeset
|
3179 |
|
77c5862dd858
Removed some outdated comments concerning TF5 support.
Matti Hamalainen <ccr@tnsp.org>
parents:
454
diff
changeset
|
3180 <!-- ================================================ --> |
|
882
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
3181 |
|
04abd37e4751
Rename additional modules from ggrtf-*.tf to gm-*.tf.
Matti Hamalainen <ccr@tnsp.org>
parents:
862
diff
changeset
|
3182 <section id="usage-loc"><title>Guild: (Old) Lords of Chaos (gm-oldloc.tf)</title> |
| 254 | 3183 <para> |
| 271 | 3184 Very barebones module with support for "blood" ripaction and |
| 3185 fail/fumble handling. | |
| 3186 </para> | |
| 3187 | |
|
1049
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3188 <!-- @commands --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3189 <!-- @binds --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3190 <!-- @keybinds --> |
|
4d1fae5ae14e
Updates to manual, use TFDoc directives.
Matti Hamalainen <ccr@tnsp.org>
parents:
1039
diff
changeset
|
3191 |
| 271 | 3192 </section> |
| 254 | 3193 |
| 230 | 3194 </chapter> |
| 3195 | |
| 3196 <!-- *************************************************************** --> | |
| 3197 | |
| 781 | 3198 <appendix id="support"><title>Support</title> |
| 259 | 3199 |
|
546
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3200 <itemizedlist> |
|
1629
be076ff19370
Remove references to bugtracker, as it has decayed due to bitrot.
Matti Hamalainen <ccr@tnsp.org>
parents:
1623
diff
changeset
|
3201 <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
|
3202 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
|
3203 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
|
3204 acted upon. |
| 1630 | 3205 </para> |
|
546
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3206 <itemizedlist> |
| 549 | 3207 <listitem><para>Take your time to <emphasis>think</emphasis> |
| 3208 while writing, and before submitting your report. Good rule of | |
| 3209 thumb is to include all information that you think might be | |
| 3210 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
|
3211 </para></listitem> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3212 |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3213 <listitem><para> |
| 549 | 3214 Remember to include information about your system and environment, |
| 3215 (*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
|
3216 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
|
3217 </para></listitem> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3218 |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3219 </itemizedlist> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3220 </listitem> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3221 |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3222 <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
|
3223 to the user's manual and only in case the issue is not documented, |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3224 you might be eligible to ask about it. |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3225 </para></listitem> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3226 |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3227 <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
|
3228 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
|
3229 the workings yourself. |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3230 </para></listitem> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3231 |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3232 <listitem><para>Be ready to be contacted by developers, in case |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3233 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
|
3234 </para></listitem> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3235 |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3236 <listitem><para>Remember not to bother the developers via tells |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3237 too much, we want to play the game too, instead of just answering |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3238 your questions and resolving problems. |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3239 </para></listitem> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3240 |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3241 <!-- |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3242 <listitem><para></para></listitem> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3243 --> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3244 </itemizedlist> |
|
1322
903f92f4b918
Add note about sending patches.
Matti Hamalainen <ccr@tnsp.org>
parents:
1313
diff
changeset
|
3245 |
|
903f92f4b918
Add note about sending patches.
Matti Hamalainen <ccr@tnsp.org>
parents:
1313
diff
changeset
|
3246 <section id="patches"><title>Sending patches/corrections</title> |
|
903f92f4b918
Add note about sending patches.
Matti Hamalainen <ccr@tnsp.org>
parents:
1313
diff
changeset
|
3247 <para> |
|
903f92f4b918
Add note about sending patches.
Matti Hamalainen <ccr@tnsp.org>
parents:
1313
diff
changeset
|
3248 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
|
3249 <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
|
3250 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
|
3251 <ulink url="http://www.mercurial-scm.org/guide/">Mercurial guide</ulink> for generic |
|
1323
bcfde549790f
Improve patch creation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
1322
diff
changeset
|
3252 Mercurial usage instructions and how to set it up. For making proper commits, you'll need to |
|
bcfde549790f
Improve patch creation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
1322
diff
changeset
|
3253 at the very least set up your username, etc. |
|
1322
903f92f4b918
Add note about sending patches.
Matti Hamalainen <ccr@tnsp.org>
parents:
1313
diff
changeset
|
3254 </para> |
|
903f92f4b918
Add note about sending patches.
Matti Hamalainen <ccr@tnsp.org>
parents:
1313
diff
changeset
|
3255 <screen> |
|
903f92f4b918
Add note about sending patches.
Matti Hamalainen <ccr@tnsp.org>
parents:
1313
diff
changeset
|
3256 # 1) Make changes to files |
|
903f92f4b918
Add note about sending patches.
Matti Hamalainen <ccr@tnsp.org>
parents:
1313
diff
changeset
|
3257 $EDITOR ggrtf.tf |
|
903f92f4b918
Add note about sending patches.
Matti Hamalainen <ccr@tnsp.org>
parents:
1313
diff
changeset
|
3258 |
|
903f92f4b918
Add note about sending patches.
Matti Hamalainen <ccr@tnsp.org>
parents:
1313
diff
changeset
|
3259 # 2) Commit related changes to a changeset your local repository |
|
903f92f4b918
Add note about sending patches.
Matti Hamalainen <ccr@tnsp.org>
parents:
1313
diff
changeset
|
3260 hg ci [filenames of changed files or nothing, if you wish to commit everything] |
|
903f92f4b918
Add note about sending patches.
Matti Hamalainen <ccr@tnsp.org>
parents:
1313
diff
changeset
|
3261 |
|
903f92f4b918
Add note about sending patches.
Matti Hamalainen <ccr@tnsp.org>
parents:
1313
diff
changeset
|
3262 # 3) Repeat steps 1 to 2 until satisfied |
|
903f92f4b918
Add note about sending patches.
Matti Hamalainen <ccr@tnsp.org>
parents:
1313
diff
changeset
|
3263 |
|
903f92f4b918
Add note about sending patches.
Matti Hamalainen <ccr@tnsp.org>
parents:
1313
diff
changeset
|
3264 # 4) Export your local changes to a bundle |
|
1323
bcfde549790f
Improve patch creation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
1322
diff
changeset
|
3265 hg bundle mychanges.bz2 &hgrepourl; |
|
bcfde549790f
Improve patch creation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
1322
diff
changeset
|
3266 |
|
bcfde549790f
Improve patch creation instructions.
Matti Hamalainen <ccr@tnsp.org>
parents:
1322
diff
changeset
|
3267 # 5) Send mychanges.bz2 to us (Ggr), as e-mail attachment ccr@tnsp.org |
|
1322
903f92f4b918
Add note about sending patches.
Matti Hamalainen <ccr@tnsp.org>
parents:
1313
diff
changeset
|
3268 </screen> |
|
903f92f4b918
Add note about sending patches.
Matti Hamalainen <ccr@tnsp.org>
parents:
1313
diff
changeset
|
3269 </section> |
|
903f92f4b918
Add note about sending patches.
Matti Hamalainen <ccr@tnsp.org>
parents:
1313
diff
changeset
|
3270 |
| 781 | 3271 </appendix> |
| 259 | 3272 |
| 3273 <!-- ================================================ --> | |
| 3274 | |
| 781 | 3275 <appendix id="faq"><title>Frequently Asked Questions (FAQ)</title> |
| 259 | 3276 <qandaset> |
| 3277 <qandaentry> | |
| 3278 <question> | |
| 270 | 3279 <para>Is "Grizzt" included in the documentation?</para> |
| 3280 </question> | |
| 3281 <answer> | |
| 3282 <para>Unfortunately no. Grizzt may be included in some future version, though.</para> | |
| 3283 </answer> | |
| 3284 </qandaentry> | |
|
314
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3285 |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3286 <qandaentry> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3287 <question> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3288 <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
|
3289 </question> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3290 <answer> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3291 <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
|
3292 </answer> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3293 </qandaentry> |
|
3ab7390f437d
Some new sections and new information added to previous sections.
Matti Hamalainen <ccr@tnsp.org>
parents:
313
diff
changeset
|
3294 |
|
331
806a7cf5e8de
Add FAQ entry about gagging of round flag.
Matti Hamalainen <ccr@tnsp.org>
parents:
327
diff
changeset
|
3295 |
|
806a7cf5e8de
Add FAQ entry about gagging of round flag.
Matti Hamalainen <ccr@tnsp.org>
parents:
327
diff
changeset
|
3296 <qandaentry> |
|
806a7cf5e8de
Add FAQ entry about gagging of round flag.
Matti Hamalainen <ccr@tnsp.org>
parents:
327
diff
changeset
|
3297 <question> |
|
546
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3298 <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
|
3299 </question> |
|
806a7cf5e8de
Add FAQ entry about gagging of round flag.
Matti Hamalainen <ccr@tnsp.org>
parents:
327
diff
changeset
|
3300 <answer> |
|
806a7cf5e8de
Add FAQ entry about gagging of round flag.
Matti Hamalainen <ccr@tnsp.org>
parents:
327
diff
changeset
|
3301 <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
|
3302 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
|
3303 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
|
3304 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
|
3305 </para> |
|
806a7cf5e8de
Add FAQ entry about gagging of round flag.
Matti Hamalainen <ccr@tnsp.org>
parents:
327
diff
changeset
|
3306 <screen> |
| 345 | 3307 /test prlist_insert("event_battle_round", "myroundgag") |
| 3308 /def -i myroundgag = /substitute -ag | |
|
331
806a7cf5e8de
Add FAQ entry about gagging of round flag.
Matti Hamalainen <ccr@tnsp.org>
parents:
327
diff
changeset
|
3309 </screen> |
|
806a7cf5e8de
Add FAQ entry about gagging of round flag.
Matti Hamalainen <ccr@tnsp.org>
parents:
327
diff
changeset
|
3310 <para> |
|
806a7cf5e8de
Add FAQ entry about gagging of round flag.
Matti Hamalainen <ccr@tnsp.org>
parents:
327
diff
changeset
|
3311 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
|
3312 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
|
3313 </para> |
|
806a7cf5e8de
Add FAQ entry about gagging of round flag.
Matti Hamalainen <ccr@tnsp.org>
parents:
327
diff
changeset
|
3314 </answer> |
|
806a7cf5e8de
Add FAQ entry about gagging of round flag.
Matti Hamalainen <ccr@tnsp.org>
parents:
327
diff
changeset
|
3315 </qandaentry> |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
3316 |
|
381
6af6df52fefd
v0.5.11.2: Removed tick predictor, it wasn't working anyway;
Matti Hamalainen <ccr@tnsp.org>
parents:
379
diff
changeset
|
3317 |
|
343
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
3318 <qandaentry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
3319 <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
|
3320 <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
|
3321 </question> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
3322 <answer> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
3323 <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
|
3324 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
|
3325 typo in the setting. See <link linkend="inst-config-batmud">setup-section</link> |
| 1449 | 3326 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
|
3327 </para> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
3328 </answer> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
3329 </qandaentry> |
|
02fbd1028a27
Updates to the manual. New sections, reordering, typofixing,
Matti Hamalainen <ccr@tnsp.org>
parents:
340
diff
changeset
|
3330 |
| 392 | 3331 <qandaentry> |
| 3332 <question> | |
| 3333 <para>How can I get my settings saved automatically? Or can I?</para> | |
| 3334 </question> | |
| 3335 <answer> | |
|
454
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3336 <para>Automatic saving and loading is possible, please refer to |
| 392 | 3337 <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
|
3338 and <link linkend="inst-config-tf">setup</link> -sections of |
| 392 | 3339 this manual for more information. |
| 3340 </para> | |
| 3341 </answer> | |
| 3342 </qandaentry> | |
|
454
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3343 |
|
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3344 <qandaentry> |
|
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3345 <question> |
|
546
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3346 <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
|
3347 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
|
3348 </question> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3349 <answer> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3350 <para> |
|
1629
be076ff19370
Remove references to bugtracker, as it has decayed due to bitrot.
Matti Hamalainen <ccr@tnsp.org>
parents:
1623
diff
changeset
|
3351 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
|
3352 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
|
3353 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
|
3354 </para> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3355 <para> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3356 Also see the next question below. |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3357 </para> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3358 </answer> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3359 </qandaentry> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3360 |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3361 <qandaentry> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3362 <!-- |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3363 <question> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3364 <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
|
3365 </question> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3366 --> |
|
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3367 <question> |
|
454
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3368 <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
|
3369 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
|
3370 </question> |
|
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3371 <answer> |
|
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3372 <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
|
3373 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
|
3374 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
|
3375 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
|
3376 </para> |
|
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3377 |
|
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3378 <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
|
3379 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
|
3380 in-game settings. |
|
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3381 </para> |
|
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3382 </answer> |
|
9f98896b5e2b
Add FAQ entry about problems concerning invalid 'cutter' setting.
Matti Hamalainen <ccr@tnsp.org>
parents:
453
diff
changeset
|
3383 </qandaentry> |
|
546
2991678d1a9a
Issue reporting issues added. Information about bugtracker, etc.
Matti Hamalainen <ccr@tnsp.org>
parents:
515
diff
changeset
|
3384 |
|
642
1be950a666af
Added note about TF5 module requiring 5.0 beta 7 or later.
Matti Hamalainen <ccr@tnsp.org>
parents:
638
diff
changeset
|
3385 <qandaentry> |
|
1be950a666af
Added note about TF5 module requiring 5.0 beta 7 or later.
Matti Hamalainen <ccr@tnsp.org>
parents:
638
diff
changeset
|
3386 <question> |
|
1be950a666af
Added note about TF5 module requiring 5.0 beta 7 or later.
Matti Hamalainen <ccr@tnsp.org>
parents:
638
diff
changeset
|
3387 <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
|
3388 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
|
3389 </question> |
|
1be950a666af
Added note about TF5 module requiring 5.0 beta 7 or later.
Matti Hamalainen <ccr@tnsp.org>
parents:
638
diff
changeset
|
3390 <answer> |
|
1be950a666af
Added note about TF5 module requiring 5.0 beta 7 or later.
Matti Hamalainen <ccr@tnsp.org>
parents:
638
diff
changeset
|
3391 <para> |
|
1be950a666af
Added note about TF5 module requiring 5.0 beta 7 or later.
Matti Hamalainen <ccr@tnsp.org>
parents:
638
diff
changeset
|
3392 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
|
3393 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
|
3394 </para> |
|
1be950a666af
Added note about TF5 module requiring 5.0 beta 7 or later.
Matti Hamalainen <ccr@tnsp.org>
parents:
638
diff
changeset
|
3395 </answer> |
|
1be950a666af
Added note about TF5 module requiring 5.0 beta 7 or later.
Matti Hamalainen <ccr@tnsp.org>
parents:
638
diff
changeset
|
3396 </qandaentry> |
|
1529
74fe408138cc
Add an FAQ item about numpad/keypad problems.
Matti Hamalainen <ccr@tnsp.org>
parents:
1526
diff
changeset
|
3397 |
|
74fe408138cc
Add an FAQ item about numpad/keypad problems.
Matti Hamalainen <ccr@tnsp.org>
parents:
1526
diff
changeset
|
3398 <qandaentry> |
|
74fe408138cc
Add an FAQ item about numpad/keypad problems.
Matti Hamalainen <ccr@tnsp.org>
parents:
1526
diff
changeset
|
3399 <question> |
|
74fe408138cc
Add an FAQ item about numpad/keypad problems.
Matti Hamalainen <ccr@tnsp.org>
parents:
1526
diff
changeset
|
3400 <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
|
3401 </question> |
|
74fe408138cc
Add an FAQ item about numpad/keypad problems.
Matti Hamalainen <ccr@tnsp.org>
parents:
1526
diff
changeset
|
3402 <answer> |
|
1539
78268db92315
Oops, a missing para-tag. Fixed.
Matti Hamalainen <ccr@tnsp.org>
parents:
1538
diff
changeset
|
3403 <para> |
|
1538
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
3404 Make sure you have configured your terminal correctly, |
|
15682433fd7a
More work on the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
1537
diff
changeset
|
3405 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
|
3406 section for more information. |
|
1539
78268db92315
Oops, a missing para-tag. Fixed.
Matti Hamalainen <ccr@tnsp.org>
parents:
1538
diff
changeset
|
3407 </para> |
|
1529
74fe408138cc
Add an FAQ item about numpad/keypad problems.
Matti Hamalainen <ccr@tnsp.org>
parents:
1526
diff
changeset
|
3408 </answer> |
|
74fe408138cc
Add an FAQ item about numpad/keypad problems.
Matti Hamalainen <ccr@tnsp.org>
parents:
1526
diff
changeset
|
3409 </qandaentry> |
| 270 | 3410 <!-- |
| 3411 <qandaentry> | |
| 3412 <question> | |
| 259 | 3413 <para></para> |
| 3414 </question> | |
| 3415 <answer> | |
| 3416 <para> | |
| 3417 </para> | |
| 3418 </answer> | |
| 3419 </qandaentry> | |
| 270 | 3420 --> |
| 3421 </qandaset> | |
| 781 | 3422 |
| 3423 </appendix> | |
| 259 | 3424 |
|
772
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3425 <!-- ================================================ --> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3426 |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3427 <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
|
3428 GnuPG</title> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3429 <para> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3430 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
|
3431 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
|
3432 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
|
3433 </para> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3434 |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3435 <itemizedlist> |
|
1544
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
3436 <listitem> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
3437 <para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
3438 Retrieve Matti Hämäläinen's public key from a keyserver: |
| 1572 | 3439 <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
|
3440 </para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
3441 </listitem> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
3442 <listitem> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
3443 <para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
3444 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
|
3445 <userinput>gpg --verify ggrtf-&ggrtfver;.tar.gz.asc</userinput> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
3446 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
|
3447 signature from "Matti Hamalainen (ccr) <ccr@tnsp.org>"' |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
3448 </para> |
|
539af86668a9
Some DocBook validation fixes.
Matti Hamalainen <ccr@tnsp.org>
parents:
1543
diff
changeset
|
3449 </listitem> |
|
772
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3450 </itemizedlist> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3451 |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3452 <para> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3453 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
|
3454 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
|
3455 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
|
3456 GNU Privacy Handbook</ulink> is available from GnuPG project. |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3457 (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
|
3458 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
|
3459 http://www.gnupg.org/documentation/guides.en.html</ulink>.) |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3460 </para> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3461 </appendix> |
|
7e87785965bf
Tiny updates to the documentation.
Matti Hamalainen <ccr@tnsp.org>
parents:
771
diff
changeset
|
3462 |
| 223 | 3463 </book> |