Mercurial > hg > batmud > alchtool
annotate README.html @ 89:eb5b6db2b250 default tip
Fixes.
| author | Matti Hamalainen <ccr@tnsp.org> |
|---|---|
| date | Thu, 19 Oct 2017 17:42:05 +0300 |
| parents | 3f30d4d59278 |
| children |
| 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> | |
| 73 | 11 © 2006-2014 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 | |
| 75 | 33 <h2>"Installation"</h2> |
| 34 <p> | |
| 76 | 35 Place the files (<b>index.php</b> and <b>results.txt</b> at the very least) in a directory |
| 75 | 36 that is accessible to whatever web-server and PHP solution you are using. |
| 37 You probably want the img/ directory as well. | |
| 38 </p> | |
| 39 | |
| 40 <p> | |
| 41 For local execution with plain PHP built-in web-server (PHP 5.4 or later required), | |
| 42 without external web-server such as Apache, you can use the included "router.php" | |
| 43 to run the system as follows: | |
| 44 </p> | |
| 45 <pre> | |
| 46 $ php -S localhost:8888 router.php | |
| 47 </pre> | |
| 48 <p> | |
| 49 Then point your web-browser to <a | |
| 50 href="http://localhost:8888/">http://localhost:8888/</a>. | |
| 51 You may need to adjust the port (8888) or your firewall settings. | |
| 52 </p> | |
| 53 | |
| 54 | |
| 49 | 55 <h2>How to use</h2> |
| 56 <p> | |
| 50 | 57 Input data for the script can be written in file <b>results.txt</b> |
| 67 | 58 either by hand, or any other way desired, such as MUD client triggers. Latest version of <a |
| 49 | 59 href="http://www.tnsp.org/~ccr/ggrtf/">GgrTF scriptset</a> for TinyFugue |
| 60 offers a nifty alchemist guild module, that can automate the data file | |
| 61 generation completely. | |
| 62 </p> | |
| 63 <p> | |
| 50 | 64 The format of the data file is as follows, example of a datafile can be |
| 49 | 65 found <a href="results_example.txt">here</a>. |
| 66 </p> | |
| 67 <ul> | |
| 68 <li>Any non-empty line that does NOT start with hash '#' character, is considered data.</li> | |
| 69 <li>Each data line is of format: <b>mineral</b> <b>organ</b> <b>herb</b> | |
| 70 <i>result</i></li> | |
| 68 | 71 <li>Each entry (mineral, organ, herb, result) is separated by whitespace |
| 72 of any amount you want to use.</li> | |
| 49 | 73 <li>Result field is as follows:<br /> |
| 74 <ul> | |
| 75 <li><b>-</b> : No match.</li> | |
| 76 <li><b>?potion_name</b> : Close, but no cigar.</li> | |
| 77 <li><b>!potion_name</b> : Found potion.</li> | |
| 78 </ul> | |
| 79 </li> | |
| 80 <li>Allowed names for minerals, herbs and organs are listed by the script. | |
| 81 Potion names are not limited, but you should be consistent, mismatches | |
| 82 cannot be detected!</li> | |
| 83 </ul> | |
| 84 | |
| 85 <h2>Contact, bugreports, etc</h2> | |
| 86 <p> | |
| 87 Tells to Ggr or Jeskko @ BatMUD, or e-mail ccr@tnsp.org (Ggr). | |
| 88 </p> | |
| 89 </div> | |
| 90 </html> |