Mercurial > hg > batmud > ggrtf

changeset 249:c864584906a2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Improvements in merchant section.
author Matti Hamalainen <ccr@tnsp.org>
date Fri, 10 Feb 2006 23:54:49 +0000
parents 6049eab4692f
children af2fa388a4e4
files docs/manual.sgml
diffstat 1 files changed, 197 insertions(+), 26 deletions(-) [+]
line wrap: on
line diff
--- a/docs/manual.sgml	Fri Feb 10 21:49:05 2006 +0000
+++ b/docs/manual.sgml	Fri Feb 10 23:54:49 2006 +0000
@@ -13,13 +13,17 @@
 -->
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
 <!-- Define some entities -->
-<!ENTITY ggrtf_ver "v0.6.0">
+<!ENTITY ggrtf_ver "v0.5.9.x/v0.6.0">
 
 <!ENTITY tfugue "<ulink url='http://tf.tcp.com/'>TinyFugue</ulink>">
 <!ENTITY homeurl "<ulink url='http://ccr.tnsp.org/ggrtf/'>http://ccr.tnsp.org/ggrtf/</ulink>">
 <!ENTITY svnrepo "<ulink url='http://svn.pupunen.net/public/ggrtf/trunk/'>Subversion-repository</ulink>">
 <!ENTITY svnurl "<ulink url='http://subversion.tigris.org/'>Subversion</ulink>">
 <!ENTITY batmud "<ulink url='http://www.bat.org/'>BatMUD</ulink>">
+<!ENTITY exampletfrc "<section><title>Example configuration</title>">
+
+<!ENTITY validval "Valid values:">
+<!ENTITY validonoff "<emphasis>on</emphasis>, <emphasis>off</emphasis>">
 
 ]>
 <book>
@@ -92,15 +96,15 @@
 </para>
  
 <para>
-The current version (as of v0.5.9.x/&ggrtf_ver; release) has modules
+The current version (as of &ggrtf_ver; release) has modules
 for following character classes:
 </para>
 <itemizedlist>
- <listitem><para>Mages (<ulink url="http://www.bat.org/help/guilds.php?str=The+Brotherhood+of+Wizardry">The Brotherhood of Wizardry</ulink>)</para></listitem>
- <listitem><para>Channellers (<ulink url="http://www.bat.org/help/guilds.php?str=The+Guild+of+Channellers">The Guild of Channellers</ulink>)</para></listitem>
- <listitem><para>Merchants (<ulink url="http://www.bat.org/help/guilds.php?str=The+Master+Merchants">The Master Merchants</ulink>)</para></listitem>
- <listitem><para>Barbarians (<ulink url="http://www.bat.org/help/guilds.php?str=Barbarian+Guild">Barbarian Guild</ulink>)</para></listitem>
- <listitem><para>LoCs (<ulink url="http://www.bat.org/help/guilds.php?str=Lords+of+Chaos">Lords of Chaos</ulink>)</para></listitem>
+ <listitem><para><link linkend="">Mages</link> (<ulink url="http://www.bat.org/help/guilds.php?str=The+Brotherhood+of+Wizardry">The Brotherhood of Wizardry</ulink>)</para></listitem>
+ <listitem><para><link linkend="">Channellers</link> (<ulink url="http://www.bat.org/help/guilds.php?str=The+Guild+of+Channellers">The Guild of Channellers</ulink>)</para></listitem>
+ <listitem><para><link linkend="">Merchants</link> (<ulink url="http://www.bat.org/help/guilds.php?str=The+Master+Merchants">The Master Merchants</ulink>)</para></listitem>
+ <listitem><para><link linkend="">Barbarians</link> (<ulink url="http://www.bat.org/help/guilds.php?str=Barbarian+Guild">Barbarian Guild</ulink>)</para></listitem>
+ <listitem><para><link linkend="">LoCs</link> (<ulink url="http://www.bat.org/help/guilds.php?str=Lords+of+Chaos">Lords of Chaos</ulink>)</para></listitem>
 </itemizedlist>
 <para>
 Also a somewhat old module for alchemists exists, but has not been updated/tested for a while.
@@ -108,10 +112,11 @@
 
 <para>
 In non-guild related sense, GgrTF has most of the basics expected from
-such triggerset. There is a prot-management and reporting system, spell-
-and skill-handling, way to easily run commands on each battle round
-(and more), pss-output mangling, spellwords to names translator
-and more.
+such triggerset. There is a <link linkend="">prot-management and reporting
+system</link>, <link linkend="">spell- and skill-handling</link>, way to
+easily <link linkend="">run commands on each battle round</link>
+(and more), <link linkend="">pss-output mangling</link>,
+<link linkend="">spellwords to names translator</link> and more.
 </para>
 
 </section>
@@ -249,6 +254,13 @@
 
 <!-- ================================================ -->
 
+<section id="usage-general"><title>General (ggrtf.tf)</title>
+<para>
+</para>
+</section>
+
+<!-- ================================================ -->
+
 <section id="usage-misc"><title>Miscellaneous stuff module (ggrtf-misc.tf)</title>
 <para>
 </para>
@@ -310,15 +322,13 @@
 <para>
 This module contains, in addition to basic skill/spell fail/fumble
 handling, several helper macros, which may ease your work as merchant.
-I've created them for myself only, so you may or may not like them
-as they are, so buyers beware.
 </para>
 
 <para>
-Many of the command macros support "autotargetting", so you can walk
-in outerworld and just type "/lj" for lumberjacking and "/mine" for
-mining and they usually know what to do. Some need bit more specific
-arguments.
+Many of the command macros support "autotargetting", which basically
+means that you can walk in outerworld and just type "/lj" for
+lumberjacking and "/mine" for mining and GgrTF usually knows what
+to do. Some macros require bit more specific arguments.
 </para>
 
 <para>
@@ -331,14 +341,15 @@
 </para>
 
 <para>
-NOTICE that you probably HAVE to replace some of these
-macros and default settings in your tfrc configuration file!
-(See section "General settings and functions" below)
+Notice that you probably HAVE to replace some of these
+macros and default settings in your TF configuration file!
+(See <link linkend="usage-merchant-settings">Settings</link>-section below.)
 </para>
 </section>
 
 <section><title>Macro commands</title>
 <para>
+&lt;&gt; = required argument, [] = optional argument,
 (*) = autotargets, (!) = moves items to item target
 </para>
 
@@ -385,7 +396,8 @@
    </row>
    <row>
     <entry>/mcut &lt;material&gt; [size]</entry>
-    <entry>Mineral cut material. Optional size can be give in grams. If no size is specified, material is cut in half.</entry>
+    <entry>Mineral cut material. Optional size can be give in grams.
+If no size is specified, material is cut in half.</entry>
    </row>
   </tbody>
  </tgroup>
@@ -402,7 +414,8 @@
   <tbody>
    <row>
     <entry>/id &lt;item&gt; [target]</entry>
-    <entry>Identify given item and optionally send output to target player. Example: /id ring jeskko</entry>
+    <entry>Casts 'identify' spell at specified item and optionally
+send output to target player. Example: /id ring jeskko</entry>
    </row>
    <row>
     <entry>/alloy &lt;materials&gt;</entry>
@@ -412,6 +425,154 @@
  </tgroup>
 </table>
 </section>
+
+<section id="usage-merchant-settings"><title>Settings</title>
+<table><title>z</title>
+ <tgroup cols="2" align="left">
+  <thead>
+   <row>
+    <entry>Variable</entry>
+    <entry>Description</entry>
+   </row>
+  </thead>
+  <tbody>
+   <row>
+    <entry>opt_havebelt</entry>
+    <entry>Enables merchant belt support. &validval; &validonoff;</entry>
+   </row>
+   <row>
+    <entry>mtool_mine</entry>
+    <entry>Tool(s) for mining. Example: /set mtool_mine=pick 1,pick 2</entry>
+   </row>
+   <row>
+    <entry>mtool_lj</entry>
+    <entry>Tool(s) for lumberjacking. Example: /set mtool_lj=saw</entry>
+   </row>
+   <row>
+    <entry>mtool_bs</entry>
+    <entry>Tool(s) for blacksmithing.</entry>
+   </row>
+   <row>
+    <entry>mtool_cp</entry>
+    <entry>Tool(s) for carpentry.</entry>
+   </row>
+   <row>
+    <entry>mtool_gc</entry>
+    <entry>Tool(s) for gem cutting.</entry>
+   </row>
+   <row>
+    <entry>mtool_gb</entry>
+    <entry>Tool(s) for glassblowing.</entry>
+   </row>
+   <row>
+    <entry>mtool_ma</entry>
+    <entry>Tool(s) for masonry.</entry>
+   </row>
+   <row>
+    <entry>mtool_sw</entry>
+    <entry>Tool(s) for sewing.</entry>
+   </row>
+   <row>
+    <entry>mtool_sc</entry>
+    <entry>Tool(s) for sculpture skill.</entry>
+   </row>
+   <row>
+    <entry>mforge_*</entry>
+    <entry>Forges/workbenches for skills (similar to mtool_* variables)</entry>
+   </row>
+  </tbody>
+ </tgroup>
+</table>
+</section>
+
+&exampletfrc;
+<screen>
+;; Disable logging
+/log off
+
+;; Set player name before loading GgrTF and modules
+/set set_plrname=Ccr
+
+;; Load additional modules here
+/load tf/ggrtf.tf
+/load tf/ggrtf-misc.tf
+/load tf/ggrtf-magical.tf
+/load tf/ggrtf-merchant.tf
+/load tf/ggrtf-pssmangle.tf
+/load tf/ggrtf-spellnames.tf
+
+;; Set names of your forges/workbenches you usually use
+/set mforge_bs=metal
+/set mforge_cp=puu2
+/set mforge_gc=hely1
+/set mforge_gb=glass
+/set mforge_ma=masonry
+/set mforge_sw=fabric
+/set mforge_sc=sculpture
+
+;; Set the tools used for mining and lumberjacking
+/set mtool_mine=axe 1,axe 2
+/set mtool_lj=axe 1,axe 2
+
+;; We want to use hammer for CarPentry skill
+/set mtool_cp=hammer
+
+;; Move mined/lumberjacked stuff into mineral box
+/mbox
+
+;; Autopeering should grep for deposits and trees
+/set set_peer=embedded|grow
+
+/def -ag -mregexp -t"^No matches for .contains" gag_cont1
+/def -ag -mregexp -t"^No matches for .\(" gag_cont2 = /echo ====================
+/def -aBCgreen -mregexp -t"^You begin hacking at the ([a-z ]+)\.$" mcut_getm1 =\
+	/set mcut_tgt=%{P1}
+
+/def -aBCgreen -msimple -t"You hack off a piece." mcut_get2 =\
+	@get %{mcut_tgt} from %{wb_forge}%;@drop %{mcut_tgt}
+
+
+;; Ripaction should be off, and we don't want extra spam either
+/ripaction off
+/set opt_info=off
+
+
+;; Bind some keys
+/def -i -B'Up' = /dokey recallb
+/def -i -B'Down' = /dokey recallf
+/def -i -b'^[[7~' = /dokey_home
+/def -i -b'^[[8~' = /dokey_end
+/def -i -b'^[OM' = /dokey newline
+/def -i -b'^[Op' = @rfd
+/def -i -b'^[Ok' = @lad
+/def -i -b'^[Oa' = /mdisc
+/def -i -b'^[Os' = /mbox
+/def -i -b'^[Os' = /mdrop
+
+/def -i -b'^[q' = @put all in my disc
+/def -i -b'^[w' = /mine
+/def -i -b'^[e' = /lj
+
+
+;; Bind numpad keys for movement
+/def -i -b'^[Ox' = /prmove n
+/def -i -b'^[Or' = /prmove s
+/def -i -b'^[Ot' = /prmove w
+/def -i -b'^[Ov' = /prmove e
+/def -i -b'^[Ow' = /prmove nw
+/def -i -b'^[Oy' = /prmove ne
+/def -i -b'^[Oq' = /prmove sw
+/def -i -b'^[Os' = /prmove se
+
+;; Numpad '5' becomes look
+/def -i -b'^[Ou' = @@look
+
+
+;; Enable logging
+/log on
+</screen>
+</section>
+
 </section>
 
 <!-- ================================================ -->
@@ -438,15 +599,23 @@
   <tbody>
    <row>
     <entry>/repu</entry>
-    <entry>Prints your current reputation and difference from previous invoking of command.</entry>
+    <entry>Prints your current reputation and reputation difference
+from previous invoking of the command.</entry>
    </row>
    <row>
     <entry>/lb</entry>
-    <entry>Starts looting and burning -command, lights a torch, waits for couple of seconds and drops corpses from inventory. After burning extinguishes the torch, prints current reputation and executes action determined by "/burnaction" status (see below). If skillbreak is detected, corpse dropping is cancelled.</entry>
+    <entry>Starts looting and burning skill, lights a torch, waits for
+couple of seconds and drops corpses from inventory. After burning
+the torch is extinguished and current reputation printed out. Then
+action determined by "/burnaction"-setting (see below) is executed.
+If a skillbreak is detected, corpse dropping will be cancelled immediately.</entry>
    </row>
    <row>
     <entry>/burnaction &lt;action&gt;</entry>
-    <entry>Sets the action done after finished burning. Available options are none, cash (drop low coins) and noeq (drop low coins and noeq).</entry>
+    <entry>Sets the action done after finished burning. Available
+options are: <emphasis>none</emphasis>, <emphasis>cash</emphasis>
+(drop small coins) and <emphasis>noeq</emphasis> (drop low
+coins and noeq).</entry>
    </row>
   </tbody>
  </tgroup>
@@ -460,7 +629,8 @@
 <section><title>Description</title>
 <para>
 This is a very barebones module for monitoring times between spider demon 
-channeling and controlling.</para>
+channelling and controlling.
+</para>
 </section>
 
 <section><title>Macro commands</title>
@@ -482,6 +652,7 @@
  </tgroup>
 </table>
 </section>
+
 </section>
 
 <!-- ================================================ -->