# HG changeset patch # User Matti Hamalainen # Date 1300817737 -7200 # Node ID 3fa5d890fc5ad6b6b5f6ae6652b0f63fca4b6fc4 # Parent 95bcf7c1c0802655ba50582a7140301c43057707 Add documentation. diff -r 95bcf7c1c080 -r 3fa5d890fc5a README.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README.html Tue Mar 22 20:15:37 2011 +0200 @@ -0,0 +1,69 @@ + + + AlchTool Documentation + + + + +
+

AlchTool - PHP-based alchemist potion research tool

+

+© 2006-2011 Jarkko Vääräniemi (Jeskko Pupunen) and Matti Hämäläinen (Ggr Pupunen) +

+

+This software is a simple PHP-based script for making BatMUD alchemist potion research easier and +a more bearable process. It will help you keep book of the combinations you +have researched and will automatically eliminate combinations that are not +possible. +

+ +

Requirements

+

+Requirements are simple, but may not be available to everyone. You will need +an environment capable of hosting PHP scripts, and a web-server. Most +UNIX/Linux shell accounts offer this possibility. PHP version 5 is +recommended, but the script may work with PHP version old as 4.3. We make no +guarantees, however. GD extension for PHP may be good to have, but +is not a strict requirement. +

+

+Other thing you will need, of course, is a web-browser, for viewing the data. +

+ +

How to use

+

+Input data for the script can be written either manually by hand, or you any +other process, such as MUD client triggers. Latest version of GgrTF scriptset for TinyFugue +offers a nifty alchemist guild module, that can automate the data file +generation completely. +

+

+The format of the data file results.txt is as follows, example of a datafile can be +found here. +

+ + +

Contact, bugreports, etc

+

+Tells to Ggr or Jeskko @ BatMUD, or e-mail ccr@tnsp.org (Ggr). +

+
+