Mercurial > hg > batmud > alchtool

changeset 49:3fa5d890fc5a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add documentation.
author Matti Hamalainen <ccr@tnsp.org>
date Tue, 22 Mar 2011 20:15:37 +0200
parents 95bcf7c1c080
children c3bb5c0f15d4
files README.html
diffstat 1 files changed, 69 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /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 @@
+<html>
+ <head>
+  <title>AlchTool Documentation</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+  <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>
+&copy; 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 may be good to have, but
+is not a strict requirement.
+</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 either manually by hand, or you any
+other process, 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 <b>results.txt</b> 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 (minera, 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>