changeset 185:76411af070f2 misc

Add documentation.
author Matti Hamalainen <ccr@tnsp.org>
date Mon, 17 Jan 2011 21:14:24 +0200
parents 84fa86a54038
children e23ea99e7aa8
files log2npctemplate.pl
diffstat 1 files changed, 18 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/log2npctemplate.pl	Sat Jan 15 08:08:57 2011 +0200
+++ b/log2npctemplate.pl	Mon Jan 17 21:14:24 2011 +0200
@@ -6,6 +6,24 @@
 #
 # Requires Perl 5.8.
 #
+# Usage
+# =====
+# 1) command qla say -- $* --;prod $*;whereami;say -??-;blook at $*;say -==-;look at $*;say ====
+# 2) rip_action set party kills (or spam party kills every once in a while to collect expvalue data)
+# 3) qla monster
+# 4) Cast detect race, detect alignment, whatnot at monster (if you wish/can/have those).
+# 5) Fight and kill monster.
+# 6) run log2npctemplate.pl < logfile.log > output.txt
+#
+# Notes
+# =====
+# - You must have spellname translator, preferably one with format:
+#   Xxxx claps its hands and says (cure critical wounds)
+#
+# - There is some flexibility in the parser, it can filter out ANSI from the
+#   input log, etc. but you may have to customize it. And that requires Perl
+#   knowledge.
+#
 use strict;
 
 # Options