changeset 262:63b3b52544c4

HCBat module description.
author Matti Hamalainen <ccr@tnsp.org>
date Sat, 11 Feb 2006 06:18:41 +0000
parents 2b18754a1f01
children 65046156d3dd
files docs/manual.sgml
diffstat 1 files changed, 23 insertions(+), 8 deletions(-) [+]
line wrap: on
line diff
--- a/docs/manual.sgml	Sat Feb 11 06:05:23 2006 +0000
+++ b/docs/manual.sgml	Sat Feb 11 06:18:41 2006 +0000
@@ -430,7 +430,28 @@
 
 <section id="usage-hc"><title>HCBat support (ggrtf-hc.tf)</title>
 <para>
+Due to the age of Hard Core BatMUD's current codebase and conceptual
+differences, several exceptions and workarounds are needed to
+improve GgrTF's compatibility with the HCBat environment.
+This module tries to provide the glue to make it happen.
 </para>
+
+<para>
+Purpose of this module is dissimilar to others, as it is meant
+to contain almost everything related to peculiarities and
+differences of HCBat. We do not have separate
+guild-specific modules for HCBat, the code needed to
+catch the differences is either in this module or in some
+special cases in the guild-specific modules.
+</para>
+
+<para>
+At the moment this module is rather simple, only replacing
+GgrTF's output macros to work around the lack of 'party report'
+-channel in HCBat. In future more functionality may be added,
+feel free to report bugs/incompatibilities to us.
+</para>
+
 </section>
 
 <!-- ================================================ -->
@@ -450,7 +471,6 @@
 <!-- ================================================ -->
 
 <section id="usage-merchant"><title>Guild: Merchants (ggrtf-merchant.tf)</title>
-<section><title>Description</title>
 <para>
 This module contains, in addition to basic skill/spell fail/fumble
 handling, several helper macros, which may ease your work as merchant.
@@ -477,7 +497,6 @@
 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>
@@ -711,12 +730,10 @@
 <!-- ================================================ -->
 
 <section id="usage-barb"><title>Guild: Barbarian (ggrtf-barb.tf)</title>
-<section><title>Description</title>
 <para>
 Functionality: Translator for barbarian reputation bar, reputation
 difference calculator and handler for automated looting and burning.
 </para>
-</section>
 
 <section><title>Macro commands</title>
 <para>&argdesc;</para>
@@ -759,12 +776,10 @@
 <!-- ================================================ -->
 
 <section id="usage-spiders"><title>Guild: Spiders (ggrtf-spiders.tf)</title>
-<section><title>Description</title>
 <para>
 This is a very barebones module for monitoring times between spider demon 
 channelling and controlling.
 </para>
-</section>
 
 <section><title>Macro commands</title>
 <para>&argdesc;</para>
@@ -792,15 +807,15 @@
 <!-- ================================================ -->
 
 <section id="usage-alch"><title>Guild: Alchemists (ggrtf-alch.tf)</title>
-<section><title>Description</title>
+
 <para>This is (a slightly outdated) module with some helper macros for Alchemists. The module hasn't been tested recently, 
 so there might be some problems with some of its features. Main features are can/jar contents compressor and potion mixing
 macro.
 </para>
+
 <para>To use the potion mixer macro, you need to define your own can/jar names and contents in the macro sources. Other
 customization might be needed as well.
 </para>
-</section>
 
 <section><title>Macro commands</title>
 <para>&argdesc;</para>