Mercurial > hg > batmud > ggrtf
changeset 1378:fbf2af8e3128
Improve documentation of alchemist module.
author | Matti Hamalainen <ccr@tnsp.org> |
---|---|
date | Tue, 29 Mar 2011 15:21:41 +0300 |
parents | 91d712edde9f |
children | fad3166c5861 |
files | docs/manual.sgml |
diffstat | 1 files changed, 26 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/manual.sgml Tue Mar 29 15:21:29 2011 +0300 +++ b/docs/manual.sgml Tue Mar 29 15:21:41 2011 +0300 @@ -3104,8 +3104,34 @@ <section id="usage-alchemist"><title>Guild: Alchemists (gm-alchemist.tf)</title> <para> +Alchemist module provides several macros that can be very helpful with +potion making and other alchemist activities. Commands for easier handling of +herb jars and organ cans, command macro that automates potion mixing to great degree and +additional helper for potion research. </para> +<para> +Potion research is a big part of alchemist guild activities, but also one of the more +tedious ones. It requires juggling with organs, herbs and minerals, keeping book of findings, etc. +GgrTF alchemist module will come to help, as it automates getting the herb and organ from your containers, +submitting the finished potion concoction flask to authenticator and stores results in a text file. +</para> + +<para> +Furthermore, the said text file is written in a specific format, that can be used with +an external utility called AlchTool, developed by Jeskko and yours truly (Ggr). This PHP-based +web utility can greatly increase your potion research efficiency. Currently (as of March 2011) +AlchTool is in "beta"-phase of version 2, but the code can be retrieved from Pupunen Mercurial +repository at <ulink linkend="http://pupunen.net/hg/alchemy/">http://pupunen.net/hg/alchemy/</ulink>. +</para> + +<para> +Default location of the results text file is user's home directory, in file called <emphasis>alch_results.txt</emphasis>, +but this can be changed by altering <emphasis>galch_file</emphasis> TF variable, for example: +</para> + +<userinput>/eval /set galch_file=%{HOME}/someotherfile.txt</userinput> + <!-- @commands --> <!-- @binds --> <!-- @keybinds -->