Mercurial > hg > batmud > alchtool
view README.html @ 68:8a1af7e3d1f1
Ok.
author | Matti Hamalainen <ccr@tnsp.org> |
---|---|
date | Mon, 17 Feb 2014 20:34:16 +0200 |
parents | 74777d6109a0 |
children | 61292cb4e59c |
line wrap: on
line source
<html> <head> <title>AlchTool Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <link href="alch.css" title="compact" rel="stylesheet" type="text/css"> </head> <body> <div class="docs"> <h1>AlchTool - PHP-based alchemist potion research tool</h1> <p> © 2006-2011 Jarkko Vääräniemi (Jeskko Pupunen) and Matti Hämäläinen (Ggr Pupunen) </p> <p> This software is a simple PHP-based script for making <a href="http://www.bat.org/">BatMUD</a> 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. </p> <h2>Requirements</h2> <p> 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. <b>GD extension</b> for PHP is also currently required. </p> <p> Other thing you will need, of course, is a web-browser, for viewing the data. </p> <h2>How to use</h2> <p> Input data for the script can be written in file <b>results.txt</b> either by hand, or any other way desired, such as MUD client triggers. Latest version of <a href="http://www.tnsp.org/~ccr/ggrtf/">GgrTF scriptset</a> for TinyFugue offers a nifty alchemist guild module, that can automate the data file generation completely. </p> <p> The format of the data file is as follows, example of a datafile can be found <a href="results_example.txt">here</a>. </p> <ul> <li>Any non-empty line that does NOT start with hash '#' character, is considered data.</li> <li>Each data line is of format: <b>mineral</b> <b>organ</b> <b>herb</b> <i>result</i></li> <li>Each entry (mineral, organ, herb, result) is separated by whitespace of any amount you want to use.</li> <li>Result field is as follows:<br /> <ul> <li><b>-</b> : No match.</li> <li><b>?potion_name</b> : Close, but no cigar.</li> <li><b>!potion_name</b> : Found potion.</li> </ul> </li> <li>Allowed names for minerals, herbs and organs are listed by the script. Potion names are not limited, but you should be consistent, mismatches cannot be detected!</li> </ul> <h2>Contact, bugreports, etc</h2> <p> Tells to Ggr or Jeskko @ BatMUD, or e-mail ccr@tnsp.org (Ggr). </p> </div> </html>