changeset 1:38fb549a8b93

Added missing file.
author Matti Hamalainen <ccr@tnsp.org>
date Sat, 02 Jan 2016 18:12:02 +0200
parents c4f3b5b88891
children cafba778bdce
files instructions.php
diffstat 1 files changed, 107 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/instructions.php	Sat Jan 02 18:12:02 2016 +0200
@@ -0,0 +1,107 @@
+<?
+require "mgeneric.inc.php";
+
+$pageCSS = "/css/docs4.css";
+$pageTitle = "Alloy combo information submission instructions";
+cmPrintPageHeader($pageTitle);
+
+echo "<h1>".$pageTitle."</h1>\n";
+?>
+<h3>Preamble</h3>
+<p>
+Okay. First of all, the <a href="/mat/">Pupunen alloy and material info database</a>
+was originally SUPPOSED to be a joint/open project. Of course,
+that didn't really happen - almost nobody was interested.
+People are generally just lazy bastards.
+During the years there have been some other contributors, those
+are listed on the alloy information page, but mostly the work was
+done by me (Ggr) as a mortal.
+<b>And I've since moved to the wizardly realms, I am
+not going to add into the data myself anymore.</b>
+</p>
+
+<p>
+<b>BUT! I am still willing to run the site and update the data IF new
+data is provided by mortal players who are ready to follow the
+instructions provided here.
+</b>
+</p>
+
+<h3>Notice!</h3>
+<p>
+Do note that I am NOT going to accept any "research" in some
+random format or as CSV or Excel tables or whatever. The system
+I made is based on raw BatMUD log file data and that is the
+ONLY format I'm going to accept contributions in.
+</p>
+
+<h3>How to gather data</h3>
+
+<ol>
+<li>To gather data, you need to have <b>logfiles</b> and do alloying.
+</li>
+
+<li>The logfiles do not need to be "complete", the ONLY relevant
+   lines of interest to my system are the:
+<pre>
+You mix X and Y and create a quantity of Z.
+</pre>
+AND the 1-2 lines preceeding it.
+</li>
+</ol>
+
+<p>
+The easiest way to get this result is to use GNU "grep" utility,
+available in most UNIX/Linux systems as follows:
+</p>
+
+<pre>
+cat your_log_files | grep -a -B2 "^You mix .* and create a quantity of " > alloylog.txt
+</pre>
+
+<p>
+The resulting alloylog.txt contents should look something like this:
+</p>
+<pre>
+An ethereal blue hammer appears in your right hand. 
+You mix copper and aluminium and create a quantity of bronze.
+--
+An ethereal blue hammer appears in your right hand. 
+You mix iron and hematite and create a quantity of brass.
+--
+You slip up and fumble your attempt.
+You mix obsidian and crystal and create a quantity of glass.
+--
+An ethereal blue hammer appears in your right hand. 
+You mix nullium and illumium and create a quantity of dukonium.
+</pre>
+
+<h3>How to submit</h3>
+<p>
+When and if you have the log data in the desired format, 
+provide me with the "alloylog.txt" file via e-mail or as a
+downloadable link.
+</p>
+
+<p>If you can't use GNU grep or other method of providing similar results, but
+are willing to send your logfiles verbatim, that is also possible,
+but not recommended.
+</p>
+
+<p>
+In either case, please compress your logfile(s)/result file(s) with RAR, 7-Zip or other
+generally used archiver especially if the files are larger than few hundred kilobytes.
+</p>
+
+<p>
+If you have something to submit, or have questions, contact me via
+tells in BatMUD or by e-mail <b>ccr@tnsp.org</b>
+</p>
+
+<p>
+<b>-- Ggr</b>
+</p>
+
+<?
+cmPrintPageFooter();
+?>