Mercurial > hg > batmud > alchtool
annotate README.html @ 68:8a1af7e3d1f1
Ok.
author | Matti Hamalainen <ccr@tnsp.org> |
---|---|
date | Mon, 17 Feb 2014 20:34:16 +0200 |
parents | 74777d6109a0 |
children | 61292cb4e59c |
rev | line source |
---|---|
49 | 1 <html> |
2 <head> | |
3 <title>AlchTool Documentation</title> | |
65 | 4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> |
49 | 5 <link href="alch.css" title="compact" rel="stylesheet" type="text/css"> |
6 </head> | |
7 <body> | |
8 <div class="docs"> | |
9 <h1>AlchTool - PHP-based alchemist potion research tool</h1> | |
10 <p> | |
67 | 11 © 2006-2011 Jarkko Vääräniemi (Jeskko Pupunen) and Matti Hämäläinen (Ggr Pupunen) |
49 | 12 </p> |
13 <p> | |
14 This software is a simple PHP-based script for making <a | |
15 href="http://www.bat.org/">BatMUD</a> alchemist potion research easier and | |
16 a more bearable process. It will help you keep book of the combinations you | |
17 have researched and will automatically eliminate combinations that are not | |
18 possible. | |
19 </p> | |
20 | |
21 <h2>Requirements</h2> | |
22 <p> | |
23 Requirements are simple, but may not be available to everyone. You will need | |
24 an environment capable of hosting PHP scripts, and a web-server. Most | |
25 UNIX/Linux shell accounts offer this possibility. PHP version 5 is | |
26 recommended, but the script may work with PHP version old as 4.3. We make no | |
63
414c64973f0c
Change documentation, as PHP GD extension currently strictly required (this
Matti Hamalainen <ccr@tnsp.org>
parents:
50
diff
changeset
|
27 guarantees, however. <b>GD extension</b> for PHP is also currently required. |
49 | 28 </p> |
29 <p> | |
30 Other thing you will need, of course, is a web-browser, for viewing the data. | |
31 </p> | |
32 | |
33 <h2>How to use</h2> | |
34 <p> | |
50 | 35 Input data for the script can be written in file <b>results.txt</b> |
67 | 36 either by hand, or any other way desired, such as MUD client triggers. Latest version of <a |
49 | 37 href="http://www.tnsp.org/~ccr/ggrtf/">GgrTF scriptset</a> for TinyFugue |
38 offers a nifty alchemist guild module, that can automate the data file | |
39 generation completely. | |
40 </p> | |
41 <p> | |
50 | 42 The format of the data file is as follows, example of a datafile can be |
49 | 43 found <a href="results_example.txt">here</a>. |
44 </p> | |
45 <ul> | |
46 <li>Any non-empty line that does NOT start with hash '#' character, is considered data.</li> | |
47 <li>Each data line is of format: <b>mineral</b> <b>organ</b> <b>herb</b> | |
48 <i>result</i></li> | |
68 | 49 <li>Each entry (mineral, organ, herb, result) is separated by whitespace |
50 of any amount you want to use.</li> | |
49 | 51 <li>Result field is as follows:<br /> |
52 <ul> | |
53 <li><b>-</b> : No match.</li> | |
54 <li><b>?potion_name</b> : Close, but no cigar.</li> | |
55 <li><b>!potion_name</b> : Found potion.</li> | |
56 </ul> | |
57 </li> | |
58 <li>Allowed names for minerals, herbs and organs are listed by the script. | |
59 Potion names are not limited, but you should be consistent, mismatches | |
60 cannot be detected!</li> | |
61 </ul> | |
62 | |
63 <h2>Contact, bugreports, etc</h2> | |
64 <p> | |
65 Tells to Ggr or Jeskko @ BatMUD, or e-mail ccr@tnsp.org (Ggr). | |
66 </p> | |
67 </div> | |
68 </html> |