Mercurial > hg > batmud > ggrtf

comparison docs/manual.sgml @ 1678:914961b1e2d2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update manual a bit, move gm-tf5 module stuff to statusline section and remove the old gm-tf5 section.
author Matti Hamalainen <ccr@tnsp.org>
date Wed, 27 Mar 2024 17:25:13 +0200
parents 54a9a23d8df0
children 63e789382fc6
comparison
equal deleted inserted replaced
1677:32c6a74b989a 1678:914961b1e2d2
980 &tfurl; statusline is used to display information that we've 980 &tfurl; statusline is used to display information that we've
981 considered to be important enough for nearly real-time view. 981 considered to be important enough for nearly real-time view.
982 </para> 982 </para>
983 983
984 <para> 984 <para>
985 The basic one-row statusline of GgrTF is meant for compatibility,
986 <link linkend="usage-tf5">TF5 support module</link> provides another
987 version, enhanced to take advantage of newer TF5 beta features
988 (TF 5.0 beta 7 or later required).
989 </para>
990
991 <para>
992 Statusline is updated synchronously at ticks, skill- and spell 985 Statusline is updated synchronously at ticks, skill- and spell
993 castings and certain other events. <emphasis>This depends on 986 castings and certain other events. <emphasis>This depends on
994 your <link linkend="inst-config-batmud">BatMUD settings</link> 987 your <link linkend="inst-config-batmud">BatMUD settings</link>
995 being correctly set up.</emphasis> If HP/SP/EP etc. information does 988 being correctly set up.</emphasis> If HP/SP/EP etc. information does
996 not appear, most likely your 'sc' setting is "wrong", 989 not appear, most likely your 'sc' setting is "wrong",
997 and thus does not get parsed by GgrTF. 990 and thus does not get parsed by GgrTF.
998 </para> 991 </para>
999 992
993 <para>
994 <emphasis>The functionality of the statusline depends on
995 your <link linkend="inst-config-batmud">BatMUD settings</link>
996 being correctly set up.</emphasis> If HP/SP/EP etc. information does
997 not appear, most likely your 'sc' setting is "wrong",
998 and thus does not get parsed by GgrTF.
999 </para>
1000 </note>
1001
1000 <screenshot> 1002 <screenshot>
1001 <mediaobject> 1003 <mediaobject>
1002 <imageobject><imagedata fileref="statusbar.gif" format="GIF" /></imageobject> 1004 <imageobject><imagedata fileref="statusbar_tf5.gif" format="GIF" /></imageobject>
1003 <imageobject><imagedata fileref="statusbar.eps" format="EPS" /></imageobject> 1005 <imageobject><imagedata fileref="statusbar_tf5.eps" format="EPS" /></imageobject>
1004 <textobject> 1006 <textobject>
1005 <phrase>GgrTF statusline</phrase> 1007 <phrase>GgrTF statusline</phrase>
1006 </textobject> 1008 </textobject>
1007 <caption> 1009 <caption>
1008 <para>Example of typical basic GgrTF statusline.</para> 1010 <para>Example of typical basic GgrTF statusline in TF5.</para>
1009 </caption> 1011 </caption>
1010 </mediaobject> 1012 </mediaobject>
1011 </screenshot> 1013 </screenshot>
1014
1015 <itemizedlist>
1016 <listitem><para>
1017 Enhanced 2-row statusline: First line contains HP/SP/EP- and
1018 skill/spell/etc- information as usual. Prot status has been
1019 moved to the second line.
1020 </para></listitem>
1021
1022 </itemizedlist>
1023
1024 <!--
1025 - example configuration
1026 - document special variables
1027 -->
1012 1028
1013 <orderedlist> 1029 <orderedlist>
1014 <listitem><para>Current hit points / hit points maximum.</para></listitem> 1030 <listitem><para>Current hit points / hit points maximum.</para></listitem>
1015 <listitem><para>Current spell points / spell points maximum.</para></listitem> 1031 <listitem><para>Current spell points / spell points maximum.</para></listitem>
1016 <listitem><para>Current endurance points / endurance points maximum.</para></listitem> 1032 <listitem><para>Current endurance points / endurance points maximum.</para></listitem>
2543 2559
2544 </section> 2560 </section>
2545 2561
2546 <!-- ================================================ --> 2562 <!-- ================================================ -->
2547 2563
2548 <section id="usage-tf5"><title>TinyFugue 5 support (gm-tf5.tf)</title>
2549 <para>
2550 This is a special enhancement module for those who use GgrTF
2551 with &tfurl; version 5.0 (beta 7 and LATER). Although GgrTF should work with TF5
2552 without this module, you may wish to take benefit of the
2553 enhanced features designed for TF5 this module provides.
2554 </para>
2555
2556 <note>
2557 <para>
2558 The code in this module uses features available on TF 5.0 beta 7
2559 and later, it will NOT work correctly in older betas!
2560 </para>
2561 <para> 2564 <para>
2562 <emphasis>The functionality of the statusline depends on 2565 <emphasis>The functionality of the statusline depends on
2563 your <link linkend="inst-config-batmud">BatMUD settings</link> 2566 your <link linkend="inst-config-batmud">BatMUD settings</link>
2564 being correctly set up.</emphasis> If HP/SP/EP etc. information does 2567 being correctly set up.</emphasis> If HP/SP/EP etc. information does
2565 not appear, most likely your 'sc' setting is "wrong", 2568 not appear, most likely your 'sc' setting is "wrong",